REST interface for BPEL-related process resources - Process instance variable list Resource - GET Method

Sample method invocation

Parameters

Required Parameters

Name	Value Type	Description
activityName	string	Name of an activity in the process definition.

Optional Parameters

Name	Value Type	Description
disposition	string	Type of variable name list to be returned. Value Description 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

The default content-type is application/json.

MIME Type: application/json

{  "description": "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

The default content-type is application/json.

MIME Type: application/json

{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description":"Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description":"Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description":"Message text parameters 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:

Code	Description
200 OK	Successful completion. The requested data is returned. Note that the list might be empty.
400 Bad Request	The parameters are not valid or they are missing.
401 Unauthorized	The 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.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.

Available since

6.2

Parent topic: Process instance variable list Resource