REST API - listSetofProcessInstanceAttributes

The table summarizes the REST API - listSetofProcessInstanceAttributes.

Request

Format 
GET <baseurl>/process/listset/instanceattributes
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).
  • module=string (1..n): Name of the module to which the process template belongs.
  • process=string (1..n): Name of the process template whose process instance attributes are to be listed.
  • version=string (1..n): OSGi-style version number of the process template. (This version number is the same as that of the module.)

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/listset/instanceattributes?attributetype=HALT_ONLY&module=%2FHelpDesk%2FProcess%20Packages%2FHelpDesk.xpdl&process=InternalHelpDeskA&version=1.0.0.201302051037
Response 
 {
       "xml-fragment":
       {
           "instanceAttribute":
           [
               {
                   "name": "INSTANCE.ACTIVITY_FAULT_DATA",
                   "type": "string",
                   "processQName":
                   {
                       "moduleName": "",
                       "processName": "",
                       "version": ""
                   },
                   "viewtype": 1234
               },
               {
                   "name": "INSTANCE.FAILED_ACTIVITY_NAME",
                   "type": "string",
                   "processQName":
                   {
                       "moduleName": "",
                       "processName": "",
                       "version": ""
                   },
                   "viewtype": 1234
               },
               {
                   "name": "INSTANCE.ACTIVITY_FAULT_NAME",
                   "type": "string",
                   "processQName":
                   {
                       "moduleName": "",
                       "processName": "",
                       "version": ""
                   },
                   "viewtype": 1234
               }
           ]
       }
    }