Récupère la liste des instances de campagne d'un locataire spécifique.

get

https://{tenanturl}/v2.0/instances

L'API est utilisée pour récupérer la liste des instances de campagne d'un locataire spécifique.
Les propriétaires de l'application peuvent accéder à la liste des instances de campagne qu'ils ont créées ou qui comprennent au moins une application dont ils sont propriétaires.
Les paramètres de filtre non spécifiés sont traités comme ayant les valeurs par défaut.
Chaque valeur de paramètre fournie est considérée comme un filtre supplémentaire pour les critères de recherche.
Attributions requises : manageAccessCertification [Gérer la certification d'accès].

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

type

string

enum

Defaults to all

Il s'agit d'un filtre de type instance de campagne obsolète. Utilisez plutôt le paramètre de requête 'types'. Si les deux paramètres de requête "type" et "types" sont utilisés, c'est la valeur sélectionnée "types" qui est prise en compte. Les valeurs disponibles sont : userassignment, groupassignment ou account.

Allowed:

types

array of strings

enum

Le filtre pour le type d'instance de campagne. Les valeurs autorisées sont : userassignment, groupassignment, account, groupmembership.

Il est possible de sélectionner plusieurs valeurs.

types

Allowed:

state

array of strings

enum

Filtre selon l'état de l'instance de campagne : all, noinstance, aborted, closed, completed, created, deleted, failed, paused, running, starting, success, cancelled.

Plusieurs valeurs peuvent être sélectionnées.

state

priority

string

enum

Defaults to all

Le filtre de priorité de l'instance de campagne : all, high, medium ou low.

Allowed:

preview

string

enum

Defaults to all

Filtre permettant d'obtenir des instances de campagne en prévisualisation : all, yes, no.

Allowed:

continuous

string

enum

Defaults to all

Filtre permettant d'obtenir les instances de campagne en cours : all, yes, no.

Allowed:

reviewersId

array of strings

Le filtre pour le réviseur de la campagne.

Fournir plusieurs valeurs dans de nouvelles lignes ou séparées par des virgules. Par exemple, 607000JX53, 6050001F7Z, 50EEPX4TQC

reviewersId

supervisorsId

array of strings

Le filtre pour le superviseur de la campagne.

Fournir plusieurs valeurs dans de nouvelles lignes ou séparées par des virgules. Par exemple, 607000JX53, 6050001F7Z, 50EEPX4TQC

supervisorsId

ownersId

array of strings

Le filtre pour le propriétaire de la campagne.

Fournir plusieurs valeurs dans de nouvelles lignes ou séparées par des virgules. Par exemple, 607000JX53, 6050001F7Z, 50EEPX4TQC

ownersId

appsId

array of strings

Le filtre pour l'application de campagne.

Fournir plusieurs valeurs dans de nouvelles lignes ou séparées par des virgules. Pour example,7728662622850583652, 7729580475382480456

appsId

overallState

string

enum

Defaults to all

Le filtre pour l'état général de l'instance de campagne. Ce filtre sert à regrouper logiquement les états possibles des instances de campagne : toutes, actives, inactives.

Allowed:

asSupervisor

boolean

enum

Considérer l'utilisateur qui appelle comme un superviseur de la campagne lorsque cette valeur est fixée à true.

Allowed:

assignmentSource

string

enum

Defaults to assigned

Filtrer les instances de campagne en fonction de la source : toutes, attribuées, déléguées.

Allowed:

skipStatistics

string

enum

Defaults to no

Filtre permettant d'inclure des données agrégées (c'est-à-dire des statistiques, des progrès) dans les objets de l'instance : données uniquement, oui ou non.

Allowed:

filter

string

Filtre générique permettant de renvoyer les instances de campagne qui contiennent l'adresse string dans l'un des attributs suivants : name (nom de l'instance de campagne).

sort

string

L'attribut de l'instance de campagne qui est utilisé pour trier les résultats. Les valeurs possibles sont les suivantes : nom, type, priorité, statut, date de dernier démarrage, date de clôture, progression, date de dernière interruption, date restante.

Lorsque vous fournissez,
nom : le nom de l'instance de la campagne est utilisé pour le tri.
type : le type d'instance de campagne est utilisé pour le tri.
priorité : la priorité de l'instance de campagne est utilisée pour le tri.
status : le statut de l'instance de campagne est utilisé pour le tri.
timelaststart : L'horodatage de l'instance de campagne lastStartDate est utilisé pour le tri.
timeclosed : L'horodatage de l'instance de campagne endDate est utilisé pour le tri.
progress : L'avancement de l'instance de campagne est utilisé pour le tri.
continuous : L'instance de campagne continuous est utilisée pour le tri.
lastpausedate : L'instance de campagne lastPauseDate est utilisée pour le tri.
timeremaining : L'instance de campagne timeRemaining est utilisée pour le tri.

sortDesc

boolean

enum

Defaults to true

Décide de l'ordre de tri.

Allowed:

limit

string

Defaults to 500

Spécifie le nombre maximum de ressources que la recherche renvoie pour une page.

page

string

Defaults to 1

Numéro de page.

Headers

x-admin-invocation

boolean

enum

required

Si la valeur est fixée à true, l'appel à l'API est traité comme un appel à l'API d'administration.

Allowed:

Responses

200

La demande a abouti.

400

Votre demande ne peut pas être traitée. Le code d'erreur et la description sont disponibles dans les données utiles de la réponse.

401

Votre demande ne peut pas être traitée. Le code d'erreur et la description sont disponibles dans les données utiles de la réponse.

500

Votre demande n'a pas pu être traitée en raison d'une erreur interne du serveur.

Language

URL

Loading…