REST Interface for BPEL-related Task Resources - Task Instance Client Settings Resource - GET Method

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

Sample method invocation

GET /rest/bpm/htm/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

Schema

{  "description": "Task Client Settings", 
   "type": "object",
   "properties":
   {  "clientSettings": {"type": "object", "additionalProperties": {"type": "string"},
         "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

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.
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 task or the client settings do 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.

Available since

6.2

Parent topic: Task Instance Client Settings Resource