Informace o uzivatelskych seznamech

Získání uživatelského seznamu

Umožnuje získat uživatelský seznam titulů pro autentizované uživatele. Pro neautentizované vrací endpointy status 401

 GET  ~/client/v7.0/folders

Dotaz nepožaduje žádné parametry.

Příklad odpovědi:

[
    {
        "name": "jmeno",
        "uuid": "2cdd2a8e-2e56-45d5-a50f-7423d74ce274",
        "itemsCount": 1,
        "users": [
            [
                {
                    "createdAt": "2024-02-08 14:38:30.874",
                    "userRole": "owner",
                    "userId": "xxx@mzk.cz"
                }
            ]
        ],
        "updatedAt": "2024-02-08 14:38:31.028612"
    },
    {
        "name": "K prezentaci",
        "uuid": "5c7e423f-ae3e-4b7c-9ce0-6536c879db34",
        "itemsCount": 13,
        "users": [
            [
                {
                    "createdAt": "2024-02-05 09:56:32.18",
                    "userRole": "follower",
                    "userId": "xxx@mzk.cz"
                },
                {
                    "createdAt": "2024-01-24 20:53:39.255",
                    "userRole": "owner",
                    "userId": "zzz@mzk.cz"
                }
            ]
        ],
        "updatedAt": "2024-02-07 16:12:07.719772"
    },
]

Význam jednotlivých klíčů:

Klíč	Popis	Datový typ
name	Název uživatelského seznamu	Řetězec
uuid	PID objektu	Řetězec
itemsCount	Počet položek v seuznami	Číslo
users	Seznam uživatelů a jejich role v seznamu (vlastník případně follower	Pole objektů
createdAt	Datum a čas vytvoření uživatele	Datum a čas v ISO formátu.
userRole	Role uživatele v rámci objektu	Řetězec
userId	ID uživatele	Řetězec
updatedAt	Datum a čas poslední aktualizace objektu	Datum a čas v ISO formátu.

Návratové kódy: 200

Vytvoření nového seznamu

Umožnuje vytvořit nový uživatelský seznam

 POST  ~/search/api/client/v7.0/folders

Body paramter ve formátu json:

{"name": "NovySeznam"} 

Příklad odpovědi:

{
    "name": "NovySeznam",
    "uuid": "b5d56622-8d1f-417f-a667-07bcf9547621",
    "itemsCount": 0,
    "users": [
        [
            {
                "createdAt": "2024-08-21 11:04:22.421",
                "userRole": "owner",
                "userId": "xxxx@mzk.cz"
            }
        ]
    ],
    "updatedAt": "2024-08-21 11:04:22.421"
}

Vytvořený seznam má automaticky přiděleného vlastníka uživatele, který požadavek poslal. Význam jednotlivých položek v odpovědi je stejný jako je uveden u předchozího příkladu.

Návratové kódy: 200

Změna vlastností uživatelského seznamu

Umožňuje měnit vlastnosti uživatelského seznamu, nyní je možná jenom změna jména.

 PUT  ~/search/api/client/v7.0/folders/{uuid}

Path parametry:

Parametr	Význam	Povinný
uuid	Identifikátor uživatelského seznamu	✅

Body parametr ve formátu json:

{"name": "NovyJmeno"} 

Příklad odpovědi:

{
    "name": "NovySeznam",
    "uuid": "b5d56622-8d1f-417f-a667-07bcf9547621",
    "itemsCount": 0,
    "users": [
        [
            {
                "createdAt": "2024-08-21 11:04:22.421",
                "userRole": "owner",
                "userId": "xxxx@mzk.cz"
            }
        ]
    ],
    "updatedAt": "2024-08-21 11:04:22.421"
}

Návratové kódy: 200

Smazání uživatelského seznamu

 DELETE  ~/search/api/client/v7.0/folders/{uuid}

Path parametry:

Parametr	Význam	Povinný
uuid	Identifikátor uživatelského seznamu	✅

Návratové kódy: 200