REST interface for BPEL-related process resources - Activity Instance Resource - PUT (Force Complete) Method

Use this method to force the completion of a specified activity instance.

Sample method invocation

PUT /rest/bpm/bfm/v1/activity/{aiid}?action={string}&continueOnError={boolean}[&faultName={string}]

Parameters

Required Parameters

Name

Value Type

Description

action

string

Action to be performed for the specified activity.

Value	Description
forceComplete	Force completion of an activity.

continueOnError

boolean

Indicates whether navigation should continue in case of an error.

Value	Description
true	In case of an error, put the activity in state failed and continue navigation.
false	In case of an error, put the activity in state stopped.

Optional Parameters

Name	Value Type	Description
faultName	string	Fault name (required if the activity should be completed with a fault).

Request Content

The activity output or fault (optional). 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]).

Response Content

None

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 instance does not exist.
409 Conflict	A conflict exists with the current state of the resource.
415 Unsupported Media Type	The content type or content encoding of the request 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 Resource