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 - Process Instance Variable List Resource - GET Method

Use this method to retrieve a list of process variable names.

Resource URI

GET /v1/process/{piid}/variables?{parameters}

Parameters

Required Parameters
NameValue TypeDescription
activityName string
Name of an activity in the process definition.
Optional Parameters
NameValue TypeDescription
disposition string
Type of variable name list to be returned.
ValueDescription
referenced
Return a list of variable names referenced by the specified activity.
visible (default)
Return a list of variable names visible by the specified activity.

Request Content

None.

Response Content

List of process variable names.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "BFM Variable List", 
   "type": "object",
   "properties":
   {  "variableNames" : {"type": ["string"], "optional": true,
         "description": "List of variable names (for a process, a pick, receive, reply or throw activity)."
      },
      "inputVariableNames" : {"type": ["string"], "optional": true,
         "description": "List of input variable names (for an invoke or an inline task activity)."
      },
      "outputVariableNames" : {"type": ["string"], "optional": true,
         "description": "List of output variable names (for an invoke or an inline task activity)."
      }
   }
}

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.
401 UnauthorizedThe caller is not authorized for this request.
403 Forbidden
The method is not meaningful for this kind of activity.
404 Not Found
The process does not exist.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available Since

6.2

Parent Topic: Process Instance Variable List Resource