groups: Grouping headers

Description

Returns the grouping headers for the specified group-by fields.

URL

/qcbin/rest/domains/{domain}/projects/{project}/{entity name}/groups/{field}[[,{field}],{field}]

Applies To

groups applies to the defects collection, the requirements collection, and the tests collection.

Remarks

This resource returns the grouping headers for which there is at least one instance in the collection. You can use these headers in your application to display the results of a query on the collection of the specified entity type.

Use logical names to identify the fields. See Field Names.

HTTP Methods

GET: Gets the grouping for subsequent queries.

PUT: N/A

DELETE: N/A

POST: N/A

Media Type	GET	PUT	DELETE	POST
application/xml		-	-	-
application/json		-	-	-

Returns

One of the HTTP Return Codes.

An XML string compliant with the GroupBy Schema or a string containing the data in another supported format. The data describes the grouping that applies to the project and entity.

Examples

GET requirement group-by headers XML