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'adresse 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 des détails de la tâche, y compris l’exécution de la tâche.
Description
Opérations HTTP fondées sur JSON dans des tâches d’intégration.
Autorisations obligatoires pour être appelées
Concepteur de données, Opérateur d’intégration
Paramètres requis pour la demande
GET, POST : identifiant de 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

Configurer HTTP HTTP
Ressource unique
Ressource de recouvrement
Description
GET
Pris en charge
Pris en charge
Récupérer l’information sur la tâche. Récupérer les détails de l’exécution d’une tâche.
POST
Pris en charge
Non pris en charge
Déclenchez une tâche d’intégration.

OBTENIR <DÉTAILS DE LA TÂCHE>

Récupérer les détails de la tâche
URI de la demande
/api/res/v1/{tenant}/tâches : récupère les détails des tâches d’intégration définies dans l’instance.
Récupère toutes les tâches d’intégration du locataire.
URI de la demande exemple :
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
Corps de la demande d'exemple
S.O.
Paramètres de chemin
Nom
Description
tenant
Code d’instance de client
Paramètres d'interrogation
Nom
Description
Obligatoire
limit
Le nombre de tâches d’intégration à inclure dans le résultat.
  • type : nombre
  • min. : 1
  • max. : 100
  • exemple : limite=50
N
offset
Le nombre de tâches à omettre 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 de tâches
Exemples de tâches réussies avec réponse GET
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"
     }
 ]
}
Charge utile pour la réponse
nom
description
nombre
Le nombre total de tâches d’intégration de client (et non seulement celles qui sont incluses dans cette réponse).
Type : nombre
Données
Un ensemble de tâches d’intégration.
  • Type : tableau
  • Définition du type :
    • 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 à une 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 trouve la charge utile de réponse
Charge utile pour la réponse
Nom
Description
type
Le type d’erreur.
title
Texte décrivant l’erreur.
erreurs
Ensemble d’erreurs décelées dans la demande.
  • Type : tableau
  • Définition du type :
    • message : message décrivant l’erreur.
    • paramètres : paramètre auquel l’erreur est liée.

POST

Déclenchement de l'exécution d'une tâche
URI de la demande
Déclenche une exécution de la tâche représentée par l’identifiant de tâche transmis.
/{taskId}/runs
URI de la demande exemple :
https://api.adaptiveinsights.com/api/rest/tasks/v1/{tenant}/tasks/integration111/runs?instanceCode=<instanceCode>
Dans cet exemple, la valeur de taskId est Integration111.
En-tête de demande d'exemple
Autorisation : De base ou par jeton
Type de contenu : application/json
Corps de la demande d'exemple
Corps de la demande requis. Il ne doit pas être vide.
Corps de la demande
{ }
Paramètre de chemin
Nom
Description
Obligatoire
taskId
Identifiant de tâche de la tâche déclenchée.
Y
Exemple de réponse
Réponse réussie pour l'exécution de la tâche de déclenchement
HTTP/1.1 201 Created
Content-Type: application/json

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

OBTENIR <DÉTAILS DE L'EXÉCUTION D'UNE TÂCHE>

Récupérer les détails de l'exécution d'une tâche
URI de la demande
Récupère les détails de l’exécution de tâche représentées par l’identifiant de tâche transmis.
/{taskId}/runs/{taskRunId}
URI de la demande exemple :
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
L'identifiant unique de la tâche d'intégration qui a été exécutée.
taskRunId
L'identifiant unique de l'exécution de la tâche.
Exemple de réponse
Demander une réponse pour une exécution de tâche réussie
{
 "id": "taskrun456",
 "status": "Completed"
}
Charge utile pour la réponse
Nom
Description
identifiant
L'identifiant unique de cette exécution de tâche d'intégration.
statut
Le statut de l’exécution de la tâche, soit :
  • Aucun
  • En attente
  • En cours
  • Annulation en cours
  • Annulé
  • Terminé
  • Échec