public

Produire un document d’un type, rempli depuis un dossier et les valeurs fournies

POST

/v1/document-types/{key}/renders

curl --request POST \
  --url '/v1/document-types/{key}/renders' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "idempotencyKey": "<string>",
  "matterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "values": {}
}
'

{
  "completedAt": "<string>",
  "contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "documentName": "<string>",
  "documentType": "<string>",
  "errorCode": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "matterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "report": {},
  "status": "en_attente"
}

Autorisations

Authorizationstringheaderobligatoire

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

keystringobligatoire

Corps

contactIdstring

La fiche contact de départ (société ou personne), quand il n’y a pas de dossier.

idempotencyKeystringobligatoire

Required string length: 8 - 128

matterIdstring

Le dossier de départ. Avec lui, le document se dépose dans sa GED.

valuesobjectdefault:{}

Les valeurs du rendu. Jamais un champ rempli par Oslaw (filledByOslaw).

Afficher child attributes

Réponse

completedAtstring | nullobligatoire

contactIdstring | nullobligatoire

La fiche de départ, ou null.

createdAtstringobligatoire

documentNamestring | nullobligatoire

Le document déposé dans la GED (du dossier, ou « Documents générés ») ; il n’y a pas de lien.

documentTypestringobligatoire

errorCodestring | nullobligatoire

Le code d’échec, traduit en phrase et geste dans la réponse texte.

idstringobligatoire

La poignée du rendu, à repasser à get_render tant qu’il n’est pas terminé.

matterIdstring | nullobligatoire

Le dossier de départ, ou null pour un rendu depuis un contact ou sans point de départ.

reportobject | nullobligatoire

Provenance des valeurs, valeurs à relire, avertissements.

statusenum<string>obligatoire

Options disponibles: en_attente, en_cours, termine, echec

Besoin d'aide supplémentaire ? Demander à l'équipe