HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

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 : GET /v2.0/instances
Obtenir les instances de campagne avec au moins un enregistrement associé à un évaluateur ou à un superviseur.
Habilitations requises : manageAccessCertification [Gérer la certification d'accès].

Query Params
string
enum
Defaults to all

Le filtre pour le type d'instance de la campagne : attribution d'utilisateur, attribution de groupe ou compte.

Allowed:
state
array of strings
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.

Plusieurs valeurs peuvent être sélectionnées.

state
string
enum
Defaults to all

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

Allowed:
string
enum
Defaults to all

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

Allowed:
string
enum
Defaults to all

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

Allowed:
ownersId
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

ownersId
appsId
array of strings

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

appsId
string
enum
Defaults to all

Pour filtrer en fonction de l'état général de l'instance de la campagne. Ce filtre permet de "regrouper" logiquement les états possibles de l'instance de campagne : actif, inactif.

Allowed:
boolean
enum

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

Allowed:
string
enum
Defaults to assigned

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

Allowed:
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 de l'instance : données uniquement, oui ou non.

Allowed:
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).

string

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.

boolean
enum
Defaults to true

Décide de l'ordre de tri.

Allowed:
string
Defaults to 500

Spécifie le nombre maximum de ressources que la recherche renvoie pour une page.

string
Defaults to 1

Numéro de page.

Responses

500

Erreur de serveur

Updated 9 months ago

Language
URL
Response 
 Choose an example:
application/json
Updated 9 months ago