Archiver un parapheur

Afficher en Markdown
Archive un parapheur existant. <Note title="Rôle requis"> `workflowArchiver` (ses propres ressources uniquement). </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 auquel appartiennent les commentaires.

Réponse

L’entité Workflow archivée.

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.

workflowStatusenum
Le statut du parapheur.
externalArchiveStatusstring
Le statut de l'archivage externe.
stoppeddouble

La date d’arrêt du parapheur.

finisheddouble

La date d’achèvement du parapheur.

closeddouble

La date de clôture du parapheur.

workflowModeenum
Le mode 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.
jobOperationstringOptionnel

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

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.

templateIdstringOptionnel

L’identifiant du modèle de parapheur.

Erreurs

403
Forbidden Error
404
Not Found Error