REST interface for federated IBM BPM resources - Task Instance Role Resource - GET Method

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

Sample method invocation

GET /rest/bpm/federated/htm/v1/task/{tkiid}/role/{role}?systemID={string}

Parameters

Required Federation Parameter

Name	Value Type	Description
systemID	string	ID of the BPEL runtime system hosting the resource.

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

Schema

{  "description": "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

Schema

{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "federationResult":
      [
         {  "systemID": {"type": "string",
               "description": "ID of the individual system the request was sent to."
            },
            "statusCode": {"type": "integer",
               "description": "HTTP Status Code returned from this system."
            },
            "errorNumber": {"type": "string", "optional": true,
               "description": "Message ID of the exception."
            },
            "errorMessage": {"type": "string", "optional": true,
               "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": {"type": "string", "optional": true,
               "description": "Status of the request."
            },
            "exceptionType": {"type": "string", "optional": true,
               "description": "Type of the exception."
            }      
         }
      ], 
      "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": {"type": "string", "optional": true,
         "description": "Status of the request."
      },
      "exceptionType": {"type": "string", "optional": true,
         "description": "Type of the exception."
      }      
   }
}

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 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.
503 Service Unavailable	The federated request could not be delivered to individual federation targets.
504 Gateway Timeout	The federated response has partial content because of missing individual responses.

Available since

7.5

Parent topic: Task Instance Role Resource