[Beta]{class="badge informative"}
API de Process Manager
Utilice la API de Process Manager en Adobe Experience Platform para enumerar las definiciones de procesos, revisar las ejecuciones y administrar las programaciones recurrentes.
Introducción
Antes de usar la API, complete el tutorial de autenticación. A continuación, incluya estos encabezados en cada solicitud:
- Autorización:
Bearer {ACCESS_TOKEN} - x-api-key:
{API_KEY} - x-gw-ims-org-id:
{ORG_ID} - x-sandbox-name:
{SANDBOX_NAME}
Enumerar definiciones de procesos list-process-definitions
Puede enumerar todas las definiciones de proceso actuales realizando una petición GET al extremo /process-definitions.
Formato de 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 | Descripción |
name |
Filtro de subcadena que no distingue entre mayúsculas y minúsculas en el nombre de la definición. |
sort |
Campo por el que ordenar. Los valores admitidos son createdAt, updatedAt y name. El valor predeterminado es createdAt. |
order |
Orden de clasificación. Los valores admitidos son asc y desc. El valor predeterminado es desc. |
pageSize |
Elementos por página. El rango admitido es de 1 a 100. El valor predeterminado es 100. |
cursor |
Cursor de paginación opaco devuelto por una llamada anterior. Exclusivo de manera mutua con offset. |
offset |
Desplazamiento basado en cero. Exclusivo de manera mutua con cursor. |
Solicitud
| code language-shell |
|---|
|
Respuesta
Una solicitud correcta devuelve el estado HTTP 200 con una lista de definiciones de proceso.
| 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 | Descripción |
definitionUuid |
El ID de la definición del proceso. |
name |
Nombre de la definición del proceso. |
imsOrg |
El ID de la organización a la que pertenece la definición del proceso. |
sandboxId |
El ID de la zona protegida a la que pertenece la definición del proceso. |
sandboxName |
Nombre de la zona protegida a la que pertenece la definición del proceso. |
tasks |
Matriz que contiene los objetos de tarea relacionados con la definición del proceso. |
tasks.id |
El ID de la tarea. |
tasks.taskType |
El tipo de tarea. Los valores posibles incluyen wait, ingest-data, verify-profile-ingestion, run-segmentation, run-profile-export, trigger-activation, run-data-distiller y send-notification. |
tasks.retry.maxAttempts |
Número de veces que se volverá a intentar realizar la tarea si se produce un error. |
tasks.retry.backoffCoefficient |
|
createdAt |
La fecha y la hora en que se creó la definición del proceso. |
updatedAt |
Fecha y hora en que se actualizó la definición del proceso por última vez. |
createdBy |
Objeto que contiene información sobre el usuario que creó la definición del proceso. |
updatedBy |
Objeto que contiene información sobre el usuario que actualizó la definición del proceso por última vez. |
Recuperar una definición de proceso específica
Puede recuperar una definición de proceso específica realizando una petición GET al extremo /process-definitions mientras proporciona el ID de definición de proceso.
Formato de API
GET /process-definitions/{DEFINITION_ID}
{DEFINITION_ID}Solicitud
| code language-shell |
|---|
|
Respuesta
Una solicitud correcta devuelve el estado HTTP 200 con información sobre la definición de proceso 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 | Descripción |
definitionUuid |
El ID de la definición del proceso. |
name |
Nombre de la definición del proceso. |
imsOrg |
El ID de la organización a la que pertenece la definición del proceso. |
sandboxId |
El ID de la zona protegida a la que pertenece la definición del proceso. |
sandboxName |
Nombre de la zona protegida a la que pertenece la definición del proceso. |
tasks |
Matriz que contiene los objetos de tarea relacionados con la definición del proceso. |
tasks.id |
El ID de la tarea. |
tasks.taskType |
El tipo de tarea. Los valores posibles incluyen wait, ingest-data, verify-profile-ingestion, run-segmentation, run-profile-export, trigger-activation, run-data-distiller y send-notification. |
tasks.retry.maxAttempts |
Número de veces que se volverá a intentar realizar la tarea si se produce un error. |
tasks.retry.backoffCoefficient |
|
createdAt |
La fecha y la hora en que se creó la definición del proceso. |
updatedAt |
Fecha y hora en que se actualizó la definición del proceso por última vez. |
createdBy |
Objeto que contiene información sobre el usuario que creó la definición del proceso. |
updatedBy |
Objeto que contiene información sobre el usuario que actualizó la definición del proceso por última vez. |
Se ejecuta la definición del proceso de lista list-process-definition-runs
Puede recuperar una lista de todas las ejecuciones de una definición de proceso realizando una petición GET al extremo /runs y proporcionando el ID de la definición de proceso.
Formato de API
GET /runs?{QUERY_PARAMETERS}
Parámetros de consulta
definitionUuidexecutionTriggerMANUAL o SCHEDULE.Solicitud
| code language-shell |
|---|
|
Respuesta
Una solicitud correcta devuelve el estado HTTP 200 con información sobre las ejecuciones de definición de proceso.
| 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 | Descripción |
runId |
El ID de la ejecución de definición del proceso. |
definitionUuid |
El ID de la definición de proceso a la que pertenece la ejecución. |
definitionName |
Nombre de la definición de proceso a la que pertenece la ejecución. |
imsOrg |
El ID de la organización a la que pertenece la ejecución de la definición del proceso. |
sandboxId |
El ID de la zona protegida a la que pertenece la ejecución de la definición del proceso. |
sandboxName |
Nombre de la zona protegida a la que pertenece la ejecución de la definición del proceso. |
state |
Estado de ejecución de la definición del proceso. Los valores posibles incluyen PENDING, RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED y TIMED_OUT. |
submittedAt |
La fecha y la hora en que se envió la ejecución de la definición del proceso. |
startedAt |
Fecha y hora en que comienza a ejecutarse la ejecución de la definición del proceso. |
events |
Un objeto que contiene las tareas que se ejecutan como parte de la ejecución de la definición del proceso. |
triggeredBy |
El método por el que se ejecutó la definición del proceso. Los valores posibles incluyen MANUAL o SCHEDULE. |
Obtener ejecución de definición de proceso específica get-process-definition-run
Puede recuperar una ejecución de definición de proceso específica realizando una petición GET al extremo /runs mientras proporciona el ID de ejecución.
Formato de API
GET /runs/{RUN_ID}
{RUN_ID}Solicitud
| code language-shell |
|---|
|
Respuesta
Una solicitud correcta devuelve el estado HTTP 200 con información sobre la ejecución de definición de proceso 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 | Descripción |
runId |
El ID de la ejecución de definición del proceso. |
definitionUuid |
El ID de la definición de proceso a la que pertenece la ejecución. |
definitionName |
Nombre de la definición de proceso a la que pertenece la ejecución. |
imsOrg |
El ID de la organización a la que pertenece la ejecución de la definición del proceso. |
sandboxId |
El ID de la zona protegida a la que pertenece la ejecución de la definición del proceso. |
sandboxName |
Nombre de la zona protegida a la que pertenece la ejecución de la definición del proceso. |
state |
Estado de ejecución de la definición del proceso. Los valores posibles incluyen PENDING, RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED y TIMED_OUT. |
submittedAt |
La fecha y la hora en que se envió la ejecución de la definición del proceso. |
startedAt |
Fecha y hora en que comienza a ejecutarse la ejecución de la definición del proceso. |
events |
Un objeto que contiene las tareas que se ejecutan como parte de la ejecución de la definición del proceso. |
triggeredBy |
El método por el que se ejecutó la definición del proceso. Los valores posibles incluyen MANUAL o SCHEDULE. |
Iniciar una ejecución de definición de proceso start-run
Puede iniciar una ejecución de definición de proceso realizando una petición POST al extremo /runs.
Formato de API
POST /runs
Solicitud
| code language-shell |
|---|
|
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| Propiedad | Tipo | Descripción |
definitionUuid |
Cadena | El ID de la definición de proceso para la que desea iniciar una ejecución. |
inputs |
Objeto | Un objeto opcional que contiene campos obligatorios en la definición del proceso. |
Respuesta
Una solicitud correcta devuelve el estado HTTP 202 Accepted con los detalles de ejecución aceptados. La ejecución es asincrónica y devuelve inmediatamente con 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 | Descripción |
runId |
El ID de la ejecución recién aceptada. |
definitionUuid |
El ID de la definición del proceso para el que se ejecuta la ejecución. |
definitionName |
Nombre de la definición de proceso a la que pertenece la ejecución. |
imsOrg |
El ID de la organización a la que pertenece la ejecución de la definición del proceso. |
sandboxId |
El ID de la zona protegida a la que pertenece la ejecución de la definición del proceso. |
sandboxName |
Nombre de la zona protegida a la que pertenece la ejecución de la definición del proceso. |
state |
El estado de la ejecución. Dado que este proceso es asincrónico, será PENDING. |
submittedAt |
La fecha y la hora en que se envió la ejecución de la definición del proceso. |
startedAt |
Fecha y hora en que comienza a ejecutarse la ejecución de la definición del proceso. |
events |
Un objeto que contiene las tareas que se ejecutan como parte de la ejecución de la definición del proceso. |
triggeredBy |
El método por el que se ejecutó la definición del proceso. Los valores posibles incluyen MANUAL o SCHEDULE. |
Recuperar programación de definición de proceso get-schedule
Puede obtener la programación de una definición de proceso realizando una petición GET al extremo /process-definitions/{DEFINITION_ID}/schedule y proporcionando el ID de la definición de proceso.
Formato de API
GET /process-definitions/{DEFINITION_ID}/schedule
{DEFINITION_ID}Solicitud
| code language-shell |
|---|
|
Respuesta
Una solicitud correcta devuelve el estado HTTP 200 con información sobre la programación de definición de proceso.
| 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 | Descripción |
cron |
El formato cron de la programación. Para obtener más información sobre las programaciones de cron, lea la documentación sobre el formato de las expresiones cron. |
paused |
Un booleano que indica si la programación está en pausa o no. |
createdAt |
La fecha y la hora en que se creó la programación. |
updatedAt |
La fecha y la hora en que se actualizó la programación por última vez. |
createdBy |
Un objeto que contiene detalles del usuario que creó la programación. |
updatedBy |
Un objeto que contiene detalles del usuario que actualizó la programación por última vez. |
Reemplazar una programación replace-schedule
Puede reemplazar la programación para una definición de proceso realizando una petición PUT al extremo /process-definitions/{DEFINITION_ID}/schedule mientras proporciona el ID de la definición de proceso.
Formato de API
PUT /process-definitions/{DEFINITION_ID}/schedule
{DEFINITION_ID}Solicitud
| code language-shell |
|---|
|
| table 0-row-3 1-row-3 | ||
|---|---|---|
| Propiedad | Tipo | Descripción |
cron |
Cadena | El formato cron de la programación. Para obtener más información sobre las programaciones de cron, lea la documentación sobre el formato de las expresiones cron. |
Respuesta
Una solicitud correcta devuelve el estado HTTP 200 con la programación actualizada.
| code language-json |
|---|
|
Eliminar la programación de definición del proceso remove-schedule
Puede quitar la programación adjunta a una definición de proceso realizando una petición DELETE al extremo /process-definitions/{DEFINITION_ID}/schedule y proporcionando al mismo tiempo el ID de la definición de proceso.
Formato de API
DELETE /process-definitions/{DEFINITION_ID}/schedule
{DEFINITION_ID}Solicitud
| code language-shell |
|---|
|
Respuesta
Una solicitud correcta devuelve HTTP 204 sin cuerpo de respuesta.
Pausar la programación especificada pause-schedule
Puede pausar la programación para una definición de proceso realizando una petición POST al extremo /process-definitions/{DEFINITION_ID}/schedule:pause mientras proporciona el ID de definición de proceso.
Formato de API
POST /process-definitions/{DEFINITION_ID}/schedule:pause
{DEFINITION_ID}Solicitud
| code language-shell |
|---|
|
Respuesta
Una solicitud correcta devuelve el estado HTTP 200 con información sobre la programación.
| code language-json |
|---|
|
Reanudar la programación especificada resume-schedule
Puede reanudar la programación de una definición de proceso realizando una petición POST al extremo /process-definitions/{DEFINITION_ID}/schedule:resume mientras proporciona el ID de definición de proceso.
Formato de API
POST /process-definitions/{DEFINITION_ID}/schedule:resume
{DEFINITION_ID}Solicitud
| code language-shell |
|---|
|
Respuesta
Una solicitud correcta devuelve el estado HTTP 200 con información sobre la programación.
| code language-json |
|---|
|