Aller au contenu
Documentation

Trouver un modèle et ses identifiants conviviaux

Lister les modèles de parcours, puis lire celui qui sert pour relever ses participants et ses documents.

2 min de lecture Mise à jour le 11 novembre 2026

1Lister les modèles

GET https://staging-api.docage.com/Transactions/TemplatesIdAndName
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…
JSON
[
  { "Id": "aaaaaaaa-0000-4000-8000-000000000001", "Name": "Contrat de prestation", "IsSystem": false },
  { "Id": "aaaaaaaa-0000-4000-8000-000000000011", "Name": "Signature de devis", "IsSystem": true }
]

Un modèle système (IsSystem) est fourni par Docage à toutes les organisations ; les autres sont ceux de votre organisation.

Pour lire les modèles avec leurs propriétés — filtrés, triés, paginés —, interrogez la liste des parcours avec IsTemplate :

QUERY https://staging-api.docage.com/Transactions
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…
Content-Type: application/json

{ "IsTemplate": true, "SortOrder": "Name", "Take": 50, "EntityProperties": ["Id", "Name", "Description"] }

Voir Lire des listes pour le filtre, le tri et la pagination.

2Relever ses identifiants conviviaux

GET https://staging-api.docage.com/Transactions/aaaaaaaa-0000-4000-8000-000000000001
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…

Relevez :

  • les participants (TransactionMembers[]) : leur FriendlyName — « Client », « Commercial »… — et leur PersonType : 2 est un participant à définir, qui attend une personne à chaque envoi ; 0 un utilisateur, 1 un contact déjà désignés. Leurs actions sont dans TransactionMemberActions[] (Type : 2 validation, 3 signature…) ;
  • les observateurs (TransactionObservers[]), désignés de même par leur FriendlyName ;
  • les documents (TransactionFiles[]) : leur FriendlyName — « Contrat » —, leur Type (0 à signer, 1 annexe), et IsDynamic : un document à remplacer, qui attend un fichier à chaque envoi.

Ce sont ces noms qui servent de clés au formulaire de création.

Les pièges

  • Un modèle ne se lance pas : il sert à créer des parcours.
  • Les identifiants conviviaux sont propres au modèle : un participant se renomme dans l'application, et la clé change avec lui.