GET v1/bunits/{bunitId}/tags/availablesubscriptions
Get a list of tags available for the business unit to add to a status report subscription.
These tags are those related to the business unit the report should be created for along
with any inherited from the ancestors of the business unit
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
bunitId |
The ID of the business unit the report should be related to | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of tags
Collection of TagName | Description | Type | Additional information |
---|---|---|---|
Id |
Id of the tag |
integer |
None. |
BusinessUnitId |
The ID of the business unit that created the tag |
integer |
None. |
Text |
The text of the tag |
string |
None. |
Inheritable |
If a tag is inheritable it can be used by business units descending original creator |
boolean |
None. |
BusinessUnitCount |
The number of business unit that the tag is assigned to |
integer |
None. |
ConsumerCount |
The number of consumption units the tag is assigned to |
integer |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml, text/xml
Sample:
<ArrayOfTag xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Tag> <Id>1</Id> <BusinessUnitId>2</BusinessUnitId> <Text>sample string 3</Text> <Inheritable>true</Inheritable> <BusinessUnitCount>5</BusinessUnitCount> <ConsumerCount>6</ConsumerCount> </Tag> <Tag> <Id>1</Id> <BusinessUnitId>2</BusinessUnitId> <Text>sample string 3</Text> <Inheritable>true</Inheritable> <BusinessUnitCount>5</BusinessUnitCount> <ConsumerCount>6</ConsumerCount> </Tag> </ArrayOfTag>