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

Get Application Instance based on Applicaton Instance Id

get

/iam/governance/selfservice/api/v1/applications/{applicationid}

Returns the details of the specified application instance. The application instance that is hidden in the catalog can also be viewed. 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 name and description attributes only for a particular application instance is /applications/{applicationid}?fields=displayName, description. The attributes are to be spcified in a Comma-separated list.

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Successful
Headers
Body ()
Root Schema : GetApplicationsByApplicationIdResponse
Type: object
Show Source
Nested Schema : GetApplicationsByApplicationIdResponseAccountForm
Type: object
Show Source
Nested Schema : childObjects
Type: array
Show Source
Nested Schema : formFields
Type: array
Show Source
Nested Schema : GetApplicationsByApplicationIdResponseChildObject
Type: object
Show Source
Nested Schema : formFields
Type: array
Show Source
Nested Schema : GetApplicationsByApplicationIdResponseFormField
Type: object
Show Source
Nested Schema : LinkDataInstances
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 demonstrates the ability to retrieve a single application in OIM. 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/applications/21

Example of GET Response Body

The following example shows the contents of the response body in JSON format.

{
  "key": "21",
  "name": "DisconnectedAppInstace2",
  "dataSetName": "DisconnectedAppInstace2",
  "description": "DisconnectedAppInstace2",
  "displayName": "DisconnectedAppInstace2",
  "itResourceKey": "44",
  "itResourceName": "DisconnectedAppInstace2",
  "objectKey": "24",
  "objectName": "DisconnectedAppInstace2",
  "type": "Disconnected",
  "isSoftDelete": "false",
  "accountForm": {
    "activeVersion": "3",
    "description": "DisconnectedAppInstace2 Form",
    "formKey": "28",
    "latestVersion": "3",
    "name": "UD_DIS2365",
    "isChild": "false",
    "formFields": [
      {
        "fieldKey": "162",
        "label": "ITResource",
        "length": "0",
        "name": "UD_DIS2365_IT",
        "type": "ITResourceLookupField",
        "variantType": "long",
        "defaultValue": "0",
        "isEncrypted": "false"
      },
      {
        "fieldKey": "163",
        "label": "Account Login",
        "length": "256",
        "name": "UD_DIS2365_LOGIN",
        "type": "TextField",
        "variantType": "String",
        "defaultValue": "",
        "isEncrypted": "false"
      },
      {
        "fieldKey": "164",
        "label": "Password",
        "length": "125",
        "name": "UD_DIS2365_PASSWORD",
        "type": "PasswordField",
        "variantType": "String",
        "defaultValue": "",
        "isEncrypted": "true"
      },
      {
        "fieldKey": "165",
        "label": "Account ID",
        "length": "256",
        "name": "UD_DIS2365_ACCOUNTID",
        "type": "TextField",
        "variantType": "String",
        "defaultValue": "",
        "isEncrypted": "false"
      }
    ],
    "childObjects": [
      {
        "description": "",
        "formKey": "29",
        "latestVersion": "3",
        "name": "UD_CHILDOBJ",
        "isChild": "true",
        "formFields": [
          {
            "fieldKey": "161",
            "label": "DisconnectedAI2Lookup",
            "length": "4000",
            "name": "UD_CHILDOBJ_DISCONNDISCONNECTE",
            "type": "LookupField",
            "variantType": "String",
            "defaultValue": "",
            "isEncrypted": "false"
          }
        ]
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "http://pseudo.com/iam/governance/selfservice/api/v1/applications/21      }
    ]
  }
}
Back to Top