Manage tabs¶

Get custom tabs for an entity¶

Returns the list of custom tabs for the given entity 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¶

Creates a new custom tab for the given entity type.

POST /{entityName}/tabs

Body:

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

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

Return value ID of the created tab.

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

Update existing custom tab¶

Updates the name or order of an existing custom tab.

PUT /{entityName}/tabs/{tabId}

Select:

{"Name", "Order"}

Body:

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

Delete custom tab¶

Deletes an existing custom tab by its ID.

DELETE /{entityName}/tabs/{tabId}