Senaste uppdatering: 22.03.2024

Det här dokumentet beskriver varje slutpunkt som är tillgänglig med Efecte REST API v1. Detta är en teknisk gränssnittsbeskrivning – du hittar REST API översikten här .

Åtkomst till datakort

HÄMTA /dc/{mallkod}/data

Hämta alla datakort efter mallkod – returnerar sidnumrerad lista med datakortsinformation efter given mall.

BEGÄRAN

SÖGPARAMETRAR

Frågeparametrar

Exempel

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

HÄMTA /dc/{mallkod}/data/ström

Returnerar alla tillgängliga datakort via strömning. För komplexa och tunga operationer kan strömmande resultat ge snabbare och mer effektiva resultat än att hämta paginerade data.

BEGÄRAN

SÖGPARAMETRAR

Frågeparametrar

Exempel

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

PUT /dc/{mallkod}/data

Skapa eller redigera flera datakort

BEGÄRAN

SÖGPARAMETRAR

Exempel

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

KROPP

[
 {
   "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/{mallkod}/data

Skapa ett nytt datakort

BEGÄRAN

SÖGPARAMETRAR

Frågeparametrar

Exempel

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

KROPP

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

GET /dc/{mallkod}/data/{datakort-ID}

Skaffa ett enda datakort

BEGÄRAN

SÖGPARAMETRAR

Frågeparametrar

Exempel

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

TA BORT /dc/{mallkod}/data/{datakort-ID}

Ta bort ett enskilt datakort

BEGÄRAN

SÖGPARAMETRAR

Exempel

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

PATCH /dc/{mallkod}/data/{datakorts-ID}

Redigera befintligt datakort

BEGÄRAN

SÖGPARAMETRAR

Frågeparametrar

Exempel

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

KROPP

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

GET /dc/{mallkod}/data/{datakort-ID}/{attributkod}

Hämta attribut från datakort

BEGÄRAN

SÖGPARAMETRAR

Exempel

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

PUT /dc/{mallkod}/data/{datakort-ID}/{attributkod}

Uppdatera attribut från datakort

BEGÄRAN

SÖGPARAMETRAR

Exempel

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

KROPP

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

POST /dc/{mallkod}/data/{datakort-ID}/{attributkod}

Lägg till värde till attribut från datakort

BEGÄRAN

SÖGPARAMETRAR

Exempel

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

KROPP

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

TA BORT /dc/{mallkod}/data/{datakort-ID}/{attributkod}

Rensa attributvärde från datakort.

BEGÄRAN

SÖGPARAMETRAR

Exempel

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

GET /dc/{mallkod}/data/{datakort-ID}/{attributkod}/fil/{platsförexternadata}

Ladda ner bilaga från datakort.

BEGÄRAN

SÖGPARAMETRAR

Exempel

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

POST /dc/{mallkod}/data/{datakort-ID}/{attributkod}/fil

Ladda upp bilaga till datakort.

BEGÄRAN

SÖGPARAMETRAR

Exempel

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"

Åtkomst till mallar

GET /dc

Hämta en lista över alla mallar.

Exempel

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

GET /dc/{mallkod}

Hämta mallen med kod.

BEGÄRAN

SÖGPARAMETRAR

Exempel

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

Hur man testar gränssnittet

HÄMTA /eko

Returnerar innehållet i frågeparametern "message". För teständamål.

BEGÄRAN

Frågeparametrar

Exempel

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

HÄMTA /echo/jwt

Returnerar innehållet i frågeparametern "message" om JWT-token är giltig. För teständamål.

BEGÄRAN

Frågeparametrar

Exempel

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

Felsökning

REST API fel

Vid eventuella fel – orsakade till exempel av misslyckad auktorisering, felaktiga parametrar eller en felaktigt formaterad fråga – kommer API :et att svara med ett standardiserat felsvar:

 {
 "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"
}

Svaret kommer alltid att innehålla ”kod”, ”fel”, ”url” och ”tidsstämpel” och i de flesta fall ”meddelande”, med detaljer om det underliggande problemet.

Möjliga fel

Kan inte hämta JWT-token från inloggningsslutpunkten

För att få en JWT-token måste användaren som används för inloggning ha en roll tilldelad med behörighet till modulen 'Externt API '. Om användaren inte har behörigheter för modulen Externt API kommer svaret från login-endpoint att innehålla information om otillräckliga behörigheter.
Om du får ett obehörigt svar trots att användarnamnet och lösenordet är korrekta och rollen har rätt behörigheter, se till att kontot är ett lokalt ESM-konto.

Attributet kan inte vara null och om du skickar ett "" som värde är fältet inte längre tomt

Attributet String-typ innehåller följande alternativ: sträng |nummer | datum

Med statiskt värde:

• Värde - sträng
• kod - sträng
• nullbar - Sant

Om du vill ha ett tomt attributvärde via REST API , använd därför denna syntax:

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