HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

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

get
https://{tenanturl}/v1.0/self/campaigns//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
Obtenir des instances de campagne correspondant à une configuration de campagne donnée pour un évaluateur ou un superviseur. Au moins un enregistrement doit être associé au réviseur ou au superviseur.
Habilitations requises : manageAccessCertification [Gérer la certification d'accès].

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID de configuration de la campagne

Query Params
state
array of strings
enum
Defaults to all

Le filtre pour l'état de l'instance de la campagne : noinstance, avorté, fermé, terminé, créé, supprimé, échoué, en pause, en cours d'exécution, en cours de démarrage, succès.

state
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

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 10 months ago

Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 10 months ago