La referencia de la API se publica en inglés.

Write a compiled status card query

PUT/api/status-cards/{id}/query
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Write a compiled status card query.

Autorización

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Cómo funcionan las claves.

Parámetros de ruta

idstringObligatorioThe status card's id.

Cuerpo de la solicitud

application/json · obligatorio

queriesarray<object>Obligatorio
queries[].qanyOpcional
queries[].scopeanyOpcional
queries[].limitanyOpcional
queries[].offsetanyOpcional
queries[].statusanyOpcional
queries[].displayStatusanyOpcional
queries[].priorityanyOpcional
queries[].assigneeAgentIdanyOpcional
queries[].assigneeUserIdanyOpcional
queries[].projectIdanyOpcional
queries[].labelIdanyOpcional
queries[].updatedWithinanyOpcional
queries[].updatedAfteranyOpcional
queries[].sortanyOpcional
titlestringObligatorio1–300 characters
changeSummarystringObligatorio1–2000 characters
generationIssueIdstring (uuid)Obligatorio

Respuestas

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.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Status cards