Schvalování dokladu

GET

/docconfirmations

Získá kolekci BO Schvalování dokladu

GET

/docconfirmations/meta/dataprotection

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

GET

/docconfirmations/views/{view}

Získá pohled nad BO Schvalování dokladu

GET

/docconfirmations/{id}

Získá daný BO Schvalování dokladu

GET

/docconfirmations/{id}/iseditlock

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

GET

/docconfirmations/{id}/meta/dataprotection

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

GET

/docconfirmations/{id}/rows

Získá řádky kolekce Schvalování dokladu - řádek

GET

/docconfirmations/{id}/rows/{id1}

Získá daný řádek kolekce Schvalování dokladu - řádek

GET

/docconfirmations/{id}/userparameters

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

POST

/docconfirmations/query

Vyhodnotí query dotaz nad BO Schvalování dokladu

POST

/docconfirmations/{id}/rows

Vytvoří nový řádek v kolekci Schvalování dokladu - řádek

PUT

/docconfirmations/{id}/confirm

Schválení daného dokladu

PUT

/docconfirmations/{id}/editlock

Vytvoří editační zámek na daném BO Schvalování dokladu

PUT

/docconfirmations/{id}/editunlock

Zruší editační zámek na daném BO Schvalování dokladu

PUT

/docconfirmations/{id}/reject

Zamítnutí schválení daného dokladu

PUT

/docconfirmations/{id}/return

Vrátí daný doklad k doplnění

PUT

/docconfirmations/{id}/rows/{id1}

Modifikuje řádek v kolekci Schvalování dokladu - řádek

PUT

/docconfirmations/{id}/start

Zahájí schvalování daného dokladu

DELETE

/docconfirmations/{id}/rows/{id1}

Smaže řádek z kolekce Schvalování dokladu - řádek

Metadata - Perzistentní položky

actualconfirmationround integer

Kolo, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

confirmationstate integer

Aktuální stav schvalování dokladu, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

doctype string (2)

Typ dokladu, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, fkAnsiCaseSensitive

document_id string (datadocumentbusinessobject) relace

ID schvalovaného dokladu, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

existsconfirmationdefs boolean

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

finishedby_id string (securityuser) relace

Schvalování ukončil, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

finisheddate$date string

Schvalování dokončeno, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

isconfirmationrequired boolean

Je vyžadováno schválení, 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

rows array (docconfirmationrow) relace

kolekce BO Schvalování dokladu - řádek, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

startedby_id string (securityuser) relace

Schválení vyžádal, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

starteddate$date string

Schvalování započato, pouze pro čtení, 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

confirmationstatedesc string (20)

Aktuální stav schvalování dokladu

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/docconfirmations?take=1

GET

https://atd.abra.eu/demodata/docconfirmations/{id}
Response
{
    "objversion": 6,
    "rows": [
        {
            "canceled": true,
            "canceledby_id": "1200000101",
            "canceleddate$date": "2006-10-05T16:10:44.205Z",
            "confirmationround": 1,
            "confirmationstate": 1,
            "confirmatororder": 1,
            "confirmatorrole_id": "4000000101",
            "confirmatoruser_id": null,
            "confirmedby_id": null,
            "docconfirmationdef_id": null,
            "id": "1000000101",
            "laststatechangedate$date": "2006-10-05T16:10:44.205Z",
            "note": "Prosím navýšti slevu na 10%\r\n",
            "objversion": 2,
            "parent_id": "1100000101",
            "requestcreateddate$date": "2006-10-04T22:00:00.000Z"
        },
        {
            "canceled": true,
            "canceledby_id": "1300000101",
            "canceleddate$date": "2006-10-05T16:57:57.549Z",
            "confirmationround": 2,
            "confirmationstate": 2,
            "confirmatororder": 1,
            "confirmatorrole_id": "4000000101",
            "confirmatoruser_id": null,
            "confirmedby_id": "1200000101",
            "docconfirmationdef_id": null,
            "id": "2000000101",
            "laststatechangedate$date": "2006-10-05T16:13:22.463Z",
            "note": "O.K.\r\n",
            "objversion": 3,
            "parent_id": "1100000101",
            "requestcreateddate$date": "2006-10-04T22:00:00.000Z"
        }
    ],
    "doctype": "IF",
    "document_id": "1100000101",
    "startedby_id": "1300000101",
    "starteddate$date": "2006-10-04T22:00:00.000Z",
    "confirmationstate": 4,
    "actualconfirmationround": 2,
    "finisheddate$date": null,
    "finishedby_id": null,
    "existsconfirmationdefs": true,
    "isconfirmationrequired": true
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/docconfirmations/query
{"take": "1"}
Response
{
    "objversion": 6,
    "rows": [
        {
            "canceled": true,
            "canceledby_id": "1200000101",
            "canceleddate$date": "2006-10-05T16:10:44.205Z",
            "confirmationround": 1,
            "confirmationstate": 1,
            "confirmatororder": 1,
            "confirmatorrole_id": "4000000101",
            "confirmatoruser_id": null,
            "confirmedby_id": null,
            "docconfirmationdef_id": null,
            "id": "1000000101",
            "laststatechangedate$date": "2006-10-05T16:10:44.205Z",
            "note": "Prosím navýšti slevu na 10%\r\n",
            "objversion": 2,
            "parent_id": "1100000101",
            "requestcreateddate$date": "2006-10-04T22:00:00.000Z"
        },
        {
            "canceled": true,
            "canceledby_id": "1300000101",
            "canceleddate$date": "2006-10-05T16:57:57.549Z",
            "confirmationround": 2,
            "confirmationstate": 2,
            "confirmatororder": 1,
            "confirmatorrole_id": "4000000101",
            "confirmatoruser_id": null,
            "confirmedby_id": "1200000101",
            "docconfirmationdef_id": null,
            "id": "2000000101",
            "laststatechangedate$date": "2006-10-05T16:13:22.463Z",
            "note": "O.K.\r\n",
            "objversion": 3,
            "parent_id": "1100000101",
            "requestcreateddate$date": "2006-10-04T22:00:00.000Z"
        }
    ],
    "doctype": "IF",
    "document_id": "1100000101",
    "startedby_id": "1300000101",
    "starteddate$date": "2006-10-04T22:00:00.000Z",
    "confirmationstate": 4,
    "actualconfirmationround": 2,
    "finisheddate$date": null,
    "finishedby_id": null,
    "existsconfirmationdefs": true,
    "isconfirmationrequired": true
}
Request

POST

https://atd.abra.eu/demodata/docconfirmations?select=id
Body
{
    "existsconfirmationdefs": true,
    "isconfirmationrequired": true,
    "rows": [
        {
            "canceled": true,
            "canceledby_id": "1200000101",
            "canceleddate$date": "2006-10-05T16:10:44.205Z",
            "confirmationround": 1,
            "confirmationstate": 1,
            "confirmatororder": 1,
            "confirmatorrole_id": "4000000101",
            "confirmatoruser_id": null,
            "confirmedby_id": null,
            "docconfirmationdef_id": null,
            "id": "1000000101",
            "laststatechangedate$date": "2006-10-05T16:10:44.205Z",
            "note": "Prosím navýšti slevu na 10%\r\n",
            "objversion": 2,
            "parent_id": "1100000101",
            "requestcreateddate$date": "2006-10-04T22:00:00.000Z"
        },
        {
            "canceled": true,
            "canceledby_id": "1300000101",
            "canceleddate$date": "2006-10-05T16:57:57.549Z",
            "confirmationround": 2,
            "confirmationstate": 2,
            "confirmatororder": 1,
            "confirmatorrole_id": "4000000101",
            "confirmatoruser_id": null,
            "confirmedby_id": "1200000101",
            "docconfirmationdef_id": null,
            "id": "2000000101",
            "laststatechangedate$date": "2006-10-05T16:13:22.463Z",
            "note": "O.K.\r\n",
            "objversion": 3,
            "parent_id": "1100000101",
            "requestcreateddate$date": "2006-10-04T22:00:00.000Z"
        }
    ]
}
Response
{
    "id": "1600000101"
}
Request

PUT

https://atd.abra.eu/demodata/docconfirmations/{id}?select=id
Body
{
    "existsconfirmationdefs": true,
    "isconfirmationrequired": true,
    "rows": [
        {
            "canceled": true,
            "canceledby_id": "1200000101",
            "canceleddate$date": "2006-10-05T16:10:44.205Z",
            "confirmationround": 1,
            "confirmationstate": 1,
            "confirmatororder": 1,
            "confirmatorrole_id": "4000000101",
            "confirmatoruser_id": null,
            "confirmedby_id": null,
            "docconfirmationdef_id": null,
            "id": "1000000101",
            "laststatechangedate$date": "2006-10-05T16:10:44.205Z",
            "note": "Prosím navýšti slevu na 10%\r\n",
            "objversion": 2,
            "parent_id": "1100000101",
            "requestcreateddate$date": "2006-10-04T22:00:00.000Z"
        },
        {
            "canceled": true,
            "canceledby_id": "1300000101",
            "canceleddate$date": "2006-10-05T16:57:57.549Z",
            "confirmationround": 2,
            "confirmationstate": 2,
            "confirmatororder": 1,
            "confirmatorrole_id": "4000000101",
            "confirmatoruser_id": null,
            "confirmedby_id": "1200000101",
            "docconfirmationdef_id": null,
            "id": "2000000101",
            "laststatechangedate$date": "2006-10-05T16:13:22.463Z",
            "note": "O.K.\r\n",
            "objversion": 3,
            "parent_id": "1100000101",
            "requestcreateddate$date": "2006-10-04T22:00:00.000Z"
        }
    ]
}
Response
{
    "id": "1600000101"
}

DELETE

https://atd.abra.eu/demodata/docconfirmations/{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": "docconfirmations",
                "object_data": {
                    "existsconfirmationdefs": true,
                    "isconfirmationrequired": true,
                    "rows": [
                        {
                            "canceled": true,
                            "canceledby_id": "1200000101",
                            "canceleddate$date": "2006-10-05T16:10:44.205Z",
                            "confirmationround": 1,
                            "confirmationstate": 1,
                            "confirmatororder": 1,
                            "confirmatorrole_id": "4000000101",
                            "confirmatoruser_id": null,
                            "confirmedby_id": null,
                            "docconfirmationdef_id": null,
                            "id": "1000000101",
                            "laststatechangedate$date": "2006-10-05T16:10:44.205Z",
                            "note": "Prosím navýšti slevu na 10%\r\n",
                            "objversion": 2,
                            "parent_id": "1100000101",
                            "requestcreateddate$date": "2006-10-04T22:00:00.000Z"
                        },
                        {
                            "canceled": true,
                            "canceledby_id": "1300000101",
                            "canceleddate$date": "2006-10-05T16:57:57.549Z",
                            "confirmationround": 2,
                            "confirmationstate": 2,
                            "confirmatororder": 1,
                            "confirmatorrole_id": "4000000101",
                            "confirmatoruser_id": null,
                            "confirmedby_id": "1200000101",
                            "docconfirmationdef_id": null,
                            "id": "2000000101",
                            "laststatechangedate$date": "2006-10-05T16:13:22.463Z",
                            "note": "O.K.\r\n",
                            "objversion": 3,
                            "parent_id": "1100000101",
                            "requestcreateddate$date": "2006-10-04T22:00:00.000Z"
                        }
                    ]
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "docconfirmations",
                "object_data": {
                    "existsconfirmationdefs": true,
                    "isconfirmationrequired": true,
                    "rows": [
                        {
                            "canceled": true,
                            "canceledby_id": "1200000101",
                            "canceleddate$date": "2006-10-05T16:10:44.205Z",
                            "confirmationround": 1,
                            "confirmationstate": 1,
                            "confirmatororder": 1,
                            "confirmatorrole_id": "4000000101",
                            "confirmatoruser_id": null,
                            "confirmedby_id": null,
                            "docconfirmationdef_id": null,
                            "id": "1000000101",
                            "laststatechangedate$date": "2006-10-05T16:10:44.205Z",
                            "note": "Prosím navýšti slevu na 10%\r\n",
                            "objversion": 2,
                            "parent_id": "1100000101",
                            "requestcreateddate$date": "2006-10-04T22:00:00.000Z"
                        },
                        {
                            "canceled": true,
                            "canceledby_id": "1300000101",
                            "canceleddate$date": "2006-10-05T16:57:57.549Z",
                            "confirmationround": 2,
                            "confirmationstate": 2,
                            "confirmatororder": 1,
                            "confirmatorrole_id": "4000000101",
                            "confirmatoruser_id": null,
                            "confirmedby_id": "1200000101",
                            "docconfirmationdef_id": null,
                            "id": "2000000101",
                            "laststatechangedate$date": "2006-10-05T16:13:22.463Z",
                            "note": "O.K.\r\n",
                            "objversion": 3,
                            "parent_id": "1100000101",
                            "requestcreateddate$date": "2006-10-04T22:00:00.000Z"
                        }
                    ]
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "docconfirmations",
                "obj_id": "1600000100",
                "object_data": {
                    "existsconfirmationdefs": true,
                    "isconfirmationrequired": true,
                    "rows": [
                        {
                            "canceled": true,
                            "canceledby_id": "1200000101",
                            "canceleddate$date": "2006-10-05T16:10:44.205Z",
                            "confirmationround": 1,
                            "confirmationstate": 1,
                            "confirmatororder": 1,
                            "confirmatorrole_id": "4000000101",
                            "confirmatoruser_id": null,
                            "confirmedby_id": null,
                            "docconfirmationdef_id": null,
                            "id": "1000000101",
                            "laststatechangedate$date": "2006-10-05T16:10:44.205Z",
                            "note": "Prosím navýšti slevu na 10%\r\n",
                            "objversion": 2,
                            "parent_id": "1100000101",
                            "requestcreateddate$date": "2006-10-04T22:00:00.000Z"
                        },
                        {
                            "canceled": true,
                            "canceledby_id": "1300000101",
                            "canceleddate$date": "2006-10-05T16:57:57.549Z",
                            "confirmationround": 2,
                            "confirmationstate": 2,
                            "confirmatororder": 1,
                            "confirmatorrole_id": "4000000101",
                            "confirmatoruser_id": null,
                            "confirmedby_id": "1200000101",
                            "docconfirmationdef_id": null,
                            "id": "2000000101",
                            "laststatechangedate$date": "2006-10-05T16:13:22.463Z",
                            "note": "O.K.\r\n",
                            "objversion": 3,
                            "parent_id": "1100000101",
                            "requestcreateddate$date": "2006-10-04T22:00:00.000Z"
                        }
                    ]
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "docconfirmations",
                "obj_id": "1600000101",
                "object_data": {
                    "existsconfirmationdefs": true,
                    "isconfirmationrequired": true,
                    "rows": [
                        {
                            "canceled": true,
                            "canceledby_id": "1200000101",
                            "canceleddate$date": "2006-10-05T16:10:44.205Z",
                            "confirmationround": 1,
                            "confirmationstate": 1,
                            "confirmatororder": 1,
                            "confirmatorrole_id": "4000000101",
                            "confirmatoruser_id": null,
                            "confirmedby_id": null,
                            "docconfirmationdef_id": null,
                            "id": "1000000101",
                            "laststatechangedate$date": "2006-10-05T16:10:44.205Z",
                            "note": "Prosím navýšti slevu na 10%\r\n",
                            "objversion": 2,
                            "parent_id": "1100000101",
                            "requestcreateddate$date": "2006-10-04T22:00:00.000Z"
                        },
                        {
                            "canceled": true,
                            "canceledby_id": "1300000101",
                            "canceleddate$date": "2006-10-05T16:57:57.549Z",
                            "confirmationround": 2,
                            "confirmationstate": 2,
                            "confirmatororder": 1,
                            "confirmatorrole_id": "4000000101",
                            "confirmatoruser_id": null,
                            "confirmedby_id": "1200000101",
                            "docconfirmationdef_id": null,
                            "id": "2000000101",
                            "laststatechangedate$date": "2006-10-05T16:13:22.463Z",
                            "note": "O.K.\r\n",
                            "objversion": 3,
                            "parent_id": "1100000101",
                            "requestcreateddate$date": "2006-10-04T22:00:00.000Z"
                        }
                    ]
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "docconfirmations",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "docconfirmations",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "docconfirmations",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "docconfirmations",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "docconfirmations",
                "obj_id": "1600000104"
            }
        }
    ]
}