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 - Activity Instance Resource - PUT (Force Complete) Method

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

Resource URI

PUT /v1/activity/{aiid}?{parameters}

Parameters

Required Parameters
NameValue TypeDescription
action string
Action to be performed for the specified activity.
ValueDescription
forceComplete
Force completion of an activity.
continueOnError boolean
Indicates whether navigation should continue in case of an error.
ValueDescription
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
NameValue TypeDescription
faultName string
Fault name (required if the activity should be completed with a fault).

Request Content

The activity output or fault (optional). The XML Schema for the activity output or fault, that is, the XML Schema type/element used for the WSDL message part definition, is referenced by the corresponding BPEL variable definition. Data defined by an XML Schema simple type is wrapped in an XML element provided by this REST interface (see Simple-Typed XML Data).

The default content-type is application/xml.

Response Content

None.

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 OKSuccess completion.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
404 Not Found
The activity instance does not exist.
409 ConflictA conflict exists with the current state of the resource.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available Since

6.2

Parent Topic: Activity Instance Resource