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.
Habilitations requises : manageAccessCertification [Gérer la certification d'accès].

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.

Allowed:

state

array of strings

enum

Defaults to all

Le filtre pour le type d'instance de campagne : userassignment, groupassignment, account, groupmembership.

Plusieurs valeurs peuvent être sélectionnées.

state

priority

string

enum

Defaults to all

Le filtre pour l'état de l'instance de la campagne : noinstance, aborted, closed, completed, created, deleted, failed, paused, running, starting, success, cancelled.

Plusieurs valeurs peuvent être sélectionnées.

Allowed:

preview

string

enum

Defaults to all

Le filtre pour la priorité de l'instance de campagne : élevée, moyenne ou faible.

Allowed:

continuous

string

enum

Defaults to all

Le filtre pour obtenir des instances de campagne de prévisualisation : oui, non.

Allowed:

reviewersId

array of strings

Le filtre pour obtenir des instances de campagne continues : oui, non.

reviewersId

supervisorsId

array of strings

Le filtre pour le réviseur de campagne.

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

supervisorsId

ownersId

array of strings

Le filtre pour le superviseur de la campagne.

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

ownersId

appsId

array of strings

Le filtre pour le propriétaire de la campagne.

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

appsId

overallState

string

enum

Defaults to all

Le filtre pour l'application de campagne.

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

Allowed:

asSupervisor

boolean

enum

Le filtre pour l'état général de l'instance de campagne. Ce filtre permet de "regrouper" logiquement les états possibles de l'instance de campagne : actif, inactif.

Allowed:

assignmentSource

string

enum

Defaults to assigned

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

Allowed:

skipStatistics

string

enum

Defaults to no

Filtre par lequel les campagnes ont été attribuées à l'utilisateur appelant : assigné, délégué.

Allowed:

filter

string

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.

sort

string

Filtre générique permettant de renvoyer les instances de campagne qui contiennent la chaîne passée dans l'un des attributs suivants : name (nom de l'instance de campagne).

sortDesc

boolean

enum

Defaults to true

L'attribut de l'instance de campagne qui est utilisé pour trier les résultats. Les valeurs possibles sont : 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.
priority : 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 : La progression de l'instance de campagne est utilisée 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.

Allowed:

limit

string

Defaults to 500

Décide de l'ordre de tri.

page

string

Defaults to 1

Spécifie le nombre maximum de ressources que la recherche renvoie pour une 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

500

Votre demande ne peut être traitée car une erreur interne du serveur s'est produite.

Language

URL

Response

Choose an example:

application/json

200La demande a abouti.

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

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