Get Request Based on Request ID
get
/iam/governance/selfservice/api/v1/requests/{reqid}
Returns the request details of the specified request id. The attributes that are to be returned can be specified as part of the query parameter named "fields". For example: The URI to get the request type and status attributes only for a particular request is /requests/{reqid}?fields=reqType, reqStatus. The attributes are to be spcified in a Comma-separated list.
Request
Supported Media Types
- application/json
Path Parameters
-
reqid(required): string
Request ID
Query Parameters
-
fields: string
Attributes to be returned in the result. RequestId attribute is mandatory in the return list. Comma-separated attributes are accepted.
Response
Supported Media Types
- application/json
200 Response
Successful
Headers
-
ResponseTime: string
Captures the time in milliseconds taken for processing the request.
Nested Schema : UserRequest
Type:
Show Source
object
-
childRequests:
array childRequests
-
id:
string
-
links:
array links
-
reqBeneficiaryList:
array reqBeneficiaryList
-
reqCreatedOn:
string
-
reqExpireOn:
string
-
reqJustification:
string
-
reqModifiedOnDate:
string
-
reqStatus:
string
-
reqTargetEntities:
array reqTargetEntities
-
reqType:
string
-
requester:
object Requester
-
requestTaskDetails:
array requestTaskDetails
401 Response
Unauthorized
404 Response
Requested entity not found
500 Response
Internal Server Error
Default Response
Unexpected error
Examples
This example retrieves all the information for a given request The information shown here is against a pseudo system and serves as a prototype.
cURL Example
curl -H "Content-Type: application/json" -X GET -u username:password https://pseudo.com/iam/governance/selfservice/api/v1/requests/12
Example of GET Response Body
The following example shows the contents of the response body in JSON format.
{ "links": [ { "rel": "self", "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/12" } ], "id": "12", "reqStatus": "Request Completed", "requester": { "name": "requesterId", "value": "17", "link": { "rel": "self", "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17" } }, "reqCreatedOn": "2019-03-14T18:35:19Z", "reqExpireOn": "2019-03-14T18:54:57Z", "reqType": "Modify User Profile", "reqBeneficiaryList": [ { "links": [ { "rel": "self", "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17" } ], "id": "17" } ], "reqTargetEntities": [], "reqModifiedOnDate": "2019-03-14T18:54:57Z", "requestTaskDetails": [ { "title": "Default operational level approval for Request ID 12", "history": { "previousApprovers": [ { "stage": "defaultOperationalApproval.approvalTask.assignee", "status": "APPROVE", "approvers": "SYSTEM ADMINISTRATORS", "acquiredBy": "sysadmin", "stageIndex": "3", "updatedDate": "2019-03-14T18:54:56Z" } ], "currentApprovers": [ { "stage": "defaultOperationalApproval.approvalTask.assignee", "status": "COMPLETED", "approvers": "" } ], "futureApprovers": [] } } ], "childRequests": [] }