API ReferenceDocumentation APIToken AdministrateurTenants

Exporter les tenants

Afficher en MarkdownOuvrir dans Claude
Exporte une recherche dans tous les tenants. Réservé aux administrateurs. <Note title="Rôle requis"> Administrateur de la plateforme (back-office Goodflag). Inaccessible aux utilisateurs du tenant. </Note>

Authentification

AuthorizationBasic

Identifiants d’administration, requis pour les endpoints /admin/api et /experimental/admin/api.

Paramètres de requête

textstringOptionnel

Le texte à rechercher.

items.idstringOptionnel
La ou les valeurs de filtre du champ id.
items.domainNamestringOptionnel
La ou les valeurs de filtre du champ domainName.
items.tenantStatusstringOptionnel
La ou les valeurs de filtre du champ tenantStatus.
items.organizationNamestringOptionnel
La ou les valeurs de filtre du champ organizationName.
items.jobOperationstringOptionnel
La ou les valeurs de filtre du champ jobOperation.
items.jobErrorCodestringOptionnel
La ou les valeurs de filtre du champ jobErrorCode.
items.createdstringOptionnel
La ou les valeurs de filtre du champ created.
items.updatedstringOptionnel
La ou les valeurs de filtre du champ updated.
items.externalArchivingParameters.archiverIdstringOptionnel
La ou les valeurs de filtre du champ externalArchivingParameters.archiverId.
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 tenants
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.
totalItemslong

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

updatedlong

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

adminUserstringOptionnel

L’utilisateur administrateur qui a créé l’export.

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.

Erreurs

400
Bad Request Error
403
Forbidden Error