Skip to content

api-workspaces.ru.md

Latest commit

 

History

History
57 lines (34 loc) · 1.61 KB

api-workspaces.ru.md

File metadata and controls

57 lines (34 loc) · 1.61 KB
Raw

Рабочие пространства (Workspaces)

Класс Comindware\Tracker\API\Service\WorkspaceService.

Получение всех рабочих пространств

Метод API: GET /Api/Workspace

public function WorkspaceService::getAll(): Workspace[]

Возвращаемые значения

Массив Workspace — рабочие пространства.

Ошибки

Исключения, вбрасываемые Client::sendRequest.

Comindware\Tracker\API\Exception\UnexpectedValueException если сервер вернул неожиданное значение.

Пример

// $api — instance of Comindware\Tracker\API\Api
$workspaces = $api->workspaces()->getAll();

Получение рабочего пространства

Метод API: GET /Api/Workspace/{id}

public function WorkspaceService::get(string $id): Workspace

Список параметров

  • $id — Идентификатор рабочего пространства.

Возвращаемые значения

Workspace — запрошенное рабочее пространство.

Ошибки

Исключения, вбрасываемые Client::sendRequest.

Comindware\Tracker\API\Exception\UnexpectedValueException если сервер вернул неожиданное значение.

Пример

// $api — instance of Comindware\Tracker\API\Api
$workspace = $api->workspaces()->get('ws.123');