Previous Next

Retrieve Case Activities

get

/cases/{id}/activities

Retrieves a list of case activities.

Request

Query Parameters
filter
What to filter by
orderBy
What to order by
orderColumn
Column to sort by
sortOrder
Order in which to sort
whereClause
Additional where clause filter

Response

Supported Media Types
  • application/json
  • application/xml
200 Response
Success
Body
Root Schema : /paths/~1cases~1{id}~1activities/get/responses/200/schema
Example application/json

{
    "type":"activities",
    "levels":0,
    "links":[
        {
            "rel":"back",
            "href":"http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c"
        },
        {
            "rel":"self",
            "href":"http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/activities"
        }
    ],
    "activity":{
        "activity":[
            {
                "name":"GetCar",
                "displayName":"Find an available car",
                "definitionId":"default/EURent!1.0/GetCar",
                "isRequired":true,
                "isRepeatable":true,
                "isManual":true,
                "relevance":"NONE",
                "state":"AVAILABLE"
            },
            {
                "name":"EmailActivity",
                "displayName":"Send Email",
                "definitionId":"http://xmlns.example.com/bpm/case/activity/EmailActivityDefinition",
                "isRequired":false,
                "isRepeatable":true,
                "isManual":true,
                "relevance":"NONE",
                "state":"AVAILABLE"
            },
            {
                "name":"SimpleWorkflowActivity",
                "displayName":"Create Task",
                "definitionId":"http://xmlns.example.com/bpm/case/activity/SimpleWFActivityDefinition",
                "isRequired":false,
                "isRepeatable":true,
                "isManual":true,
                "relevance":"NONE",
                "state":"AVAILABLE"
            }
        ]
    }
}

Examples

The following example shows a response body when retrieving a list of case activities.

{
						"type": "activities",
						"levels": 0,
						"links": [{
							"rel": "back",
							"href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c"
						},
						{
							"rel": "self",
							"href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/activities"
						}],
						"activity": {
							"activity": [{
								"name": "GetCar",
								"displayName": "Find an available car",
								"definitionId": "default/EURent!1.0/GetCar",
								"isRequired": true,
								"isRepeatable": true,
								"isManual": true,
								"relevance": "NONE",
								"state": "AVAILABLE"
							},
							{
								"name": "EmailActivity",
								"displayName": "Send Email",
								"definitionId": "http://xmlns.example.com/bpm/case/activity/EmailActivityDefinition",
								"isRequired": false,
								"isRepeatable": true,
								"isManual": true,
								"relevance": "NONE",
								"state": "AVAILABLE"
 							},
							{
								"name": "SimpleWorkflowActivity",
								"displayName": "Create Task",
								"definitionId": "http://xmlns.example.com/bpm/case/activity/SimpleWFActivityDefinition",
								"isRequired": false,
								"isRepeatable": true,
								"isManual": true,
								"relevance": "NONE",
								"state": "AVAILABLE"
							}]
						}
					}	

For more information about cURL, see Use cURL