REST Interface for BPEL-related Task Resources - Task Instance Binary Custom Property Resource - GET Method

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

Sample method invocation

GET /rest/bpm/htm/v1/task/{tkiid}/binaryCustomProperty/{name}

Parameters

None

Request Content

None

Response Content

Binary custom property value (optional). If the type of the binary custom property has a value of the form "Content-Type: " followed by a type/subtype MIME type specification then this value becomes the Content-Type for the response message, otherwise the Content-Type is set to "text/plain".

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.
204 No Content	The binary custom property exists but its content has 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.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.

Change history

The following changes have been applied to this method:

Release	Description
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