Справочник API публикуется на английском языке.

List workspace files for a task

GET/api/issues/{issueId}/file-resources/list
Personal API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

List workspace files for a task.

Pagination. Use limit, offset to page through results. See pagination.

Авторизация

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Как работают ключи.

Параметры пути

issueIdstringОбязательныйThe task's id.

Параметры запроса

projectIdstring (uuid)Необязательный
workspaceIdstring (uuid)Необязательный
workspacestringНеобязательныйone of: "auto", "execution", "project"
pathstringНеобязательныйat least 1 character
modestringНеобязательныйone of: "all", "recent", "changed"
qstringНеобязательный
limitintegerНеобязательный≥ 1≤ 100
offsetintegerНеобязательный≥ 0≤ 10000

Ответы

200SuccessThe request worked; the body holds the result.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
429Too many requestsToo many requests; wait for Retry-After seconds.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Tasks