[Beta]{class="badge informative"}

API do Gerenciador de processos

Use a API do Gerenciador de Processos em Adobe Experience Platform para listar definições de processo, revisar execuções de execução e gerenciar agendamentos recorrentes.

Introdução

Antes de usar a API, conclua o tutorial de autenticação. Em seguida, inclua esses cabeçalhos em cada solicitação:

  • Autorização: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id {ORG_ID}
  • x-sandbox-name: {SANDBOX_NAME}
NOTE
Para obter mais informações sobre sandboxes em Adobe Experience Platform, consulte a documentação de visão geral das sandboxes.

Listar definições de processo list-process-definitions

Você pode listar todas as definições de processo atuais fazendo uma solicitação GET para o ponto de extremidade /process-definitions.

Formato da API

GET /process-definitions

Parâmetros de consulta

Uma lista de parâmetros de consulta disponíveis.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
Parâmetro Descrição
name Filtro de substring que não diferencia maiúsculas de minúsculas no nome da definição.
sort Campo de acordo com o qual classificar. Os valores com suporte são createdAt, updatedAt e name. O padrão é createdAt.
order Ordem de classificação. Os valores com suporte são asc e desc. O padrão é desc.
pageSize Itens por página. O intervalo suportado é de 1 a 100. O padrão é 100.
cursor Cursor de paginação opaco retornado por uma chamada anterior. Mutualmente exclusivo com offset.
offset Deslocamento baseado em zero. Mutualmente exclusivo com cursor.

Solicitação

Uma solicitação de exemplo para obter uma lista de definições de processo.
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}"

Resposta

Uma solicitação bem-sucedida retorna o status HTTP 200 com uma lista de definições de processo.

Uma resposta de amostra ao recuperar uma lista de definições de processo.
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
Campo Descrição
definitionUuid A ID da definição do processo.
name O nome da definição do processo.
imsOrg A ID da organização à qual a definição de processo pertence.
sandboxId A ID da sandbox à qual a definição de processo pertence.
sandboxName O nome da sandbox à qual a definição de processo pertence.
tasks Uma matriz que contém os objetos de tarefa relacionados à definição do processo.
tasks.id A ID da tarefa.
tasks.taskType O tipo de tarefa. Os valores possíveis incluem wait, ingest-data, verify-profile-ingestion, run-segmentation, run-profile-export, trigger-activation, run-data-distiller e send-notification.
tasks.retry.maxAttempts O número de vezes que a tarefa será repetida se falhar.
tasks.retry.backoffCoefficient
createdAt A data e a hora em que a definição do processo foi criada.
updatedAt A data e a hora em que a definição do processo foi atualizada pela última vez.
createdBy Um objeto que contém informações sobre o usuário que criou a definição do processo.
updatedBy Um objeto que contém informações sobre o usuário que atualizou a definição do processo pela última vez.

Recuperar uma definição de processo específica

Você pode recuperar uma definição de processo específica fazendo uma solicitação GET para o ponto de extremidade /process-definitions ao fornecer a ID de definição do processo.

Formato da API

GET /process-definitions/{DEFINITION_ID}
Parâmetro
Descrição
{DEFINITION_ID}
A ID da definição do processo.

Solicitação

Uma solicitação de amostra para recuperar a definição de processo especificada.
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}"

Resposta

Uma solicitação bem-sucedida retorna o status HTTP 200 com informações sobre a definição de processo solicitada.

Uma resposta de amostra ao recuperar uma definição de processo específica.
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
Campo Descrição
definitionUuid A ID da definição do processo.
name O nome da definição do processo.
imsOrg A ID da organização à qual a definição de processo pertence.
sandboxId A ID da sandbox à qual a definição de processo pertence.
sandboxName O nome da sandbox à qual a definição de processo pertence.
tasks Uma matriz que contém os objetos de tarefa relacionados à definição do processo.
tasks.id A ID da tarefa.
tasks.taskType O tipo de tarefa. Os valores possíveis incluem wait, ingest-data, verify-profile-ingestion, run-segmentation, run-profile-export, trigger-activation, run-data-distiller e send-notification.
tasks.retry.maxAttempts O número de vezes que a tarefa será repetida se falhar.
tasks.retry.backoffCoefficient
createdAt A data e a hora em que a definição do processo foi criada.
updatedAt A data e a hora em que a definição do processo foi atualizada pela última vez.
createdBy Um objeto que contém informações sobre o usuário que criou a definição do processo.
updatedBy Um objeto que contém informações sobre o usuário que atualizou a definição do processo pela última vez.

Listar execuções de definição de processo list-process-definition-runs

Você pode recuperar uma lista de todas as execuções de uma definição de processo fazendo uma solicitação GET para o ponto de extremidade /runs e fornecendo a ID da definição de processo.

Formato da API

GET /runs?{QUERY_PARAMETERS}

Parâmetros de consulta

Parâmetro
Obrigatório
Descrição
definitionUuid
Sim
A definição do processo cujas execuções você deseja listar.
executionTrigger
Não
Filtra os resultados das execuções iniciadas por MANUAL ou SCHEDULE.

Solicitação

Uma solicitação de amostra para recuperar todas as execuções manuais para a definição de processo especificada.
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}"

Resposta

Uma solicitação bem-sucedida retorna o status HTTP 200 com informações sobre as execuções de definição de processo.

Um exemplo de resposta ao recuperar as execuções de uma definição de processo.
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
Campo Descrição
runId A ID da execução da definição do processo.
definitionUuid A ID da definição de processo à qual a execução pertence.
definitionName O nome da definição de processo à qual a execução pertence.
imsOrg A ID da organização à qual pertence a execução de definição de processo.
sandboxId A ID da sandbox à qual pertence a execução de definição do processo.
sandboxName O nome da sandbox à qual pertence a execução de definição do processo.
state O estado da execução da definição do processo. Os valores possíveis incluem PENDING, RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED e TIMED_OUT.
submittedAt A data e a hora em que a execução de definição do processo foi enviada.
startedAt A data e a hora em que a execução da definição de processo começa.
events Um objeto que contém as tarefas executadas como parte da execução de definição do processo.
triggeredBy O método no qual a definição de processo foi executada. Os valores possíveis incluem MANUAL ou SCHEDULE.

Obter execução de definição de processo específica get-process-definition-run

Você pode recuperar uma execução de definição de processo específica fazendo uma solicitação GET para o ponto de extremidade /runs enquanto fornece a ID da execução.

Formato da API

GET /runs/{RUN_ID}
Parâmetro
Descrição
{RUN_ID}
A ID da execução da definição do processo.

Solicitação

Uma solicitação de amostra para recuperar a execução de definição de processo especificada.
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}"

Resposta

Uma solicitação bem-sucedida retorna o status HTTP 200 com informações sobre a execução de definição de processo especificada.

Uma resposta de amostra com informações sobre a execução da definição do processo.
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
Campo Descrição
runId A ID da execução da definição do processo.
definitionUuid A ID da definição de processo à qual a execução pertence.
definitionName O nome da definição de processo à qual a execução pertence.
imsOrg A ID da organização à qual pertence a execução de definição de processo.
sandboxId A ID da sandbox à qual pertence a execução de definição do processo.
sandboxName O nome da sandbox à qual pertence a execução de definição do processo.
state O estado da execução da definição do processo. Os valores possíveis incluem PENDING, RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED e TIMED_OUT.
submittedAt A data e a hora em que a execução de definição do processo foi enviada.
startedAt A data e a hora em que a execução da definição de processo começa.
events Um objeto que contém as tarefas executadas como parte da execução de definição do processo.
triggeredBy O método no qual a definição de processo foi executada. Os valores possíveis incluem MANUAL ou SCHEDULE.

Iniciar uma execução de definição de processo start-run

Você pode iniciar uma execução de definição de processo fazendo uma solicitação POST para o ponto de extremidade /runs.

Formato da API

POST /runs

Solicitação

Uma solicitação de amostra para iniciar uma execução de definição de processo.
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
Propriedade Tipo Descrição
definitionUuid String A ID da definição de processo para a qual você deseja iniciar uma execução.
inputs Objeto Um objeto opcional que contém campos obrigatórios na definição do processo.

Resposta

Uma solicitação bem-sucedida retorna o status HTTP 202 Accepted com os detalhes de execução aceitos. A execução é assíncrona e retorna imediatamente com state: PENDING.

Uma resposta de amostra ao iniciar uma execução de definição de processo.
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
Campo Descrição
runId A ID da execução recém-aceita.
definitionUuid A ID da definição do processo para a qual a execução é feita.
definitionName O nome da definição de processo à qual a execução pertence.
imsOrg A ID da organização à qual pertence a execução de definição de processo.
sandboxId A ID da sandbox à qual pertence a execução de definição do processo.
sandboxName O nome da sandbox à qual pertence a execução de definição do processo.
state O estado da execução. Como este processo é assíncrono, será PENDING.
submittedAt A data e a hora em que a execução de definição do processo foi enviada.
startedAt A data e a hora em que a execução da definição de processo começa.
events Um objeto que contém as tarefas executadas como parte da execução de definição do processo.
triggeredBy O método no qual a definição de processo foi executada. Os valores possíveis incluem MANUAL ou SCHEDULE.

Recuperar programação de definição de processo get-schedule

Você pode obter o agendamento para uma definição de processo fazendo uma solicitação GET para o ponto de extremidade /process-definitions/{DEFINITION_ID}/schedule e fornecendo a ID da definição de processo.

Formato da API

GET /process-definitions/{DEFINITION_ID}/schedule
Parâmetro
Descrição
{DEFINITION_ID}
A ID da definição do processo que é proprietária do agendamento.

Solicitação

Uma solicitação de amostra para recuperar a programação para uma definição de processo.
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}"

Resposta

Uma solicitação bem-sucedida retorna o status HTTP 200 com informações sobre o agendamento de definição de processo.

Uma resposta de amostra com informações sobre o agendamento de definição de processo.
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
Campo Descrição
cron O formato CRON do agendamento. Para obter mais informações sobre agendamentos cron, leia a documentação formato de expressão cron.
paused Um booleano que indica se a programação está ou não pausada.
createdAt A data e a hora em que a programação foi criada.
updatedAt A data e a hora em que a programação foi atualizada pela última vez.
createdBy Um objeto que contém detalhes do usuário que criou o agendamento.
updatedBy Um objeto que contém detalhes do usuário que atualizou o agendamento pela última vez.

Substituir um agendamento replace-schedule

Você pode substituir o agendamento de uma definição de processo fazendo uma solicitação PUT para o ponto de extremidade /process-definitions/{DEFINITION_ID}/schedule enquanto fornece a ID da definição do processo.

Formato da API

PUT /process-definitions/{DEFINITION_ID}/schedule
Parâmetro
Descrição
{DEFINITION_ID}
A ID da definição do processo que é proprietária do agendamento.

Solicitação

Um exemplo de solicitação para substituir o agendamento da definição de processo.
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
Propriedade Tipo Descrição
cron String O formato CRON do agendamento. Para obter mais informações sobre agendamentos cron, leia a documentação formato de expressão cron.

Resposta

Um exemplo de resposta ao atualizar um agendamento.

Uma solicitação bem-sucedida retorna o status HTTP 200 com o agendamento atualizado.

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
  }
}

Remover o agendamento de definição de processo remove-schedule

Você pode remover o agendamento anexado a uma definição de processo fazendo uma solicitação DELETE para o ponto de extremidade /process-definitions/{DEFINITION_ID}/schedule enquanto fornece a ID da definição de processo.

Formato da API

DELETE /process-definitions/{DEFINITION_ID}/schedule
Parâmetro
Descrição
{DEFINITION_ID}
A ID da definição do processo.

Solicitação

Um exemplo de solicitação para remover o agendamento da definição de processo.
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}"

Resposta

Uma solicitação bem-sucedida retorna HTTP 204 sem corpo de resposta.

Pausar o agendamento especificado pause-schedule

Você pode pausar o agendamento para uma definição de processo fazendo uma solicitação POST para o ponto de extremidade /process-definitions/{DEFINITION_ID}/schedule:pause enquanto fornece a ID de definição do processo.

Formato da API

POST /process-definitions/{DEFINITION_ID}/schedule:pause
Parâmetro
Descrição
{DEFINITION_ID}
A ID da definição do processo.

Solicitação

Um exemplo de solicitação para pausar o agendamento.
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}"

Resposta

Uma solicitação bem-sucedida retorna o status HTTP 200 com informações sobre o agendamento.

Um exemplo de resposta ao pausar um agendamento.
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
  }
}

Retomar a programação especificada resume-schedule

Você pode retomar o agendamento de uma definição de processo fazendo uma solicitação POST para o ponto de extremidade /process-definitions/{DEFINITION_ID}/schedule:resume ao fornecer a ID de definição do processo.

Formato da API

POST /process-definitions/{DEFINITION_ID}/schedule:resume
Parâmetro
Descrição
{DEFINITION_ID}
A ID da definição do processo.

Solicitação

Um exemplo de solicitação ao retomar um agendamento.
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}"

Resposta

Uma solicitação bem-sucedida retorna o status HTTP 200 com informações sobre o agendamento.

Um exemplo de resposta ao retomar um agendamento.
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