Hlavní inventární protokol

GET

/maininvprotocols

Získá kolekci BO Hlavní inventární protokol

GET

/maininvprotocols/{id}

Získá konkrétní BO Hlavní inventární protokol

POST

/maininvprotocols

Vytvoří nový BO Hlavní inventární protokol a vrátí jeho kompletní reprezentaci

PUT

/maininvprotocols/{id}

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

DELETE

/maininvprotocols/{id}

Smaže BO Hlavní inventární protokol na základě jeho ID

Metadata - Perzistentní položky

AddRowsFromPIP boolean

Přidávat řádky skladových karet z DIP, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

CheckDiffContents boolean

Kontrola rozdílu počtu na dílčích skladových kartách vůči počtu na pozicích, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

CheckSDocsInPreparation boolean

Kontrola na skladové pohyby ve stavu "V přípravě", pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

Closed boolean

Ukončen, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat

CorrectedBy_ID string (securityuser) relace

Opravil; ID objektu Uživatel, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

CreatedBy_ID string (securityuser) relace

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

DateOfEnd$DATE string

Rozhodné datum inventury, pole vlastněné tabulkou, možné řadit a filtrovat

Description string (500)

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

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; ID objektu Řada dokladů, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

InventoryType integer

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

IsLogistic boolean

Příznak, zda se jedná o inventuru polohovaného skladu, 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í; ID objektu Období, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

StartedAt$DATE string

Zahájení inventury, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat

StartingLogistic boolean

Zahájení polohování, pole vlastněné tabulkou, možné řadit a filtrovat

Store_ID string (store) relace

Sklad; ID objektu Sklad, 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 (24)

Číslo dok., pouze pro čtení

ID string (10)

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

InventoryTypeDesc string (25)

Popis typu inventury, pouze pro čtení

NewRelatedDocument_ID string (10)

ID dokladu pro připojení, fkAnsiCaseSensitive

NewRelatedType integer

Typ relace

Started boolean

Inventura zahájena

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request 
GET
https://atd.abra.eu/demodata/maininvprotocols?take=1
GET
https://atd.abra.eu/demodata/maininvprotocols/{id}
Response 
{
    "ID": "2100000101",
    "ObjVersion": 7,
    "DocQueue_ID": "1G00000101",
    "Period_ID": "1D00000101",
    "OrdNumber": 1,
    "DocDate$DATE": "2012-12-22T23:00:00.000Z",
    "CreatedBy_ID": "1A00000101",
    "CorrectedBy_ID": "1A00000101",
    "DateOfEnd$DATE": "2012-12-30T23:00:00.000Z",
    "Store_ID": "1500000101",
    "Closed": true,
    "Description": "Inventura výrobního skladu materiálu",
    "StartingLogistic": false,
    "InventoryType": 1,
    "AddRowsFromPIP": false,
    "StartedAt$DATE": "2013-05-23T09:55:13.156Z",
    "CheckDiffContents": true,
    "CheckSDocsInPreparation": true,
    "IsLogistic": false
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "maininvprotocols", "take": "1"}
POST
https://atd.abra.eu/demodata/maininvprotocols/query
{"take": "1"}
Response 
{
    "ID": "2100000101",
    "ObjVersion": 7,
    "DocQueue_ID": "1G00000101",
    "Period_ID": "1D00000101",
    "OrdNumber": 1,
    "DocDate$DATE": "2012-12-22T23:00:00.000Z",
    "CreatedBy_ID": "1A00000101",
    "CorrectedBy_ID": "1A00000101",
    "DateOfEnd$DATE": "2012-12-30T23:00:00.000Z",
    "Store_ID": "1500000101",
    "Closed": true,
    "Description": "Inventura výrobního skladu materiálu",
    "StartingLogistic": false,
    "InventoryType": 1,
    "AddRowsFromPIP": false,
    "StartedAt$DATE": "2013-05-23T09:55:13.156Z",
    "CheckDiffContents": true,
    "CheckSDocsInPreparation": true,
    "IsLogistic": false
}
Request 
POST
https://atd.abra.eu/demodata/maininvprotocols?select=id
Body 
{
    "AddRowsFromPIP": false,
    "CheckDiffContents": true,
    "CheckSDocsInPreparation": true,
    "CorrectedBy_ID": "1A00000101",
    "CreatedBy_ID": "1A00000101",
    "DateOfEnd$DATE": "2012-12-30T23:00:00.000Z",
    "Description": "Inventura výrobního skladu materiálu",
    "DocDate$DATE": "2012-12-22T23:00:00.000Z",
    "DocQueue_ID": "1G00000101",
    "InventoryType": 1,
    "IsLogistic": false,
    "OrdNumber": 1,
    "Period_ID": "1D00000101",
    "StartingLogistic": false,
    "Store_ID": "1500000101"
}
Response 
{
    "id": "2100000101"
}
Request 
PUT
https://atd.abra.eu/demodata/maininvprotocols/{id}?select=id
Body 
{
    "AddRowsFromPIP": false,
    "CheckDiffContents": true,
    "CheckSDocsInPreparation": true,
    "CorrectedBy_ID": "1A00000101",
    "CreatedBy_ID": "1A00000101",
    "DateOfEnd$DATE": "2012-12-30T23:00:00.000Z",
    "Description": "Inventura výrobního skladu materiálu",
    "DocDate$DATE": "2012-12-22T23:00:00.000Z",
    "DocQueue_ID": "1G00000101",
    "InventoryType": 1,
    "IsLogistic": false,
    "OrdNumber": 1,
    "Period_ID": "1D00000101",
    "StartingLogistic": false,
    "Store_ID": "1500000101"
}
Response 
{
    "id": "2100000101"
}
DELETE
https://atd.abra.eu/demodata/maininvprotocols/{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": "maininvprotocols",
                "object_data": {
                    "AddRowsFromPIP": false,
                    "CheckDiffContents": true,
                    "CheckSDocsInPreparation": true,
                    "CorrectedBy_ID": "1A00000101",
                    "CreatedBy_ID": "1A00000101",
                    "DateOfEnd$DATE": "2012-12-30T23:00:00.000Z",
                    "Description": "Inventura výrobního skladu materiálu",
                    "DocDate$DATE": "2012-12-22T23:00:00.000Z",
                    "DocQueue_ID": "1G00000101",
                    "InventoryType": 1,
                    "IsLogistic": false,
                    "OrdNumber": 1,
                    "Period_ID": "1D00000101",
                    "StartingLogistic": false,
                    "Store_ID": "1500000101"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "maininvprotocols",
                "object_data": {
                    "AddRowsFromPIP": false,
                    "CheckDiffContents": true,
                    "CheckSDocsInPreparation": true,
                    "CorrectedBy_ID": "1A00000101",
                    "CreatedBy_ID": "1A00000101",
                    "DateOfEnd$DATE": "2012-12-30T23:00:00.000Z",
                    "Description": "Inventura výrobního skladu materiálu",
                    "DocDate$DATE": "2012-12-22T23:00:00.000Z",
                    "DocQueue_ID": "1G00000101",
                    "InventoryType": 1,
                    "IsLogistic": false,
                    "OrdNumber": 1,
                    "Period_ID": "1D00000101",
                    "StartingLogistic": false,
                    "Store_ID": "1500000101"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "maininvprotocols",
                "obj_id": "2100000100",
                "object_data": {
                    "AddRowsFromPIP": false,
                    "CheckDiffContents": true,
                    "CheckSDocsInPreparation": true,
                    "CorrectedBy_ID": "1A00000101",
                    "CreatedBy_ID": "1A00000101",
                    "DateOfEnd$DATE": "2012-12-30T23:00:00.000Z",
                    "Description": "Inventura výrobního skladu materiálu",
                    "DocDate$DATE": "2012-12-22T23:00:00.000Z",
                    "DocQueue_ID": "1G00000101",
                    "InventoryType": 1,
                    "IsLogistic": false,
                    "OrdNumber": 1,
                    "Period_ID": "1D00000101",
                    "StartingLogistic": false,
                    "Store_ID": "1500000101"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "maininvprotocols",
                "obj_id": "2100000101",
                "object_data": {
                    "AddRowsFromPIP": false,
                    "CheckDiffContents": true,
                    "CheckSDocsInPreparation": true,
                    "CorrectedBy_ID": "1A00000101",
                    "CreatedBy_ID": "1A00000101",
                    "DateOfEnd$DATE": "2012-12-30T23:00:00.000Z",
                    "Description": "Inventura výrobního skladu materiálu",
                    "DocDate$DATE": "2012-12-22T23:00:00.000Z",
                    "DocQueue_ID": "1G00000101",
                    "InventoryType": 1,
                    "IsLogistic": false,
                    "OrdNumber": 1,
                    "Period_ID": "1D00000101",
                    "StartingLogistic": false,
                    "Store_ID": "1500000101"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "maininvprotocols",
                "obj_id": "2100000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "maininvprotocols",
                "obj_id": "2100000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "maininvprotocols",
                "obj_id": "2100000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "maininvprotocols",
                "obj_id": "2100000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "maininvprotocols",
                "obj_id": "2100000104"
            }
        }
    ]
}