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/<shared_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.

Back to top

Examples

Back to top

See also: