API ReferenceDocumentation APIToken PortailWorkflows

Exporter les parapheurs

Afficher en MarkdownOuvrir dans Claude
Exporte une recherche dans tous les parapheurs. <Note title="Rôle requis"> `workflowViewer` OU `workflowManager` Également autorisés sans rôle : les membres d'un groupe autorisé, les utilisateurs du parapheur, le propriétaire. </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.layoutIdstringOptionnel
La ou les valeurs de filtre du champ layoutId.
items.templateIdstringOptionnel
La ou les valeurs de filtre du champ templateId.
items.groupIdstringOptionnel
La ou les valeurs de filtre du champ groupId.
items.userIdstringOptionnel
La ou les valeurs de filtre du champ userId.
items.emailstringOptionnel
La ou les valeurs de filtre du champ email.
items.firstNamestringOptionnel
La ou les valeurs de filtre du champ firstName.
items.lastNamestringOptionnel
La ou les valeurs de filtre du champ lastName.
items.userHashstringOptionnel
La ou les valeurs de filtre du champ userHash.
items.namestringOptionnel
La ou les valeurs de filtre du champ name.
items.data1stringOptionnel
La ou les valeurs de filtre du champ data1.
items.data2stringOptionnel
La ou les valeurs de filtre du champ data2.
items.data3stringOptionnel
La ou les valeurs de filtre du champ data3.
items.data4stringOptionnel
La ou les valeurs de filtre du champ data4.
items.data5stringOptionnel
La ou les valeurs de filtre du champ data5.
items.data6stringOptionnel
La ou les valeurs de filtre du champ data6.
items.data7stringOptionnel
La ou les valeurs de filtre du champ data7.
items.data8stringOptionnel
La ou les valeurs de filtre du champ data8.
items.data9stringOptionnel
La ou les valeurs de filtre du champ data9.
items.data10stringOptionnel
La ou les valeurs de filtre du champ data10.
items.data11stringOptionnel
La ou les valeurs de filtre du champ data11.
items.data12stringOptionnel
La ou les valeurs de filtre du champ data12.
items.data13stringOptionnel
La ou les valeurs de filtre du champ data13.
items.data14stringOptionnel
La ou les valeurs de filtre du champ data14.
items.data15stringOptionnel
La ou les valeurs de filtre du champ data15.
items.data16stringOptionnel
La ou les valeurs de filtre du champ data16.
items.viewAuthorizedGroupsstringOptionnel
La ou les valeurs de filtre du champ viewAuthorizedGroups.
items.viewAuthorizedUsersstringOptionnel
La ou les valeurs de filtre du champ viewAuthorizedUsers.
items.currentRecipientEmailsstringOptionnel
La ou les valeurs de filtre du champ currentRecipientEmails.
items.currentRecipientUsersstringOptionnel
La ou les valeurs de filtre du champ currentRecipientUsers.
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.workflowStatusstringOptionnel
La ou les valeurs de filtre du champ workflowStatus.
items.jobOperationstringOptionnel
La ou les valeurs de filtre du champ jobOperation.
items.jobErrorCodestringOptionnel
La ou les valeurs de filtre du champ jobErrorCode.
items.nextCleanstringOptionnel
La ou les valeurs de filtre du champ nextClean.
items.nextProcessstringOptionnel
La ou les valeurs de filtre du champ nextProcess.
items.createdstringOptionnel
La ou les valeurs de filtre du champ created.
items.updatedstringOptionnel
La ou les valeurs de filtre du champ updated.
items.startedstringOptionnel
La ou les valeurs de filtre du champ started.
items.externalArchiveStatusstringOptionnel
La ou les valeurs de filtre du champ externalArchiveStatus.
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 parapheurs
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