Parametry

Struktura danych JSON

Obiekt Parameter

  • id – (readonly) ID w bazie danych
  • created – (readonly) data utworzenia parametru
  • createdUserId – (readonly) ID usera który utworzył parametr
  • lastChanged – (readonly) data ostatniej modyfikacji parametru
  • lastChangedUserId – (readonly) ID usera który ostatnie modyfikował
  • name – nazwa parametru
  • type – typ wartości w parametrze, enum: STRING(tekstowy), NUMBER_INT(liczba całkowita), NUMBER_REAL(liczba rzeczywista), DICT(słownik)
  • categoryId – ID kategorii w której parametr jest dostępny, lub null gdy parametr ogólny
  • isMulti – czy jest to parametr multi?
  • dictionary – tablica wartości dla słownika, lub wartość null gdy parametr nie jest słownikiem

Pobieranie wszystkich parametrów i ich wyszukiwanie

GET

/parameters

Parametry w ścieżce zapytania

Nie przekazanie żadnych parametrów w ścieżce spowoduje pobranie wszystkich parametrów z aplikacji

  • catId – ID kategorii z której pobrać parametry
  • isCatStrict – podanie false spowoduje pobranie parametrów z podanej kategorii i jej subkategorii, a podanie true spowoduje pobranie parametrów tylko z podanej kategorii
/parameters?catId=10&isCatStrict=false
Odpowiedź JSON - zawiera tablicę obiektów Parameter
Przykładowa odpowiedź:
{
    "params":[
        {
            "id":7,
            "created":"2022-05-22T09:32:03Z",
            "createdUserId":1,
            "lastChanged":"2022-05-29T10:33:13Z",
            "lastChangedUserId":2,
            "name":"Montaż",
            "type":"DICT",
            "categoryId":10,
            "isMulti":false,
            "dictionary":[
                "THT",
                "SMD"
            ]
        }
    ]
}

Pobieranie parametru

GET

/parameters

Parametry w ścieżce zapytania
  • id – ID parametru
/parameters?id=1
Odpowiedź JSON
{
    "id":1,
    "created":"2022-05-26T13:53:51Z",
    "createdUserId":1,
    "lastChanged":"2022-05-26T13:53:51Z",
    "lastChangedUserId":1,
    "name":"Nazwa parametru",
    "type":"STRING",
    "categoryId":null,
    "isMulti":false,
    "dictionary":null
}

Dodawanie parameetru

POST

/parameters

Dane JSON w zapytaniu (body)

Należy przekazać obiekt Parameter. Pola readonly są pomijane, nie trzeba ich przekazywać.

Dane odpowiedzi JSON

W odpowiedzi zwrócony zostanie nowo utworzony obiekt Parameter zawierający ID.

Edycja parametru

PUT

/parameters

Dane JSON w zapytaniu (body)

Należy przekazać pełny obiekt Parameter do edycji. Należy przekazać pole ID, reszta pól readonly jest pomijana.

Dane odpowiedzi JSON

W odpowiedzi zwrócony zostanie obiekt Parameter.

Usuwanie parametru

DELETE

/parameters

Parametry w ścieżce zapytania
  • id – ID parametru do usunięcia
/parameters?id=1
Odpowiedź - 204 No Content