REST interface for BPEL-related process resources - Activity Instance Variable Resource - GET Method

Use this method to retrieve a activity's variable data.

Sample method invocation

GET /rest/bpm/bfm/v1/activity/{aiid}/variable/{name}

Parameters

None

Request Content

None

Response Content

Activity variable data. Data defined by an XML Schema simple type is wrapped in an XML/JSON element provided by this REST interface (see Simple-Typed Data).

The default content-type is application/xml.

MIME Type: application/xml

The XML Schema type/element is defined as part of the custom process definition.

MIME Type: application/json

The JSON Schema can be derived from the XML Schema type/element definition (see [JSON Format]).

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "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	Success completion.
400 Bad Request	The parameters are not valid or they are missing.
401 Unauthorized	The caller is not authorized for this request.
404 Not Found	The activity or the variable 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: Activity Instance Variable Resource