Query a collection of entities

Entities are members of collections. An entity collection is read by performing a GET operation on /{project}/{entities}. The returned data is paged.

Collections are represented by data in XML format that conforms to the Entities Collection Schema. To retrieve the information in another supported format, add an ACCEPT header. For example, an application/json header. Alternatively, you can use an alt clause to specify the format. Returned data in alternate formats contains the same information as the XML data.

For example, the defect collection resource is at:
/qcbin/rest/domains/{domain}/projects/{project}/defects

See the example of returned collections where Accept:application/xml

The JSON format consists of an "entities" object that contains a Total Results value and an array of objects that each represent an entity . Each entity object contains a Fields object containing an array of field values, and a Type value containing the entity type.

/qcbin/rest/domains/DOMAIN_NAME/projects/PROJECT_NAME/tests?alt=application/json

{"entities":
	[
		{"Fields":
			[
				{"Name":"estimate-devtime","values":[]},
				{"Name":"vc-checkin-time","values":[{"value":"17:12:44"}]},
				{"Name":"vc-time","values":[{}]},
				{"Name":"base-test-id","values":[]},
				{"Name":"storage-path","values":[{}]},
				{"Name":"vc-start-audit-action-id","values":[{"value":"3"}]},
				{"Name":"configurations-count","values":[{"value":"1"}]},
				{"Name":"id","values":[{"value":"1"}]},
				{"Name":"vc-comments","values":[{}]},
				{"Name":"description","values":[{"value":"\r\n\r\n>test1 desc\r\n\r\n"}]},
				{"Name":"name","values":[{"value":"Test1"}]},
				{"Name":"has-linkage","values":[{"value":"N"}]},
				{"Name":"vc-status","values":[{"value":"Checked_In"}]},
				{"Name":"has-criteria","values":[{"value":"N"}]},
				{"Name":"dev-comments","values":[{"value":"\r\n\r\ntest 1 comment\r\n\r\n"}]},
				{"Name":"vc-version-number","values":[{"value":"2"}]},
				{"Name":"vc-checkin-user-name","values":[{"value":"sa"}]},
				{"Name":"creation-time","values":[{"value":"2012-01-01"}]},
				{"Name":"template","values":[{}]},
				{"Name":"last-modified","values":[{"value":"2012-01-01 17:14:31"}]},
				{"Name":"status","values":[{"value":"Design"}]},
				{"Name":"has-dependencies","values":[{"value":"0"}]},
				{"Name":"attachment","values":[{}]},
				{"Name":"steps","values":[{"value":"0"}]},
				{"Name":"runtime-data","values":[{}]},
				{"Name":"check-out-user-name","values":[{}]},
				{"Name":"vc-checkin-date","values":[{"value":"2012-01-01"}]},
				{"Name":"subtype-id","values":[{"value":"MANUAL"}]},
				{"Name":"vc-end-audit-action-id","values":[{"value":"3"}]},
				{"Name":"parent-id","values":[{"value":"1001"}]},
				{"Name":"exec-status","values":[{"value":"Passed"}]},
				{"Name":"test-ver-stamp","values":[{"value":"13"}]},
				{"Name":"vc-checkin-comments","values":[{"value":"t 1 checked in"}]},
				{"Name":"vc-date","values":[]},
				{"Name":"owner","values":[{"value":"sa"}]},
				{"Name":"text-sync","values":[{}]},
				{"Name":"step-param","values":[{"value":"0"}]},
				{"Name":"timeout","values":[]}
			],
		"Type":"test"
		}
	],
	"TotalResults":1
}

See Also

Filtering a Collection of Entities
Relations
fields Clause
Data Paging
order-by Clause: Sort Results
groups: Grouping headers