Documentation Home Page OPAL-RT Dashboard Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »


class opalone._internal.boards.Board(board_id, project_id, board_type=None)

Bases: Resource, ABC

Base class for all boards. Cannot be instantiated, must use subclass.

Parameters:
  • board_id (str) – The ID of the board.

  • project_id (str) – The ID of the Project that owns this board.

  • board_type (BoardType) – The type of board.

delete()

Delete the current board.

to_json(fields, values)

Convert this resource to a serialized JSON representation.

Parameters:
  • fields (tuple[str] | list[str]) – Fields to include.

  • values (tuple[object] | list[object]) – The value of each field

Returns:

The serialized JSON representation.

Return type:

str

property created_at: str

The creation date of the board.

This property is read-only, it cannot be modified.

property description: str

A description of the board.

property id: str

The ID of the resource.

This property is read-only, it cannot be modified.

property modified_at: str

The last-modified date of the board.

This property is read-only, it cannot be modified.

property name: str

The name of the board.

The Board name must be unique within a group or within the root level of boards.

property order: int

The order of this board within its group.

property parent: None | Group

The parent Board that contains the current board.

property path: str

The path of the board in the board tree.

This property is read-only, it cannot be modified.

property type: BoardType

The type of the board.

This property is read-only, it cannot be modified.

  • No labels