Role

GET

/securityroles

Získá kolekci BO Role

GET

/securityroles/{id}

Získá konkrétní BO Role

POST

/securityroles

Vytvoří nový BO Role a vrátí jeho kompletní reprezentaci

PUT

/securityroles/{id}

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

DELETE

/securityroles/{id}

Smaže BO Role na základě jeho ID

Metadata - Perzistentní položky

ExcludedTimes array (securityroleexcludedtime) relace

Vyloučené časy; kolekce BO Nepracovní časy rolí, objekt na který pole odkazuje je 'vlastněn'

Hidden boolean

Skrytý, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole nepodporuje ochranu dat/GDPR

IsImpersonal boolean

Nepersonální, 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

Parent_ID string (securityrole) relace

Nadřízená r.; ID objektu Role, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole nepodporuje ochranu dat/GDPR

ShiftCalendar_ID string (shiftcalendar) relace

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

ShortName string (10)

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

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í

DisplayParent string (43)

Nadřízená(zobr.), pouze pro čtení

ID string (10)

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

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request 
GET
https://atd.abra.eu/demodata/securityroles?take=1
GET
https://atd.abra.eu/demodata/securityroles/{id}
Response 
{
    "ID": "SUPER00000",
    "ObjVersion": 3,
    "Hidden": false,
    "Name": "role Supervisor",
    "ShortName": "Supervisor",
    "Note": "",
    "Parent_ID": null,
    "IsImpersonal": false,
    "ShiftCalendar_ID": "1000000000",
    "ExcludedTimes": []
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "securityroles", "take": "1"}
POST
https://atd.abra.eu/demodata/securityroles/query
{"take": "1"}
Response 
{
    "ID": "SUPER00000",
    "ObjVersion": 3,
    "Hidden": false,
    "Name": "role Supervisor",
    "ShortName": "Supervisor",
    "Note": "",
    "Parent_ID": null,
    "IsImpersonal": false,
    "ShiftCalendar_ID": "1000000000",
    "ExcludedTimes": []
}
Request 
POST
https://atd.abra.eu/demodata/securityroles?select=id
Body 
{
    "ExcludedTimes": [],
    "Hidden": false,
    "IsImpersonal": false,
    "Name": "role Supervisor",
    "Note": "",
    "Parent_ID": null,
    "ShiftCalendar_ID": "1000000000",
    "ShortName": "Supervisor"
}
Response 
{
    "id": "SUPER00000"
}
Request 
PUT
https://atd.abra.eu/demodata/securityroles/{id}?select=id
Body 
{
    "ExcludedTimes": [],
    "Hidden": false,
    "IsImpersonal": false,
    "Name": "role Supervisor",
    "Note": "",
    "Parent_ID": null,
    "ShiftCalendar_ID": "1000000000",
    "ShortName": "Supervisor"
}
Response 
{
    "id": "SUPER00000"
}
DELETE
https://atd.abra.eu/demodata/securityroles/{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": "securityroles",
                "object_data": {
                    "ExcludedTimes": [],
                    "Hidden": false,
                    "IsImpersonal": false,
                    "Name": "role Supervisor",
                    "Note": "",
                    "Parent_ID": null,
                    "ShiftCalendar_ID": "1000000000",
                    "ShortName": "Supervisor"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "securityroles",
                "object_data": {
                    "ExcludedTimes": [],
                    "Hidden": false,
                    "IsImpersonal": false,
                    "Name": "role Supervisor",
                    "Note": "",
                    "Parent_ID": null,
                    "ShiftCalendar_ID": "1000000000",
                    "ShortName": "Supervisor"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "securityroles",
                "obj_id": "SUPER00000",
                "object_data": {
                    "ExcludedTimes": [],
                    "Hidden": false,
                    "IsImpersonal": false,
                    "Name": "role Supervisor",
                    "Note": "",
                    "Parent_ID": null,
                    "ShiftCalendar_ID": "1000000000",
                    "ShortName": "Supervisor"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "securityroles",
                "obj_id": "SUPER00001",
                "object_data": {
                    "ExcludedTimes": [],
                    "Hidden": false,
                    "IsImpersonal": false,
                    "Name": "role Supervisor",
                    "Note": "",
                    "Parent_ID": null,
                    "ShiftCalendar_ID": "1000000000",
                    "ShortName": "Supervisor"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "securityroles",
                "obj_id": "SUPER00000"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "securityroles",
                "obj_id": "SUPER00001"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "securityroles",
                "obj_id": "SUPER00002"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "securityroles",
                "obj_id": "SUPER00003"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "securityroles",
                "obj_id": "SUPER00004"
            }
        }
    ]
}