Créer un champ dynamique

curl -X POST https://workflow-manager/api/workflows/workflowId/dynamicFields \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "test2",
  "description": "this is an other description"
}'

{
  "created": 1782821624864,
  "currentRecipientEmails": [],
  "currentRecipientUsers": [],
  "email": "bobby.schulist3960@my-company.com",
  "firstName": "Thomas",
  "groupId": "grp_BTsBTqgZuePSmmPz5ynWM2nN",
  "id": "wfl_2xm2NZ8k1P41dFewbxSudxXz",
  "lastName": "Graham",
  "logs": [],
  "name": "Awesome Wooden Gloves",
  "notifiedEvents": [
    "recipientRefused",
    "recipientFinished",
    "workflowStopped",
    "workflowFinished"
  ],
  "pictureResourceId": "res_Nct5FtPxv8E5u18sePwFXNpP",
  "progress": 0,
  "steps": [
    {
      "allowComments": true,
      "hideAttachments": false,
      "hideWorkflowRecipients": false,
      "id": "stp_AP3iNsa3nupKNRNX2f4msWBh",
      "invitePeriod": 86400000,
      "isFinished": false,
      "isStarted": false,
      "logs": [],
      "maxInvites": 5,
      "recipients": [
        {
          "consentPageId": "cop_AfGTsGSh1mmatSUL5AWFo2Do",
          "country": "FR",
          "email": "keeley.brown2482@my-company.com",
          "firstName": "Kent",
          "lastName": "Barton",
          "comments": "Aliquam et numquam voluptatem enim est illo.",
          "organizationId": "org_i3niMbz4WCYkMgYe9y7KnHgv",
          "phoneNumber": "+33 6 12 34 56 78",
          "pictureResourceId": "res_4Z7qYs9LrDsZ5v293CLMGJYb",
          "preferredLocale": "fr",
          "userId": "usr_KG8yTeqRa1kskaSp7Y7GRPAB"
        }
      ],
      "requiredRecipients": 1,
      "sendDownloadLink": true,
      "stepType": "signature",
      "validityPeriod": 8553600000,
      "viewConfidentialAttachments": true,
      "disableMandatoryViewing": false,
      "faceToFaceSignature": false,
      "requireSupportingDocuments": false,
      "supportingDocumentIds": [],
      "supportingDocuments": []
    }
  ],
  "tenantId": "ten_Hm5gqY6oKADYdg9cjhsVbQDH",
  "updated": 1782821625034,
  "userId": "usr_JCwoLDH99mzqizvqyAYJx4gV",
  "viewAuthorizedGroups": [
    "grp_BTsBTqgZuePSmmPz5ynWM2nN",
    "grp_ExUUECizVJs8KVq7nCwhwMR1"
  ],
  "viewAuthorizedUsers": [
    "usr_KySV8xSBw1M2vbe2YcN4gAUB"
  ],
  "watchers": [
    {
      "notifiedEvents": [
        "recipientRefused",
        "recipientFinished",
        "workflowStarted",
        "workflowStopped",
        "workflowFinished",
        "workflowFinishedDownloadLink",
        "workflowFinishedDownloadLinkNoAttachment"
      ],
      "email": "merle.bradtke5468@my-company.com"
    },
    {
      "notifiedEvents": [
        "recipientRefused",
        "recipientFinished",
        "workflowStarted",
        "workflowStopped",
        "workflowFinished",
        "workflowFinishedDownloadLink",
        "workflowFinishedDownloadLinkNoAttachment"
      ],
      "userId": "usr_KySV8xSBw1M2vbe2YcN4gAUB"
    }
  ],
  "workflowMode": "FULL",
  "workflowStatus": "draft",
  "allowConsolidation": true,
  "allowedCoManagerUsers": [],
  "coManagerNotifiedEvents": [],
  "description": "3 Allée, Voie des Grands Augustins, 56331 Ivry-sur-Seine",
  "dynamicFields": [
    {
      "id": "dyc_2UZJRuMww2uJ1cHAjbziT8v2",
      "name": "test",
      "order": 1,
      "type": "TEXT",
      "description": "this is a description"
    },
    {
      "id": "dyc_4cGLC2AUzQja3GWGjdZbiUpL",
      "name": "test2",
      "order": 2,
      "type": "TEXT",
      "description": "this is an other description"
    }
  ]
}

Ajoute un champ dynamique.

Rôle requis

workflowManager

Également autorisés sans rôle : les membres d’un groupe autorisé, le propriétaire.

Ajoute un champ dynamique. <Note title="Rôle requis"> `workflowManager` Également autorisés sans rôle : les membres d'un groupe autorisé, le propriétaire. </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.

Requête

This endpoint expects an object.

namestringRequis

Le nom du champ dynamique.

descriptionstringOptionnel

La description du champ dynamique.

Réponse

Créer un champ dynamique

createdlong

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

currentRecipientEmailslist of any

La liste des adresses email des destinataires actuellement invités à signer ou valider.

currentRecipientUserslist of any

La liste des utilisateurs destinataires actuellement invités à signer ou valider.

emailstring

L’adresse email de l’utilisateur propriétaire du parapheur.

firstNamestring

Le prénom de l’utilisateur propriétaire du parapheur.

groupIdstring

L'identifiant du groupe auquel appartient le parapheur.

idstring

L'identifiant du parapheur.

lastNamestring

Le nom de l’utilisateur propriétaire du parapheur.

logslist of any

Les journaux du parapheur.

namestring

Le nom du parapheur.

notifiedEventslist of strings

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

pictureResourceIdstring

L’identifiant de la ressource photo de l’utilisateur propriétaire du parapheur.

progresslong

L'avancement du parapheur.

stepslist of objects

Les étapes du parapheur.

tenantIdstring

L'identifiant du tenant auquel appartient le parapheur.

updatedlong

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

userIdstring

L'identifiant de l'utilisateur auquel appartient le parapheur.

viewAuthorizedGroupslist of strings

La liste des identifiants de groupes dont les membres peuvent consulter ce parapheur.

viewAuthorizedUserslist of strings

La liste des identifiants d’utilisateurs autorisés à consulter ce parapheur.

watcherslist of objects

La liste des utilisateurs autorisés à voir le parapheur et notifiés de ses événements.

workflowModeenum

Le mode du parapheur.

workflowStatusenum

Le statut du parapheur.

allowConsolidationbooleanOptionnel

Indique si la consolidation du parapheur est activée.

allowedCoManagerUserslist of anyOptionnel

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

coManagerNotifiedEventslist of anyOptionnel

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

descriptionstringOptionnel

La description du parapheur.

dynamicFieldslist of objectsOptionnel

Liste des champs dynamiques.

layoutIdstringOptionnel

La disposition utilisée pour les champs de métadonnées.

data1stringOptionnel

La valeur du champ de métadonnée data1.

data2stringOptionnel

La valeur du champ de métadonnée data2.

data3stringOptionnel

La valeur du champ de métadonnée data3.

data4stringOptionnel

La valeur du champ de métadonnée data4.

data5stringOptionnel

La valeur du champ de métadonnée data5.

data6stringOptionnel

La valeur du champ de métadonnée data6.

data7stringOptionnel

La valeur du champ de métadonnée data7.

data8stringOptionnel

La valeur du champ de métadonnée data8.

data9stringOptionnel

La valeur du champ de métadonnée data9.

data10stringOptionnel

La valeur du champ de métadonnée data10.

data11stringOptionnel

La valeur du champ de métadonnée data11.

data12stringOptionnel

La valeur du champ de métadonnée data12.

data13stringOptionnel

La valeur du champ de métadonnée data13.

data14stringOptionnel

La valeur du champ de métadonnée data14.

data15stringOptionnel

La valeur du champ de métadonnée data15.

data16stringOptionnel

La valeur du champ de métadonnée data16.

starteddoubleOptionnel

La date du premier démarrage du parapheur.

stoppeddoubleOptionnel

La date d’arrêt du parapheur. (Renseignée uniquement lorsque workflowMode = SINGLE_SIGNER)

finisheddoubleOptionnel

La date d’achèvement du parapheur. (Renseignée uniquement lorsque workflowMode = SINGLE_SIGNER)

closeddoubleOptionnel

La date de clôture du parapheur. (Renseignée uniquement lorsque workflowMode = SINGLE_SIGNER)

templateIdstringOptionnel

L’identifiant du modèle de parapheur.

jobOperationstringOptionnel

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

Erreurs

403

Forbidden Error