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 Client Settings Resource - GET Method

Use this method to retrieve client settings for a human task instance.

Resource URI

GET /v1/task/{tkiid}/clientSettings/{type}

Parameters

None.

Request Content

None.

Response Content

Task instance client settings for the specified client type.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "HTM Task Client Settings", 
   "type": "object",
   "properties":
   {  "clientSettings": {"type": "object",
         "description": "List of client setting names and values."
      }
   }
}

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.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
404 Not Found
The task or the client settings do not exist.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available Since

6.2

Parent Topic: Task Instance Client Settings Resource