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 Metadata Resource - GET Method

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

Resource URI

GET /v1/task/{tkiid}/binaryCustomProperty/{name}/metadata

Parameters

None.

Request Content

None.

Response Content

Binary custom property metadata. Note that a binary custom property may exist without a value having been set.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "HTM Task Binary Custom Property Metadata", 
   "type": "object",
   "properties":
   {  "type": {"type": "string",
         "description": "Data type of the binary custom property value."
      },
      "query": {"type": "string",
         "description": "Queryable string that describes the binary custom property."
      }
   }
} 

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
The binary custom property exists but its content has 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 Metadata Resource