Retrieve a Case
get
/cases/{id}
Retrieves a case by ID.
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success
Root Schema : schema
Type:
objectExamples
The following example shows a response body when retrieving a case by ID.
{
"type": "case",
"levels": 2,
"links": [{
"rel": "back",
"href": "http://example.com/bpm/api/3.0/cases/"
},
{
"rel": "self",
"href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c"
}],
"title": "Car rental for Jim Mitch",
"activity": {
"rel": "activities",
"href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/activities"
},
"milestones": {
"rel": "milestones",
"href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/milestones"
},
"comments": {
"rel": "comments",
"href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/comments"
},
"stakeholders": {
"rel": "stakeholders",
"href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/stakeholders"
},
"casedata": {
"rel": "casedata",
"href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/casedata"
},
"documents": {
"rel": "documents",
"href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/documents"
},
"caseDefinitionId": "default/EURent!1.0/EURent",
"caseDefinitionName": "EURent",
"categoryDisplayName": "Rent",
"state": "ACTIVE",
"startDate": "2015-06-05 17:42:50"
}
For more information about cURL, see Use cURL