Expediční list

GET

/shippinglists

Získá kolekci BO Expediční list

GET

/shippinglists/meta/dataprotection

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

GET

/shippinglists/views/{view}

Získá pohled nad BO Expediční list

GET

/shippinglists/{id}

Získá daný BO Expediční list

GET

/shippinglists/{id}/iseditlock

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

GET

/shippinglists/{id}/meta/dataprotection

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

GET

/shippinglists/{id}/rows

Získá řádky kolekce Expediční list - řádek

GET

/shippinglists/{id}/rows/{id1}

Získá daný řádek kolekce Expediční list - řádek

GET

/shippinglists/{id}/userparameters

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

POST

/shippinglists

Vytvoří nový BO Expediční list

POST

/shippinglists/query

Vyhodnotí query dotaz nad BO Expediční list

POST

/shippinglists/{id}/rows

Vytvoří nový řádek v kolekci Expediční list - řádek

POST

/shippinglists/import/billsofdelivery

ZASTARALÉ! Provede import v těle specifikovaných zdrojových dokladů do nového cílového dokladu

POST

/shippinglists/import/billsofdelivery/{source_doc_id}

ZASTARALÉ! Provede import v url specifikovaného zdrojového dokladu do nového cílového dokladu

POST

/shippinglists/import/materialdistributions

ZASTARALÉ! Provede import v těle specifikovaných zdrojových dokladů do nového cílového dokladu

POST

/shippinglists/import/materialdistributions/{source_doc_id}

ZASTARALÉ! Provede import v url specifikovaného zdrojového dokladu do nového cílového dokladu

POST

/shippinglists/import/outgoingtransfers

ZASTARALÉ! Provede import v těle specifikovaných zdrojových dokladů do nového cílového dokladu

POST

/shippinglists/import/outgoingtransfers/{source_doc_id}

ZASTARALÉ! Provede import v url specifikovaného zdrojového dokladu do nového cílového dokladu

PUT

/shippinglists/{id}

Modifikuje daný BO Expediční list

PUT

/shippinglists/{id}/editlock

Vytvoří editační zámek na daném BO Expediční list

PUT

/shippinglists/{id}/editunlock

Zruší editační zámek na daném BO Expediční list

PUT

/shippinglists/{id}/rows/{id1}

Modifikuje řádek v kolekci Expediční list - řádek

PUT

/shippinglists/{dest_doc_id}/import/billsofdelivery

ZASTARALÉ! Provede import v těle specifikovaných zdrojových dokladů do již existujícího cílového dokladu

PUT

/shippinglists/{dest_doc_id}/import/billsofdelivery/{source_doc_id}

ZASTARALÉ! Provede import v url specifikovaného zdrojového dokladu do již existujícího cílového dokladu

PUT

/shippinglists/{dest_doc_id}/import/materialdistributions

ZASTARALÉ! Provede import v těle specifikovaných zdrojových dokladů do již existujícího cílového dokladu

PUT

/shippinglists/{dest_doc_id}/import/materialdistributions/{source_doc_id}

ZASTARALÉ! Provede import v url specifikovaného zdrojového dokladu do již existujícího cílového dokladu

PUT

/shippinglists/{dest_doc_id}/import/outgoingtransfers

ZASTARALÉ! Provede import v těle specifikovaných zdrojových dokladů do již existujícího cílového dokladu

PUT

/shippinglists/{dest_doc_id}/import/outgoingtransfers/{source_doc_id}

ZASTARALÉ! Provede import v url specifikovaného zdrojového dokladu do již existujícího cílového dokladu

DELETE

/shippinglists/{id}

Smaže BO Expediční list

DELETE

/shippinglists/{id}/rows/{id1}

Smaže řádek z kolekce Expediční list - řádek

Metadata - Perzistentní položky

address_id string (address) relace

Vlastní adresa, pole vlastněné tabulkou, možné řadit a filtrovat

correctedat$date string

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

correctedby_id string (securityuser) relace

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

createdat$date string

Vytvořeno, 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 (50)

Popis, 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

docdate$date string

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

docqueue_id string (docqueue) relace

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

firm_id string (firm) relace

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

firmoffice_id string (firmoffice) relace

Provozovna, 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

ordnumber integer

Pořadové číslo, pole vlastněné tabulkou, možné řadit a filtrovat

period_id string (period) relace

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

person_id string (person) relace

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

pmstate_id string (pmstate) relace

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

responsiblerole_id string (securityrole) relace

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

responsibleuser_id string (securityuser) relace

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

rows array (shippinglistrow) relace

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

transportationtype_id string (transportationtype) relace

Způsob dopravy, 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

Metadata - Neperzistentní položky

capacity number

Celk.obj.

capacityunit integer

Jedn.celk.obj.

classid string (26)

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

displayname string (24)

Číslo dok., pouze pro čtení

id string (10)

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

newrelateddocument_id string (10)

ID dokladu pro připojení, fkAnsiCaseSensitive

newrelatedtype integer

Typ relace

weight number

Celk.hmot.

weightunit integer

Jedn.celk.hm.

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request

GET

https://atd.abra.eu/demodata/shippinglists?take=1

GET

https://atd.abra.eu/demodata/shippinglists/{id}
Response
{
    "address_id": null,
    "correctedat$date": null,
    "correctedby_id": null,
    "createdat$date": null,
    "createdby_id": null,
    "description": null,
    "docdate$date": null,
    "docqueue_id": null,
    "firm_id": null,
    "firmoffice_id": null,
    "objversion": null,
    "ordnumber": null,
    "period_id": null,
    "person_id": null,
    "pmstate_id": null,
    "responsiblerole_id": null,
    "responsibleuser_id": null,
    "rows": null,
    "transportationtype_id": null
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/shippinglists/query
{"take": "1"}
Response
{
    "address_id": null,
    "correctedat$date": null,
    "correctedby_id": null,
    "createdat$date": null,
    "createdby_id": null,
    "description": null,
    "docdate$date": null,
    "docqueue_id": null,
    "firm_id": null,
    "firmoffice_id": null,
    "objversion": null,
    "ordnumber": null,
    "period_id": null,
    "person_id": null,
    "pmstate_id": null,
    "responsiblerole_id": null,
    "responsibleuser_id": null,
    "rows": null,
    "transportationtype_id": null
}
Request

POST

https://atd.abra.eu/demodata/shippinglists?select=id
Body
{
    "address_id": null,
    "correctedat$date": null,
    "correctedby_id": null,
    "createdat$date": null,
    "createdby_id": null,
    "description": null,
    "docdate$date": null,
    "docqueue_id": null,
    "firm_id": null,
    "firmoffice_id": null,
    "ordnumber": null,
    "period_id": null,
    "person_id": null,
    "pmstate_id": null,
    "responsiblerole_id": null,
    "responsibleuser_id": null,
    "rows": null,
    "transportationtype_id": null
}
Response
{
    "id": "1600000101"
}
Request

PUT

https://atd.abra.eu/demodata/shippinglists/{id}?select=id
Body
{
    "address_id": null,
    "correctedat$date": null,
    "correctedby_id": null,
    "createdat$date": null,
    "createdby_id": null,
    "description": null,
    "docdate$date": null,
    "docqueue_id": null,
    "firm_id": null,
    "firmoffice_id": null,
    "ordnumber": null,
    "period_id": null,
    "person_id": null,
    "pmstate_id": null,
    "responsiblerole_id": null,
    "responsibleuser_id": null,
    "rows": null,
    "transportationtype_id": null
}
Response
{
    "id": "1600000101"
}

DELETE

https://atd.abra.eu/demodata/shippinglists/{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": "shippinglists",
                "object_data": {
                    "address_id": null,
                    "correctedat$date": null,
                    "correctedby_id": null,
                    "createdat$date": null,
                    "createdby_id": null,
                    "description": null,
                    "docdate$date": null,
                    "docqueue_id": null,
                    "firm_id": null,
                    "firmoffice_id": null,
                    "ordnumber": null,
                    "period_id": null,
                    "person_id": null,
                    "pmstate_id": null,
                    "responsiblerole_id": null,
                    "responsibleuser_id": null,
                    "rows": null,
                    "transportationtype_id": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "shippinglists",
                "object_data": {
                    "address_id": null,
                    "correctedat$date": null,
                    "correctedby_id": null,
                    "createdat$date": null,
                    "createdby_id": null,
                    "description": null,
                    "docdate$date": null,
                    "docqueue_id": null,
                    "firm_id": null,
                    "firmoffice_id": null,
                    "ordnumber": null,
                    "period_id": null,
                    "person_id": null,
                    "pmstate_id": null,
                    "responsiblerole_id": null,
                    "responsibleuser_id": null,
                    "rows": null,
                    "transportationtype_id": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "shippinglists",
                "obj_id": "1600000100",
                "object_data": {
                    "address_id": null,
                    "correctedat$date": null,
                    "correctedby_id": null,
                    "createdat$date": null,
                    "createdby_id": null,
                    "description": null,
                    "docdate$date": null,
                    "docqueue_id": null,
                    "firm_id": null,
                    "firmoffice_id": null,
                    "ordnumber": null,
                    "period_id": null,
                    "person_id": null,
                    "pmstate_id": null,
                    "responsiblerole_id": null,
                    "responsibleuser_id": null,
                    "rows": null,
                    "transportationtype_id": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "shippinglists",
                "obj_id": "1600000101",
                "object_data": {
                    "address_id": null,
                    "correctedat$date": null,
                    "correctedby_id": null,
                    "createdat$date": null,
                    "createdby_id": null,
                    "description": null,
                    "docdate$date": null,
                    "docqueue_id": null,
                    "firm_id": null,
                    "firmoffice_id": null,
                    "ordnumber": null,
                    "period_id": null,
                    "person_id": null,
                    "pmstate_id": null,
                    "responsiblerole_id": null,
                    "responsibleuser_id": null,
                    "rows": null,
                    "transportationtype_id": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "shippinglists",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "shippinglists",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "shippinglists",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "shippinglists",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "shippinglists",
                "obj_id": "1600000104"
            }
        }
    ]
}