Dernière mise à jour : 22.03.2024

Ce document décrit chaque point de terminaison disponible avec l' REST API Efecte v1. Il s'agit d'une description technique de l'interface ; vous trouverez la présentation REST API ici .

Accès aux cartes de données

OBTENIR /dc/{templateCode}/données

Obtenir toutes les cartes de données par code de modèle – renvoie une liste paginée des informations de la carte de données par modèle donné.

DEMANDE

PARAMÈTRES DE CHEMIN

PARAMÈTRES DE REQUÊTE

Exemple

GET https://efecte.efectecloud.com/rest-api/itsm/v1/dc/incident/data?filter=%24status%24%20%3D%20%2702%20-%20Solving%27&selectedAttributes=subject%2Cstatus&limit=2&filterId=0&dataCards=true

OBTENIR /dc/{templateCode}/data/stream

Renvoie toutes les cartes de données disponibles par streaming. Pour les opérations complexes et lourdes, le streaming peut fournir des résultats plus rapides et plus efficaces que l'obtention de données paginées.

DEMANDE

PARAMÈTRES DE CHEMIN

PARAMÈTRES DE REQUÊTE

Exemple

GET https://efecte.efectecloud.com/rest-api/itsm/v1/dc/incident/data?filter=%24status%24%20%3D%20%2702%20-%20Solving%27&selectedAttributes=subject%2Cstatus&limit=2&filterId=0&dataCards=true

METTRE /dc/{templateCode}/données

Créer ou modifier plusieurs cartes de données

DEMANDE

PARAMÈTRES DE CHEMIN

Exemple

PUT https://efecte.efectecloud.com/rest-api/itsm/v1/dc/incident/data

CORPS

[
 {
   "folderCode": "incident_management",
   "dataCardId": "12345",
   "data": {
     "description": {
       "values": [
         {
           "value": "Updating incident"
         }
       ]
     },
     "description": {
       "values": [
         {
           "value": "Description"
         }
       ]
     }
   }
 },
 {
   "folderCode": "incident_management",
   "data": {
     "description": {
       "values": [
         {
           "value": "Creating a new incident"
         }
       ]
     }
   }
 }
]

POST /dc/{templateCode}/données

Créer une nouvelle carte de données

DEMANDE

PARAMÈTRES DE CHEMIN

PARAMÈTRES DE REQUÊTE

Exemple

POST https://efecte.efectecloud.com/rest-api/itsm/v1/dc/incident/data

CORPS

 {
   "folderCode": "incident_management",
   "data": {
     "description": {
       "values": [
         {
           "value": "Creating incident"
         }
       ]
     },
     "description": {
       "values": [
         {
           "value": "Description"
         }
       ]
     }
   }
 }

OBTENIR /dc/{templateCode}/data/{dataCardId}

Obtenez une seule carte de données

DEMANDE

PARAMÈTRES DE CHEMIN

PARAMÈTRES DE REQUÊTE

Exemple

GET https://efecte.efectecloud.com/rest-api/itsm/v1/dc/incident/data/12345

SUPPRIMER /dc/{templateCode}/data/{dataCardId}

Supprimer une seule carte de données

DEMANDE

PARAMÈTRES DE CHEMIN

Exemple

DELETE https://efecte.efectecloud.com/rest-api/itsm/v1/dc/incident/data/12345

PATCH /dc/{templateCode}/data/{dataCardId}

Modifier la carte de données existante

DEMANDE

PARAMÈTRES DE CHEMIN

PARAMÈTRES DE REQUÊTE

Exemple

PATCH https://efecte.efectecloud.com/rest-api/itsm/v1/dc/incident/data/12345

CORPS

{
   "folderCode": "incident_management",
   "data": {
     "description": {
       "values": [
         {
           "value": "Creating incident"
         }
       ]
     },
     "description": {
       "values": [
         {
           "value": "Description"
         }
       ]
     }
   }
 }

OBTENIR /dc/{templateCode}/data/{dataCardId}/{attributeCode}

Obtenir l'attribut de la carte de données

DEMANDE

PARAMÈTRES DE CHEMIN

Exemple

GET https://efecte.efectecloud.com/rest-api/itsm/v1/dc/incident/data/12345/subject

METTRE /dc/{templateCode}/data/{dataCardId}/{attributeCode}

Mettre à jour l'attribut à partir de la carte de données

DEMANDE

PARAMÈTRES DE CHEMIN

Exemple

PUT https://efecte.efectecloud.com/rest-api/itsm/v1/dc/incident/data/12345/subject

CORPS

{
 "values": [
   {
     "value":"Updating subject"
   }
 ]
}

POST /dc/{templateCode}/data/{dataCardId}/{attributeCode}

Ajouter de la valeur à l'attribut à partir de la carte de données

DEMANDE

PARAMÈTRES DE CHEMIN

Exemple

POST https://efecte.efectecloud.com/rest-api/itsm/v1/dc/incident/data/12345/subject

CORPS

{
 "values": [
   {
     "value":"Adding value to subject"
   }
 ]
}

SUPPRIMER /dc/{templateCode}/data/{dataCardId}/{attributeCode}

Effacer la valeur de l'attribut de la carte de données.

DEMANDE

PARAMÈTRES DE CHEMIN

Exemple

DELETE https://efecte.efectecloud.com/rest-api/itsm/v1/dc/incident/data/12345/subject

OBTENIR /dc/{templateCode}/data/{dataCardId}/{attributeCode}/file/{locationOfExternalData}

Télécharger la pièce jointe à partir de la carte de données.

DEMANDE

PARAMÈTRES DE CHEMIN

Exemple

GET https://efecte.efectecloud.com/rest-api/itsm/v1/dc/incident/data/12345/subject/file/20210512_01

POST /dc/{templateCode}/data/{dataCardId}/{attributeCode}/fichier

Télécharger la pièce jointe sur la carte de données.

DEMANDE

PARAMÈTRES DE CHEMIN

Exemple

POST https://efecte.efectecloud.com/rest-api/itsm/v1/dc/incident/data/12345/subject/file/20210512_01 -H "Content-Type: multipart/form-data" -F "fileName=example.png" -F "fileUpload=example.png;type=image/png"

Accéder aux modèles

OBTENIR /dc

Obtenir la liste de tous les modèles.

Exemple

GET https://efecte.efectecloud.com/rest-api/itsm/v1/dc

OBTENIR /dc/{templateCode}

Obtenir le modèle par code.

DEMANDE

PARAMÈTRES DE CHEMIN

Exemple

GET https://efecte.efectecloud.com/rest-api/itsm/v1/dc/incident

Comment tester l'interface

OBTENIR /écho

Renvoie le contenu du paramètre de requête « message ». À des fins de test.

DEMANDE

PARAMÈTRES DE REQUÊTE

Exemple

GET https://efecte.efectecloud.com/rest-api/itsm/v1/echo?message=Hello%20world

OBTENIR /echo/jwt

Renvoie le contenu du paramètre de requête « message » si le jeton JWT est valide. À des fins de test.

DEMANDE

PARAMÈTRES DE REQUÊTE

Exemple

GET https://efecte.efectecloud.com/rest-api/itsm/v1/echo?message=Hello%20world

Dépannage

Erreurs REST API

En cas d'erreur, causée par exemple par une autorisation échouée, des paramètres erronés ou une requête mal formatée, l' API répondra avec une réponse d'erreur standardisée :

 {
 "code": 401,
 "message": "Token was empty or not provided. Token should be provided in AUTHORIZATION header.",
 "error": "Unauthorized",
 "url": "https://efecte.efectecloud.com/itsm/api/v1/dc/incident/data?limit=50&filterId=0",
 "timestamp": "2021-12-21T11:41:22Z"
}

La réponse inclura toujours « code », « erreur », « URL » et « horodatage » et dans la plupart des cas « message », donnant des détails sur le problème sous-jacent.

Erreurs possibles

Impossible d'acquérir le jeton JWT à partir du point de terminaison de connexion

Pour obtenir un jeton JWT, l'utilisateur utilisé pour la connexion doit disposer d'un rôle avec autorisation pour le module « API externe ». Si l'utilisateur ne dispose pas des autorisations pour le module API externe », la réponse du point de terminaison de connexion indiquera des autorisations insuffisantes.
Si vous recevez une réponse non autorisée même si le nom d'utilisateur et le mot de passe sont corrects et que le rôle dispose des autorisations appropriées, assurez-vous que le compte est un compte ESM local.

L'attribut n'est pas nullable et si vous envoyez un « » comme valeur, le champ n'est plus vide

L'attribut de type chaîne contient les options suivantes : chaîne | nombre | date

Avec StaticValue :

• Valeur - chaîne
• code - chaîne
• nullable - Vrai

Par conséquent, si vous souhaitez une valeur d’attribut vide via REST API , utilisez cette syntaxe :

"email": {
           "values": [
               {
                   "value": null
               }
           ]
       }