API ReferenceDocumentation APIToken PortailWorkflow Templates

Exporter les modèles de parapheur

Afficher en MarkdownOuvrir dans Claude
Exporte une recherche dans tous les modèles de parapheur. <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 requête

textstringOptionnel

Le texte à rechercher.

items.idstringOptionnel
La ou les valeurs de filtre du champ id.
items.tenantIdstringOptionnel
La ou les valeurs de filtre du champ tenantId.
items.namestringOptionnel
La ou les valeurs de filtre du champ name.
items.isDisabledstringOptionnel
La ou les valeurs de filtre du champ isDisabled.
items.steps.idstringOptionnel
La ou les valeurs de filtre du champ steps.id.
items.recipients.emailstringOptionnel
La ou les valeurs de filtre du champ recipients.email.
items.recipients.userIdstringOptionnel
La ou les valeurs de filtre du champ recipients.userId.
items.recipients.subjectstringOptionnel
La ou les valeurs de filtre du champ recipients.subject.
items.recipients.firstNamestringOptionnel
La ou les valeurs de filtre du champ recipients.firstName.
items.recipients.lastNamestringOptionnel
La ou les valeurs de filtre du champ recipients.lastName.
items.recipients.countrystringOptionnel
La ou les valeurs de filtre du champ recipients.country.
items.recipients.organizationIdstringOptionnel
La ou les valeurs de filtre du champ recipients.organizationId.
items.nextCleanstringOptionnel
La ou les valeurs de filtre du champ nextClean.
items.createdstringOptionnel
La ou les valeurs de filtre du champ created.
items.updatedstringOptionnel
La ou les valeurs de filtre du champ updated.
sortBystringOptionnel

Le champ utilisé pour trier le résultat de la recherche.

sortOrderenumOptionnel

L’ordre de tri du résultat de la recherche.

Valeurs autorisées:

Requête

This endpoint expects an object.
contentTypestringOptionnel
Le type de contenu de l'export.
beforeItemsstringOptionnel

Pour un export en fichier unique, le texte ajouté avant les éléments exportés.

afterItemsstringOptionnel

Pour un export en fichier unique, le texte ajouté après les éléments exportés.

betweenItemsstringOptionnel

Pour un export en fichier unique, le texte ajouté entre les éléments exportés.

itemTemplatestringOptionnel

Le modèle appliqué à chaque élément exporté. S’il est absent, chaque élément est sérialisé en JSON.

expiredlongOptionnel
La date d'expiration de l'export. Horodatage en millisecondes depuis l'epoch.

Réponse

Exporter les modèles de parapheur

createdlong

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

exportOperationstring

Le nom de l’opération d’export.

idstring
L'identifiant de l'export.
searchQuerystring

La requête de recherche des éléments exportés.

sizelong
La taille de l'export.
tenantIdstring
L'identifiant du tenant auquel appartient l'export.
totalItemslong

Le nombre total d’éléments exportés.

updatedlong

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

afterItemsstringOptionnel

Pour un export en fichier unique, le texte ajouté après les éléments exportés.

beforeItemsstringOptionnel

Pour un export en fichier unique, le texte ajouté avant les éléments exportés.

betweenItemsstringOptionnel

Pour un export en fichier unique, le texte ajouté entre les éléments exportés.

contentTypestringOptionnel
Le type de contenu de l'export.
expiredlongOptionnel
La date d'expiration de l'export. Horodatage en millisecondes depuis l'epoch.
itemTemplatestringOptionnel

Le modèle appliqué à chaque élément exporté. S’il est absent, chaque élément est sérialisé en JSON.

jobOperationstringOptionnel

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

userIdstringOptionnel

L’identifiant de l’utilisateur qui a créé l’export.

Erreurs

400
Bad Request Error
403
Forbidden Error