[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}
NOTE
Pour plus d’informations sur les sandbox dans Adobe Experience Platform, consultez la documentation de présentation des sandbox.

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

Liste des paramètres de requête disponibles.
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

Exemple de requête pour obtenir une liste de définitions de processus.
code language-shell
curl -X GET "https://aep-maestro.adobe.io/process-definitions?sort=updatedAt&order=desc&pageSize=2" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

Réponse

Une requête réussie renvoie le statut HTTP 200 avec une liste de définitions de processus.

Exemple de réponse lors de la récupération d’une liste de définitions de processus.
code language-json
{
  "items": [
    {
      "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
      "name": "onboard-new-customer",
      "imsOrg": "{ORG_ID}",
      "sandboxId": "{SANDBOX_ID}",
      "sandboxName": "prod",
      "tasks": [
          {
            "id": "wait-task-id",
            "taskType": "wait",
            "retry": {
                "maxAttempts": 1,
                "backoffCoefficient": 2.0
            }
        }
      ],
      "createdAt": "2026-05-13T17:45:00Z",
      "updatedAt": "2026-05-13T17:45:00Z",
      "createdBy": {
        "userId": "{USER_ID}",
        "isService": false
      },
      "updatedBy": {
        "userId": "{USER_ID}",
        "isService": false
      }
    }
  ],
  "offset": 0,
  "nextCursor": "opaque-pagination-cursor",
  "pageSize": 1,
  "total": 1,
  "hasMore": true
}
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}
Paramètre
Description
{DEFINITION_ID}
L’identifiant de la définition du processus.

Requête

Exemple de requête pour récupérer la définition de processus spécifiée.
code language-shell
curl -X GET "https://aep-maestro.adobe.io/process-definitions/5b4e018b-f37c-4104-928b-b67148ce8537" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

Réponse

Une requête réussie renvoie un état HTTP 200 avec des informations sur la définition de processus demandée.

Exemple de réponse lors de la récupération d’une définition de processus spécifique.
code language-json
{
    "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
    "name": "onboard-new-customer",
    "imsOrg": "{ORG_ID}",
    "sandboxId": "{SANDBOX_ID}",
    "sandboxName": "prod",
    "tasks": [
        {
            "id": "wait-task-id",
            "taskType": "wait",
            "retry": {
                "maxAttempts": 1,
                "backoffCoefficient": 2.0
        }
    }
    ],
    "createdAt": "2026-05-13T17:45:00Z",
    "updatedAt": "2026-05-13T17:45:00Z",
    "createdBy": {
        "userId": "{USER_ID}",
        "isService": false
    },
    "updatedBy": {
        "userId": "{USER_ID}",
        "isService": false
    }
}
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

Paramètre
Requis
Description
definitionUuid
Oui
Définition du processus dont vous souhaitez répertorier les exécutions.
executionTrigger
Non
Filtre les résultats pour les exécutions lancées par MANUAL ou SCHEDULE.

Requête

Exemple de requête pour récupérer toutes les exécutions manuelles pour la définition de processus spécifiée.
code language-shell
curl -X GET "https://aep-maestro.adobe.io/runs?definitionUuid=5b4e018b-f37c-4104-928b-b67148ce8537&executionTrigger=MANUAL" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

Réponse

Une requête réussie renvoie un état HTTP 200 avec des informations sur les exécutions de définition de processus.

Exemple de réponse lors de la récupération des exécutions d’une définition de processus.
code language-json
[
  {
    "runId": "b4d8e7c0-6c31-4d77-9f3d-c7d8a99496d2",
    "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
    "definitionName": "Sample run",
    "imsOrg": "{ORG_ID}",
    "sandboxId": "{SANDBOX_ID}",
    "sandboxName": "prod",
    "state": "RUNNING",
    "submittedAt": "2026-10-23T18:32:52.402Z",
    "startedAt": "2026-10-23T18:32:52.402Z",
    "events": [
        {
            "type": "PROCESS_STARTED",
            "taskId": "sample-task",
            "taskType": "wait",
            "attempt": 1,
            "occurredAt": "2026-10-23T18:33:07.402Z"
        }
    ],
    "triggeredBy": "MANUAL"
  }
]
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}
Paramètre
Description
{RUN_ID}
Identifiant de l’exécution de la définition de processus.

Requête

Exemple de requête pour récupérer l’exécution de définition de processus spécifiée.
code language-shell
curl -X GET "https://aep-maestro.adobe.io/runs/{RUN_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

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.

Exemple de réponse contenant des informations sur l’exécution de la définition de processus.
code language-json
{
    "runId": "b4d8e7c0-6c31-4d77-9f3d-c7d8a99496d2",
    "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
    "definitionName": "Sample run",
    "imsOrg": "{ORG_ID}",
    "sandboxId": "{SANDBOX_ID}",
    "sandboxName": "prod",
    "state": "RUNNING",
    "submittedAt": "2026-10-23T18:32:52.402Z",
    "startedAt": "2026-10-23T18:32:52.402Z",
    "events": [
        {
            "type": "PROCESS_STARTED",
            "taskId": "sample-task",
            "taskType": "wait",
            "attempt": 1,
            "occurredAt": "2026-10-23T18:33:07.402Z"
        }
    ],
    "triggeredBy": "MANUAL"
}
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

Exemple de requête pour démarrer une exécution de définition de processus.
code language-shell
curl -X POST "https://aep-maestro.adobe.io/runs" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Content-Type: application/json" \
  -d '{
    "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
    "inputs": {
      "customerEmail": "alice@example.com",
      "orgName": "ACME Corp"
    }
  }'
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.

Exemple de réponse lors du démarrage de l’exécution d’une définition de processus.
code language-json
{
    "runId": "b4d8e7c0-6c31-4d77-9f3d-c7d8a99496d2",
    "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
    "definitionName": "Sample run",
    "imsOrg": "{ORG_ID}",
    "sandboxId": "{SANDBOX_ID}",
    "sandboxName": "prod",
    "state": "PENDING",
    "submittedAt": "2026-10-23T18:32:52.402Z",
    "startedAt": "2026-10-23T18:32:52.402Z",
    "events": [
        {
            "type": "PROCESS_STARTED",
            "taskId": "sample-task",
            "taskType": "wait",
            "attempt": 1,
            "occurredAt": "2026-10-23T18:33:07.402Z"
        }
    ],
    "triggeredBy": "MANUAL"
}
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
Paramètre
Description
{DEFINITION_ID}
Identifiant de la définition de processus propriétaire du planning.

Requête

Exemple de requête pour récupérer le planning d’une définition de processus.
code language-shell
curl -X GET "https://aep-maestro.adobe.io/process-definitions/{DEFINITION_ID}/schedule" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

Réponse

Une requête réussie renvoie le statut HTTP 200 avec des informations sur le planning de définition du processus.

Exemple de réponse contenant des informations sur le planning de définition du processus.
code language-json
{
  "cron": "0 0 * * *",
  "paused": false,
  "createdAt": "2026-10-23T20:50:40.581Z",
  "updatedAt": "2026-10-23T20:50:40.581Z",
  "createdBy": {
    "userId": "{USER_ID}",
    "isService": false
  },
  "updatedBy": {
    "userId": "{USER_ID}",
    "isService": false
  }
}
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
Paramètre
Description
{DEFINITION_ID}
Identifiant de la définition de processus propriétaire du planning.

Requête

Exemple de requête pour remplacer le planning de la définition de processus.
code language-shell
curl -X PUT "https://aep-maestro.adobe.io/process-definitions/5b4e018b-f37c-4104-928b-b67148ce8537/schedule" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Content-Type: application/json" \
  -d '{
    "cron": "0 0 * * *"
  }'
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

Exemple de réponse lors de la mise à jour d’un planning.

Une requête réussie renvoie le statut HTTP 200 avec le planning mis à jour.

code language-json
{
  "cron": "0 0 * * *",
  "paused": false,
  "createdAt": "2026-10-23T20:50:40.581Z",
  "updatedAt": "2026-10-23T20:50:40.581Z",
  "createdBy": {
    "userId": "{USER_ID}",
    "isService": false
  },
  "updatedBy": {
    "userId": "{USER_ID}",
    "isService": false
  }
}

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
Paramètre
Description
{DEFINITION_ID}
L’identifiant de la définition du processus.

Requête

Exemple de requête pour supprimer le planning de la définition de processus.
code language-shell
curl -X DELETE "https://aep-maestro.adobe.io/process-definitions/5b4e018b-f37c-4104-928b-b67148ce8537/schedule" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

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
Paramètre
Description
{DEFINITION_ID}
L’identifiant de la définition du processus.

Requête

Exemple de requête pour suspendre le planning.
code language-shell
curl -X POST "https://aep-maestro.adobe.io/process-definitions/5b4e018b-f37c-4104-928b-b67148ce8537/schedule:pause" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

Réponse

Une requête réussie renvoie un état HTTP 200 avec des informations sur le planning.

Exemple de réponse lors de la suspension d’un planning.
code language-json
{
  "cron": "0 0 * * *",
  "paused": true,
  "createdAt": "2026-10-23T20:50:40.581Z",
  "updatedAt": "2026-10-23T20:50:40.581Z",
  "createdBy": {
    "userId": "{USER_ID}",
    "isService": false
  },
  "updatedBy": {
    "userId": "{USER_ID}",
    "isService": false
  }
}

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
Paramètre
Description
{DEFINITION_ID}
L’identifiant de la définition du processus.

Requête

Exemple de requête lors de la reprise d’un planning.
code language-shell
curl -X POST "https://aep-maestro.adobe.io/process-definitions/5b4e018b-f37c-4104-928b-b67148ce8537/schedule:resume" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

Réponse

Une requête réussie renvoie un état HTTP 200 avec des informations sur le planning.

Exemple de réponse lors de la reprise d’un planning.
code language-json
{
  "cron": "0 0 * * *",
  "paused": false,
  "createdAt": "2026-10-23T20:50:40.581Z",
  "updatedAt": "2026-10-23T20:50:40.581Z",
  "createdBy": {
    "userId": "{USER_ID}",
    "isService": false
  },
  "updatedBy": {
    "userId": "{USER_ID}",
    "isService": false
  }
}
recommendation-more-help
experience-platform-help-process-manager