Retrieve Cases
get
/cases
Retrieves cases.
Request
Query Parameters
-
limit: integer
Maximum number of items per page. Set between 1 and 100. Default is 25.
-
offset: integer
Index for the first item on a page of list items. Default is 1.
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 case list.
{
"type" : "cases",
"levels" : 3,
"links" : [{
"rel" : "self",
"href" : "http://example.com/bpm/api/3.0/cases/?limit=25&offset=0"
}
],
"title" : "Case List",
"casecount" : 0,
"cases" : [{
"rel" : "case instance",
"title" : "Car rental for Jim Mitch",
"href" : "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c",
"createdDate" : "2015-06-05 17:42:50",
"state" : "ACTIVE"
}, {
"rel" : "case instance",
"title" : "Car rental for Jim Mitch",
"href" : "http://example.com/bpm/api/3.0/cases/c7c55f2c-33f7-4366-916e-748f6314615e",
"createdDate" : "2015-06-05 17:42:45",
"state" : "ACTIVE"
}
]
}
For more information about cURL, see Use cURL