Récupère la liste des configurations de campagne du locataire concerné.

get

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

L'API est utilisée pour récupérer la liste des configurations de campagne d'un locataire spécifique.
L'administrateur qui gère un locataire spécifique peut voir la liste de toutes les configurations de campagne créées pour ce locataire.
Les propriétaires de l'application peuvent accéder à la liste des configurations de campagne qu'ils ont créées ou qui comprennent au moins une application dont ils sont propriétaires.
Les paramètres de filtrage non spécifiés sont considéré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 configuration 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:

priority

string

enum

Defaults to all

Le filtre pour le type de configuration de la campagne : userassignment, groupassignment, account, groupmembership.

Plusieurs valeurs peuvent être sélectionnées.

Allowed:

preview

string

enum

Defaults to all

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

Allowed:

draft

string

enum

Defaults to all

Le filtre pour obtenir la configuration de la campagne de prévisualisation : oui, non.

Allowed:

filter

string

Le filtre pour obtenir la configuration de la campagne en mode brouillon : oui, non.

sort

string

Un filtre générique qui filtre les réponses contenant la chaîne passée dans l'un des attributs suivants : name (nom de la configuration de la campagne).

sortDesc

boolean

enum

Defaults to true

L'attribut de la configuration de la campagne qui est utilisé pour trier les résultats. Les valeurs possibles sont : owner, launchdate, name, type, priority, createdOn.

Lorsque vous fournissez,
owner :Le fullName du propriétaire est utilisé pour le tri.
launchdate :L'horodatage de la configuration de la campagne launchDate est utilisé pour le tri.
name : Le nom de la configuration de la campagne est utilisé pour le tri.
type :Le type de la configuration de la campagne est utilisé pour le tri.
priority :La priorité de la configuration de la campagne est utilisée pour le tri.
createdOn : L'horodatage de la configuration de campagne creationDate 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.

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