Vývojová dokumentace

GET

/devdocs

Získá kolekci BO Vývojová dokumentace

GET

/devdocs/meta/dataprotection

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

GET

/devdocs/views/{view}

Získá pohled nad BO Vývojová dokumentace

GET

/devdocs/{id}

Získá daný BO Vývojová dokumentace

GET

/devdocs/{id}/iseditlock

Otestuje, zda existuje editační zámek na daném BO Vývojová dokumentace

GET

/devdocs/{id}/meta/dataprotection

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

GET

/devdocs/{id}/userparameters

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

POST

/devdocs

Vytvoří nový BO Vývojová dokumentace

POST

/devdocs/query

Vyhodnotí query dotaz nad BO Vývojová dokumentace

PUT

/devdocs/{id}

Modifikuje daný BO Vývojová dokumentace

PUT

/devdocs/{id}/editlock

Vytvoří editační zámek na daném BO Vývojová dokumentace

PUT

/devdocs/{id}/editunlock

Zruší editační zámek na daném BO Vývojová dokumentace

DELETE

/devdocs/{id}

Smaže BO Vývojová dokumentace

Metadata - Perzistentní položky

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_id string (devblob) relace

Popis požadavku, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn', pole nepodporuje ochranu dat/GDPR

devbug_id string (devbug) relace

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

devdoc_id string (devdoc) relace

Zdrojová dokumentace, 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, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

documentedby_id string (securityuser) relace

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

elapsedtime number

Strávený čas, pole vlastněné tabulkou, možné řadit a filtrovat

estimatedtime number

Odhadovaný čas, pole vlastněné tabulkou, možné řadit a filtrovat

firm_id string (firm) relace

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

part_id string (devpart) relace

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

period_id string (period) relace

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

priority integer

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

product_id string (devproduct) relace

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

relatedto_id string (devblob) relace

Souvisí s, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn', pole nepodporuje ochranu dat/GDPR

relatedtohelp integer

Vazba na help, pole vlastněné tabulkou, možné řadit a filtrovat

releaseinfo string (500)

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

remainingtime number

Zbývající čas, pole vlastněné tabulkou, možné řadit a filtrovat

shortdesc string (100)

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

testdate$date string

Dat.testování, pole vlastněné tabulkou, možné řadit a filtrovat

tested integer

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

testedby_id string (securityuser) relace

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

topics string (220)

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

version_id string (devfutureversion) relace

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

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

newrelateddocument_id string (10)

ID dokladu pro připojení, fkAnsiCaseSensitive

newrelatedtype integer

Typ relace

remainingtimevaliditydate$date string

Datum platnosti, pouze pro čtení

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

GET

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

GET

https://atd.abra.eu/demodata/devdocs/{id}
Response
{
    "correctedby_id": null,
    "createdby_id": null,
    "description_id": null,
    "devbug_id": null,
    "devdoc_id": null,
    "docdate$date": null,
    "docqueue_id": null,
    "documentedby_id": null,
    "elapsedtime": null,
    "estimatedtime": null,
    "firm_id": null,
    "objversion": null,
    "ordnumber": null,
    "part_id": null,
    "period_id": null,
    "priority": null,
    "product_id": null,
    "relatedto_id": null,
    "relatedtohelp": null,
    "releaseinfo": null,
    "remainingtime": null,
    "shortdesc": null,
    "testdate$date": null,
    "tested": null,
    "testedby_id": null,
    "topics": null,
    "version_id": null
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/devdocs/query
{"take": "1"}
Response
{
    "correctedby_id": null,
    "createdby_id": null,
    "description_id": null,
    "devbug_id": null,
    "devdoc_id": null,
    "docdate$date": null,
    "docqueue_id": null,
    "documentedby_id": null,
    "elapsedtime": null,
    "estimatedtime": null,
    "firm_id": null,
    "objversion": null,
    "ordnumber": null,
    "part_id": null,
    "period_id": null,
    "priority": null,
    "product_id": null,
    "relatedto_id": null,
    "relatedtohelp": null,
    "releaseinfo": null,
    "remainingtime": null,
    "shortdesc": null,
    "testdate$date": null,
    "tested": null,
    "testedby_id": null,
    "topics": null,
    "version_id": null
}
Request

POST

https://atd.abra.eu/demodata/devdocs?select=id
Body
{
    "correctedby_id": null,
    "createdby_id": null,
    "description_id": null,
    "devbug_id": null,
    "devdoc_id": null,
    "docdate$date": null,
    "docqueue_id": null,
    "documentedby_id": null,
    "elapsedtime": null,
    "estimatedtime": null,
    "firm_id": null,
    "ordnumber": null,
    "part_id": null,
    "period_id": null,
    "priority": null,
    "product_id": null,
    "relatedto_id": null,
    "relatedtohelp": null,
    "releaseinfo": null,
    "remainingtime": null,
    "shortdesc": null,
    "testdate$date": null,
    "tested": null,
    "testedby_id": null,
    "topics": null,
    "version_id": null
}
Response
{
    "id": "1600000101"
}
Request

PUT

https://atd.abra.eu/demodata/devdocs/{id}?select=id
Body
{
    "correctedby_id": null,
    "createdby_id": null,
    "description_id": null,
    "devbug_id": null,
    "devdoc_id": null,
    "docdate$date": null,
    "docqueue_id": null,
    "documentedby_id": null,
    "elapsedtime": null,
    "estimatedtime": null,
    "firm_id": null,
    "ordnumber": null,
    "part_id": null,
    "period_id": null,
    "priority": null,
    "product_id": null,
    "relatedto_id": null,
    "relatedtohelp": null,
    "releaseinfo": null,
    "remainingtime": null,
    "shortdesc": null,
    "testdate$date": null,
    "tested": null,
    "testedby_id": null,
    "topics": null,
    "version_id": null
}
Response
{
    "id": "1600000101"
}

DELETE

https://atd.abra.eu/demodata/devdocs/{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": "devdocs",
                "object_data": {
                    "correctedby_id": null,
                    "createdby_id": null,
                    "description_id": null,
                    "devbug_id": null,
                    "devdoc_id": null,
                    "docdate$date": null,
                    "docqueue_id": null,
                    "documentedby_id": null,
                    "elapsedtime": null,
                    "estimatedtime": null,
                    "firm_id": null,
                    "ordnumber": null,
                    "part_id": null,
                    "period_id": null,
                    "priority": null,
                    "product_id": null,
                    "relatedto_id": null,
                    "relatedtohelp": null,
                    "releaseinfo": null,
                    "remainingtime": null,
                    "shortdesc": null,
                    "testdate$date": null,
                    "tested": null,
                    "testedby_id": null,
                    "topics": null,
                    "version_id": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "devdocs",
                "object_data": {
                    "correctedby_id": null,
                    "createdby_id": null,
                    "description_id": null,
                    "devbug_id": null,
                    "devdoc_id": null,
                    "docdate$date": null,
                    "docqueue_id": null,
                    "documentedby_id": null,
                    "elapsedtime": null,
                    "estimatedtime": null,
                    "firm_id": null,
                    "ordnumber": null,
                    "part_id": null,
                    "period_id": null,
                    "priority": null,
                    "product_id": null,
                    "relatedto_id": null,
                    "relatedtohelp": null,
                    "releaseinfo": null,
                    "remainingtime": null,
                    "shortdesc": null,
                    "testdate$date": null,
                    "tested": null,
                    "testedby_id": null,
                    "topics": null,
                    "version_id": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "devdocs",
                "obj_id": "1600000100",
                "object_data": {
                    "correctedby_id": null,
                    "createdby_id": null,
                    "description_id": null,
                    "devbug_id": null,
                    "devdoc_id": null,
                    "docdate$date": null,
                    "docqueue_id": null,
                    "documentedby_id": null,
                    "elapsedtime": null,
                    "estimatedtime": null,
                    "firm_id": null,
                    "ordnumber": null,
                    "part_id": null,
                    "period_id": null,
                    "priority": null,
                    "product_id": null,
                    "relatedto_id": null,
                    "relatedtohelp": null,
                    "releaseinfo": null,
                    "remainingtime": null,
                    "shortdesc": null,
                    "testdate$date": null,
                    "tested": null,
                    "testedby_id": null,
                    "topics": null,
                    "version_id": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "devdocs",
                "obj_id": "1600000101",
                "object_data": {
                    "correctedby_id": null,
                    "createdby_id": null,
                    "description_id": null,
                    "devbug_id": null,
                    "devdoc_id": null,
                    "docdate$date": null,
                    "docqueue_id": null,
                    "documentedby_id": null,
                    "elapsedtime": null,
                    "estimatedtime": null,
                    "firm_id": null,
                    "ordnumber": null,
                    "part_id": null,
                    "period_id": null,
                    "priority": null,
                    "product_id": null,
                    "relatedto_id": null,
                    "relatedtohelp": null,
                    "releaseinfo": null,
                    "remainingtime": null,
                    "shortdesc": null,
                    "testdate$date": null,
                    "tested": null,
                    "testedby_id": null,
                    "topics": null,
                    "version_id": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "devdocs",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "devdocs",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "devdocs",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "devdocs",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "devdocs",
                "obj_id": "1600000104"
            }
        }
    ]
}