Overview
This structure represents the unique key fields associated with a public tab group. Public Tab Groups can be identified by PublicTabGroupName or PublicTabGroupUid. When specifying a PwsPublicTabGroupRef as an input to a web service, you may specify any combination of the two fields. However, if you do specify more than one, they must both refer to the same public tab group or the public tab group reference will not be considered valid. When a PwsPublicTabGroupRef is returned in the response to a web service, the PublicTabGroupName and PublicTabGroupUid will be populated, and guaranteed to refer to a single public tab group.
Tab groups allow users to select the tabs they want to be displayed to suit their current needs. A public tab group is a tab group that is accessible to everyone in the organization who can access the management portal. Click here to learn more about tab groups and tab group management.
Format
- PwsPublicTabGroupRef
- PublicTabGroupId: Int32
- PublicTabGroupName: String
- PublicTabGroupUid: Int64
Elements
Element | Data Type | Required? | Description | Sample Data |
|---|---|---|---|---|
PublicTabGroupId | Int32 | No | The public tab group Id is a unique identifier for a public tab group. For internal use only. | |
PublicTabGroupName | String | One of PublicTabGroupName or PublicTabGroupUID id is required | The public tab group name is a unique identifier for a public tab group | |
PublicTabGroupUid | Int64 | See PublicTabGroupName | A unique and immutable identifier for a public tab group |