Récupère la liste des instances de campagne associées à la configuration de campagne spécifiée dans le locataire spécifique.

get

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

L'API est utilisée pour récupérer la liste des instances de campagne associées à la configuration de campagne spécifiée du 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…

Path Params

string

required

ID de configuration de la campagne

Query Params

state

string

enum

Defaults to all

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

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:

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.
lastpausedate : L'horodatage de l'instance de campagne lastPauseDate est utilisé pour le tri.
timeremaining : L'horodatage de l'instance de campagne timeRemaining est utilisé pour le tri.

sortDesc

boolean

enum

Defaults to true

Détermine si le tri par ordre décroissant est appliqué. Valeurs autorisées : true, false

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.

403

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…