[Beta]{class="badge informative"}
API di Gestione processi
Utilizzare l’API di Gestione processi in Adobe Experience Platform per elencare le definizioni dei processi, esaminare le esecuzioni e gestire le pianificazioni ricorrenti.
Introduzione
Prima di utilizzare l’API, completa l’esercitazione sull’autenticazione. Quindi includi queste intestazioni in ogni richiesta:
- Autorizzazione:
Bearer {ACCESS_TOKEN} - x-api-key:
{API_KEY} - x-gw-ims-org-id:
{ORG_ID} - x-sandbox-name:
{SANDBOX_NAME}
Elencare le definizioni dei processi list-process-definitions
È possibile elencare tutte le definizioni di processo correnti effettuando una richiesta GET all’endpoint /process-definitions.
Formato API
GET /process-definitions
Parametri query
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
|---|---|
| Parametro | Descrizione |
name |
Filtro della sottostringa senza distinzione tra maiuscole e minuscole sul nome della definizione. |
sort |
Campo in base al quale eseguire l’ordinamento. I valori supportati sono createdAt, updatedAt e name. Il valore predefinito è createdAt. |
order |
Ordinamento. I valori supportati sono asc e desc. Il valore predefinito è desc. |
pageSize |
Elementi per pagina. L’intervallo supportato è compreso tra 1 e 100. Il valore predefinito è 100. |
cursor |
Cursore di paginazione opaco restituito da una chiamata precedente. Reciprocamente esclusivo con offset. |
offset |
Offset basato su zero. Reciprocamente esclusivo con cursor. |
Richiesta
| code language-shell |
|---|
|
Risposta
In caso di esito positivo, la richiesta restituisce lo stato HTTP 200 con un elenco di definizioni di 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 | Descrizione |
definitionUuid |
ID della definizione del processo. |
name |
Nome della definizione del processo. |
imsOrg |
ID dell’organizzazione a cui appartiene la definizione del processo. |
sandboxId |
ID della sandbox a cui appartiene la definizione del processo. |
sandboxName |
Nome della sandbox a cui appartiene la definizione del processo. |
tasks |
Matrice contenente gli oggetti attività correlati alla definizione del processo. |
tasks.id |
ID dell’attività. |
tasks.taskType |
Tipo di attività. I valori possibili includono wait, ingest-data, verify-profile-ingestion, run-segmentation, run-profile-export, trigger-activation, run-data-distiller e send-notification. |
tasks.retry.maxAttempts |
Il numero di tentativi di esecuzione dell’attività in caso di esito negativo. |
tasks.retry.backoffCoefficient |
|
createdAt |
Data e ora di creazione della definizione del processo. |
updatedAt |
Data e ora dell’ultimo aggiornamento della definizione del processo. |
createdBy |
Oggetto contenente informazioni sull’utente che ha creato la definizione del processo. |
updatedBy |
Oggetto contenente informazioni sull’ultimo utente che ha aggiornato la definizione del processo. |
Recuperare una definizione di processo specifica
È possibile recuperare una definizione di processo specifica effettuando una richiesta GET all’endpoint /process-definitions e fornendo l’ID della definizione di processo.
Formato API
GET /process-definitions/{DEFINITION_ID}
{DEFINITION_ID}Richiesta
| code language-shell |
|---|
|
Risposta
In caso di esito positivo, la richiesta restituisce lo stato HTTP 200 con informazioni sulla definizione del processo richiesto.
| 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 | Descrizione |
definitionUuid |
ID della definizione del processo. |
name |
Nome della definizione del processo. |
imsOrg |
ID dell’organizzazione a cui appartiene la definizione del processo. |
sandboxId |
ID della sandbox a cui appartiene la definizione del processo. |
sandboxName |
Nome della sandbox a cui appartiene la definizione del processo. |
tasks |
Matrice contenente gli oggetti attività correlati alla definizione del processo. |
tasks.id |
ID dell’attività. |
tasks.taskType |
Tipo di attività. I valori possibili includono wait, ingest-data, verify-profile-ingestion, run-segmentation, run-profile-export, trigger-activation, run-data-distiller e send-notification. |
tasks.retry.maxAttempts |
Il numero di tentativi di esecuzione dell’attività in caso di esito negativo. |
tasks.retry.backoffCoefficient |
|
createdAt |
Data e ora di creazione della definizione del processo. |
updatedAt |
Data e ora dell’ultimo aggiornamento della definizione del processo. |
createdBy |
Oggetto contenente informazioni sull’utente che ha creato la definizione del processo. |
updatedBy |
Oggetto contenente informazioni sull’ultimo utente che ha aggiornato la definizione del processo. |
Elencare esecuzioni definizione processo list-process-definition-runs
È possibile recuperare un elenco di tutte le esecuzioni per una definizione di processo effettuando una richiesta GET all’endpoint /runs e fornendo l’ID della definizione di processo.
Formato API
GET /runs?{QUERY_PARAMETERS}
Parametri query
definitionUuidexecutionTriggerMANUAL o SCHEDULE.Richiesta
| code language-shell |
|---|
|
Risposta
In caso di esito positivo, la richiesta restituisce lo stato HTTP 200 con informazioni sull’esecuzione della definizione del 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 | Descrizione |
runId |
ID dell’esecuzione della definizione del processo. |
definitionUuid |
ID della definizione del processo a cui appartiene l’esecuzione. |
definitionName |
Nome della definizione del processo a cui appartiene l’esecuzione. |
imsOrg |
ID dell’organizzazione a cui appartiene l’esecuzione della definizione del processo. |
sandboxId |
ID della sandbox a cui appartiene la definizione del processo. |
sandboxName |
Nome della sandbox a cui appartiene la definizione del processo. |
state |
Stato dell’esecuzione della definizione del processo. I valori possibili includono PENDING, RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED e TIMED_OUT. |
submittedAt |
Data e ora in cui è stata inviata l’esecuzione della definizione del processo. |
startedAt |
Data e ora di inizio dell’esecuzione della definizione del processo. |
events |
Oggetto contenente le attività eseguite durante l’esecuzione della definizione del processo. |
triggeredBy |
Il metodo con cui è stata eseguita la definizione del processo. I valori possibili includono MANUAL o SCHEDULE. |
Ottieni esecuzione definizione processo specifica get-process-definition-run
È possibile recuperare una definizione di processo specifica eseguita effettuando una richiesta GET all’endpoint /runs e fornendo l’ID esecuzione.
Formato API
GET /runs/{RUN_ID}
{RUN_ID}Richiesta
| code language-shell |
|---|
|
Risposta
In caso di esito positivo, la richiesta restituisce lo stato HTTP 200 con informazioni sull’esecuzione della definizione di processo specificata.
| 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 | Descrizione |
runId |
ID dell’esecuzione della definizione del processo. |
definitionUuid |
ID della definizione del processo a cui appartiene l’esecuzione. |
definitionName |
Nome della definizione del processo a cui appartiene l’esecuzione. |
imsOrg |
ID dell’organizzazione a cui appartiene l’esecuzione della definizione del processo. |
sandboxId |
ID della sandbox a cui appartiene la definizione del processo. |
sandboxName |
Nome della sandbox a cui appartiene la definizione del processo. |
state |
Stato dell’esecuzione della definizione del processo. I valori possibili includono PENDING, RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED e TIMED_OUT. |
submittedAt |
Data e ora in cui è stata inviata l’esecuzione della definizione del processo. |
startedAt |
Data e ora di inizio dell’esecuzione della definizione del processo. |
events |
Oggetto contenente le attività eseguite durante l’esecuzione della definizione del processo. |
triggeredBy |
Il metodo con cui è stata eseguita la definizione del processo. I valori possibili includono MANUAL o SCHEDULE. |
Avviare l’esecuzione di una definizione di processo start-run
È possibile avviare l’esecuzione di una definizione di processo effettuando una richiesta POST all’endpoint /runs.
Formato API
POST /runs
Richiesta
| code language-shell |
|---|
|
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| Proprietà | Tipo | Descrizione |
definitionUuid |
Stringa | ID della definizione del processo per cui si desidera avviare un’esecuzione. |
inputs |
Oggetto | Oggetto facoltativo contenente campi obbligatori nella definizione del processo. |
Risposta
In caso di esito positivo, la richiesta restituisce lo stato HTTP 202 Accettato con i dettagli di esecuzione accettati. L’esecuzione è asincrona e restituisce immediatamente 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 | Descrizione |
runId |
ID della nuova esecuzione accettata. |
definitionUuid |
ID della definizione del processo per cui viene eseguita l’esecuzione. |
definitionName |
Nome della definizione del processo a cui appartiene l’esecuzione. |
imsOrg |
ID dell’organizzazione a cui appartiene l’esecuzione della definizione del processo. |
sandboxId |
ID della sandbox a cui appartiene la definizione del processo. |
sandboxName |
Nome della sandbox a cui appartiene la definizione del processo. |
state |
Stato dell’esecuzione. Poiché il processo è asincrono, sarà PENDING. |
submittedAt |
Data e ora in cui è stata inviata l’esecuzione della definizione del processo. |
startedAt |
Data e ora di inizio dell’esecuzione della definizione del processo. |
events |
Oggetto contenente le attività eseguite durante l’esecuzione della definizione del processo. |
triggeredBy |
Il metodo con cui è stata eseguita la definizione del processo. I valori possibili includono MANUAL o SCHEDULE. |
Recupera pianificazione definizione processo get-schedule
È possibile ottenere la pianificazione per una definizione di processo effettuando una richiesta GET all’endpoint /process-definitions/{DEFINITION_ID}/schedule e fornendo l’ID della definizione di processo.
Formato API
GET /process-definitions/{DEFINITION_ID}/schedule
{DEFINITION_ID}Richiesta
| code language-shell |
|---|
|
Risposta
In caso di esito positivo, la richiesta restituisce lo stato HTTP 200 con informazioni sulla pianificazione della definizione del 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 | Descrizione |
cron |
Formato cron per la pianificazione. Per ulteriori informazioni sulle pianificazioni cron, leggere la documentazione relativa al formato di espressione cron cron. |
paused |
Valore booleano che indica se la pianificazione è sospesa o meno. |
createdAt |
La data e l’ora di creazione della pianificazione. |
updatedAt |
La data e l’ora dell’ultimo aggiornamento della pianificazione. |
createdBy |
Oggetto contenente i dettagli dell’utente che ha creato la pianificazione. |
updatedBy |
Oggetto contenente i dettagli dell’ultimo utente che ha aggiornato la pianificazione. |
Sostituire una pianificazione replace-schedule
È possibile sostituire la pianificazione per una definizione di processo effettuando una richiesta PUT all’endpoint /process-definitions/{DEFINITION_ID}/schedule e fornendo l’ID della definizione di processo.
Formato API
PUT /process-definitions/{DEFINITION_ID}/schedule
{DEFINITION_ID}Richiesta
| code language-shell |
|---|
|
| table 0-row-3 1-row-3 | ||
|---|---|---|
| Proprietà | Tipo | Descrizione |
cron |
Stringa | Formato cron per la pianificazione. Per ulteriori informazioni sulle pianificazioni cron, leggere la documentazione relativa al formato di espressione cron cron. |
Risposta
In caso di esito positivo, la richiesta restituisce lo stato HTTP 200 con la pianificazione aggiornata.
| code language-json |
|---|
|
Rimuovi la pianificazione della definizione del processo remove-schedule
È possibile rimuovere la pianificazione associata a una definizione di processo effettuando una richiesta DELETE all’endpoint /process-definitions/{DEFINITION_ID}/schedule e fornendo l’ID della definizione di processo.
Formato API
DELETE /process-definitions/{DEFINITION_ID}/schedule
{DEFINITION_ID}Richiesta
| code language-shell |
|---|
|
Risposta
In caso di esito positivo, la richiesta restituisce HTTP 204 senza corpo di risposta.
Sospendi la pianificazione specificata pause-schedule
È possibile mettere in pausa la pianificazione di una definizione di processo effettuando una richiesta POST all’endpoint /process-definitions/{DEFINITION_ID}/schedule:pause e fornendo l’ID della definizione di processo.
Formato API
POST /process-definitions/{DEFINITION_ID}/schedule:pause
{DEFINITION_ID}Richiesta
| code language-shell |
|---|
|
Risposta
In caso di esito positivo, la richiesta restituisce lo stato HTTP 200 con informazioni sulla pianificazione.
| code language-json |
|---|
|
Riprendi la pianificazione specificata resume-schedule
È possibile riprendere la pianificazione per una definizione di processo effettuando una richiesta POST all’endpoint /process-definitions/{DEFINITION_ID}/schedule:resume e fornendo l’ID di definizione del processo.
Formato API
POST /process-definitions/{DEFINITION_ID}/schedule:resume
{DEFINITION_ID}Richiesta
| code language-shell |
|---|
|
Risposta
In caso di esito positivo, la richiesta restituisce lo stato HTTP 200 con informazioni sulla pianificazione.
| code language-json |
|---|
|