Consulter un document de modèle

GET

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

GET

/api/templateDocuments/:templateDocumentId

curl https://workflow-manager/api/templateDocuments/templateDocumentId \
     -H "Authorization: Bearer <token>"

{
  "created": 1782821289019,
  "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_Cde85qJ6oqukKiGwih4ztJV1",
  "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": 1782821289151,
  "confidentiality": false,
  "orderIndex": 1,
  "pdfSignatureFields": [
    {
      "imageHeight": 80,
      "imagePage": -1,
      "imageWidth": 150,
      "imageX": 390,
      "imageY": 710
    }
  ],
  "signatureProfileId": "sip_CSRi6rm3B6QaZ8KKH8v9tcr5"
}

Renvoie un document de modèle de parapheur existant.

Rôle requis

Aucun. Autorisés : tout utilisateur du tenant.

Renvoie un document de modèle de parapheur existant. <Note title="Rôle requis"> Aucun. Autorisés : tout utilisateur du tenant. </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.

Réponse

Consulter un document de modèle

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

403

Forbidden Error

404

Not Found Error