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

Ensure the review document for a Markdown work product

POST/api/issues/{id}/work-products/{workProductId}/review-document
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Ensure the review document for a Markdown work product.

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 task's id.
workProductIdstringObligatoireThe workproduct's id.

Réponses

200SuccessThe request worked; the body holds the result.
201SuccessCreated; the body holds the new resource.
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.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
413Payload too largeThe body or file is larger than the limit.
415Unsupported media typeThe body is not in a supported content type.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

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

Tasks