Obsolète - Récupérer les instances de campagne.

get

https://{tenanturl}/v1.0/self/instances

L'api permettant d'obtenir les instances de campagne v1.0 ( v1.0/self/instances ) est obsolète. La fin de vie est 31-Dec-2025. Utilisez l'API alternative suivante : La demande GET /v2.0/instances
API n'est valable que pour les ressources créées à l'aide de la version V1. Toute tentative d'accès aux ressources V2-exclusive à l'aide de l'API V1 se soldera par une erreur 400. En outre, les ressources V2 sont exclues des résultats de recherche du filtre de l'API V1.
Accueillir les instances de campagne avec au moins un enregistrement associé à un réviseur ou à un superviseur.
Entités 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

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

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.

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:

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

Pour filtrer en fonction de l'état général de l'instance de la 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 d'instance : dataonly, yes ou no.

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é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.

Responses

200

Réussite

400

Statut d'erreur générique de l'application. Le code d'erreur et la description sont disponibles dans la charge utile.

500

Erreur de serveur

Language

URL

Loading…