Blokace dokumentu

GET

/documentblockings

Získá kolekci BO Blokace dokumentu

GET

/documentblockings/meta/dataprotection

Získá seznam položek BO, které mohou být chráněny na BO Blokace dokumentu

GET

/documentblockings/views/{view}

Získá pohled nad BO Blokace dokumentu

GET

/documentblockings/{id}

Získá daný BO Blokace dokumentu

GET

/documentblockings/{id}/iseditlock

Otestuje, zda existuje editační zámek na daném BO Blokace dokumentu

GET

/documentblockings/{id}/meta/dataprotection

Získá seznam chráněných položek, které jsou na BO Blokace dokumentu aktuálnímu uživateli znepřístupněny

GET

/documentblockings/{id}/userparameters

Získá seznam uživatelských parametrů včetně jejich hodnot k danému BO Blokace dokumentu

POST

/documentblockings

Vytvoří nový BO Blokace dokumentu

POST

/documentblockings/query

Vyhodnotí query dotaz nad BO Blokace dokumentu

PUT

/documentblockings/{id}

Modifikuje daný BO Blokace dokumentu

PUT

/documentblockings/{id}/editlock

Vytvoří editační zámek na daném BO Blokace dokumentu

PUT

/documentblockings/{id}/editunlock

Zruší editační zámek na daném BO Blokace dokumentu

DELETE

/documentblockings/{id}

Smaže BO Blokace dokumentu

Metadata - Perzistentní položky

blockingtype integer

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

correctedby_id string (securityuser) relace

Opravil, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

createdby_id string (securityuser) relace

Vytvořil, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

description string (30)

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

docqueue_id string (docqueue) relace

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

documenttype string (2)

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

objversion integer

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

validto$date string

Platnost do data, 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

displayname string (100)

Název, 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/documentblockings?take=1

GET

https://atd.abra.eu/demodata/documentblockings/{id}
Response
{
    "blockingtype": null,
    "correctedby_id": null,
    "createdby_id": null,
    "description": null,
    "docqueue_id": null,
    "documenttype": null,
    "objversion": null,
    "validto$date": null
}
Request POST

POST

https://atd.abra.eu/demodata/query
{"class": "documentblockings", "take": "1"}

POST

https://atd.abra.eu/demodata/documentblockings/query
{"take": "1"}
Response
{
    "blockingtype": null,
    "correctedby_id": null,
    "createdby_id": null,
    "description": null,
    "docqueue_id": null,
    "documenttype": null,
    "objversion": null,
    "validto$date": null
}
Request

POST

https://atd.abra.eu/demodata/documentblockings?select=id
Body
{
    "blockingtype": null,
    "correctedby_id": null,
    "createdby_id": null,
    "description": null,
    "docqueue_id": null,
    "documenttype": null,
    "validto$date": null
}
Response
{
    "id": "1600000101"
}
Request

PUT

https://atd.abra.eu/demodata/documentblockings/{id}?select=id
Body
{
    "blockingtype": null,
    "correctedby_id": null,
    "createdby_id": null,
    "description": null,
    "docqueue_id": null,
    "documenttype": null,
    "validto$date": null
}
Response
{
    "id": "1600000101"
}

DELETE

https://atd.abra.eu/demodata/documentblockings/{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": "documentblockings",
                "object_data": {
                    "blockingtype": null,
                    "correctedby_id": null,
                    "createdby_id": null,
                    "description": null,
                    "docqueue_id": null,
                    "documenttype": null,
                    "validto$date": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "documentblockings",
                "object_data": {
                    "blockingtype": null,
                    "correctedby_id": null,
                    "createdby_id": null,
                    "description": null,
                    "docqueue_id": null,
                    "documenttype": null,
                    "validto$date": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "documentblockings",
                "obj_id": "1600000100",
                "object_data": {
                    "blockingtype": null,
                    "correctedby_id": null,
                    "createdby_id": null,
                    "description": null,
                    "docqueue_id": null,
                    "documenttype": null,
                    "validto$date": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "documentblockings",
                "obj_id": "1600000101",
                "object_data": {
                    "blockingtype": null,
                    "correctedby_id": null,
                    "createdby_id": null,
                    "description": null,
                    "docqueue_id": null,
                    "documenttype": null,
                    "validto$date": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "documentblockings",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "documentblockings",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "documentblockings",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "documentblockings",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "documentblockings",
                "obj_id": "1600000104"
            }
        }
    ]
}