Rechercher des pièces justificatives

GET

https://workflow-manager/api/documents/:workflowId/supportingDocuments

GET

/api/documents/:workflowId/supportingDocuments

curl https://workflow-manager/api/documents/workflowId/supportingDocuments \
     -H "Authorization: Bearer <token>"

{
  "pageIndex": 1,
  "itemsPerPage": 1,
  "totalItems": 1,
  "items": [
    {
      "created": 1,
      "displayedParts": [
        {
          "contentType": "string",
          "filename": "string",
          "hash": "string",
          "size": 1,
          "isOriginal": true,
          "policyUri": "string",
          "visualIdentification": "string"
        }
      ],
      "groupId": "string",
      "id": "string",
      "parts": [
        {
          "contentType": "string",
          "filename": "string",
          "hash": "string",
          "size": 1,
          "isOriginal": true,
          "policyUri": "string",
          "visualIdentification": "string"
        }
      ],
      "tenantId": "string",
      "updated": 1,
      "userId": "string",
      "viewAuthorizedGroups": [
        "string"
      ],
      "viewAuthorizedUsers": [
        "string"
      ],
      "workflowId": "string",
      "workflowName": "string",
      "confidentiality": true,
      "orderIndex": 1,
      "pdfSignatureFields": [
        {
          "imageHeight": 1.1,
          "imagePage": 1,
          "imageWidth": 1.1,
          "imageX": 1.1,
          "imageY": 1.1,
          "fieldId": "string"
        }
      ],
      "signatureProfileId": "string",
      "subOrderIndex": 1,
      "data1": "string",
      "data2": "string",
      "data3": "string",
      "data4": "string",
      "data5": "string",
      "data6": "string",
      "data7": "string",
      "data8": "string",
      "data9": "string",
      "data10": "string",
      "data11": "string",
      "data12": "string",
      "data13": "string",
      "data14": "string",
      "data15": "string",
      "data16": "string"
    }
  ]
}

Recherche les pièces justificatives d’un parapheur. Le paramètre de chemin est l’identifiant du parapheur.

Rôle requis

Aucun. Autorisés : les membres d’un groupe autorisé, les utilisateurs du parapheur, le propriétaire.

Également acceptés : jeton d’invitation, jeton de visionneuse.

Recherche les pièces justificatives d'un parapheur. Le paramètre de chemin est l'identifiant du parapheur. <Note title="Rôle requis"> Aucun. Autorisés : les membres d'un groupe autorisé, les utilisateurs du parapheur, le propriétaire. Également acceptés : jeton d'invitation, jeton de visionneuse. </Note>

Authentification

AuthorizationBearer

Authentification Bearer par jeton utilisateur ou jeton d’accès : Authorization: Bearer <token>.

Paramètres de chemin

workflowIdstringRequis

L'identifiant du parapheur.

Paramètres de requête

textstringOptionnel

Le texte à rechercher.

sortBystringOptionnel

Le champ utilisé pour trier le résultat de la recherche.

sortOrderenumOptionnel

L’ordre de tri du résultat de la recherche.

Valeurs autorisées:

itemsPerPageintegerOptionnel1-50Par défaut 50

Le nombre d’éléments par page à renvoyer.

pageIndexintegerOptionnel>=0Par défaut 0

L’index de la page à renvoyer.

Réponse

Rechercher des pièces justificatives

pageIndexintegerOptionnel

L'index de la page.

itemsPerPageintegerOptionnel

Le nombre d’éléments par page.

totalItemsintegerOptionnel

Le nombre total d’éléments, toutes pages comprises.

itemslist of objectsOptionnel

Erreurs

403

Forbidden Error