IBM Business Process Manager, Version 8.5.5

REST interface for BPD-related resources - BPD Tag Groups Resource - GET Method

Use this method to retrieve the tag groups and all their tags for a business process definition.

Sample method invocation

GET /rest/bpm/wle/v1/bpdtaggroup/{bpdId}[?snapshotId={string}][&branchId={string}]

Parameters

Note: In order to identify the correct snapshot to be used, you must specify one of the snapshotId or branchId parameters.
The snapshot is obtained using the following precedence rules:
1) If the snapshotId parameter is specified, then that specific snapshot will be used, and the branchId parameter is ignored.
2) If the branchId parameter is specified, then the tip (current) snapshot of the specified branch (track) will be used.

Optional parameters

Name	Value Type	Description
snapshotId	string	The ID of the snapshot for the business process definition. Either 'snapshotId' or 'branchId' must be specified.
branchId	string	The ID of the branch for the business process definition. Either 'snapshotId' or 'branchId' must be specified.

Request content

None

Response content

The tag groups and all their tags.

The default content type is application/json.

MIME type: application/xml

+ View schema

<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/bpdtaggroups"
elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:pref="http://rest.bpm.ibm.com/v1/data/root"
xmlns:tns="http://rest.bpm.ibm.com/v1/data/bpdtaggroups">

<import schemaLocation="Common.xsd" namespace="http://rest.bpm.ibm.com/v1/data/common"/>
<import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root"/>
  
  	<complexType name="TagGroups">
		<sequence>
			<element name="TagGroups" minOccurs="0" maxOccurs="unbounded"
					type="tns:TagGroup">
			</element>
		</sequence>
    </complexType>
    
    <complexType name="TagGroup">    
		<sequence>
			<element name="tags" minOccurs="0" maxOccurs="unbounded"
					 type="tns:TagData">
			</element>
		</sequence>	
			<attribute name="TagGroupName" type="string" use="required" />    
    </complexType>
    
    <complexType name="TagData">
    	<sequence>
			<element name="BpmnObjectIds" minOccurs="0" maxOccurs="unbounded"
					 type="string">
			</element>
		</sequence>	
    	<attribute name="value" type="string" use="required" />
		<attribute name="occurrences" type="int" use="required" />
    </complexType>
    
	<complexType name="BPDTagGroupInfo">
		<complexContent>
			<extension base="pref:Data">
				<sequence>
					<element name="TagGroupInfo" type="tns:TagGroups" />
				</sequence>
			</extension>
		</complexContent>
	</complexType>

</schema>

Error Response content

Detailed error information.

The default content type is application/json.

MIME type: application/json

+ View schema

{  "description": "WLE Error Response", 
   "type": "object",
   "properties":
   {  "status": {"type": "string",
         "description": "The status of the previous API call."
      },
      "exceptionType": {"type": "string",
         "description": "The classname associated with the exception."
      },
      "errorNumber": {"type": "string",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description": "Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description":"Message text parameters of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional exception details, for example, a stack trace."
      }
   }
}

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Success completion.
400 Bad Request	The parameters are not valid or they are missing.
401 Unauthorized	The caller is not authorized for this request.
404 Not Found	The resource does not exist.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	A severe problem has occurred, programmer's details are provided.

Available since

8.0.1

Parent Topic: BPD Tag Groups Resource