WebSphere Process Server, Version 6.2.0.1 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, i5/OS, z/OS


Human Task Manager REST Interface - Task Instance Binary Custom Property Resource - PUT Method

Use this method to set the value of a binary custom property of a task.

Resource URI

PUT /v1/task/{tkiid}/binaryCustomProperty/{name}?{parameters}

Parameters

Optional Parameters
NameValue TypeDescription
type string
The type of the custom property - it is recommended specifying a valid MIME type.
query string
Query string for a custom property.
allowCreate boolean
Indicates whether the implicit creation of a binary custom property is allowed.
ValueDescription
true
A new binary custom property is created if it does not yet exist.
false (default)
Status code 404 Not Found is returned if the binary custom property does not exist.

Request Content

Binary custom property value. The content-type is derived from the type parameter and a Content-Type specification in the message body according to the following rules:
  1. If the parameter "type" has been specified then its value is taken as Binary Custom Property type, otherwise rule 2 applies
  2. If the message-body has a Content-Type specification (in the response header or content-disposition header) then its value, prefixed with "Content-Type: ", is taken as Binary Custom Property type, otherwise rule 3 applies
  3. The default value "Content-Type: text/plain" is taken as Binary Custom Property type

The request message body, that is, the binary custom property value, can be omitted. In this case, the specification of the query parameter is not allowed and the type parameter, if specified, must be text/plain.

Response Content

None.

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "HTM 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.
204 No Content
A binary custom property value has not been specified. Therefore, the binary custom property as well as its "query" attribute are set to a null value.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
404 Not Found
The binary custom property does not exist.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Change History

The following changes have been applied to this method:
ReleaseDescription
6.2
Status code "204 No Content" is returned when no request message body is provided.

Available Since

6.1.2

Parent Topic: Task Instance Binary Custom Property Resource