Consulter un modèle de parapheur

GET

https://workflow-manager/api/templates/:templateId

GET

/api/templates/:templateId

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

{
  "layoutSelectionMode": "list",
  "steps": [
    {
      "stepType": "signature",
      "recipientSelectionMode": "list",
      "id": "stp_QKkU85549V9UteCjChPWhHn7",
      "maxRecipients": 1,
      "allowedConsentPages": [],
      "requiredRecipients": 1,
      "validityPeriod": 8553600000,
      "invitePeriod": 86400000,
      "maxInvites": 5,
      "sendDownloadLink": true,
      "readonly": false,
      "removable": true,
      "allowComments": true,
      "hideAttachments": false,
      "viewConfidentialAttachments": true,
      "hideWorkflowRecipients": false,
      "recipients": [
        {
          "consentPageId": "cop_AfGTsGSh1mmatSUL5AWFo2Do",
          "email": "keeley.brown2482@my-company.com",
          "userId": "usr_KG8yTeqRa1kskaSp7Y7GRPAB",
          "pictureResourceId": "res_4Z7qYs9LrDsZ5v293CLMGJYb",
          "phoneNumber": "+33 6 12 34 56 78",
          "comments": "Aliquam et numquam voluptatem enim est illo.",
          "firstName": "Kent",
          "lastName": "Barton",
          "country": "FR",
          "organizationId": "org_i3niMbz4WCYkMgYe9y7KnHgv",
          "preferredLocale": "fr"
        }
      ],
      "allowedGroups": []
    }
  ],
  "documentSelectionMode": "any",
  "coManagerSelectionMode": "none",
  "allowConsolidation": true,
  "allowManagerAddStep": true,
  "allowedLayouts": [
    "lay_JSyVFZirokNH1UhNQLtjGGME"
  ],
  "allowedSignatureProfiles": [
    "sip_Gqm6QHpCFxuaqqk88gsKNBvk"
  ],
  "coManagerCanEditCoManager": false,
  "coManagerNotifiedEvents": [
    "recipientRefused",
    "recipientFinished",
    "workflowStopped",
    "workflowFinished"
  ],
  "coManagerNotifiedEventsReadonly": false,
  "coManagerUsersModifiable": true,
  "created": 1782821288845,
  "id": "wtm_QELjCwLJmgvCzNEUy7JH1yAa",
  "isDisabled": false,
  "maxAttachments": 5,
  "maxDocuments": 10,
  "maxWatchers": 6,
  "name": "Awesome Rubber Bench",
  "notifiedEvents": [
    "recipientRefused",
    "recipientFinished",
    "workflowStopped",
    "workflowFinished"
  ],
  "notifiedEventsReadonly": false,
  "tenantId": "ten_Hm5gqY6oKADYdg9cjhsVbQDH",
  "updated": 1782821288845,
  "watchers": [
    {
      "notifiedEvents": [
        "recipientRefused",
        "recipientFinished",
        "workflowStarted",
        "workflowStopped",
        "workflowFinished",
        "workflowFinishedDownloadLink",
        "workflowFinishedDownloadLinkNoAttachment"
      ],
      "readonly": true,
      "removable": false,
      "email": "mickey.wiegand1449@my-company.com"
    },
    {
      "notifiedEvents": [
        "recipientRefused",
        "recipientFinished",
        "workflowStarted",
        "workflowStopped",
        "workflowFinished",
        "workflowFinishedDownloadLink",
        "workflowFinishedDownloadLinkNoAttachment"
      ],
      "readonly": false,
      "removable": true,
      "userId": "usr_3EDGspNESZNdTC8wQFY6zigh"
    }
  ],
  "allowedCoManagerGroups": [],
  "allowedCoManagerUsers": [],
  "description": "Apt. 480, 9814 Impasse Monsieur-le-Prince, 55936 Aix-en-Provence"
}

Renvoie un modèle de parapheur existant.

Rôle requis

Aucun. Autorisés : tout utilisateur du tenant.

Renvoie un modèle de parapheur existant. <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 chemin

templateIdstringRequis

L’identifiant du modèle de parapheur.

Réponse

Consulter un modèle de parapheur

layoutSelectionModeenum

Valeurs possibles : list, listOrNull, any ou anyOrNull.

stepslist of objects

Les étapes du modèle de parapheur.

documentSelectionModeenum

Valeurs possibles : list ou any.

coManagerSelectionModeenum

Valeurs possibles : none, list, any ou anyOrNull.

allowConsolidationboolean

Indique si la consolidation du parapheur est activée.

allowManagerAddStepboolean

Indique si le gestionnaire peut ajouter de nouvelles étapes.

allowedLayoutslist of strings

La liste des dispositions de parapheur utilisables dans le parapheur.

allowedSignatureProfileslist of strings

La liste des profils de signature autorisés pour signer les documents.

coManagerCanEditCoManagerboolean

Indique si les événements du cogestionnaire sont modifiables par un cogestionnaire.

coManagerNotifiedEventslist of strings

Les types d’événements pour lesquels le cogestionnaire reçoit des notifications.

coManagerNotifiedEventsReadonlyboolean

Indique si les événements notifiés au cogestionnaire sont en lecture seule.

coManagerUsersModifiableboolean

Indique si les événements notifiés au cogestionnaire sont modifiables.

createdlong

La date de création de l’entité.

idstring

L’identifiant du modèle de parapheur.

isDisabledboolean

Indique si le modèle de parapheur est désactivé.

maxAttachmentslongPar défaut 10

Le nombre maximal de pièces jointes.

maxDocumentslongPar défaut 200

Le nombre maximal de documents à signer.

maxWatcherslong

Le nombre maximal d'observateurs.

namestring

Le nom du modèle de parapheur.

notifiedEventslist of strings

Les types d’événements pour lesquels le propriétaire reçoit des notifications.

notifiedEventsReadonlyboolean

Indique si les événements notifiés sont en lecture seule.

tenantIdstring

L’identifiant du tenant auquel appartient le modèle de parapheur.

updatedlong

La date de dernière modification de l’entité.

watcherslist of objects

La liste des observateurs du parapheur.

allowedCoManagerGroupslist of anyOptionnel

La liste des groupes dont les membres peuvent être désignés cogestionnaires du parapheur.

allowedCoManagerUserslist of anyOptionnel

La liste des cogestionnaires pouvant être désignés sur le parapheur.

descriptionstringOptionnel

La description du modèle de parapheur.

jobOperationstringOptionnel

L’opération de tâche en cours d’exécution.

Erreurs

403

Forbidden Error

404

Not Found Error