Modifier un document de modèle

PATCH

https://workflow-manager/api/templateDocuments/:templateDocumentId

PATCH

/api/templateDocuments/:templateDocumentId

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

{
  "created": 1782821522437,
  "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"
    }
  ],
  "id": "wtd_FUucDAxrnF8C6EajxfiRGQSo",
  "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"
    }
  ],
  "readonly": true,
  "removable": false,
  "templateId": "wtm_QELjCwLJmgvCzNEUy7JH1yAa",
  "tenantId": "ten_Hm5gqY6oKADYdg9cjhsVbQDH",
  "updated": 1782821522502,
  "confidentiality": false,
  "orderIndex": 2,
  "pdfSignatureFields": [
    {
      "imageHeight": 80,
      "imagePage": -1,
      "imageWidth": 150,
      "imageX": 390,
      "imageY": 710
    }
  ],
  "signatureProfileId": "sip_CSRi6rm3B6QaZ8KKH8v9tcr5",
  "subOrderIndex": 5
}

Modifie un document de modèle de parapheur existant.

Rôle requis

templateManager

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

templateDocumentIdstringRequis

L'identifiant du document.

Requête

This endpoint expects an object.

readonlybooleanOptionnel

Indique si le document est en lecture seule.

removablebooleanOptionnel

Indique si le document est supprimable.

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.

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.

Réponse

L’entité TemplateDocument mise à jour.

createdlong

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

displayedPartslist of objects

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

idstring

L'identifiant du document.

partslist of objects

Les parties du document.

readonlyboolean

Indique si le document est en lecture seule.

removableboolean

Indique si le document est supprimable.

templateIdstring

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

tenantIdstring

L'identifiant du tenant auquel appartient le document.

updatedlong

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

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.

Erreurs

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

412

Precondition Failed Error

Authentification

Paramètres de chemin

En-têtes

Requête

Réponse

Erreurs