ALM 12.5x REST API Reference
Read an Instance
Working with the API > How Do I... > Read an Instance

An instance is a complete functional unit of information. Examples of instances are a single defect or a single lock. 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.
For example, /qcbin/api/domains/{domain}/projects/{project}/defects/23 where 23 is the defect ID.

Example of getting a defect instance
Copy Code 
*** Request ***
GET /qcbin/api/domains/DEFAULT/projects/REST/defects/4 HTTP/1.1
Host: my-server:8081
Connection: keep-alive
Accept: application/json
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.95 Safari/537.36
Accept-Encoding: gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8,he;q=0.6
Cookie: JSESSIONID=1234567890; hp_last_segment=segment neutral; s_vi=1234567890; hpeuck_answ=0; Remember_me=1234567890; s_fid=1234567890; [email protected]; SMSESSION=1234567890; JSESSIONID=1234567890; hp_last_segment=segment neutral; s_vi=1234567890; hpeuck_answ=0; Remember_me=1234567890; s_fid=1234567890; [email protected]; LWSSO_COOKIE_KEY=1234567890; QCSession=1234567890; ALM_USER=1234567890; XSRF-TOKEN=1234567890

*** Response ***
HTTP/1.1 200 OK
Date: Tue, 23 Dec 2014 15:49:32 GMT
Cache-Control: no-cache, max-age=0
Pragma: no-cache
Content-Type: application/json
Content-Encoding: gzip
Vary: Accept-Encoding, User-Agent
Content-Length: 455
Server: Jetty(9.1.3.v20140225)
{
    "type": "defect",
    "has-change": null,
    "planned-closing-ver": null,
    "test-reference": null,
    "subject": null,
    "reproducible": null,
    "request-id": null,
    "request-server": null,
    "id": 4,
    "ver-stamp": 2,
    "has-others-linkage": "N",
    "description": "<html><body>\n<p>Alternative source of income required.</p> \n</body></html>",
    "priority": null,
    "name": "Estate entailed to Collins",
    "has-linkage": "N",
    "run-reference": null,
    "cycle-reference": null,
    "dev-comments": null,
    "creation-time": "2014-12-23",
    "to-mail": null,
    "request-note": null,
    "closing-version": null,
    "cycle-id": null,
    "detection-version": null,
    "last-modified": "2014-12-23 15:16:45",
    "status": "Fixed",
    "closing-date": null,
    "detected-in-rcyc": null,
    "detected-in-rel": null,
    "severity": "2-Medium",
    "attachment": null,
    "extended-reference": null,
    "estimated-fix-time": null,
    "project": null,
    "target-rel": null,
    "detected-by": "elizabeth",
    "environment": null,
    "step-reference": null,
    "owner": "darcy",
    "target-rcyc": null,
    "actual-fix-time": null,
    "request-type": null
}