1. REST API for Oracle Identity Governance Self Service
  2. Tasks
  3. Request

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
Path Parameters
Query Parameters
  • Attributes to be returned in the result. RequestId attribute is mandatory in the return list. Comma-separated attributes are accepted.
Back to Top

Response

Supported Media Types

200 Response

Successful
Headers
Body ()
Root Schema : ReqGetResponse
Type: object
Show Source
Nested Schema : UserRequest
Type: object
Show Source
Nested Schema : childRequests
Type: array
Show Source
Nested Schema : reqBeneficiaryList
Type: array
Show Source
Nested Schema : reqTargetEntities
Type: array
Show Source
Nested Schema : Requester
Type: object
Show Source
Nested Schema : requestTaskDetails
Type: array
Show Source
Nested Schema : childRequests
Type: object
Show Source
Nested Schema : LinkDataInstances
Type: object
Show Source
Nested Schema : RequestBeneficiary
Type: object
Show Source
Nested Schema : reqTargetEntity
Type: object
Show Source
Nested Schema : AppFormData
Type: object
Show Source
Nested Schema : requestTaskDetails
Type: object
Show Source
Nested Schema : history
Type: object
Show Source
Nested Schema : currentApprovers
Type: array
Show Source
Nested Schema : futureApprovers
Type: array
Show Source
Nested Schema : previousApprovers
Type: array
Show Source
Nested Schema : Approvers
Type: object
Show Source

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Default Response

Unexpected error
Back to Top

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/2029

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/governance/selfservice/api/v1/requests/2029"
    }
  ],
  "id": "2029",
  "reqStatus": "Request Completed",
  "requester": "2007",
  "reqCreatedOn": "Fri Mar 04 12:26:51 IST 2016",
  "reqExpireOn": "Wed Apr 06 15:55:31 IST 2016",
  "reqType": "Heterogeneous Request",
  "userLogin": "TESTUSER1",
  "reqBenefiiciaryList": [
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/governance/selfservice/api/v1/users/TESTUSER1"
        }
      ],
      "userLogin": "TESTUSER1",
      "displayName": "Test user1"
    }
  ],
  "reqTargetEntities": [
    {
      "entityName": "DisconnectedAppInstance1",
      "entityId": "1",
      "entityType": "ApplicationInstance",
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/governance/selfservice/api/v1/applications/1"
        }
      ]
    },
    {
      "entityName": "abc_meaning2",
      "entityId": "2",
      "entityType": "Entitlement",
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/governance/selfservice/api/v1/entitlements/2"
        }
      ]
    },
    {
      "entityName": "Role1",
      "entityId": "7",
      "entityType": "Role",
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/governance/selfservice/api/v1/roles/7"
        }
      ]
    },
    {
      "entityName": "abc_meaning1",
      "entityId": "1",
      "entityType": "Entitlement",
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/governance/selfservice/api/v1/entitlements/1"
        }
      ]
    }
  ],
  "reqModifiedOnDate": "Wed Apr 06 15:55:31 IST 2016",
  "requestTaskDetails": [
    {
      "title": "Default request level approval for Request ID 2029"
    }
  ],
  "history": {
    "previousApprovers": [
      {
        "stage": "defaultRequestApproval.approvalTask.assignee",
        "status": "APPROVE",
        "approvers": "SYSTEM ADMINISTRATORS",
        "acquiredBy": "xelsysadm",
        "stageIndex": "3",
        "updatedDate": "Fri Mar 04 12:28:40 IST 2016"
      }
    ],
    "currentApprovers": [
      {
        "stage": "defaultRequestApproval.approvalTask.assignee",
        "status": "COMPLETED",
        "approvers": "SYSTEM ADMINISTRATORS"
      }
    ],
    "futureApprovers": [
      
    ]
  },
  "childRequests": [
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/governance/selfservice/api/v1/requests/2030"
        }
      ],
      "id": "2030"
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/governance/selfservice/api/v1/requests/2031"
        }
      ],
      "id": "2031"
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/governance/selfservice/api/v1/requests/2032"
        }
      ],
      "id": "2032"
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/governance/selfservice/api/v1/requests/2033"
        }
      ],
      "id": "2033"
    }
  ]
}
Back to Top