6.2

Přístup k číselníkům

Číselníky jsou používány na mnoha místech v CRM. Téměř za každým výběrovým polem je korespondující číselník. Každý číselník má unikátní kód (CHAR(32)) a jednotlivé položky číselníku pak mají unikátní hodnotu (CHAR(16)).

GET /api/lists

Získání seznamu všech dostupných číselníků.

Odpověď (application/json)

200 OK

Pole objektů, přičemž každý objekt představuje jeden dostupný číselník.

[
  { "id": "abcd", "name": "Číselník 1" }, 
  { "id": "efgh", "name": "Číselník 2" }, 
  /*...*/
]

GET /api/lists/{list}

Získání jednoho číselníku včetně seznamu položek.

Odpověď (application/json)

200 OK

Jeden objekt reprezentující celý číselník. Popis struktury zde.

404 NOT FOUND

Dotaz na neexistující číselník.

PUT /api/lists/{list} (pouze admin)

Založení nového číselníku s kódem {list} nebo změna existujícího. Pomocí tohoto koncového bodu lze změnit název číselníku a nebo zámek.

Požadavek (application/json)

V těle požadavku musí být JSON v následujícím tvaru:

PUT /api/lists/prod_colors
{
  "name": "Barvy produktu",
  "locked": false
}

Odpověď

201 OK CREATED

Číselník byl úspěšně založen