La référence de l'API est publiée en anglais.

Write a compiled status card query

PUT/api/status-cards/{id}/query
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Write a compiled status card query.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

idstringObligatoireThe status card's id.

Corps de la requête

application/json · obligatoire

queriesarray<object>Obligatoire
queries[].qanyFacultatif
queries[].scopeanyFacultatif
queries[].limitanyFacultatif
queries[].offsetanyFacultatif
queries[].statusanyFacultatif
queries[].displayStatusanyFacultatif
queries[].priorityanyFacultatif
queries[].assigneeAgentIdanyFacultatif
queries[].assigneeUserIdanyFacultatif
queries[].projectIdanyFacultatif
queries[].labelIdanyFacultatif
queries[].updatedWithinanyFacultatif
queries[].updatedAfteranyFacultatif
queries[].sortanyFacultatif
titlestringObligatoire1–300 characters
changeSummarystringObligatoire1–2000 characters
generationIssueIdstring (uuid)Obligatoire

Réponses

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.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Status cards