Tab Manager (REST)

{
    "tab": {
        "Name": "Aliases1234",
        "Order": 100,
        "LinkType": 3,
        "ObjectType": {
            "ArtifactTypeID": 10
        },
        "IsVisible": true,
        "Parent": {
            "Secured": false,
            "Value": {
                "ArtifactID": 1003663
            }
        }
    }
}

The following table lists the available IconIdentifier values:

public async Task<int?> CreateTabExample()
{
    int? result = null;
    using (HttpClient client = new HttpClient())
    {
        client.DefaultRequestHeaders.Add("X-CSRF-Header", "-");
        client.DefaultRequestHeaders.Add("Authorization", "Basic " + Convert.ToBase64String(Encoding.GetEncoding("ISO-8859-1").GetBytes("test@test.com:SomePassword")));
        client.DefaultRequestHeaders.Add("X-Kepler-Version", "2.0");
        client.BaseAddress = new Uri("https://localhost/");
     
        var tabName = "SomeNewTab";
        var order = 100;
     
        string inputJSON = $"{{\"tab\":{{ \"Name\": \"{tabName}\", \"Order\":  \"{order}\", \"LinkType\": 3, \"IsVisible\": true, \"Parent\": {{\"Value\": {{\"ArtifactID\": 1003663 }} }} }} }}";
        var url = "/Relativity.REST/API/relativity-data-visualization/v1/workspaces/-1/tabs/";
        var response = await client.PostAsync(url, new StringContent(inputJSON, Encoding.UTF8, "application/json"));
        response.EnsureSuccessStatusCode();
        var content = await response.Content.ReadAsStringAsync();
        result = JsonConvert.DeserializeObject<int>(content);
    }
     
    return result;
}

The body of the request contains the following fields:

• tabRequest - represents a TabRequest object. This object contains optional fields that aren't required to create a tab, such as RelativityApplications, ObjectType, and IsDefault fields. Any fields on this object not included in the JSON request are automatically set to null or a default value. For more information, see JSON payloads for create and update operations.
  • Name - the user-friendly name of the tab.
  • Order - the numerical value designating the position of the tab in the Relativity UI. For information about the order of tabs in a workspace, see Retrieve tab orders.
  • LinkType - indicates type of link associated with the tab. For example, a parent type indicates that the tab may have sub-tabs.

    The following table summarizes the values used to represent link types:

    Name	Value	Description
    Unknown	0	Indicates an unknown link type.
    Object	1	Indicates that the tab links to a Relativity object.
    Link	2	Indicates that the tab links to a URL.
    Parent	3	Indicates that the tab may have sub-tabs.

    Available link types are included on the TabLinkTypeEnum enumeration.

  • IsVisible - a Boolean value indicating whether the tab is displayed in a workspace.
  • Parent - contains the following fields for the parent tab:
    • Secured - a Boolean value indicating whether the current user has permission to view the settings in the Value field.
    • Value - an object containing Artifact ID or the GUIDs used to identify the parent tab:
      • ArtifactID - the Artifact ID of the parent tab.
      • Guids - an array of GUIDs for the parent tab.
  • RelativityApplications - a list of items that describe the applications that contain the current tab. Each item contains the following fields:
    • ArtifactID - the Artifact ID of the application.
    • Guids - an array of GUIDs for the application.
  • ObjectType - contains information about the object type that you want associated with the tab. These fields are only required for creating a tab with an object link type:
    • Secured - indicates whether the current user has permission to view the setting in the Value field.
    • Value - an object containing object type identifiers:
      • ArtifactTypeID - the ID of the Artifact Type of the object.
      • ArtifactID - the Artifact ID of the object type.
      • Guids - the GUIDs for the object type.
      • Name - the name of the object type.

    Note: You can only create one tab per object type. After you create a tab for an object type, you can't reuse the Artifact ID to create another tab. Making a call with the Artifact ID returns an Invalid ObjectType error.

  • Link - a link to a URL. This field is only required for a creating a tab with an external type link.
  • IsDefault - a Boolean value indicating whether the tab should be the first tab that you access when navigating to the parent tab.
  • IsShownInSidebar - a Boolean value indicating whether the tab should be displayed in the sidebar.
  • IconIdentifier - the string identifier for the icon displayed when the tab is listed in the sidebar. For valid values, see IconIdentifier field.

{
  "tabRequest": {
    "Name": "Tab - Object",
    "Order": 100,
    "LinkType": 1,
    "IsVisible": true,
    "Parent": {
      "Secured": false,
      "Value": {
        "ArtifactID": 1436126
      }
    },
    "ObjectType": {
      "Secured": false,
      "Value": {
          "ArtifactTypeID": 1000045
      }
    }
  }
}

{
  "tabRequest": {
    "Name": "Tab - Link",
    "Order": 100,
    "LinkType": 2,
    "IsVisible": true,
    "Parent": {
      "Secured": false,
      "Value": {
        "ArtifactID": 1436126
      }
    },
    "Link": "%ApplicationPath%/Admin/LinkTabExample/Example.aspx?%AppID%"
  }
}

{
   "tabRequest":{
      "Name":"Aliases1234",
      "Order": 100,
      "LinkType":3,
      "IsVisible":true,
      "Parent":{
         "Secured": false,
         "Value": {
            "ArtifactID": 1003663
         }
      }
   }
}

The response contains a TabResponse object with the following fields:

• ObjectIdentifier - an object containing identifying information for the tab as follows:
  • Name - the user-friendly name of the tab.
  • ArtifactID - the Artifact ID of the tab.
  • Guids - an array of GUIDs used to identify the tab.
• Order - the numerical value designating the position of the tab in the Relativity UI.
• Link - a link to a URL. This field is only required for a tab with an external type link.
• IsDefault - a Boolean value indicating whether this tab is the first one displayed to the users when they access a workspace. For more information, see Tabs on the RelativityOne Documentation site.
• IsVisible - a Boolean value indicating whether the tab is displayed in a workspace.
• IsShownInSidebar - a Boolean value indicating whether the tab should be displayed in the sidebar.
• RelativityApplications - contains the following fields:
  • HasSecuredItems - a Boolean value indicating whether the list contains one or more items that aren't accessible to the current user.
  • ViewableItems - a list of items (accessible to the current user) that describe the applications that contain the current tab. Each item contains the following fields:
    • ArtifactID - the Artifact ID of the application.
    • Name - the name of the application.
    • Guids - GUIDs used to identify the application.
• LinkType - indicates type of link associated with the tab. For more information on link types, see Create a tab.
• CreatedOn - the date and time when the tab was added to Relativity.
• CreatedBy - contains the following fields that represent the user who created the Tab:
  • Secured - indicates whether the current user has permission to view the setting in the Value field.
  • Value - contains the following fields:
    • ArtifactID - the Artifact ID of the user.
    • Name - the name of the user.
    • Guids - GUIDs used to identify the user.
• LastModifiedBy - contains the following fields that represent the user who last modified the Tab:
  • Secured - indicates whether the current user has permission to view the setting in the Value field.
  • Value - contains the following fields:
    • ArtifactID - the Artifact ID of the user.
    • Name - the name of the user.
    • Guids - GUIDs used to identify the user.
• Meta - provides additional information available as extended metadata. It includes the following fields:
  • Unsupported - an array of fields not supported on the current instance of this tab.
  • ReadOnly - an array of tab fields that can't be modified, such its name or link.
• Actions - an array of Action objects indicating operations that you have permissions to perform on this tab. For example, you may not have permissions to modify a tab that is part of a locked application. Each Action object contains the following fields that are available as extended metadata:
  • Name - the name of an operation available through REST for the tab, such as delete, update, and so on.
  • Href - the URL used to make an HTTP request for the operation.
  • Verb - the name of the HTTP method for the operation.
  • IsAvailable - a Boolean value indicating whether you have permissions to perform the operation on this tab.
  • Reason - an explanation for the unavailability of an action.
• ObjectType - contains information about the object type that you want associated with the tab. These fields are only required for a tab with an object link type:
  • Secured - a Boolean value indicating whether the current user has permission to view the settings in the Value field.
  • Value - an object containing identifying information for the object type:
    • ArtifactTypeID - the ID of the Artifact Type of the object.

    • ArtifactID - the Artifact ID of the object type.

    • Guids - an array of GUIDs used to identify the object type.

    • Name - the user-friendly name of the object type.

• Parent - contains the following fields for the parent tab:
  • Secured - a Boolean value indicating whether the current user has permission to view the settings in the Value field.
  • Value - contains the following fields:
    • Name - the user-friendly name of the parent tab.
    • ArtifactID - the Artifact ID of the parent tab.
    • Guids - an array of GUIDs used to identify the parent tab.
• IconIdentifier - the string identifier for the icon displayed when the tab is listed in the sidebar. For a list of valid values, see IconIdentifier field.
• LastModifiedOn - the date and time when the tab was most recently modified.

{
    "ObjectIdentifier": {
        "Name": "Workspaces",
        "ArtifactID": 1015520,
        "Guids": []
    },
    "Order": -1000,
    "IsDefault": true,
    "IsVisible": true,
    "IsShownInSidebar": true,
    "RelativityApplications": {
        "HasSecuredItems": false,
        "ViewableItems": []
    },
    "LinkType": "Object",
    "CreatedOn": "2014-09-29T15:32:47.187",
    "ObjectType": {
        "Secured": false,
        "Value": {
            "ArtifactTypeID": 8,
            "Name": "Workspace",
            "ArtifactID": 1016187,
            "Guids": []
        }
    },
    "Parent": {
        "Secured": false,
        "Value": {
            "Name": "System",
            "ArtifactID": 62,
            "Guids": [
                "bd10a60d-b8ec-4928-84ee-6fc4f30d9612"
            ]
        }
    },
    "IconIdentifier": "sidebar-workspaces",
    "CreatedBy": {
        "Secured": false,
        "Value": {
            "Name": "User1",
            "ArtifactID": 1000987,
            "Guids": []
        }
    },
    "LastModifiedBy": {
        "Secured": false,
        "Value": {
            "Name": "User2",
            "ArtifactID": 1000777,
            "Guids": []
        }
    },
    "Meta": {
        "Unsupported": [
            "RelativityApplications"
        ],
        "ReadOnly": []
    },
    "Actions": [
        {
            "Name": "Delete",
            "Href": "relativity-data-visualization/v1/workspaces/-1/tabs/1015520",
            "Verb": "DELETE",
            "IsAvailable": false,
            "Reason": [
                "This tab cannot be deleted because it is a system tab."
            ]
        },
        {
            "Name": "Update",
            "Href": "relativity-data-visualization/v1/workspaces/-1/tabs/1015520",
            "Verb": "PUT",
            "IsAvailable": true,
            "Reason": []
        }
    ],
    "LastModifiedOn": "2020-07-07T19:33:02.72"
}

{
    "ObjectIdentifier": {
        "Name": "Workspaces",
        "ArtifactID": 1015520,
        "Guids": []
    },
    "Order": -1000,
    "IsDefault": true,
    "IsVisible": true,
    "IsShownInSidebar": true,
    "RelativityApplications": {
        "HasSecuredItems": false,
        "ViewableItems": []
    },
    "LinkType": "Object",
    "CreatedOn": "2014-09-29T15:32:47.187",
    "ObjectType": {
        "Secured": false,
        "Value": {
            "ArtifactTypeID": 8,
            "Name": "Workspace",
            "ArtifactID": 1016187,
            "Guids": []
        }
    },
    "Parent": {
        "Secured": false,
        "Value": {
            "Name": "System",
            "ArtifactID": 62,
            "Guids": [
                "bd10a60d-b8ec-4928-84ee-6fc4f30d9612"
            ]
        }
    },
    "IconIdentifier": "sidebar-workspaces",
    "CreatedBy": {
        "Secured": false,
        "Value": {
            "Name": "User1",
            "ArtifactID": 1000987,
            "Guids": []
        }
    },
    "LastModifiedBy": {
        "Secured": false,
        "Value": {
            "Name": "User2",
            "ArtifactID": 1000777,
            "Guids": []
        }
    },
    "Meta": {
        "Unsupported": [
            "RelativityApplications"
        ],
        "ReadOnly": []
    },
    "Actions": [
        {
            "Name": "Delete",
            "Href": "relativity-data-visualization/v1/workspaces/-1/tabs/1015520",
            "Verb": "DELETE",
            "IsAvailable": false,
            "Reason": [
                "This tab cannot be deleted because it is a system tab."
            ]
        },
        {
            "Name": "Update",
            "Href": "relativity-data-visualization/v1/workspaces/-1/tabs/1015520",
            "Verb": "PUT",
            "IsAvailable": true,
            "Reason": []
        }
    ],
    "LastModifiedOn": "2020-07-07T19:33:02.72"
}

The body of the request depends on the type of link used for the tab. The sample JSON requests contain the various fields from the following list:

• tabRequest - represents a TabRequest object. This object has some fields that aren't required to update a tab, such as RelativityApplications field, ObjectType, and IsDefault fields. Any field on this object not included in the JSON request are automatically set to null or a default value. For more information, see JSON payloads for create and update operations.
  • Name - the user-friendly name of the tab.
  • Order - the numerical value designating the position of the tab in the Relativity UI.
  • IsDefault - a Boolean value indicating whether the tab should be the first tab that you access when navigating to the parent tab.
  • IsVisible - a Boolean value indicating whether the tab is displayed in a workspace.
  • IsShownInSidebar - a Boolean value indicating whether the tab should be displayed in the sidebar.
  • LinkType - indicates type of link associated with the tab. For more information on link types, see Create a tab.
  • Link - a link to a URL. This field is only required for a creating a tab with an external type link.

  • Parent - contains the following fields for the parent tab:

    • Secured - a Boolean value indicating whether the current user has permission to view the settings in the Value field.
    • Value - contains the following fields:
      • ArtifactID - the Artifact ID of the parent tab.
      • Guids - the GUIDs used to identify the parent tab.
• ObjectType - contains information about the object type that you want associated with the tab. These fields are only required for a tab with an object link type:
  • Secured - a Boolean value indicating whether the current user has permission to view the settings in the Value field.
  • Value - an object containing identifying information for the object type:
    • ArtifactTypeID - the ID of the Artifact Type of the object.

    • ArtifactID - the Artifact ID of the object type.

    • Guids - an array of GUIDs used to identify the object type.

    • Name - the user-friendly name of the object type.

    Note: You can only create one tab per object type. After you create a tab for an object type, you can't reuse the Artifact ID to create another tab. Making a call with the Artifact ID returns an Invalid ObjectType error.

• IconIdentifier - the string identifier for the icon displayed when the tab is listed in the sidebar. For a list of valid values, see IconIdentifier field.

{
  "tabRequest": {
    "Name": "Updated Tab - Object",
    "Order": 100,
    "LinkType": 1,
    "IsVisible": true,
    "Parent": {
      "Secured": false,
      "Value": {
        "ArtifactID": 1436126
      }
    },
    "ObjectType": {
      "Secured": false,
      "Value": {
          "ArtifactTypeID": 1000045
      }
    }
  }
}

{
  "tabRequest": {
    "Name": " Updated Tab - Link",
    "Order": 3,
    "LinkType": 2,
    "Link": "%ApplicationPath%/Admin/LinkTabExample/Example.aspx?%AppID%",
    "IsVisible": true,
    "Parent": {
      "Secured": false,
      "Value": {
        "ArtifactID":1003663
      }
    }
  }
}

{
  "tabRequest": {
    "Name": "Alias",
    "Order": 20,
    "IsDefault": false,
    "IsVisible": true,
    "IsShownInSidebar": true,
    "LinkType": "Parent",
    "Parent": {
      "Secured": false,
      "Value": {
        "ArtifactID": 62
      }
    },
    "IconIdentifier": "sidebar-access"
  }
}

{
    "ObjectIdentifier": {
        "Name": "Aliases12345",
        "ArtifactID": 1018257,
        "Guids": []
    },
    "Order": 100,
    "IsDefault": false,
    "IsVisible": true,
    "IsShownInSidebar": false,
    "RelativityApplications": {
        "HasSecuredItems": false,
        "ViewableItems": []
    },
    "LinkType": "Parent",
    "CreatedOn": "2020-10-27T12:04:35.087",
    "ObjectType": {
        "Secured": false
    },
    "Parent": {
        "Secured": false,
        "Value": {
            "Name": "User and Group Management",
            "ArtifactID": 1015494,
            "Guids": []
        }
    },
    "CreatedBy": {
        "Secured": false,
        "Value": {
            "Name": "User1",
            "ArtifactID": 1000987,
            "Guids": []
        }
    },
    "LastModifiedBy": {
        "Secured": false,
        "Value": {
            "Name": "User1",
            "ArtifactID": 1000987,
            "Guids": []
        }
    },
    "LastModifiedOn": "2020-10-27T12:06:47.947"
}

The response contains the following fields:

• ArtifactTypeID - the Artifact Type ID of the object type.
• Name - the user-friendly name of the object type.
• ArtifactID - the Artifact ID of the object type.
• Guids - an array of GUIDs used to identify the object type.

[
    {
        "ArtifactTypeID": 1000008,
        "Name": "Scope",
        "ArtifactID": 1016340,
        "Guids": []
    },
    {
        "ArtifactTypeID": 1000012,
        "Name": "Sanitizer",
        "ArtifactID": 1016493,
        "Guids": []
    }
]

The response contains the following fields:

• ObjectIdentifier - an object containing identifying information for the parent tab as follows:
  • ArtifactID - the Artifact ID of the parent tab.
  • Name - the user-friendly name of the parent tab.
  • Guids - an array of GUIDs used to identify the parent tab.

• SupportedChildTypeLinkTypes - an array of link types that a child tab can have.

Name	Value	Description
Object	1	Indicates that the tab links to a Relativity object.
Link	2	Indicates that the tab links to a URL.
Parent	3	Indicates that the tab may have sub-tabs.

[
    {
        "ObjectIdentifier": {
            "Name": "Other Tabs",
            "ArtifactID": 1018230,
            "Guids": []
        },
        "SupportedChildTypeLinkTypes": [
            "Object",
            "Link",
            "Parent"
        ]
    }
]

The response contains the following fields:

• ObjectIdentifier - an object containing identifying information for the tab as follows:
  • ArtifactID - the Artifact ID of the tab.
  • Name - the user-friendly name of the tab.
  • Guids - an array of GUIDs used to identify the tab.
• Parent - contains the following fields for the parent tab:
  • Secured - a Boolean value indicating whether the current user has permission to view the settings in the Value field.
  • Value - contains the following fields:
    • ArtifactID - the Artifact ID of the parent tab.
    • Guids - the GUIDs used to identify the parent tab.
• Order - the numerical value designating the position of the tab in the Relativity UI.

[
    {
        "ObjectIdentifier": {
            "Name": "Workspaces",
            "ArtifactID": 1015520,
            "Guids": []
        },
        "Parent": {
            "Secured": false,
            "Value": {
                "ArtifactID": 62,
                "Guids": []
            }
        },
        "Order": -1000
    },
    {
        "ObjectIdentifier": {
            "Name": "User Status",
            "ArtifactID": 1014996,
            "Guids": []
        },
        "Parent": {
            "Secured": false,
            "Value": {
                "ArtifactID": 62,
                "Guids": []
            }
        },
        "Order": -10
    }]

• ObjectIdentifier - an object containing identifying information for the tab as follows:
  • Name - the user-friendly name of the tab.
  • ArtifactID - the Artifact ID of the tab.
  • Guids - an array of GUIDs used to identify the tab.
• ObjectType - contains information about the object type that you want associated with the tab. These fields are only required for a tab with an object link type:
  • Secured - a Boolean value indicating whether the current user has permission to view the settings in the Value field.
  • Value - an object containing identifying information for the object type:
    • ArtifactTypeID - the ID of the Artifact Type of the object.
    • Name - the user-friendly name of the object type.
    • ArtifactID - the Artifact ID of the object type.
    • Guids - an array of GUIDs used to identify the object type.
• ObjectTypeIdentifier - contains the following fields for the object type associated with the tab. If an exception occurs when populating this value, the Tab is returned but this property is omitted. See the following fields:
  • Secured - a Boolean value indicating whether the current user has permission to view the settings in the Value field.
  • Value - contains the following fields:
    • Name - the user-friendly name of the object type.
    • ArtifactTypeID - the ID of the Artifact Type of the object.
    • ArtifactID - the Artifact ID of the object type.
    • Guids - an array of GUIDs used to identify the object type.
• LinkType - indicates type of link associated with the tab. For more information on link types, see Create a tab.
• Order - the numerical value designating the position of the tab in the Relativity UI.
• IsDefault - a Boolean value indicating whether this tab is the first one displayed to the users when they access a workspace. For more information, see Tabs on the RelativityOne Documentation site.
• IsVisible - a Boolean value indicating whether the tab is displayed in a workspace.
• IsShownInSidebar - a Boolean value indicating whether the tab should be displayed in the sidebar.
• Url - the relative path URL for navigating to the tab. The URL begins with /Relativity. If an exception occurs when populating this value, the Tab is returned but this property is omitted.
• IconIdentifier - the string identifier for the icon displayed when the tab is listed in the sidebar. For a list of valid values, see IconIdentifier field.
• Parent - contains the following fields for the parent tab:
  • Secured - a Boolean value indicating whether the current user has permission to view the settings in the Value field.
  • Value - contains the following fields:
    • ArtifactID - the Artifact ID of the parent tab.
    • Guids - the GUIDs used to identify the parent tab.

[
    {
        "ObjectIdentifier": {
            "Name": "Workspaces",
            "ArtifactID": 1015520,
            "Guids": []
        },
        "ObjectTypeIdentifier": {
            "Secured": false,
            "Value": {
                "ArtifactTypeID": 8,
                "Name": "Workspace",
                "ArtifactID": 1016187,
                "Guids": []
            }
        },
        "LinkType": "Object",
        "Order": -1000,
        "IsDefault": true,
        "IsVisible": true,
        "IsShownInSidebar": true,
        "Url": "/Relativity/RelativityInternal.aspx?AppID=-1&ArtifactTypeID=8&ArtifactID=62&Mode=ListPage",
        "IconIdentifier": "sidebar-workspaces"
    },
    {
        "ObjectIdentifier": {
            "Name": "User Status",
            "ArtifactID": 1014996,
            "Guids": []
        },
        "LinkType": "Link",
        "Order": -10,
        "IsDefault": false,
        "IsVisible": true,
        "IsShownInSidebar": true,
        "Url": "/Relativity/External.aspx?AppID=-1&ArtifactID=-1&DirectTo=%25ApplicationPath%25%2fCustomPages%2f2ff16b11-a4ca-4f02-8bbb-1f07f23fe713%2fstaticObjects.html%23%2fstaticObjects%2fuserstatus",
        "IconIdentifier": "sidebar-access"
    }
]