Obsolète - Récupérer les instances correspondant à une configuration de campagne spécifique.

get

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

L'API permettant d'obtenir des instances d'une campagne spécifique v1.0 ( v1.0/self/campaigns/{id }/instances) est obsolète. La fin de vie est 31-Dec-2025. Utilisez l'API alternative suivante : GET /v2.0/campaigns/{id }/instances
La demande d'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 des filtres de l'API V1.
Obtenir des instances de campagne correspondant à une configuration de campagne donnée pour un réviseur ou un superviseur. Au moins un enregistrement doit être associé au réviseur ou au superviseur : 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

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

state

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

403

Votre demande ne peut pas être traitée. Le code d'erreur et la description sont disponibles dans la charge utile.

500

Erreur de serveur

Language

URL

Loading…