Vývojová dokumentace

GET

/devdocs

Získá kolekci BO Vývojová dokumentace

GET

/devdocs/{id}

Získá konkrétní BO Vývojová dokumentace

POST

/devdocs

Vytvoří nový BO Vývojová dokumentace a vrátí jeho kompletní reprezentaci

PUT

/devdocs/{id}

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

DELETE

/devdocs/{id}

Smaže BO Vývojová dokumentace na základě jeho ID

Metadata - Perzistentní položky

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

Description_ID

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; ID objektu Vývojový 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; ID objektu Vývojová 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; ID objektu Řada dokladů, 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; ID objektu Uživatel, 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; ID objektu 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; ID objektu Část vývojových produktů, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

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

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

RelatedToHelp integer

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

RelatedTo_ID

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

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; ID objektu Uživatel, 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; ID objektu Plánovaná verze vývojového produktu, 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,
    "ID": null,
    "ObjVersion": null,
    "OrdNumber": null,
    "Part_ID": null,
    "Period_ID": null,
    "Priority": null,
    "Product_ID": null,
    "RelatedToHelp": null,
    "RelatedTo_ID": 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,
    "ID": null,
    "ObjVersion": null,
    "OrdNumber": null,
    "Part_ID": null,
    "Period_ID": null,
    "Priority": null,
    "Product_ID": null,
    "RelatedToHelp": null,
    "RelatedTo_ID": 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,
    "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,
    "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,
    "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,
    "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,
                    "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,
                    "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,
                    "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,
                    "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,
                    "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,
                    "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,
                    "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,
                    "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"
            }
        }
    ]
}