Ostatnia aktualizacja: 22.03.2024

W tym dokumencie opisano każdy punkt końcowy dostępny w interfejsie Efecte REST API v1. Jest to opis techniczny interfejsu — przegląd interfejsu REST API można znaleźć tutaj .

Dostęp do kart danych

POBIERZ /dc/{kod szablonu}/dane

Pobierz wszystkie karty danych według kodu szablonu – zwraca podzieloną na strony listę informacji o kartach danych według podanego szablonu.

WNIOSEK

PARAMETRY ŚCIEŻKI

PARAMETRY ZAPYTANIA

Przykład

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

POBIERZ /dc/{kod szablonu}/dane/strumień

Zwraca wszystkie dostępne karty danych poprzez strumieniowanie. W przypadku złożonych i intensywnych operacji strumieniowanie wyników może zapewnić szybsze i wydajniejsze rezultaty niż pobieranie danych stronicowanych.

WNIOSEK

PARAMETRY ŚCIEŻKI

PARAMETRY ZAPYTANIA

Przykład

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

WPISZ /dc/{kod szablonu}/dane

Utwórz lub edytuj wiele kart danych

WNIOSEK

PARAMETRY ŚCIEŻKI

Przykład

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

CIAŁO

[
 {
   "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/{kod szablonu}/dane

Utwórz nową kartę danych

WNIOSEK

PARAMETRY ŚCIEŻKI

PARAMETRY ZAPYTANIA

Przykład

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

CIAŁO

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

POBIERZ /dc/{kod szablonu}/dane/{identyfikator karty danych}

Zdobądź pojedynczą kartę danych

WNIOSEK

PARAMETRY ŚCIEŻKI

PARAMETRY ZAPYTANIA

Przykład

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

USUŃ /dc/{kod szablonu}/dane/{identyfikator karty danych}

Usuń pojedynczą kartę danych

WNIOSEK

PARAMETRY ŚCIEŻKI

Przykład

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

PATCH /dc/{kod szablonu}/data/{identyfikator karty danych}

Edytuj istniejącą kartę danych

WNIOSEK

PARAMETRY ŚCIEŻKI

PARAMETRY ZAPYTANIA

Przykład

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

CIAŁO

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

POBIERZ /dc/{kod szablonu}/dane/{identyfikator karty danych}/{kod atrybutu}

Pobierz atrybut z karty danych

WNIOSEK

PARAMETRY ŚCIEŻKI

Przykład

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

PUT /dc/{kod szablonu}/data/{identyfikator karty danych}/{kod atrybutu}

Aktualizacja atrybutu z karty danych

WNIOSEK

PARAMETRY ŚCIEŻKI

Przykład

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

CIAŁO

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

POST /dc/{kod szablonu}/dane/{identyfikator karty danych}/{kod atrybutu}

Dodaj wartość do atrybutu z karty danych

WNIOSEK

PARAMETRY ŚCIEŻKI

Przykład

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

CIAŁO

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

USUŃ /dc/{kod szablonu}/dane/{identyfikator karty danych}/{kod atrybutu}

Wyczyść wartość atrybutu z karty danych.

WNIOSEK

PARAMETRY ŚCIEŻKI

Przykład

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

GET /dc/{kod szablonu}/data/{identyfikator karty danych}/{kod atrybutu}/plik/{lokalizacja danych zewnętrznych}

Pobierz załącznik z karty danych.

WNIOSEK

PARAMETRY ŚCIEŻKI

Przykład

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

POST /dc/{kod szablonu}/dane/{identyfikator karty danych}/{kod atrybutu}/plik

Prześlij załącznik do karty danych.

WNIOSEK

PARAMETRY ŚCIEŻKI

Przykład

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"

Dostęp do szablonów

POBIERZ /dc

Pobierz listę wszystkich szablonów.

Przykład

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

GET /dc/{kod szablonu}

Pobierz szablon za pomocą kodu.

WNIOSEK

PARAMETRY ŚCIEŻKI

Przykład

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

Jak przetestować interfejs

POBIERZ /echo

Zwraca zawartość parametru zapytania „message”. Do celów testowych.

WNIOSEK

PARAMETRY ZAPYTANIA

Przykład

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

POBIERZ /echo/jwt

Zwraca zawartość parametru zapytania „message”, jeśli token JWT jest prawidłowy. Do celów testowych.

WNIOSEK

PARAMETRY ZAPYTANIA

Przykład

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

Rozwiązywanie problemów

Błędy REST API

W przypadku wystąpienia błędów – na przykład z powodu nieudanej autoryzacji, błędnych parametrów lub nieprawidłowo sformatowanego zapytania – API odpowie standardową odpowiedzią na błąd:

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

Odpowiedź będzie zawsze zawierać „kod”, „błąd”, „adres URL” i „znacznik czasu”, a w większości przypadków „komunikat”, podając szczegóły dotyczące podstawowego problemu.

Możliwe błędy

Nie można uzyskać tokena JWT z punktu końcowego logowania

Aby uzyskać token JWT, użytkownik używany do logowania musi mieć przypisaną rolę z uprawnieniami do modułu „Zewnętrzne API ”. Jeśli użytkownik nie ma uprawnień do modułu „Zewnętrzne API , odpowiedź punktu końcowego logowania będzie zawierać informację o niewystarczających uprawnieniach.
Jeśli otrzymasz odpowiedź „authorized-response”, mimo że nazwa użytkownika i hasło są prawidłowe, a rola ma właściwe uprawnienia, upewnij się, że konto jest lokalnym kontem ESM.

Atrybut nie może przyjmować wartości null, a jeśli wyślesz „” jako wartość, pole nie będzie już puste

Atrybut typu String zawiera następujące opcje: string |number |date

Z wartością statyczną:

• Wartość - ciąg
• kod - ciąg znaków
• nullable - Prawda

Jeśli zatem chcesz uzyskać pustą wartość atrybutu za pomocą REST API , użyj następującej składni:

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