Modifier un document

PATCH

https://workflow-manager/api/documents/:documentId

PATCH

/api/documents/:documentId

curl -X PATCH https://workflow-manager/api/documents/documentId \
     -H "If-Match: If-Match" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "signatureProfileId": "sip_CSRi6rm3B6QaZ8KKH8v9tcr5",
  "pdfSignatureFields": [
    {
      "imagePage": -1,
      "imageX": 390,
      "imageY": 710,
      "imageWidth": 150,
      "imageHeight": 80
    }
  ],
  "confidentiality": false,
  "orderIndex": 10,
  "subOrderIndex": 5
}'

{
  "created": 1782821377330,
  "displayedParts": [
    {
      "contentType": "application/pdf",
      "filename": "Document",
      "hash": "O3DoQCYo2l443ulByo4hwGuxzCZwiW0Vr7K9j56AYuM=",
      "size": 18667,
      "isOriginal": true,
      "policyUri": "https://sites.banque-france.fr/igc/signature/ps/ps_1_2_250_1_115_200_300_4.pdf"
    }
  ],
  "groupId": "grp_BTsBTqgZuePSmmPz5ynWM2nN",
  "id": "doc_ABZhKrpUbf4BCyWCkM1mRyqP",
  "parts": [
    {
      "contentType": "application/pdf",
      "filename": "Document",
      "hash": "O3DoQCYo2l443ulByo4hwGuxzCZwiW0Vr7K9j56AYuM=",
      "size": 18667,
      "isOriginal": true,
      "policyUri": "https://sites.banque-france.fr/igc/signature/ps/ps_1_2_250_1_115_200_300_4.pdf"
    }
  ],
  "tenantId": "ten_Hm5gqY6oKADYdg9cjhsVbQDH",
  "updated": 1782821377384,
  "userId": "usr_JCwoLDH99mzqizvqyAYJx4gV",
  "viewAuthorizedGroups": [
    "grp_BTsBTqgZuePSmmPz5ynWM2nN",
    "grp_ExUUECizVJs8KVq7nCwhwMR1"
  ],
  "viewAuthorizedUsers": [
    "usr_4jreEenog6oRuAo74sW6RS3z"
  ],
  "workflowId": "wfl_Ed1PfdvZJC9PMT3s4MZy4Pko",
  "workflowName": "Heavy Duty Wooden Pants",
  "confidentiality": false,
  "orderIndex": 2,
  "pdfSignatureFields": [
    {
      "imageHeight": 80,
      "imagePage": -1,
      "imageWidth": 150,
      "imageX": 390,
      "imageY": 710
    }
  ],
  "signatureProfileId": "sip_CSRi6rm3B6QaZ8KKH8v9tcr5",
  "subOrderIndex": 5
}

Modifie un document de parapheur existant.

Rôle requis

workflowManager

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

Également acceptés : jeton de visionneuse.

Modifie un document de parapheur existant. <Note title="Rôle requis"> `workflowManager` Également autorisés sans rôle : les membres d'un groupe autorisé, le propriétaire. Également acceptés : jeton de visionneuse. </Note>

Authentification

AuthorizationBearer

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

Paramètres de chemin

documentIdstringRequis

L'identifiant du document.

Requête

This endpoint expects an object.

signatureProfileIdstringOptionnel

Le profil de signature utilisé pour signer le document. S’il est vide, le document est une pièce jointe.

pdfSignatureFieldslist of objectsOptionnel

Pour un document PDF, la liste des champs de signature que les signataires devront remplir.

confidentialitybooleanOptionnel

Le statut de confidentialité des pièces jointes.

orderIndexlongOptionnel

L'index d'ordre permet de personnaliser l'ordre d'affichage des documents.

subOrderIndexlongOptionnel

L’index de sous-ordre permet de personnaliser l’ordre d’affichage des documents dans les dossiers.

Réponse

L’entité Document mise à jour.

createdlong

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

displayedPartslist of objects

Les parties du document affichées à l’utilisateur final.

groupIdstring

L'identifiant du groupe auquel appartient le document.

idstring

L'identifiant du document.

partslist of objects

Les parties du document.

tenantIdstring

L'identifiant du tenant auquel appartient le document.

updatedlong

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

userIdstring

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

viewAuthorizedGroupslist of strings

La liste des identifiants de groupes dont les membres peuvent consulter le parapheur auquel appartient le document.

viewAuthorizedUserslist of strings

La liste des identifiants d’utilisateurs autorisés à consulter le parapheur auquel appartient le document.

workflowIdstring

L'identifiant du parapheur auquel appartient le document.

workflowNamestring

Le nom du parapheur auquel appartient le document.

confidentialitybooleanOptionnel

Le statut de confidentialité des pièces jointes.

orderIndexlongOptionnel

L'index d'ordre permet de personnaliser l'ordre d'affichage des documents.

pdfSignatureFieldslist of objectsOptionnel

Pour un document PDF, la liste des champs de signature que les signataires devront remplir.

signatureProfileIdstringOptionnel

Le profil de signature utilisé pour signer le document. S’il est absent, le document est une pièce jointe.

subOrderIndexlongOptionnel

L’index de sous-ordre permet de personnaliser l’ordre d’affichage des documents dans les dossiers.

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.

Erreurs

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

412

Precondition Failed Error

Authentification

Paramètres de chemin

En-têtes

Requête

Réponse

Erreurs