Skip to content

Manage tabs

Get custom tabs for an entity

Returns list of assemblies for the given type

GET /{entityName}/tabs

Output example:

[
    {
        "Name": "Book Labor",
        "Order": 0,
        "EntityType": "issue",
        "Id": "1a97acd9-27af-4ba6-b4f3-431f6c39a44d"
    }
]

Create a new custom tab for an entity

Create new custom tab for the given entity type

POST /{entityName}/tabs

Body:

{
    "Name" : "Permits",
    "Order" : 1
}

Order property defines the order of the tabs in the UI.

Return value Id of the created tab

{
    "Value": "b3bf0c6f-1fcc-4e4b-9eae-48798e94d258"
}

create_tab_result

Update existing custom tab

Update name or order of the existing custom tab

PUT /{entityName}/tabs/{tabId}

Select:

{"Name", "Order"}

Body:

{
    "Order" : 1,
    "Name" : "Permits*"
}

Delete custom tab

Delete existing custom tab by given id

DELETE /{entityName}/tabs/{tabId}