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

Use this method to retrieve user(s) or group(s) associated with a task's role.

Resource URI

GET /v1/task/{tkiid}/role/{role}

Parameters

None.

Request Content

None.

Response Content

User(s) or group(s) in the specified human task role.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "HTM Staff Result Set", 
   "type": "object",
   "properties":
   {
      "staffResultSet" :
      {  "resultType" : {"type": "string", 
            "description": "Indicator that describes the content of the staff result set.",
            "enum":
            [
               "RESULT_TYPE_NOBODY", 
               "RESULT_TYPE_EVERYBODY", 
               "RESULT_TYPE_USERIDS", 
               "RESULT_TYPE_GROUPIDS", 
               "RESULT_TYPE_USERIDS_AND_GROUPIDS"
            ]
         },
         "userIDs" : {"type": ["string"], "optional": true,
            "description": "User IDs when the result type indicates that user IDs are returned."
         },
         "groupIDs" : {"type": ["string"], "optional": true,
            "description": "Group IDs when the result type indicates that group IDs are returned."
         }
      }
   }       
} 

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 does not exist.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available Since

6.1.2

Parent Topic: Task Instance Role Resource