Rechercher des modèles de parapheur

GET

https://workflow-manager/api/templates

GET

/api/templates

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

{
  "pageIndex": 1,
  "itemsPerPage": 1,
  "totalItems": 1,
  "items": [
    {
      "layoutSelectionMode": "any",
      "steps": [
        {
          "stepType": "approval",
          "recipientSelectionMode": "any",
          "id": "string",
          "maxRecipients": 1.1,
          "allowedConsentPages": [
            null
          ],
          "requiredRecipients": 1.1,
          "validityPeriod": 4320000000,
          "invitePeriod": 1340000000,
          "maxInvites": 1.1,
          "sendDownloadLink": true,
          "readonly": true,
          "removable": true,
          "allowComments": true,
          "hideAttachments": true,
          "viewConfidentialAttachments": true,
          "hideWorkflowRecipients": true,
          "recipients": [
            {
              "consentPageId": "string",
              "email": "string",
              "userId": "string",
              "pictureResourceId": "string",
              "phoneNumber": "string",
              "comments": "string",
              "firstName": "string",
              "lastName": "string",
              "country": "string",
              "organizationId": "string",
              "preferredLocale": "string"
            }
          ],
          "allowedGroups": [
            null
          ]
        }
      ],
      "documentSelectionMode": "list",
      "coManagerSelectionMode": "any",
      "allowConsolidation": true,
      "allowManagerAddStep": true,
      "allowedLayouts": [
        "string"
      ],
      "allowedSignatureProfiles": [
        "string"
      ],
      "coManagerCanEditCoManager": true,
      "coManagerNotifiedEvents": [
        "string"
      ],
      "coManagerNotifiedEventsReadonly": true,
      "coManagerUsersModifiable": true,
      "created": 1,
      "id": "string",
      "isDisabled": true,
      "maxAttachments": 10,
      "maxDocuments": 200,
      "maxWatchers": 1,
      "name": "string",
      "notifiedEvents": [
        "string"
      ],
      "notifiedEventsReadonly": true,
      "tenantId": "string",
      "updated": 1,
      "watchers": [
        {
          "notifiedEvents": [
            "string"
          ],
          "readonly": true,
          "removable": true,
          "email": "string",
          "userId": "string"
        }
      ],
      "allowedCoManagerGroups": [
        null
      ],
      "allowedCoManagerUsers": [
        null
      ],
      "description": "string",
      "jobOperation": "string"
    }
  ]
}

Recherche dans tous les modèles de parapheur.

Rôle requis

Aucun. Autorisés : tout utilisateur du tenant.

Recherche dans tous les modèles 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.namestringOptionnel

La ou les valeurs de filtre du champ name.

items.isDisabledstringOptionnel

La ou les valeurs de filtre du champ isDisabled.

items.steps.idstringOptionnel

La ou les valeurs de filtre du champ steps.id.

items.recipients.emailstringOptionnel

La ou les valeurs de filtre du champ recipients.email.

items.recipients.userIdstringOptionnel

La ou les valeurs de filtre du champ recipients.userId.

items.recipients.subjectstringOptionnel

La ou les valeurs de filtre du champ recipients.subject.

items.recipients.firstNamestringOptionnel

La ou les valeurs de filtre du champ recipients.firstName.

items.recipients.lastNamestringOptionnel

La ou les valeurs de filtre du champ recipients.lastName.

items.recipients.countrystringOptionnel

La ou les valeurs de filtre du champ recipients.country.

items.recipients.organizationIdstringOptionnel

La ou les valeurs de filtre du champ recipients.organizationId.

items.nextCleanstringOptionnel

La ou les valeurs de filtre du champ nextClean.

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 WorkflowTemplate.

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