Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Dernière mise à jour : 2025-02-07
Référence : tâches

Référence : tâches

Point de terminaison de l'URL

https://api.adaptiveinsights.com/api/rest/tasks/v1/<tenant>/tasks?instanceCode=<instanceCode>
Version : v1
Catégorie
Déclenchement de la tâche d'intégration et récupération du détail de la tâche, y compris de son exécution.
Description
Des opérations HTTP basées sur JSON dans les tâches d'intégration.
Autorisations requises pour appeler
Concepteur de données, opérateur d'intégration
Paramètres obligatoires dans la demande
GET, POST: identifiant de la tâche d'intégration, identifiant d'exécution de la tâche d'intégration
Récupérez ou mettez à jour des tâches d'intégration.

VERB(S) HTTP pris en charge

Verbe HTTP
Ressource unique
Ressources de recouvrement
Description
GET
Prise en charge
Prise en charge
Extraire les informations sur la tâche. Récupérez le détail de l'exécution de la tâche.
POST
Prise en charge
Non pris en charge
Déclenchez une tâche d'intégration.

GET <DÉTAIL DES TÂCHES>

Récupérer le détail d'une tâche
URI de la demande
/api/res/v1/{tenant}/tasks : récupère le détail des tâches d'intégration définies dans l'instance.
Récupère toutes les tâches d'intégration de l'environnement client.
Exemple d'URI de demande :
https://api.adaptiveinsights.com/api/rest/tasks/v1/<tenant>/tasks?instanceCode=<instanceCode>
En-tête de demande d'exemple
Autorisation : de base ou par jeton
Exemple de corps de demande
S/O
Paramètres de chemin
Nom
Description
tenant
Le code de l'instance de client
Paramètres de requête
Nom
Description
Obligatoire
limit
Nombre de tâches d'intégration à inclure dans le résultat.
  • type : nombre
  • min. : 1
  • max. : 100
  • Exemple : Limit=50
N
offset
Le nombre de tâches à ignorer avant de commencer à inclure des tâches dans les résultats.
  • min. : 0
  • exemple : décalage=0
N
taskType
Filtrez les tâches récupérées par type de tâche.
  • Intégration
  • exemple : taskType=integration
N
Réponse
Liste des tâches
Exemple de tâches traitées avec succès
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"
     }
 ]
}
Données utiles de la réponse
nom
description
nombre
Nombre total de tâches d'intégration client (et non pas uniquement celles incluses dans cette réponse).
Type : nombre
données
Un ensemble de tâches d'intégration.
  • Type : Tableau
  • Définition du type :
    • Id : identifiant unique de la tâche d'intégration.
    • Nom : le nom de la tâche d'intégration.
Réponse non réussie
Exemple de réponse à la demande de tâches incorrectes
{
 "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"
     }
 ]
}
Où se trouvent les données utiles de la réponse
Données utiles de la réponse
Nom
Description
type
Le type d'erreur.
title
Texte décrivant l'erreur.
erreurs
Ensemble des erreurs trouvées dans la demande.
  • Type : tableau
  • Définition du type :
    • message : message décrivant l'erreur.
    • parameter : le paramètre auquel l'erreur est liée.

POST

Déclencher l'exécution de la tâche
URI de la demande
Déclenchez une exécution de la tâche représentée par l'identifiant de tâche transmis.
/{taskId}/runs
Exemple d'URI de demande :
https://api.adaptiveinsights.com/api/rest/tasks/v1/{tenant}/tasks/integration111/runs?instanceCode=<instanceCode>
Dans cet exemple, TaskId est Integration111.
En-tête de demande d'exemple
Autorisation : de base ou par jeton
Type de contenu : application/json
Exemple de corps de demande
Corps de la demande obligatoire. Ce champ ne doit pas être vide.
Corps de la demande
{ }
Paramètre de chemin
Nom
Description
Obligatoire
taskId
Identifiant de la tâche en cours de déclenchement.
O
Exemple de réponse
Réponse d'exécution de la tâche avec déclenchement réussi
HTTP/1.1 201 Created
Content-Type: application/json

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

GET <DÉTAIL D'EXÉCUTION DE LA TÂCHE:

Récupérer le détail d'exécution d'une tâche
URI de la demande
Récupérez le détail de l'exécution de tâche représentée par l'identifiant de tâche transmis.
/{taskId}/runs/{taskRunId}
Exemple d'URI de demande :
https://api.adaptiveinsights.com/api/rest/tasks/v1/{tenant}/tasks/integration111/runs/taskrun456?instanceCode=<instanceCode>
Dans cet exemple, nous utilisons les identifiants suivants :
Identifiant
Valeur
taskId
integration111
taskRunId
taskrun456
Paramètres de chemin
Nom
Description
taskId
Identifiant unique de la tâche d'intégration qui a été exécutée.
taskRunId
Identifiant unique de l'exécution de la tâche.
Exemple de réponse
Réponse de récupération de l'exécution de la tâche réussie
{
 "id": "taskrun456",
 "status": "Completed"
}
Données utiles de la réponse
Nom
Description
id
Identifiant unique de l'exécution de cette tâche d'intégration.
statut
Le statut d'exécution de la tâche :
  • Aucune
  • En attente
  • En cours
  • Annulation en cours
  • Annulé
  • Terminé
  • Échec