Get requests
get
/iam/governance/selfservice/api/v1/requests
Returns all the requests raised within Oracle Identity Manager. The requests in context of the logged in user are returned. For example for an end user, the requests raised for the end user or by the end user are displayed. However for a manager the requests raised by/for the manager and/or the requests raised by/for the direct reportees are returned.
The requests can be be filtered using the filter query parameter to refine the result set. For example to get all requests in Draft state the filter parameter requestStatus can be used, /requests?q=requestStatus=draft.
In addition to above default behaviour where view=trackRequests we have view=pendingApprovals as query param. this provides the tasks of the user with attributes as title,id,creator,taskId,state,assignee,created. In view=pendingApprovals mode we can filter the pending request's with the filter param "q=state eq assigned", where state could be Any, Assigned, Completed, Suspended, Withdrawn, Expired, Errored, Alerted, Information Required.
Request
Supported Media Types
- application/json
Query Parameters
-
fields(optional): string
Attributes to be returned in the result.RequestId attribute is mandatory in return list. Comma-separated attributes are accepted.
-
q(optional): string
Search filter to get the requests. SCIM filter is accepted. Filter attributes can be requester details or beneficiary details. There should not be any spaces for attribute value. If you want to pass space in between attribute values then replace it with "::". Sample value for filter is "requester eq john or beneficiary eq avink". In view=pendingApprovals mode we can filter the pending request's with the filter param "q=state eq assigned"
-
uuid: string
Target User ID
Response
Supported Media Types
- application/json
200 Response
Successful
Headers
-
ResponseTime: string
Captures the time in milliseconds taken for processing the request.
401 Response
Unauthorized
404 Response
Resource not found
500 Response
Internal Server Error
Default Response
Unexpected error
Examples
This example retrieves the request information for all requests. 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
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"
}
],
"requests": [
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/1002"
}
],
"id": "1002",
"reqStatus": "Request Completed",
"requester": "1",
"reqCreatedOn": "Mon Feb 22 13:12:03 IST 2016",
"reqExpireOn": "Mon Feb 22 13:12:07 IST 2016",
"reqType": "Modify User Profile"
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/1003"
}
],
"id": "1003",
"reqStatus": "Request Completed",
"requester": "1",
"reqCreatedOn": "Mon Feb 22 13:12:27 IST 2016",
"reqExpireOn": "Mon Feb 22 13:12:28 IST 2016",
"reqType": "Modify User Profile"
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/1004"
}
],
"id": "1004",
"reqStatus": "Request Completed",
"requester": "1",
"reqCreatedOn": "Mon Feb 22 14:30:10 IST 2016",
"reqExpireOn": "Mon Feb 22 14:30:11 IST 2016",
"reqType": "Modify User Profile"
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/2001"
}
],
"id": "2001",
"reqStatus": "Request Completed",
"requester": "1",
"reqCreatedOn": "Mon Feb 29 19:06:26 IST 2016",
"reqExpireOn": "Mon Feb 29 19:09:31 IST 2016",
"reqType": "Create Role"
},
{
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/2002"
}
],
"id": "2002",
"reqStatus": "Request Awaiting Approval",
"requester": "1",
"reqCreatedOn": "Mon Feb 29 19:08:27 IST 2016",
"reqType": "Create Role"
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/2003"
}
],
"id": "2003",
"reqStatus": "Request Completed",
"requester": "1",
"reqCreatedOn": "Mon Feb 29 19:27:30 IST 2016",
"reqExpireOn": "Mon Feb 29 19:27:57 IST 2016",
"reqType": "Modify Role"
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/2039"
}
],
"id": "2039",
"reqStatus": "Request Completed",
"requester": "1",
"reqCreatedOn": "Mon Mar 07 13:23:55 IST 2016",
"reqExpireOn": "Mon Mar 21 18:25:22 IST 2016",
"reqType": "Heterogeneous Request"
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/2040"
}
],
"id": "2040",
"reqStatus": "Request Completed",
"requester": "1",
"reqCreatedOn": "Mon Mar 07 13:24:20 IST 2016",
"reqExpireOn": "Mon Mar 07 13:32:04 IST 2016",
"reqType": "Provision ApplicationInstance"
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/2041"
}
],
"id": "2041",
"reqStatus": "Request Completed",
"requester": "1",
"reqCreatedOn": "Mon Mar 07 13:24:20 IST 2016",
"reqExpireOn": "Mon Mar 21 18:25:21 IST 2016",
"reqType": "Provision Entitlement"
}
]
}