Skip to content

api-items.ru.md

Latest commit

 

History

History
164 lines (102 loc) · 5.41 KB

api-items.ru.md

File metadata and controls

164 lines (102 loc) · 5.41 KB
Raw

Элементы (Items)

Выборка элементов, удовлетворяющих выражению

Метод API: POST /Api/Item/Query

public function ItemService::query(string $expression, array $properties
                    [ , array $orderBy, [ , int $limit [ , int $offset ]]] ): Item[]

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

  • $expression — Выражение на Comindware Expression Language.
  • $properties — Список свойств элемента, которые надо вернуть. Обратите внимание, что если вам нужны системные (встроенные) свойства Item, то их тоже надо указывать в этом аргументе (за исключением свойства «id», которое возвращается всегда).
  • $orderBy — Параметры сортировки в виде массива ['поле' => 'направление'], где «поле» — имя поля, а «направление» — «Ascending» или «Descending». На данный момент сортировка возможна только по одному полю. Если аргумент не указан или null, элементы будут отсортированы по возрастанию идентификатора.
  • $limit — Наибольшее количество элементов, которые надо вернуть (по умолчанию 100).
  • $offset — Сколько элементов пропустить от начала.

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

Массив Item. Обратите внимание, что в моделях будут заполнены только те свойства, которые были указаны в аргументе $properties.

Ошибки

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

Пример

Получение элемента

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

public function ItemService::get(string $id): Item

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

  • $id — Идентификатор элемента.

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

Item — элемент.

Ошибки

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

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

Пример

// $api — instance of Comindware\Tracker\API\Api
$item = $api->items()->get('123456');

Создание элемента

Метод API: POST /Api/Item/{id}

public function ItemService::create(string $containerId, Item $item): string

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

  • $containerId — Идентификатор контейнера, в котором создать элемент.
  • $item — Модель создаваемого элемента.

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

Идентификатор созданного элемента.

Ошибки

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

InvalidArgumentException если у $item не задано ни одного свойства.

Пример

use Comindware\Tracker\API\Model\Item;

// Create new Item.
$item = new Item();
$item->set('title', 'Foo');
$item->set('description', '<h1>Foo</h1> <p>Bar baz.</p>');

// Post it to Tracker.
// $api — instance of Comindware\Tracker\API\Api
$itemId = $api->items()->create('tracker.123', $item);

См. также:

Получение возможных переходов

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

public function ItemService::getTransitions( string $id ): Transition[]

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

  • $id — идентификатор Item.

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

Массив Transition.

Ошибки

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

Пример

// $api — instance of Comindware\Tracker\API\Api
$transitions = $api->items()->getTransitions('123456');

Перевод в другое состояние

Метод API: GET /Api/Item/{id}/Transition/{transition}

public function ItemService::transit( string $itemId, string $transitionId ): void

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

  • $itemId — идентификатор Item.
  • $transitionId — идентификатор Transition.

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

Метод не возвращает значений.

Ошибки

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

Пример

// $api — instance of Comindware\Tracker\API\Api
$api->items()->transit('123456', '3d9c1eb0650f42f8ac1bad7d7e0067ac');