REST interface for BPD-related resources - Tracking Group Resource - GET Method [deprecated]

This function is deprecated. Use this method to retrieve the detailed information related to a tracking group.

Sample method invocation

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

Usage Notes

The tgId can be obtained from the response of [Asset List Resource - GET] (Field TrackingGroup.poId).

Parameters

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

Optional parameters

Name	Value Type	Description
snapshotId	string	The identifier of the snapshot associated with the tracking group. You must set one of the `snapshotId` or `branchId` parameters.
branchId	string	The identifier of the branch associated with the tracking group. You must set one of the `snapshotId` or `branchId` parameters.

Request content

None

Response content

The detailed information related to the tracking group (TrackingGroupType complexType).

The default content type is application/json.

MIME type: application/json

Schema

{
    "status":"200",
    "data":{
        "tgId":{"type": "string", "description": "The ID of the tracking group."},
        "name":{"type": "string", "description": "The name of the tracking group."},
        "enabled":{"type": "boolean"},
        "desc":{"type": "string", "description": "The description of the tracking group."},
				"externalUniqueId":{"type": "string", "description": "The external unique ID of the tracking group."},                
        "variables":[{
                "name":{"type": "string", "description": "The name of the variable."},
                "variableId":{"type": "string", "description": "The ID of the variable."},
                "type":{"type": "string", "description": "The type of the variable.",
                	"enum":
                	[
                		"string",
                		"datatime",
                		"number"
                	]
                },
				        "externalUniqueId":{"type": "string", "description": "The external unique ID of the variable."},                
                "desc":{"type": "string", "description": "The description of the variable."}
            }
        ]
    }
}

Example content

{
    "status":"200",
    "data":{
        "tgId":"14.298c3209-1637-4f1f-a729-ec7529729592",
        "name":"TG1",
        "enabled":true,
        "desc":"My Test Tracking Group",
        "externalUniqueId":"P36e567388231",
        "variables":[{
                "name":"name",
                "variableId":"17.a725c00b-0e5f-40ae-aa5f-d9dfd8eadb55",
                "externalUniqueId":"a40cb77388231",
                "type":"string",
                "desc":"name documentation"
            },
            {
                "name":"creationDate",
                "variableId":"17.79e1f666-3593-4ff7-860a-c3a9e0bdd553",
                "externalUniqueId":"q57dacd6c8231",
                "type":"datetime",
                "desc":"creationDate documentation"
            }
        ]
    }
}

MIME type: application/xml

Schema

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

	<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="VariableType">
		<sequence>
			<element name="name" type="string" />
			<element name="variableId" type="string" />
			<element name="externalUniqueId" type="string" />
			<element name="type" type="string"/>
			<element name="desc" type="string" />
			<element name="richDesc" type="string" />
		</sequence>
	</complexType>

	<complexType name="TrackingGroupType">
		<complexContent>
			<extension base="pref:Data">
				<sequence>
					<element name="tgId" type="string" />
					<element name="name" type="string" />
					<element name="enabled" type="boolean" />
					<element name="desc" type="string" />
					<element name="richDesc" type="string" />
					<element name="externalUniqueId" type="string" />
					<element name="variables" type="tns:VariableType" maxOccurs="unbounded"/>
				</sequence>
			</extension>
		</complexContent>
	</complexType>

</schema>

Error Response content

Detailed error information.

The default content type is application/json.

MIME type: application/json

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	Successful completion - detailed report returned.
400 Bad Request	The parameters are not valid or they are missing.
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

7.5.1

Parent Topic: Tracking Group Resource