REST API - listProcessInstanceAttributes

The table summarizes the REST API - listProcessInstanceAttributes.

Request

Format 
GET <baseurl>/process/list/instanceattributes/<module>/<process>/<version>
Path parameters
  • module: Name of the module to which the process template belongs.
  • process: Name of the process template whose process instance attributes are to be listed.
  • version: OSGi-style version number of the process template. (This version number is the same as that of the module.)

    These parameters can be obtained from listProcessTemplates , queryProcessTemplates , and queryProcessTemplatesAlt .
Query parameters attributetype=string (0..n): Enumerated value which, if specified, filters the result set to include only those attributes which belong to the specified type (FILTERABLE, SORTABLE, DISPLAYABLE or HALT_ONLY).

Response

JSON Returns a JSON representation of the content of the instanceAttributes element.
XML Returns the content of the instanceAttributes element (from the ProcessManagement schema).

Example

Request 
get <baseurl>/process/list/instanceattributes/HelpDesk%2FProcess%20Packages%2FHelpDesk.xpdl/InternalHelpDeskA/1.0.0.201210231049?attributetype=DISPLAYABLE
Response 
{
   "xml-fragment":
   {
       "instanceAttribute":
       [
           {
               "name": "INSTANCE.WAITING_WORK_COUNT",
               "type": "integer",
               "processQName":
               {
                   "moduleName": "",
                   "processName": "",
                   "version": ""
               },
               "viewtype": 123
           },
           {
               "name": "INSTANCE.VERSION",
               "type": "string",
               "processQName":
               {
                   "moduleName": "",
                   "processName": "",
                   "version": ""
               },
               "viewtype": 123
           },
           {
               "name": "INSTANCE.PRIORITY",
               "type": "short",
               "processQName":
               {
                   "moduleName": "",
                   "processName": "",
                   "version": ""
               },
               "viewtype": 123
           },
                   .
                   .
                   .
       ]
   }
}