Uživatel

GET

/securityusers

Získá kolekci BO Uživatel

GET

/securityusers/{id}

Získá konkrétní BO Uživatel

POST

/securityusers

Vytvoří nový BO Uživatel a vrátí jeho kompletní reprezentaci

PUT

/securityusers/{id}

Provede aktualizaci BO Uživatel a vrátí jeho kompletní, aktualizovanou reprezentaci. Operaci PUT je možné využívat i k částečným aktualizacím zdrojů (PATCH).

DELETE

/securityusers/{id}

Smaže BO Uživatel na základě jeho ID

Metadata - Perzistentní položky

Address_ID

pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn', pole je přístupná pro hromadné změny

AskToNPS boolean

Zobrazovat NPS, pole vlastněné tabulkou, možné řadit a filtrovat, pole je přístupná pro hromadné změny

BIAccess boolean

Vizualizace dat, pole vlastněné tabulkou, možné řadit a filtrovat, pole je přístupná pro hromadné změny

BI_GID string (26)

Identifikace ve Vizualizaci dat, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, fkAnsiCaseSensitive

DPBypass boolean

Obejít ochranu dat, pole vlastněné tabulkou, možné řadit a filtrovat, pole je přístupná pro hromadné změny

Locked boolean

Uzamčen, pole vlastněné tabulkou, možné řadit a filtrovat, pole je přístupná pro hromadné změny

LoginName string (30)

Přihlašovací jméno, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

Name string (30)

Jméno, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

Note string (0)

Poznámka, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

ObjVersion integer

Verze objektu, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

OfferToLogin boolean

Nabízet v přihlašovacím okně, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole je přístupná pro hromadné změny

PortalLoginName string (30)

Přihlašovací jméno, pole vlastněné tabulkou, možné řadit a filtrovat

PortalSecPassword string (40)

Heslo, pole vlastněné tabulkou, možné řadit a filtrovat

SecPassword string (100)

Heslo, pole vlastněné tabulkou, možné řadit a filtrovat

SecToken string (100)

Token, pole vlastněné tabulkou, možné řadit a filtrovat

SecTokenFastLogin boolean

Rychlé přihlášení, pole vlastněné tabulkou, možné řadit a filtrovat

ShortName string (10)

Zkratka, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

WebAPIAccess boolean

Přihlášení nevizuálního uživatele API, pole vlastněné tabulkou, možné řadit a filtrovat, pole je přístupná pro hromadné změny

Metadata - Neperzistentní položky

ClassID string (26)

ID třídy, pouze pro čtení, fkAnsiCaseSensitive, pole nepodporuje ochranu dat/GDPR

Comment string (8191)

Poznámka

DisplayName string (100)

Název, pouze pro čtení

ID string (10)

Vlastní ID, pouze pro čtení, fkAnsiCaseSensitive, pole nepodporuje ochranu dat/GDPR

IsActive boolean

Aktivní

LogonPassword string (100)

Heslo

UpdatedSecToken string (100)

Nový token

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request 
GET
https://atd.abra.eu/demodata/securityusers?take=1
GET
https://atd.abra.eu/demodata/securityusers/{id}
Response 
{
    "ID": "SUPER00000",
    "ObjVersion": 10,
    "Name": "Supervisor",
    "ShortName": "Super",
    "Note": "Správce systému",
    "Address_ID": "SUPER00000",
    "LoginName": "Supervisor",
    "Locked": false,
    "SecPassword": "37528AE0F6526D38757CBD52563255",
    "SecToken": "5345533037",
    "SecTokenFastLogin": false,
    "PortalLoginName": "",
    "PortalSecPassword": "",
    "OfferToLogin": true,
    "WebAPIAccess": true,
    "BIAccess": false,
    "BI_GID": "Q0NLAWKXRROL3A5K01C5HIS00C",
    "AskToNPS": true,
    "DPBypass": false
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "securityusers", "take": "1"}
POST
https://atd.abra.eu/demodata/securityusers/query
{"take": "1"}
Response 
{
    "ID": "SUPER00000",
    "ObjVersion": 10,
    "Name": "Supervisor",
    "ShortName": "Super",
    "Note": "Správce systému",
    "Address_ID": "SUPER00000",
    "LoginName": "Supervisor",
    "Locked": false,
    "SecPassword": "37528AE0F6526D38757CBD52563255",
    "SecToken": "5345533037",
    "SecTokenFastLogin": false,
    "PortalLoginName": "",
    "PortalSecPassword": "",
    "OfferToLogin": true,
    "WebAPIAccess": true,
    "BIAccess": false,
    "BI_GID": "Q0NLAWKXRROL3A5K01C5HIS00C",
    "AskToNPS": true,
    "DPBypass": false
}
Request 
POST
https://atd.abra.eu/demodata/securityusers?select=id
Body 
{
    "AskToNPS": true,
    "BIAccess": false,
    "DPBypass": false,
    "Locked": false,
    "LoginName": "Supervisor",
    "Name": "Supervisor",
    "Note": "Správce systému",
    "OfferToLogin": true,
    "PortalLoginName": "",
    "PortalSecPassword": "",
    "SecPassword": "37528AE0F6526D38757CBD52563255",
    "SecToken": "5345533037",
    "SecTokenFastLogin": false,
    "ShortName": "Super",
    "WebAPIAccess": true
}
Response 
{
    "id": "SUPER00000"
}
Request 
PUT
https://atd.abra.eu/demodata/securityusers/{id}?select=id
Body 
{
    "AskToNPS": true,
    "BIAccess": false,
    "DPBypass": false,
    "Locked": false,
    "LoginName": "Supervisor",
    "Name": "Supervisor",
    "Note": "Správce systému",
    "OfferToLogin": true,
    "PortalLoginName": "",
    "PortalSecPassword": "",
    "SecPassword": "37528AE0F6526D38757CBD52563255",
    "SecToken": "5345533037",
    "SecTokenFastLogin": false,
    "ShortName": "Super",
    "WebAPIAccess": true
}
Response 
{
    "id": "SUPER00000"
}
DELETE
https://atd.abra.eu/demodata/securityusers/{id}
Response 
200 - OK Everything worked as expected.
Dávkové zprocování záznamů Request 
PUT
https://atd.abra.eu/demodata//batch
  • CREATE
  • UPDATE
  • DELETE
Body - Create 
{
    "items": [
        {
            "type": "create",
            "id": "id0",
            "data": {
                "class_id": "securityusers",
                "object_data": {
                    "AskToNPS": true,
                    "BIAccess": false,
                    "DPBypass": false,
                    "Locked": false,
                    "LoginName": "Supervisor",
                    "Name": "Supervisor",
                    "Note": "Správce systému",
                    "OfferToLogin": true,
                    "PortalLoginName": "",
                    "PortalSecPassword": "",
                    "SecPassword": "37528AE0F6526D38757CBD52563255",
                    "SecToken": "5345533037",
                    "SecTokenFastLogin": false,
                    "ShortName": "Super",
                    "WebAPIAccess": true
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "securityusers",
                "object_data": {
                    "AskToNPS": true,
                    "BIAccess": false,
                    "DPBypass": false,
                    "Locked": false,
                    "LoginName": "Supervisor",
                    "Name": "Supervisor",
                    "Note": "Správce systému",
                    "OfferToLogin": true,
                    "PortalLoginName": "",
                    "PortalSecPassword": "",
                    "SecPassword": "37528AE0F6526D38757CBD52563255",
                    "SecToken": "5345533037",
                    "SecTokenFastLogin": false,
                    "ShortName": "Super",
                    "WebAPIAccess": true
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "securityusers",
                "obj_id": "SUPER00000",
                "object_data": {
                    "AskToNPS": true,
                    "BIAccess": false,
                    "DPBypass": false,
                    "Locked": false,
                    "LoginName": "Supervisor",
                    "Name": "Supervisor",
                    "Note": "Správce systému",
                    "OfferToLogin": true,
                    "PortalLoginName": "",
                    "PortalSecPassword": "",
                    "SecPassword": "37528AE0F6526D38757CBD52563255",
                    "SecToken": "5345533037",
                    "SecTokenFastLogin": false,
                    "ShortName": "Super",
                    "WebAPIAccess": true
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "securityusers",
                "obj_id": "SUPER00001",
                "object_data": {
                    "AskToNPS": true,
                    "BIAccess": false,
                    "DPBypass": false,
                    "Locked": false,
                    "LoginName": "Supervisor",
                    "Name": "Supervisor",
                    "Note": "Správce systému",
                    "OfferToLogin": true,
                    "PortalLoginName": "",
                    "PortalSecPassword": "",
                    "SecPassword": "37528AE0F6526D38757CBD52563255",
                    "SecToken": "5345533037",
                    "SecTokenFastLogin": false,
                    "ShortName": "Super",
                    "WebAPIAccess": true
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "securityusers",
                "obj_id": "SUPER00000"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "securityusers",
                "obj_id": "SUPER00001"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "securityusers",
                "obj_id": "SUPER00002"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "securityusers",
                "obj_id": "SUPER00003"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "securityusers",
                "obj_id": "SUPER00004"
            }
        }
    ]
}