REST Interface for BPEL-related Task Resources - Task Instance Output Data Resource - PUT Method

Use this method to set the output for a task. Note that this operation deletes any output or fault data that was previously set.

Sample method invocation

PUT /rest/bpm/htm/v1/task/{tkiid}/output

Parameters

None

Request Content

Human task output.

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.

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:
CodeDescription
200 OKSuccess completion.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
403 Forbidden
The output does not exist because the task's interface refers to a one-way operation.
404 Not Found
The task does not exist.
409 ConflictA conflict exists with the current state of the resource.
415 Unsupported Media TypeThe content type or content encoding of the request is not supported.
500 Internal Server ErrorA severe problem has occurred. Programmer's details are provided.

Available since

6.1.2

Parent topic: Task Instance Output Data Resource