[Beta]{class="badge informative"}
API Process Manager
Utilisez l’API Process Manager dans Adobe Experience Platform pour répertorier les définitions de processus, passer en revue les exécutions et gérer les plannings de périodicité.
Prise en main
Avant d’utiliser l’API, suivez le tutoriel authentification. Incluez ensuite ces en-têtes dans chaque requête :
- Authorization:
Bearer {ACCESS_TOKEN} - x-api-key :
{API_KEY} - x-gw-ims-org-id :
{ORG_ID} - x-sandbox-name :
{SANDBOX_NAME}
Répertorier les définitions de processus list-process-definitions
Vous pouvez répertorier toutes les définitions de processus actuelles en effectuant une requête GET au point d’entrée /process-definitions.
Format d’API
GET /process-definitions
Paramètres de requête
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
|---|---|
| Paramètre | Description |
name |
Filtre de sous-chaîne insensible à la casse sur le nom de la définition. |
sort |
Champ par lequel trier. Les valeurs prises en charge sont createdAt, updatedAt et name. La valeur par défaut est createdAt. |
order |
Ordre de tri. Les valeurs prises en charge sont asc et desc. La valeur par défaut est desc. |
pageSize |
Éléments par page. La plage prise en charge est comprise entre 1 et 100. La valeur par défaut est 100. |
cursor |
Curseur de pagination opaque renvoyé par un appel précédent. Mutuellement exclusif avec offset. |
offset |
Décalage basé sur zéro. Mutuellement exclusif avec cursor. |
Requête
| code language-shell |
|---|
|
Réponse
Une requête réussie renvoie le statut HTTP 200 avec une liste de définitions de processus.
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2 | |
|---|---|
| Champ | Description |
definitionUuid |
L’identifiant de la définition du processus. |
name |
Nom de la définition de processus. |
imsOrg |
L’identifiant de l’organisation à laquelle appartient la définition du processus. |
sandboxId |
Identifiant du sandbox auquel appartient la définition du processus. |
sandboxName |
Nom du sandbox auquel appartient la définition de processus. |
tasks |
Tableau contenant les objets de tâche liés à la définition de processus. |
tasks.id |
L’identifiant de la tâche. |
tasks.taskType |
Type de tâche. Les valeurs possibles comprennent wait, ingest-data, verify-profile-ingestion, run-segmentation, run-profile-export, trigger-activation, run-data-distiller et send-notification. |
tasks.retry.maxAttempts |
Le nombre de reprises de la tâche en cas d’échec. |
tasks.retry.backoffCoefficient |
|
createdAt |
Date et heure auxquelles la définition du processus a été créée. |
updatedAt |
Date et heure de la dernière mise à jour de la définition du processus. |
createdBy |
Objet contenant des informations sur l’utilisateur qui a créé la définition de processus. |
updatedBy |
Objet contenant des informations sur l’utilisateur qui a mis à jour la définition du processus pour la dernière fois. |
Récupération d’une définition de processus spécifique
Vous pouvez récupérer une définition de processus spécifique en effectuant une requête GET au point d’entrée /process-definitions tout en fournissant l’identifiant de définition de processus.
Format d’API
GET /process-definitions/{DEFINITION_ID}
{DEFINITION_ID}Requête
| code language-shell |
|---|
|
Réponse
Une requête réussie renvoie un état HTTP 200 avec des informations sur la définition de processus demandée.
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2 | |
|---|---|
| Champ | Description |
definitionUuid |
L’identifiant de la définition du processus. |
name |
Nom de la définition de processus. |
imsOrg |
L’identifiant de l’organisation à laquelle appartient la définition du processus. |
sandboxId |
Identifiant du sandbox auquel appartient la définition du processus. |
sandboxName |
Nom du sandbox auquel appartient la définition de processus. |
tasks |
Tableau contenant les objets de tâche liés à la définition de processus. |
tasks.id |
L’identifiant de la tâche. |
tasks.taskType |
Type de tâche. Les valeurs possibles comprennent wait, ingest-data, verify-profile-ingestion, run-segmentation, run-profile-export, trigger-activation, run-data-distiller et send-notification. |
tasks.retry.maxAttempts |
Le nombre de reprises de la tâche en cas d’échec. |
tasks.retry.backoffCoefficient |
|
createdAt |
Date et heure auxquelles la définition du processus a été créée. |
updatedAt |
Date et heure de la dernière mise à jour de la définition du processus. |
createdBy |
Objet contenant des informations sur l’utilisateur qui a créé la définition de processus. |
updatedBy |
Objet contenant des informations sur l’utilisateur qui a mis à jour la définition du processus pour la dernière fois. |
Liste des exécutions de définition de processus list-process-definition-runs
Vous pouvez récupérer une liste de toutes les exécutions pour une définition de processus en envoyant une requête GET au point d’entrée /runs et en fournissant l’identifiant de la définition de processus.
Format d’API
GET /runs?{QUERY_PARAMETERS}
Paramètres de requête
definitionUuidexecutionTriggerMANUAL ou SCHEDULE.Requête
| code language-shell |
|---|
|
Réponse
Une requête réussie renvoie un état HTTP 200 avec des informations sur les exécutions de définition de processus.
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 | |
|---|---|
| Champ | Description |
runId |
Identifiant de l’exécution de la définition de processus. |
definitionUuid |
L’identifiant de la définition de processus à laquelle appartient l’exécution. |
definitionName |
Nom de la définition de processus à laquelle appartient l’exécution. |
imsOrg |
Identifiant de l’organisation à laquelle appartient l’exécution de définition de processus. |
sandboxId |
Identifiant du sandbox auquel appartient l’exécution de définition du processus. |
sandboxName |
Nom du sandbox auquel appartient l’exécution de définition de processus. |
state |
État de l’exécution de la définition de processus. Les valeurs possibles comprennent PENDING, RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED et TIMED_OUT. |
submittedAt |
Date et heure auxquelles l’exécution de la définition du processus a été envoyée. |
startedAt |
Date et heure auxquelles l’exécution de la définition de processus commence. |
events |
Objet contenant les tâches exécutées dans le cadre de l’exécution de la définition de processus. |
triggeredBy |
Méthode utilisée pour exécuter la définition du processus. Les valeurs possibles sont MANUAL ou SCHEDULE. |
Obtenir l’exécution de la définition de processus spécifique get-process-definition-run
Vous pouvez récupérer une définition de processus spécifique exécutée en envoyant une requête GET au point d’entrée /runs et en fournissant l’identifiant d’exécution.
Format d’API
GET /runs/{RUN_ID}
{RUN_ID}Requête
| code language-shell |
|---|
|
Réponse
Une requête réussie renvoie un état HTTP 200 avec des informations sur l’exécution de la définition de processus spécifiée.
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 | |
|---|---|
| Champ | Description |
runId |
Identifiant de l’exécution de la définition de processus. |
definitionUuid |
L’identifiant de la définition de processus à laquelle appartient l’exécution. |
definitionName |
Nom de la définition de processus à laquelle appartient l’exécution. |
imsOrg |
Identifiant de l’organisation à laquelle appartient l’exécution de définition de processus. |
sandboxId |
Identifiant du sandbox auquel appartient l’exécution de définition du processus. |
sandboxName |
Nom du sandbox auquel appartient l’exécution de définition de processus. |
state |
État de l’exécution de la définition de processus. Les valeurs possibles comprennent PENDING, RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED et TIMED_OUT. |
submittedAt |
Date et heure auxquelles l’exécution de la définition du processus a été envoyée. |
startedAt |
Date et heure auxquelles l’exécution de la définition de processus commence. |
events |
Objet contenant les tâches exécutées dans le cadre de l’exécution de la définition de processus. |
triggeredBy |
Méthode utilisée pour exécuter la définition du processus. Les valeurs possibles sont MANUAL ou SCHEDULE. |
Démarrer une exécution de définition de processus start-run
Vous pouvez démarrer l’exécution d’une définition de processus en effectuant une requête POST vers le point d’entrée /runs.
Format d’API
POST /runs
Requête
| code language-shell |
|---|
|
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| Propriété | Type | Description |
definitionUuid |
Chaîne | L’identifiant de la définition de processus pour laquelle vous souhaitez démarrer une exécution. |
inputs |
Objet | Un objet facultatif contenant les champs obligatoires dans la définition du processus. |
Réponse
Une requête réussie renvoie le statut HTTP 202 Accepted avec les détails d’exécution acceptés. L’exécution est asynchrone et renvoie immédiatement avec state: PENDING.
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 | |
|---|---|
| Champ | Description |
runId |
L’identifiant de l’exécution nouvellement acceptée. |
definitionUuid |
L’identifiant de la définition de processus pour laquelle l’exécution est effectuée. |
definitionName |
Nom de la définition de processus à laquelle appartient l’exécution. |
imsOrg |
Identifiant de l’organisation à laquelle appartient l’exécution de définition de processus. |
sandboxId |
Identifiant du sandbox auquel appartient l’exécution de définition du processus. |
sandboxName |
Nom du sandbox auquel appartient l’exécution de définition de processus. |
state |
État de l’exécution. Ce processus étant asynchrone, la valeur sera PENDING. |
submittedAt |
Date et heure auxquelles l’exécution de la définition du processus a été envoyée. |
startedAt |
Date et heure auxquelles l’exécution de la définition de processus commence. |
events |
Objet contenant les tâches exécutées dans le cadre de l’exécution de la définition de processus. |
triggeredBy |
Méthode utilisée pour exécuter la définition du processus. Les valeurs possibles sont MANUAL ou SCHEDULE. |
Récupérer le planning de définition du processus get-schedule
Vous pouvez obtenir le planning d’une définition de processus en adressant une requête GET au point d’entrée /process-definitions/{DEFINITION_ID}/schedule et en fournissant l’identifiant de la définition de processus.
Format d’API
GET /process-definitions/{DEFINITION_ID}/schedule
{DEFINITION_ID}Requête
| code language-shell |
|---|
|
Réponse
Une requête réussie renvoie le statut HTTP 200 avec des informations sur le planning de définition du processus.
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
|---|---|
| Champ | Description |
cron |
Format cron pour le planning. Pour plus d’informations sur les plannings cron, consultez la documentation relative au format d’expression cron. |
paused |
Valeur booléenne qui indique si le planning est suspendu ou non. |
createdAt |
Date et heure de création du planning. |
updatedAt |
Date et heure de la dernière mise à jour du planning. |
createdBy |
Un objet contenant les détails de l’utilisateur qui a créé le planning. |
updatedBy |
Un objet contenant les détails de la dernière mise à jour du planning effectuée par l’utilisateur. |
Remplacer un planning replace-schedule
Vous pouvez remplacer le planning d’une définition de processus en effectuant une requête PUT au point d’entrée /process-definitions/{DEFINITION_ID}/schedule tout en fournissant l’identifiant de la définition de processus.
Format d’API
PUT /process-definitions/{DEFINITION_ID}/schedule
{DEFINITION_ID}Requête
| code language-shell |
|---|
|
| table 0-row-3 1-row-3 | ||
|---|---|---|
| Propriété | Type | Description |
cron |
Chaîne | Format cron pour le planning. Pour plus d’informations sur les plannings cron, consultez la documentation relative au format d’expression cron. |
Réponse
Une requête réussie renvoie le statut HTTP 200 avec le planning mis à jour.
| code language-json |
|---|
|
Supprimer le planning de définition du processus remove-schedule
Vous pouvez supprimer le planning associé à une définition de processus en effectuant une requête DELETE au point d’entrée /process-definitions/{DEFINITION_ID}/schedule tout en fournissant l’identifiant de la définition de processus.
Format d’API
DELETE /process-definitions/{DEFINITION_ID}/schedule
{DEFINITION_ID}Requête
| code language-shell |
|---|
|
Réponse
Une requête réussie renvoie un HTTP 204 sans corps de réponse.
Mettre en pause le planning spécifié pause-schedule
Vous pouvez suspendre la planification d’une définition de processus en effectuant une requête POST au point d’entrée /process-definitions/{DEFINITION_ID}/schedule:pause tout en fournissant l’identifiant de définition de processus.
Format d’API
POST /process-definitions/{DEFINITION_ID}/schedule:pause
{DEFINITION_ID}Requête
| code language-shell |
|---|
|
Réponse
Une requête réussie renvoie un état HTTP 200 avec des informations sur le planning.
| code language-json |
|---|
|
Reprendre la planification spécifiée resume-schedule
Vous pouvez reprendre la planification d’une définition de processus en effectuant une requête POST au point d’entrée /process-definitions/{DEFINITION_ID}/schedule:resume tout en fournissant l’identifiant de définition de processus.
Format d’API
POST /process-definitions/{DEFINITION_ID}/schedule:resume
{DEFINITION_ID}Requête
| code language-shell |
|---|
|
Réponse
Une requête réussie renvoie un état HTTP 200 avec des informations sur le planning.
| code language-json |
|---|
|