[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}
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
| 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
| code language-shell |
|---|
|
Resposta
Uma solicitação bem-sucedida retorna o status HTTP 200 com uma lista de definições de processo.
| 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 | |
|---|---|
| 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}
{DEFINITION_ID}Solicitação
| code language-shell |
|---|
|
Resposta
Uma solicitação bem-sucedida retorna o status HTTP 200 com informações sobre a definição de processo solicitada.
| 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 | |
|---|---|
| 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
definitionUuidexecutionTriggerMANUAL ou SCHEDULE.Solicitação
| code language-shell |
|---|
|
Resposta
Uma solicitação bem-sucedida retorna o status HTTP 200 com informações sobre as execuções de definição de processo.
| 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 | |
|---|---|
| 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}
{RUN_ID}Solicitação
| code language-shell |
|---|
|
Resposta
Uma solicitação bem-sucedida retorna o status HTTP 200 com informações sobre a execução de definição de processo especificada.
| 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 | |
|---|---|
| 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
| code language-shell |
|---|
|
| 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.
| 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 | |
|---|---|
| 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
{DEFINITION_ID}Solicitação
| code language-shell |
|---|
|
Resposta
Uma solicitação bem-sucedida retorna o status HTTP 200 com informações sobre o agendamento de definição de processo.
| 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 | |
|---|---|
| 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
{DEFINITION_ID}Solicitação
| code language-shell |
|---|
|
| 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
Uma solicitação bem-sucedida retorna o status HTTP 200 com o agendamento atualizado.
| code language-json |
|---|
|
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
{DEFINITION_ID}Solicitação
| code language-shell |
|---|
|
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
{DEFINITION_ID}Solicitação
| code language-shell |
|---|
|
Resposta
Uma solicitação bem-sucedida retorna o status HTTP 200 com informações sobre o agendamento.
| code language-json |
|---|
|
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
{DEFINITION_ID}Solicitação
| code language-shell |
|---|
|
Resposta
Uma solicitação bem-sucedida retorna o status HTTP 200 com informações sobre o agendamento.
| code language-json |
|---|
|