Rechercher des documents de modèle

GET

https://workflow-manager/api/templateDocuments

GET

/api/templateDocuments

curl https://workflow-manager/api/templateDocuments \
     -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"
        }
      ],
      "id": "string",
      "parts": [
        {
          "contentType": "string",
          "filename": "string",
          "hash": "string",
          "size": 1,
          "isOriginal": true,
          "policyUri": "string",
          "visualIdentification": "string"
        }
      ],
      "readonly": true,
      "removable": true,
      "templateId": "string",
      "tenantId": "string",
      "updated": 1,
      "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
    }
  ]
}

Recherche dans tous les documents de modèle de parapheur.

Rôle requis

Aucun. Autorisés : tout utilisateur du tenant.

Recherche dans tous les documents de modèle de parapheur. <Note title="Rôle requis"> Aucun. Autorisés : tout utilisateur du tenant. </Note>

Authentification

AuthorizationBearer

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

Paramètres de requête

textstringOptionnel

Le texte à rechercher.

items.idstringOptionnel

La ou les valeurs de filtre du champ id.

items.tenantIdstringOptionnel

La ou les valeurs de filtre du champ tenantId.

items.templateIdstringOptionnel

La ou les valeurs de filtre du champ templateId.

items.signatureProfileIdstringOptionnel

La ou les valeurs de filtre du champ signatureProfileId.

items.confidentialitystringOptionnel

La ou les valeurs de filtre du champ confidentiality.

items.createdstringOptionnel

La ou les valeurs de filtre du champ created.

items.updatedstringOptionnel

La ou les valeurs de filtre du champ updated.

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

Une page d’entités TemplateDocument.

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

400

Bad Request Error

403

Forbidden Error