WebSphere Process Server, Version 6.2.0.1 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, i5/OS, z/OS


Business Flow Manager REST Interface - Activity Instance List Resource - GET Method

Use this method to retrieve a list of activity instances.

Resource URI

GET /v1/activities/filter?{parameters}

Parameters

Optional Parameters
NameValue TypeDescription
whereClause string
Specifies the filter criteria applied when the query is executed.
orderByClause string
Orders the result of the query execution by the values of the columns you identify.
offset integer
Return results after the specified list entry.
size integer
Maximum number of list entries to be returned.

Request Content

None.

Response Content

List of activity instances.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "BFM Activity List", 
   "type": "object",
   "properties":
   {  "identifier" : {"type": "string"},
      "items": 
      [
         {  "activationTime": {"type": "string", "format": "date-time",
               "description": "Activation time of the activity instance."
            },
            "aiid": {"type": "string",
               "description": "Activity instance object identifier."
            },
            "completionTime": {"type": "string", "format": "date-time",
               "description": "Completion time of the activity instance."
            },
            "description": {"type": "string",
               "description": "Description of the activity instance."
            },
            "executionState": {"type": "string", 
               "description": "Execution state of the activity instance.",
               "enum":
               [
                  "STATE_CLAIMED",
                  "STATE_EXPIRED",
                  "STATE_FAILED",
                  "STATE_FAILING",
                  "STATE_FINISHED",
                  "STATE_INACTIVE",
                  "STATE_PROCESSING_UNDO",
                  "STATE_READY",
                  "STATE_RUNNING",
                  "STATE_SKIPPED",
                  "STATE_STOPPED",
                  "STATE_TERMINATED",
                  "STATE_TERMINATING",
                  "STATE_WAITING"
               ]
            },    
            "expirationTime": {"type": "string", "format": "date-time",
               "description": "Time when the activity instance will expire or expired."
            },
            "kind": {"type": "string", 
               "description": "Kind of the activity, for example, whether the activity is a pick or receive activity.",
               "enum":
               [
                  "KIND_ASSIGN",
                  "KIND_COMPENSATE",
                  "KIND_COMPENSATE_SCOPE",
                  "KIND_CUSTOM",
                  "KIND_EMPTY",
                  "KIND_FLOW",
                  "KIND_FLOW_END",
                  "KIND_FOR_EACH_PARALLEL",
                  "KIND_FOR_EACH_PARALLEL_END",
                  "KIND_FOR_EACH_SERIAL",
                  "KIND_FOR_EACH_SERIAL_END",
                  "KIND_INVOKE",
                  "KIND_INVOKE_END",
                  "KIND_PICK",
                  "KIND_PICK_END",
                  "KIND_RECEIVE",
                  "KIND_REPEAT_UNTIL",
                  "KIND_REPEAT_UNTIL_END",
                  "KIND_REPLY",
                  "KIND_RETHROW",
                  "KIND_SCOPE",
                  "KIND_SCOPE_END",
                  "KIND_SCRIPT",
                  "KIND_SEQUENCE",
                  "KIND_SEQUENCE_END",
                  "KIND_STAFF",
                  "KIND_SWITCH",
                  "KIND_SWITCH_END",
                  "KIND_TERMINATE",
                  "KIND_THROW",
                  "KIND_WAIT",
                  "KIND_WHILE",
                  "KIND_WHILE_END"
               ]
            },
            "name": {"type": "string",
               "description": "Name of the activity instance."
            },
            "owner": {"type": "string",
               "description": "Owner of the activity instance."
            },
            "processInstanceID": {"type": "string",
               "description": "ID of the containing process instance."
            },
            "processInstanceName": {"type": "string",
               "description": "Name of the process instance the activity belongs to."
            },
            "processTemplateID": {"type": "string",
               "description": "ID of the process template that contains the activity definition."
            },
            "processTemplateName": {"type": "string",
               "description": "Name of the first process template in the hierarchy that contains the activity definition."
            },
            "startTime": {"type": "string", "format": "date-time",
               "description": "Start time of the activity instance."
            }
         }
      ]
   }
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "BFM Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description":"Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description":"Message text of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional, exception details, for example, a stack trace."
      }
   }
} 

Status Codes

The method returns one of the following status codes:
CodeDescription
200 OK
Successful completion - requested data returned. Note that the list may be empty.
400 Bad RequestThe parameters are not valid or they are missing.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available Since

6.2

Parent Topic: Activity Instance List Resource