Swagger\Client\BoardApi

All URIs are relative to https://localhost:20000/api/3.1

Method	HTTP request	Description
allBoardItems	GET /board_items	Get All Board Items
allBoardSections	GET /board_sections	Get All Board sections
allBoards	GET /boards	Get All Boards
board	GET /boards/{board_id}	Get Board
boardItem	GET /board_items/{board_item_id}	Get Board Item
boardSection	GET /board_sections/{board_section_id}	Get Board section
createBoard	POST /boards	Create Board
createBoardItem	POST /board_items	Create Board Item
createBoardSection	POST /board_sections	Create Board section
deleteBoard	DELETE /boards/{board_id}	Delete Board
deleteBoardItem	DELETE /board_items/{board_item_id}	Delete Board Item
deleteBoardSection	DELETE /board_sections/{board_section_id}	Delete Board section
searchBoards	GET /boards/search	Search Boards
updateBoard	PATCH /boards/{board_id}	Update Board
updateBoardItem	PATCH /board_items/{board_item_id}	Update Board Item
updateBoardSection	PATCH /board_sections/{board_section_id}	Update Board section

allBoardItems

\Swagger\Client\Model\BoardItem[] allBoardItems($fields, $sorts, $board_section_id)

Get All Board Items

Get information about all board items.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\BoardApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$fields = "fields_example"; // string | Requested fields.
$sorts = "sorts_example"; // string | Fields to sort by.
$board_section_id = "board_section_id_example"; // string | Filter to a specific board section

try {
    $result = $apiInstance->allBoardItems($fields, $sorts, $board_section_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardApi->allBoardItems: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
fields	string	Requested fields.	[optional]
sorts	string	Fields to sort by.	[optional]
board_section_id	string	Filter to a specific board section	[optional]

Return type

\Swagger\Client\Model\BoardItem[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

allBoardSections

\Swagger\Client\Model\BoardSection[] allBoardSections($fields, $sorts)

Get All Board sections

Get information about all board sections.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\BoardApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$fields = "fields_example"; // string | Requested fields.
$sorts = "sorts_example"; // string | Fields to sort by.

try {
    $result = $apiInstance->allBoardSections($fields, $sorts);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardApi->allBoardSections: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
fields	string	Requested fields.	[optional]
sorts	string	Fields to sort by.	[optional]

Return type

\Swagger\Client\Model\BoardSection[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

allBoards

\Swagger\Client\Model\Board[] allBoards($fields)

Get All Boards

Get information about all boards.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\BoardApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->allBoards($fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardApi->allBoards: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\Board[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

board

\Swagger\Client\Model\Board board($board_id, $fields)

Get Board

Get information about a board.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\BoardApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$board_id = "board_id_example"; // string | Id of board
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->board($board_id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardApi->board: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
board_id	string	Id of board
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\Board

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

boardItem

\Swagger\Client\Model\BoardItem boardItem($board_item_id, $fields)

Get Board Item

Get information about a board item.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\BoardApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$board_item_id = "board_item_id_example"; // string | Id of board item
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->boardItem($board_item_id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardApi->boardItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
board_item_id	string	Id of board item
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\BoardItem

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

boardSection

\Swagger\Client\Model\BoardSection boardSection($board_section_id, $fields)

Get Board section

Get information about a board section.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\BoardApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$board_section_id = "board_section_id_example"; // string | Id of board section
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->boardSection($board_section_id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardApi->boardSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
board_section_id	string	Id of board section
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\BoardSection

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createBoard

\Swagger\Client\Model\Board createBoard($body, $fields)

Create Board

Create a new board.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\BoardApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\Board(); // \Swagger\Client\Model\Board | Board
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->createBoard($body, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardApi->createBoard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\Board	Board
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\Board

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createBoardItem

\Swagger\Client\Model\BoardItem createBoardItem($body, $fields)

Create Board Item

Create a new board item.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\BoardApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\BoardItem(); // \Swagger\Client\Model\BoardItem | Board Item
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->createBoardItem($body, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardApi->createBoardItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\BoardItem	Board Item
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\BoardItem

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createBoardSection

\Swagger\Client\Model\BoardSection createBoardSection($body, $fields)

Create Board section

Create a new board section.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\BoardApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\BoardSection(); // \Swagger\Client\Model\BoardSection | Board section
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->createBoardSection($body, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardApi->createBoardSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\BoardSection	Board section
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\BoardSection

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteBoard

string deleteBoard($board_id)

Delete Board

Delete a board.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\BoardApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$board_id = "board_id_example"; // string | Id of board

try {
    $result = $apiInstance->deleteBoard($board_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardApi->deleteBoard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
board_id	string	Id of board

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteBoardItem

string deleteBoardItem($board_item_id)

Delete Board Item

Delete a board item.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\BoardApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$board_item_id = "board_item_id_example"; // string | Id of board item

try {
    $result = $apiInstance->deleteBoardItem($board_item_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardApi->deleteBoardItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
board_item_id	string	Id of board item

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteBoardSection

string deleteBoardSection($board_section_id)

Delete Board section

Delete a board section.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\BoardApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$board_section_id = "board_section_id_example"; // string | Id of board section

try {
    $result = $apiInstance->deleteBoardSection($board_section_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardApi->deleteBoardSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
board_section_id	string	Id of board section

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

searchBoards

\Swagger\Client\Model\Board[] searchBoards($title, $created_at, $first_name, $last_name, $fields, $favorited, $creator_id, $sorts, $page, $per_page, $offset, $limit, $filter_or, $permission)

Search Boards

Search Boards If multiple search params are given and `filter_or` is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match all search param criteria will be returned. If `filter_or` is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match any of the search criteria. String search params use case-insensitive matching. String search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions. example="dan%" will match "danger" and "Danzig" but not "David" example="D_m%" will match "Damage" and "dump" Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept "IS NULL" and "NOT NULL" as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only "true" and "false" as values.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\BoardApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$title = "title_example"; // string | Matches board title.
$created_at = "created_at_example"; // string | Matches the timestamp for when the board was created.
$first_name = "first_name_example"; // string | The first name of the user who created this board.
$last_name = "last_name_example"; // string | The last name of the user who created this board.
$fields = "fields_example"; // string | Requested fields.
$favorited = true; // bool | Return favorited boards when true.
$creator_id = "creator_id_example"; // string | Filter on boards created by a particular user.
$sorts = "sorts_example"; // string | The fields to sort the results by
$page = 789; // int | The page to return. DEPRECATED. Use offset instead.
$per_page = 789; // int | The number of items in the returned page. DEPRECATED. Use limit instead.
$offset = 789; // int | The number of items to skip before returning any. (used with limit and takes priority over page and per_page)
$limit = 789; // int | The maximum number of items to return. (used with offset and takes priority over page and per_page)
$filter_or = true; // bool | Combine given search criteria in a boolean OR expression
$permission = "permission_example"; // string | Filter results based on permission, either show (default) or update

try {
    $result = $apiInstance->searchBoards($title, $created_at, $first_name, $last_name, $fields, $favorited, $creator_id, $sorts, $page, $per_page, $offset, $limit, $filter_or, $permission);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardApi->searchBoards: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
title	string	Matches board title.	[optional]
created_at	string	Matches the timestamp for when the board was created.	[optional]
first_name	string	The first name of the user who created this board.	[optional]
last_name	string	The last name of the user who created this board.	[optional]
fields	string	Requested fields.	[optional]
favorited	bool	Return favorited boards when true.	[optional]
creator_id	string	Filter on boards created by a particular user.	[optional]
sorts	string	The fields to sort the results by	[optional]
page	int	The page to return. DEPRECATED. Use offset instead.	[optional]
per_page	int	The number of items in the returned page. DEPRECATED. Use limit instead.	[optional]
offset	int	The number of items to skip before returning any. (used with limit and takes priority over page and per_page)	[optional]
limit	int	The maximum number of items to return. (used with offset and takes priority over page and per_page)	[optional]
filter_or	bool	Combine given search criteria in a boolean OR expression	[optional]
permission	string	Filter results based on permission, either show (default) or update	[optional]

Return type

\Swagger\Client\Model\Board[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateBoard

\Swagger\Client\Model\Board updateBoard($board_id, $body, $fields)

Update Board

Update a board definition.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\BoardApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$board_id = "board_id_example"; // string | Id of board
$body = new \Swagger\Client\Model\Board(); // \Swagger\Client\Model\Board | Board
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->updateBoard($board_id, $body, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardApi->updateBoard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
board_id	string	Id of board
body	\Swagger\Client\Model\Board	Board
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\Board

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateBoardItem

\Swagger\Client\Model\BoardItem updateBoardItem($board_item_id, $body, $fields)

Update Board Item

Update a board item definition.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\BoardApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$board_item_id = "board_item_id_example"; // string | Id of board item
$body = new \Swagger\Client\Model\BoardItem(); // \Swagger\Client\Model\BoardItem | Board Item
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->updateBoardItem($board_item_id, $body, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardApi->updateBoardItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
board_item_id	string	Id of board item
body	\Swagger\Client\Model\BoardItem	Board Item
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\BoardItem

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateBoardSection

\Swagger\Client\Model\BoardSection updateBoardSection($board_section_id, $body, $fields)

Update Board section

Update a board section definition.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\BoardApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$board_section_id = "board_section_id_example"; // string | Id of board section
$body = new \Swagger\Client\Model\BoardSection(); // \Swagger\Client\Model\BoardSection | Board section
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->updateBoardSection($board_section_id, $body, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardApi->updateBoardSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
board_section_id	string	Id of board section
body	\Swagger\Client\Model\BoardSection	Board section
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\BoardSection

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

BoardApi.md

Latest commit

History

BoardApi.md

File metadata and controls

Swagger\Client\BoardApi

allBoardItems

Get information about all board items.

Example

Parameters

Return type

Authorization

HTTP request headers

allBoardSections

Get information about all board sections.

Example

Parameters

Return type

Authorization

HTTP request headers

allBoards

Get information about all boards.

Example

Parameters

Return type

Authorization

HTTP request headers

board

Get information about a board.

Example

Parameters

Return type

Authorization

HTTP request headers

boardItem

Get information about a board item.

Example

Parameters

Return type

Authorization

HTTP request headers

boardSection

Get information about a board section.

Example

Parameters

Return type

Authorization

HTTP request headers

createBoard

Create a new board.

Example

Parameters

Return type

Authorization

HTTP request headers

createBoardItem

Create a new board item.

Example

Parameters

Return type

Authorization

HTTP request headers

createBoardSection

Create a new board section.

Example

Parameters

Return type

Authorization

HTTP request headers

deleteBoard

Delete a board.

Example

Parameters

Return type

Authorization

HTTP request headers

deleteBoardItem

Delete a board item.

Example