Skip to content

Board structure

BoardStructure

Bases: Boards

Class responsible to make calls to Kanbanize board structure endpoints

Source code in kanbanize_sdk/endpoints/board_structure.py 
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class BoardStructure(Boards):
    """
    Class responsible to make calls to Kanbanize board structure endpoints
    """

    list = private

    insert = private

    update = private

    delete = private

    def get(self, board_id: int) -> dict:
        """
        This method is responsible to get one board structure from the platform.

        Parameters:
            board_id: An integer parameter that represents the board identification.

        Returns:
            A searched board object
        """
        return self.service.get(self.endpoint + f'/{board_id}/currentStructure')

    def get_revision(self, board_id: int) -> dict:
        """
        This method is responsible to get one board structure revision from the platform.

        Parameters:
            board_id: An integer parameter that represents the board identification.

        Returns:
            A searched board object
        """
        return self.service.get(self.endpoint + f'/{board_id}/currentStructure/revision')

get(board_id)

This method is responsible to get one board structure from the platform.

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board identification.

 required

Returns:

Type Description
dict

A searched board object
Source code in kanbanize_sdk/endpoints/board_structure.py 
18
19
20
21
22
23
24
25
26
27
28
def get(self, board_id: int) -> dict:
    """
    This method is responsible to get one board structure from the platform.

    Parameters:
        board_id: An integer parameter that represents the board identification.

    Returns:
        A searched board object
    """
    return self.service.get(self.endpoint + f'/{board_id}/currentStructure')

get_revision(board_id)

This method is responsible to get one board structure revision from the platform.

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board identification.

 required

Returns:

Type Description
dict

A searched board object
Source code in kanbanize_sdk/endpoints/board_structure.py 
30
31
32
33
34
35
36
37
38
39
40
def get_revision(self, board_id: int) -> dict:
    """
    This method is responsible to get one board structure revision from the platform.

    Parameters:
        board_id: An integer parameter that represents the board identification.

    Returns:
        A searched board object
    """
    return self.service.get(self.endpoint + f'/{board_id}/currentStructure/revision')