Créer un modèle de parapheur

POST

https://workflow-manager/api/tenants/:tenantId/templates

POST

/api/tenants/:tenantId/templates

curl -X POST https://workflow-manager/api/tenants/tenantId/templates \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "isDisabled": false,
  "name": "Intelligent Plastic Lamp",
  "description": "752 Avenue Zadkine, 41463 Beauvais",
  "layoutSelectionMode": "list",
  "allowedLayouts": [
    "lay_AYNmME5o24fa9YevH6aR2oMF"
  ],
  "maxWatchers": 10,
  "steps": [
    {
      "stepType": "signature",
      "recipientSelectionMode": "list",
      "maxRecipients": 10,
      "recipients": [
        {
          "consentPageId": "cop_AfGTsGSh1mmatSUL5AWFo2Do",
          "email": "keeley.brown2482@my-company.com",
          "userId": "usr_KG8yTeqRa1kskaSp7Y7GRPAB",
          "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": [],
      "allowedConsentPages": [
        "cop_5WPAvvRMYhCix5KyYqbXYYck"
      ],
      "requiredRecipients": 1,
      "maxInvites": 5,
      "sendDownloadLink": true,
      "validityPeriod": 8553600000,
      "invitePeriod": 86400000,
      "readonly": false,
      "removable": true,
      "allowComments": true,
      "hideAttachments": false,
      "viewConfidentialAttachments": true,
      "hideWorkflowRecipients": false
    }
  ],
  "notifiedEvents": [
    "recipientRefused",
    "recipientFinished",
    "workflowStopped",
    "workflowFinished"
  ],
  "notifiedEventsReadonly": false,
  "coManagerNotifiedEvents": [
    "recipientRefused",
    "recipientFinished",
    "workflowStopped",
    "workflowFinished"
  ],
  "coManagerNotifiedEventsReadonly": false,
  "watchers": [
    {
      "notifiedEvents": [
        "recipientRefused",
        "recipientFinished",
        "workflowStarted",
        "workflowStopped",
        "workflowFinished",
        "workflowFinishedDownloadLink",
        "workflowFinishedDownloadLinkNoAttachment"
      ],
      "readonly": false,
      "removable": true,
      "userId": "usr_srHrGH8xiXQPehNzs34WDmNB"
    },
    {
      "notifiedEvents": [
        "recipientRefused",
        "recipientFinished",
        "workflowStarted",
        "workflowStopped",
        "workflowFinished",
        "workflowFinishedDownloadLink",
        "workflowFinishedDownloadLinkNoAttachment"
      ],
      "readonly": false,
      "removable": true,
      "email": "ivory.baumbach5613@my-company.com"
    }
  ],
  "allowedSignatureProfiles": [
    "sip_8yKHsKPWgSZ4VFx2iHBkmnun"
  ],
  "documentSelectionMode": "any",
  "maxDocuments": 10,
  "maxAttachments": 20,
  "coManagerSelectionMode": "none",
  "allowedCoManagerUsers": [],
  "coManagerUsersModifiable": true,
  "coManagerCanEditCoManager": false,
  "allowedCoManagerGroups": [],
  "allowConsolidation": true,
  "allowManagerAddStep": true
}'

{
  "layoutSelectionMode": "list",
  "steps": [
    {
      "stepType": "signature",
      "recipientSelectionMode": "list",
      "id": "stp_36RMPSGFdm1Cgo4FfhxqPamm",
      "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_AYNmME5o24fa9YevH6aR2oMF"
  ],
  "allowedSignatureProfiles": [
    "sip_8yKHsKPWgSZ4VFx2iHBkmnun"
  ],
  "coManagerCanEditCoManager": false,
  "coManagerNotifiedEvents": [
    "recipientRefused",
    "recipientFinished",
    "workflowStopped",
    "workflowFinished"
  ],
  "coManagerNotifiedEventsReadonly": false,
  "coManagerUsersModifiable": true,
  "created": 1782821851723,
  "id": "wtm_7DqHvUW2vEhULCoUczJ89owh",
  "isDisabled": false,
  "maxAttachments": 10,
  "maxDocuments": 10,
  "maxWatchers": 10,
  "name": "Intelligent Plastic Lamp",
  "notifiedEvents": [
    "recipientRefused",
    "recipientFinished",
    "workflowStopped",
    "workflowFinished"
  ],
  "notifiedEventsReadonly": false,
  "tenantId": "ten_Hm5gqY6oKADYdg9cjhsVbQDH",
  "updated": 1782821851723,
  "watchers": [
    {
      "notifiedEvents": [
        "recipientRefused",
        "recipientFinished",
        "workflowStarted",
        "workflowStopped",
        "workflowFinished",
        "workflowFinishedDownloadLink",
        "workflowFinishedDownloadLinkNoAttachment"
      ],
      "readonly": false,
      "removable": true,
      "email": "ivory.baumbach5613@my-company.com"
    },
    {
      "notifiedEvents": [
        "recipientRefused",
        "recipientFinished",
        "workflowStarted",
        "workflowStopped",
        "workflowFinished",
        "workflowFinishedDownloadLink",
        "workflowFinishedDownloadLinkNoAttachment"
      ],
      "readonly": false,
      "removable": true,
      "userId": "usr_srHrGH8xiXQPehNzs34WDmNB"
    }
  ],
  "allowedCoManagerGroups": [],
  "allowedCoManagerUsers": [],
  "description": "752 Avenue Zadkine, 41463 Beauvais"
}

Crée un modèle de parapheur.

Rôle requis

templateManager

Crée un modèle de parapheur. <Note title="Rôle requis"> `templateManager` </Note>

Authentification

AuthorizationBearer

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

Paramètres de chemin

tenantIdstringRequis

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

Requête

This endpoint expects an object.

isDisabledbooleanRequis

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

namestringRequis

Le nom du modèle de parapheur.

descriptionstringOptionnel

La description du modèle de parapheur.

layoutSelectionModeenumOptionnel

Valeurs possibles : list, listOrNull, any ou anyOrNull.

allowedLayoutslist of stringsOptionnel

La liste des dispositions de parapheur utilisables dans le parapheur.

maxWatcherslongOptionnel

Le nombre maximal d'observateurs.

stepslist of objectsOptionnel

Les étapes du modèle de parapheur.

notifiedEventslist of stringsOptionnel

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

notifiedEventsReadonlybooleanOptionnel

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

coManagerNotifiedEventslist of stringsOptionnel

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

coManagerNotifiedEventsReadonlybooleanOptionnel

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

watcherslist of objectsOptionnel

La liste des observateurs du parapheur.

allowedSignatureProfileslist of stringsOptionnel

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

documentSelectionModeenumOptionnel

Valeurs possibles : list ou any.

maxDocumentslongOptionnelPar défaut 200

Le nombre maximal de documents à signer.

maxAttachmentslongOptionnelPar défaut 10

Le nombre maximal de pièces jointes.

coManagerSelectionModeenumOptionnel

Valeurs possibles : none, list, any ou anyOrNull.

allowedCoManagerUserslist of anyOptionnel

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

coManagerUsersModifiablebooleanOptionnel

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

coManagerCanEditCoManagerbooleanOptionnel

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

allowedCoManagerGroupslist of anyOptionnel

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

allowConsolidationbooleanOptionnel

Indique si la consolidation du parapheur est activée.

allowManagerAddStepbooleanOptionnel

Indique si le gestionnaire peut ajouter de nouvelles étapes.

Réponse

L’entité WorkflowTemplate créée.

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

400

Bad Request Error

403

Forbidden Error

404

Not Found Error