Passa al contenuto principale
Documentazione
Documentazione
Adaptive Planning
Ultimo aggiornamento: 2025-02-07
Riferimenti: Attività

Riferimenti: Attività

URL Endpoint

https://api.adaptiveinsights.com/api/rest/tasks/v1/<tenant>/tasks?instanceCode=<instanceCode>
Versione: v1
Categoria
Attivare l'attività di integrazione e recuperare i dettagli dell'attività, inclusa l'esecuzione dell'attività.
Descrizione
Operazioni HTTP basate su JSON nelle attività di integrazione.
Autorizzazioni necessarie per il richiamo
Designer dati, Operatore di integrazione
Parametri obbligatori su richiesta
GET, POST: ID attività di integrazione, ID esecuzione attività di integrazione
Recuperare o aggiornare le attività di integrazione.

VERBI HTTP supportati

Verbo HTTP
Risorsa singola
Risorsa raccolta
Descrizione
GET
Supportato
Supportato
Recuperare le informazioni sull'attività. Recuperare i dettagli dell'esecuzione dell'attività.
POST
Supportato
Non supportato
Attivare un'attività di integrazione.

GET <DETTAGLI ATTIVITÀ>

Recupera dettagli attività
URI della richiesta
/api/rest/v1/{tenant}/tasks: recupera i dettagli delle attività di integrazione definite nell'istanza.
Recupera tutte le attività di integrazione del tenant.
URI richiesta di esempio:
https://api.adaptiveinsights.com/api/rest/tasks/v1/<tenant>/tasks?instanceCode=<instanceCode>
Intestazione richiesta di esempio
Autorizzazione: di base o basata su token
Esempio di corpo richiesta
N/D
Parametri percorso
Nome
Descrizione
tenant
Il codice dell'istanza del cliente
Parametri query
Nome
Descrizione
Obbligatorio
limit
Il numero di attività di integrazione da includere nel risultato.
  • tipo: numero
  • min: 1
  • max: 100
  • esempio: limit=50
N
offset
Il numero di attività da ignorare prima di iniziare a includere le attività nei risultati.
  • min: 0
  • esempio: offset=0
N
taskType
Filtrare le attività recuperate in base al tipo di attività.
  • Integrazione
  • esempio: taskType=integrazione
N
Risposta
Elenco di attività
Attività di esempio GET Response
HTTP/1.1 200 Ok
Content-Type: application/json

{
 "count": 3,
 "data": [
     {
         "id": "integration4",
         "taskType": "integration",
         "name": "An Integration Task"
     },
     {
         "id": "integration111",
         "taskType": "integration",
         "name": "Another Integration Task"
     },
     {
         "id": "integration43",
         "taskType": "integration",
         "name": "Also Another Integration Task"
     }
 ]
}
Payload risposta
nome
descrizione
conteggio
Il numero totale di attività di integrazione del cliente (non solo quelle incluse in questa risposta).
Digitare: numero
dati
Una raccolta di attività di integrazione.
  • Tipo: Matrice
  • Definizione del tipo:
    • Id: ID univoco dell'attività di integrazione.
    • Nome: il nome dell'attività di integrazione.
Risposta non riuscita
Esempio di risposta alla richiesta di attività non valide
{
 "type" : "validation-error",
 "title": "invalid request",
 "errors" : [
     {
         "message" : "must be a non-negative integer",
         "parameter" : "offset"
     },
     {
         "message" : "must be positive integer no greater than 100",
         "parameter" : "limit"
     },
     {
         "message" : "must be a valid task type",
         "parameter" : "kind"
     }
 ]
}
Dove si trova il payload della risposta
Payload risposta
Nome
Descrizione
type
Il tipo di errore.
title
Testo che descrive l'errore.
errori
Una raccolta di errori trovati nella richiesta.
  • Tipo: matrice
  • Definizione del tipo:
    • message: un messaggio che descrive l'errore.
    • parametro: il parametro a cui è correlato l'errore.

POST

Eseguire l'attività di attivazione
URI della richiesta
Attivare un'esecuzione dell'attività rappresentata dall'identificativo dell'attività passato.
/{taskId}/runs
URI richiesta di esempio:
https://api.adaptiveinsights.com/api/rest/tasks/v1/{tenant}/tasks/integration111/runs?instanceCode=<instanceCode>
In questo esempio, taskId è l'integrazione111.
Intestazione richiesta di esempio
Autorizzazione: di base o basata su token
Content-Type: application/json
Esempio di corpo richiesta
Corpo della richiesta obbligatorio. Non deve essere vuoto.
Corpo richiesta
{ }
Parametro percorso
Nome
Descrizione
Obbligatorio
taskId
L'ID dell'attività in fase di attivazione.
S
Risposta di esempio
Risposta all'esecuzione dell'attività di attivazione completata
HTTP/1.1 201 Created
Content-Type: application/json

{
 "id": "taskrun456",
 "status": "Completed"
}

GET <DETTAGLI ESECUZIONE ATTIVITÀ>

Recupera dettagli esecuzione attività
URI della richiesta
Recuperare i dettagli dell'esecuzione dell'attività rappresentata dall'identificativo dell'attività passato.
/{taskId}/runs/{taskRunId}
URI richiesta di esempio:
https://api.adaptiveinsights.com/api/rest/tasks/v1/{tenant}/tasks/integration111/runs/taskrun456?instanceCode=<instanceCode>
In questo esempio, vengono utilizzati i seguenti ID:
ID
Valore
taskId
integrazione111
taskRunId
taskrun456
Parametri percorso
Nome
Descrizione
taskId
Identificatore univoco dell'attività di integrazione eseguita.
taskRunId
Identificatore univoco dell'esecuzione dell'attività.
Risposta di esempio
Richiesta risposta esecuzione attività completata
{
 "id": "taskrun456",
 "status": "Completed"
}
Payload risposta
Nome
Descrizione
ID
L'identificatore univoco dell'esecuzione dell'attività di integrazione.
stato
Lo stato dell'esecuzione dell'attività:
  • Nessuno
  • In attesa
  • In corso
  • Annullamento in corso
  • Annullato
  • Completato
  • Non riuscito