Aller au contenu
Documentation

Rechercher des parcours

Lister les parcours en cours, terminés, d'une période, d'un nom, ou ceux qui attendent votre signature.

2 min de lecture Mise à jour le 9 novembre 2026

La liste des parcours se lit à l'adresse de leur type, avec un filtre dans le corps :

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

{
  "Filter": {
    "OperatorType": "And",
    "Operands": [
      { "PropertyName": "GlobalStatus", "Comparison": "=", "Value": "3" },
      { "PropertyName": "Name", "Comparison": "contains", "Value": "facture" }
    ]
  },
  "SortOrder": "StartDate_Desc",
  "Skip": 0,
  "Take": 50,
  "EntityProperties": ["Id", "Name", "GlobalStatus", "StartDate", "EndDate"]
}

Ici, les parcours terminés dont le nom contient « facture », du plus récent au plus ancien. La réponse est un tableau de parcours ; l'en-tête Docage-TotalItems donne leur nombre total. La même lecture se fait par GET https://staging-api.docage.com/Transactions, avec le même corps : voir Lire des listes.

Des filtres courants

Les parcours… Le filtre
en cours { "PropertyName": "GlobalStatus", "Comparison": "=", "Value": "2" }
terminés { "PropertyName": "GlobalStatus", "Comparison": "=", "Value": "3" }
refusés, expirés ou annulés GlobalStatus à 4, 5 ou 6
envoyés depuis le 1er novembre { "PropertyName": "StartDate", "Comparison": ">=", "Value": "2026-11-01T00:00:00Z" }
qui attendent votre signature { "PropertyName": "IsSignableByMe", "Comparison": "=", "Value": "true" }
d'un champ personnalisé { "PropertyName": "CustomFields.NumeroContrat", "Comparison": "=", "Value": "C-20810" }
de votre référence { "PropertyName": "ExternalId", "Comparison": "=", "Value": "DOSSIER-2026-0042" }

Les valeurs de GlobalStatus sont dans Lire le statut d'un parcours.

Les autres listes

  • Les modèles de parcours : "IsTemplate": true dans le corps — sinon la liste ne rend que des parcours.
  • Les parcours d'un classeur : GET https://staging-api.docage.com/Transactions/BoxList/{boxid}.
  • Les parcours liés à un contact : "LinkedToTypeName": "Contact" et "LinkedToId", l'identifiant du contact.
  • Pour un sélecteur, l'identifiant et le nom seuls : QUERY https://staging-api.docage.com/Transactions/EntitiesIdAndName.

Les pièges

  • Filtrez sur GlobalStatus, pas sur Status : cette ancienne propriété existe encore, avec l'ancienne numérotation (« signé » y valait 5).
  • Un critère qui ne se lit pas — une propriété mal écrite, une valeur d'un autre type — ne retient aucun parcours : une liste vide inattendue se relit critère par critère.
  • Écrivez les dates en UTC, avec leur Z.