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

Read task workspace file content

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

Read task workspace file content.

Авторизация

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)Необязательный
pathstringОбязательныйat least 1 character
workspacestringНеобязательныйone of: "auto", "execution", "project"

Ответы

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