Share this page
GET: Read an instance
This topic provides instructions for using the GET operation to retrieve information about an entity.
Overview
An instance is a complete functional unit of information, for example, a single defect. The properties of an instance are represented by data in JSON format.
Instances are members of collections. See Collections.
To get the resource for an entity, use the URI for the entity collection with the entity ID appended.
To get the entity ID, first read all instances and locate the desired entity.
GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects/23
23 is the defect ID.
Note: When GETting instances, the REST API does not necessarily display all fields for the instance. For a complete list of available fields, see Retrieving metadata.
Examples
Example of getting a defect instance
GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects/1014
{
"type": "defect",
"creation_time": "2016-10-27T10:35:46Z",
"parent": {
"type": "work_item_root",
"id": "1001"
},
"version_stamp": 9,
"release": {
"type": "release",
"id": "1001"
},
"sprint": {
"type": "sprint",
"id": "1001"
},
"description": "<html><body>\n<p>Emptying out items in cart takes way too long. It could take more than 45 seconds. </p> \n</body></html>",
"fixed_in_build": null,
"qa_owner": null,
"invested_hours": 0,
"detected_by": {
"type": "workspace_user",
"id": "1003"
},
"closed_on": null,
"id": "1014",
"last_modified": "2016-10-27T11:12:15Z",
"defect_type": {
"type": "list_node",
"id": "1026"
},
"phase": {
"type": "phase",
"id": "1001"
},
"severity": {
"type": "list_node",
"id": "1005"
},
"owner": {
"type": "workspace_user",
"id": "1004"
},
"author": {
"type": "workspace_user",
"id": "1003"
},
"story_points": 4,
"product_areas": {
"total_count": 2,
"data": [
{
"type": "product_area",
"id": "1005"
},
{
"type": "product_area",
"id": "1003"
}
]
},
"team": {
"type": "team",
"id": "1003"
},
"remaining_hours": 0,
"priority": {
"type": "list_node",
"id": "1015"
},
"user_tags": {
"total_count": 1,
"data": [
{
"type": "user_tag",
"id": "1001"
}
]
},
"taxonomies": {
"total_count": 1,
"data": [
{
"type": "taxonomy_item_node",
"id": "1008"
}
]
},
"name": "Emptying out items in cart takes way too long",
"estimated_hours": 0,
"detected_in_build": null
}
Example of getting a shared entity instance
Some entities, such as releases, can exist both in a workspace context and in a shared area context.
When an entity exists in a shared area context, it is available to all associated workspaces. It is stored in a reserved resource called shared_area.
| Context | Request |
|---|---|
| Workspace (non-shared) | GET .../api/shared_spaces/2001/workspaces/1003/releases
|
| Space (shared) | GET .../api/shared_spaces/2001/shared_area/releases
|
See also:
