Viimeisin päivitys: 22.03.2024

Tämä dokumentti kuvaa jokaisen Efecte REST API v1:n käytettävissä olevan päätepisteen. Tämä on tekninen rajapintakuvaus - REST API:n yleiskatsauksen löydät täältä.

Tietokortteihin pääsy

GET /dc/{templateCode}/data

Hae kaikki tietokortit mallin koodin perusteella – palauttaa sivutetun luettelon tietokorttitiedoista annetulle mallille.

PYYNTÖ

POLKUPARAMETRIT

KYSELYPARAMETRIT

Esimerkki

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

GET /dc/{templateCode}/data/stream

Palauttaa kaikki käytettävissä olevat tietokortit striimaamalla. Monimutkaisissa ja raskaissa operaatioissa striimatut tulokset voivat olla nopeampia ja tehokkaampia kuin sivutetun datan hakeminen.

PYYNTÖ

POLKUPARAMETRIT

KYSELYPARAMETRIT

Esimerkki

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/{templateCode}/data

Luo tai muokkaa useita tietokortteja

PYYNTÖ

POLKUPARAMETRIT

Esimerkki

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

RUNKO

[

 {

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

Luo uusi tietokortti

PYYNTÖ

POLKUPARAMETRIT

KYSELYPARAMETRIT

Esimerkki

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

RUNKO

 {

   "folderCode": "incident_management",

   "data": {

     "description": {

       "values": [

         {

           "value": "Creating incident"

         }

       ]

     },

     "description": {

       "values": [

         {

           "value": "Description"

         }

       ]

     }

   }

 }

GET /dc/{templateCode}/data/{dataCardId}

Hae yksittäinen tietokortti

PYYNTÖ

POLKUPARAMETRIT

KYSELYPARAMETRIT

Esimerkki

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

DELETE /dc/{templateCode}/data/{dataCardId}

Poista yksittäinen tietokortti

PYYNTÖ

POLKUPARAMETRIT

Esimerkki

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

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

Muokkaa olemassa olevaa tietokorttia

PYYNTÖ

POLKUPARAMETRIT

KYSELYPARAMETRIT

Esimerkki

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

RUNKO

{

   "folderCode": "incident_management",

   "data": {

     "description": {

       "values": [

         {

           "value": "Creating incident"

         }

       ]

     },

     "description": {

       "values": [

         {

           "value": "Description"

         }

       ]

     }

   }

 }

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

Hae attribuutti tietokortilta

PYYNTÖ

POLKUPARAMETRIT

Esimerkki

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

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

Päivitä attribuutti tietokortilla

PYYNTÖ

POLKUPARAMETRIT

Esimerkki

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

RUNKO

{

 "values": [

   {

     "value":"Updating subject"

   }

 ]

}

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

Lisää arvo attribuuttiin tietokortilla

PYYNTÖ

POLKUPARAMETRIT

Esimerkki

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

RUNKO

{

 "values": [

   {

     "value":"Adding value to subject"

   }

 ]

}

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

Tyhjennä attribuutin arvo tietokortilla.

PYYNTÖ

POLKUPARAMETRIT

Esimerkki

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

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

Lataa liite tietokortilta.

PYYNTÖ

POLKUPARAMETRIT

Esimerkki

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

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

Lataa liite tietokortille.

PYYNTÖ

POLKUPARAMETRIT

Esimerkki

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"

Malleihin pääsy

GET /dc

Hae luettelo kaikista malleista.

Esimerkki

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

GET /dc/{templateCode}

Hae malli koodin perusteella.

PYYNTÖ

POLKUPARAMETRIT

Esimerkki

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

Rajapinnan testaaminen

GET /echo

Palauttaa ”message”-kyselyparametrin sisällön. Testaustarkoituksiin.

PYYNTÖ

KYSELYPARAMETRIT

Esimerkki

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

GET /echo/jwt

Palauttaa ”message”-kyselyparametrin sisällön, jos JWT-token on validi. Testaustarkoituksiin.

PYYNTÖ

KYSELYPARAMETRIT

Esimerkki

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

Vianmääritys

REST API -virheet

Virhetilanteissa – jotka voivat johtua esimerkiksi epäonnistuneesta valtuutuksesta, virheellisistä parametreista tai virheellisesti muotoillusta kyselystä – API vastaa vakiomuotoisella virhevastauksella:

 {

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

}

Vastaus sisältää aina kentät ”code”, ”error”, ”url” ja ”timestamp”, ja useimmissa tapauksissa myös ”message”, joka antaa lisätietoa taustalla olevasta ongelmasta.

Mahdolliset virheet

JWT-tokenin hakeminen login-päätepisteestä ei onnistu

JWT-tokenin saamiseksi kirjautumiseen käytetyllä käyttäjällä täytyy olla rooli, jolle on annettu oikeus ’External API’ -moduuliin. Jos käyttäjällä ei ole oikeuksia External API -moduuliin, login-päätepisteen vastaus sisältää tiedon riittämättömistä oikeuksista.
Jos saat unauthorized-vastauksen, vaikka käyttäjätunnus ja salasana ovat oikein ja roolilla on oikeat käyttöoikeudet, varmista, että tili on paikallinen ESM-tili.

Attribuutti ei ole nullable, ja jos lähetät arvoksi “”, kenttä ei ole enää tyhjä

String-tyyppinen attribuutti sisältää seuraavat vaihtoehdot: string | number | date

StaticValuen kanssa:

• Value - string
• code - string
• nullable - True

Jos siis haluat tyhjän attribuuttiarvon REST API:n kautta, käytä tätä syntaksia:

"email": {

           "values": [

               {

                   "value": null

               }

           ]

       }