latestOpenAPI 3.0.12026-07-263104131.9 MB

753f26d46650

Custom Tabs

Create a new Custom Tab

Create a Custom Tab with the provided details

post/v2/tab

namestring required

The display name to use for the custom tab

descriptionstring

The description to use for the custom tab

entityType'NODE_ROLE' | 'ORGANIZATION' | 'END_USER' | 'SYSTEM' | 'GLOBAL'

The type to use for the custom tab. Organizations and Locations share the same type of tab

entityIdinteger

For tab types that require an id to create (currently, only NODE_ROLE types), this field is the ID of the entity

positioninteger

The Custom Tab that was created

defaultboolean

idinteger

Tab ID

namestring

Display name of tab

descriptionstring

The description to use for the custom tab

entityType'NODE_ROLE' | 'ORGANIZATION' | 'END_USER' | 'SYSTEM' | 'GLOBAL'

The type of object the tab is for (ie, NODE_ROLE, ORGANIZATION, END_USER, etc)

entityIdinteger

For entity types that are bound to an ID, this will be the id of the object. Otherwise, omitted

parentTabIdinteger

For tab extensions, this will be the id of the tab that was extended (ie, the 'root tab')

positioninteger

Integer representing the position of the tab. Used when ordering multiple tabs

isDefaultboolean

True if this is a default tab, false otherwise