REST interface for federated IBM BPM resources - Task Instance Resource - PUT (Start) Method

Use this method to start a new task using a synchronous (call) or asynchronous (start) operation.

Sample method invocation

PUT /rest/bpm/federated/htm/v1/task/{tkiid}?systemID={string}&action={string}&mode={string}[&relation={string}][&parentTaskID={string}]

Parameters

Required Federation Parameter

Name	Value Type	Description
systemID	string	ID of the BPEL runtime system hosting the resource.

Required Parameters

Name

Value Type

Description

action

string

Action to be performed for the specified task.

Value	Description
start	Start a new task.

mode

string

Task start mode.

Value	Description
sync	Use a synchronous operation to start the task. This value is only allowed for invocation tasks, and it is not allowed if the parameters `relation` and `parentTaskID` are specified.
async	Use a asynchronous operation to start the task.

Optional Parameters

Name

Value Type

Description

relation

string

Task relationship - must be specified together with the parentTaskID parameter.

Value	Description
subTask	The new task is a subtask. This value can only be used when the `mode` parameter is set to `async`.

parentTaskID

string

Task ID of the parent task - must be specified together with the relation parameter.

Request Content

Human task input (optional).

The default content-type is application/xml.

MIME Type: application/xml

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

Response Content

Human task output. Only returned if the task is an invocation task and the mode parameter is set to sync.

The default content-type is application/xml.

MIME Type: application/xml

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

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "federationResult":
      [
         {  "systemID": {"type": "string",
               "description": "ID of the individual system the request was sent to."
            },
            "statusCode": {"type": "integer",
               "description": "HTTP Status Code returned from this system."
            },
            "errorNumber": {"type": "string", "optional": true,
               "description": "Message ID of the exception."
            },
            "errorMessage": {"type": "string", "optional": true,
               "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": {"type": "string", "optional": true,
               "description": "Status of the request."
            },
            "exceptionType": {"type": "string", "optional": true,
               "description": "Type of the exception."
            }      
         }
      ], 
      "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": {"type": "string", "optional": true,
         "description": "Status of the request."
      },
      "exceptionType": {"type": "string", "optional": true,
         "description": "Type of the exception."
      }      
   }
}

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 task does not exist.
406 Not Acceptable	The requested content type or content encoding is not supported.
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.
503 Service Unavailable	The federated request could not be delivered to individual federation targets.
504 Gateway Timeout	The federated response has partial content because of missing individual responses.

Available since

7.5

Parent topic: Task Instance Resource