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

Use this method to set the fault data 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}/fault?faultName={string}

Parameters

Required Parameters

Name	Value Type	Description
faultName	string	Name of the fault for which a fault is to be updated.

Request Content

Human task fault.

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:

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.
403 Forbidden	A fault does not exist because the task's interface refers to a one-way operation.
404 Not Found	The task does not exist.
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.1.2

Parent topic: Task Instance Fault Data Resource