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

Use this method to retrieve a client resource for a specified human task template.

Sample method invocation

GET /rest/bpm/htm/v1/taskTemplate/{tktid}/resource?clientType={string}&resourceName={string}

Parameters

Required Parameters

Name

Value Type

Description

clientType

string

The type of client the resource is associated with.

Value	Description
Lotus Forms	Client based on Lotus Forms.
Dojo	Client based on the Dojo toolkit.
Portal	Client based on WebSphere Portal Server.

resourceName

string

Name of a custom client setting associated with the resource - it is required that the task definition has a custom client setting for the specified resource.

Request Content

None

Response Content

Task template client resource for the specified client type. The content-type is dynamically resolved: for XFDL files, "application/xml" is used; for HTML files, "text/html" is used.

The default content-type is (dynamically resolved).

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 template or the client resource 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.

Available since

6.1.2

Parent topic: Task Template Client Resource Resource