Skip to content

api-attachments.ru.md

Latest commit

 

History

History
65 lines (41 loc) · 1.81 KB

api-attachments.ru.md

File metadata and controls

65 lines (41 loc) · 1.81 KB
Raw

Вложения (Attachments)

Создание вложения

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

public function AttachmentService::create(string $itemId, File $file): string

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

  • $itemId — Идентификатор элемента, в котором создать вложение.
  • $file — Файл.

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

Идентификатор созданного вложения.

Ошибки

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

Пример

use Comindware\Tracker\API\Util\File\LocalFile;

// $api — instance of Comindware\Tracker\API\Api
$attachmentId = $api->attachments()->create(
    '123456', // Item id
    new LocalFile('/path/to/file', 'foo.txt')
 );

См. также:

Получение содержимого файла

Метод API: POST /Api/Attachment/Content/{revisionId}

public function AttachmentService::getContent((string $revisionId): Psr\Http\Message\StreamInterface

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

  • $revisionId — Идентификатор версии вложения, содержимое которой надо получить.

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

Экземпляр Psr\Http\Message\StreamInterface для содержимого запрошенного файла.

Ошибки

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

Пример

// $api — instance of Comindware\Tracker\API\Api
$stream = $api->attachments()->getContent('rev.123456');
file_put_contents('/path/to/file', (string) $stream);