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

Check whether task workspace files can be opened

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

Check whether task workspace files can be opened.

Авторизация

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.

Тело запроса

application/json · обязательно

queriesarray<object>Обязательный
queries[].projectIdstring (uuid)Необязательный
queries[].workspaceIdstring (uuid)Необязательный
queries[].pathstringОбязательныйat least 1 character
queries[].workspacestringНеобязательныйone of: "auto", "execution", "project"

Ответы

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
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.
429Too many requestsToo many requests; wait for Retry-After seconds.

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

Tasks