Viimeisin päivitys: 22.03.2024

Tässä dokumentissa kuvataan jokainen Efecte REST API v1:n kanssa käytettävissä oleva päätepiste. Tämä on tekninen rajapinnan kuvaus – REST API yleiskatsaus löytyy täältä .

Datakorttien käyttö

GET /dc/{mallikoodi}/data

Hae kaikki datakortit mallipohjan koodin mukaan – palauttaa sivutetun luettelon datakorttitiedoista annetun mallipohjan mukaan.

PYYTÄÄ

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

Palauttaa kaikki saatavilla olevat datakortit suoratoistona. Monimutkaisissa ja raskaissa operaatioissa suoratoistotulokset voivat tarjota nopeampia ja tehokkaampia tuloksia kuin sivutetun datan hakeminen.

PYYTÄÄ

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

Luo tai muokkaa useita datakortteja

PYYTÄÄ

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

Luo uusi datakortti

PYYTÄÄ

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/{mallikoodi}/data/{tietokortin tunnus}

Hanki yksi datakortti

PYYTÄÄ

POLKUPARAMETRIT

KYSELYPARAMETRIT

Esimerkki

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

POISTA /dc/{mallikoodi}/data/{tietokortintunnus}

Yhden datakortin poistaminen

PYYTÄÄ

POLKUPARAMETRIT

Esimerkki

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

KORJAUS /dc/{mallikoodi}/data/{tietokortin tunnus}

Muokkaa olemassa olevaa datakorttia

PYYTÄÄ

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/{mallikoodi}/data/{tietokortintunnus}/{attribuuttikoodi}

Hae ominaisuus datakortilta

PYYTÄÄ

POLKUPARAMETRIT

Esimerkki

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

PUT /dc/{mallikoodi}/data/{tietokortin tunnus}/{attribuuttikoodi}

Päivitä ominaisuus datakortista

PYYTÄÄ

POLKUPARAMETRIT

Esimerkki

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

RUNKO

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

POST /dc/{mallikoodi}/data/{tietokortintunnus}/{attribuuttikoodi}

Lisää arvo attribuuttiin datakortista

PYYTÄÄ

POLKUPARAMETRIT

Esimerkki

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

RUNKO

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

POISTA /dc/{mallikoodi}/data/{tietokortintunnus}/{attribuuttikoodi}

Tyhjennä attribuutin arvo datakortilta.

PYYTÄÄ

POLKUPARAMETRIT

Esimerkki

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

GET /dc/{mallikoodi}/data/{tietokortintunnus}/{attribuuttikoodi}/file/{ulkoistentietojensijainti}

Lataa liite datakortilta.

PYYTÄÄ

POLKUPARAMETRIT

Esimerkki

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

POST /dc/{mallikoodi}/data/{tietokortintunnus}/{attribuuttikoodi}/tiedosto

Lataa liite datakorttiin.

PYYTÄÄ

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"

Mallien käyttö

GET /dc

Hanki luettelo kaikista malleista.

Esimerkki

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

GET /dc/{mallikoodi}

Hae mallipohja koodilla.

PYYTÄÄ

POLKUPARAMETRIT

Esimerkki

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

Käyttöliittymän testaaminen

GET /echo

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

PYYTÄÄ

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 kelvollinen. Testaustarkoituksiin.

PYYTÄÄ

KYSELYPARAMETRIT

Esimerkki

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

Vianmääritys

REST API -virheet

Virheiden sattuessa – esimerkiksi epäonnistuneen valtuutuksen, virheellisten parametrien tai huonosti muotoillun kyselyn aiheuttamien – API vastaa standardoidulla 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 tekstit ”code”, ”error”, ”url” ja ”timestamp” sekä useimmissa tapauksissa tekstin ”message”, jossa annetaan tietoja taustalla olevasta ongelmasta.

Mahdollisia virheitä

JWT-tunnusta ei voida hankkia kirjautumispäätepisteestä

JWT-tokenin saamiseksi kirjautumiseen käytettävällä käyttäjällä on oltava rooli, jolla on käyttöoikeudet 'External API -moduuliin. Jos käyttäjällä ei ole käyttöoikeuksia External API -moduuliin, login-endpoint-vastaus sisältää tiedon riittämättömistä käyttöoikeuksista.
Jos saat "authorized-response" -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 tyhjä, ja jos lähetät arvona "", kenttä ei ole enää tyhjä.

Merkkijonotyyppinen attribuutti sisältää seuraavat asetukset: merkkijono |numero | päivämäärä

StaticValue-arvolla:

• Arvo - merkkijono
• koodi - merkkijono
• tyhjäksi kelpaava - Tosi

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

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