REST interface for federated IBM BPM resources - Task Instance Binary Custom Property Resource - PUT Method

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

Sample method invocation

PUT /rest/bpm/federated/htm/v1/task/{tkiid}/binaryCustomProperty/{name}?systemID={string}[&type={string}][&query={string}][&allowCreate={boolean}]

Parameters

Required Federation Parameter

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

Optional Parameters

Name

Value Type

Description

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.

Value	Description
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:

If the parameter "type" has been specified then its value is taken as Binary Custom Property type, otherwise rule 2 applies
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
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

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.
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 Request	The parameters are not valid or they are missing.
401 Unauthorized	The caller is not authorized for this request.
404 Not Found	The binary custom property 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.
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 Binary Custom Property Resource