Jump to

• Request
• Response
• Examples

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

• application/json

Path Parameters

• applicationid: string
  Unique Application Instance Id

Query Parameters

• fields(optional): string
  Attributes to be returned in the result. Comma-separated attributes are accepted.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Headers

• ResponseTime: string
  Captures the time in milliseconds taken for processing the request.

Body ()

Root Schema : GetApplicationsByApplicationIdResponse

Type: object

Show Source

• accountForm(optional): object GetApplicationsByApplicationIdResponseAccountForm
• dataSetName(optional): string
• description(optional): string
• displayName(optional): string
• isSoftDelete(optional): string
• itResourceKey(optional): string
• itResourceName(optional): string
• key(optional): string
• links(optional): array links
• name(optional): string
• objectKey(optional): string
• objectName(optional): string
• type(optional): string

{
    "properties":{
        "key":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "dataSetName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "itResourceKey":{
            "type":"string"
        },
        "itResourceName":{
            "type":"string"
        },
        "objectKey":{
            "type":"string"
        },
        "objectName":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "isSoftDelete":{
            "type":"string"
        },
        "accountForm":{
            "$ref":"#/definitions/GetApplicationsByApplicationIdResponseAccountForm"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : GetApplicationsByApplicationIdResponseAccountForm

Type: object

Show Source

• activeVersion(optional): string
• childObjects(optional): array childObjects
• description(optional): string
• formFields(optional): array formFields
• formKey(optional): string
• isChild(optional): string
• latestVersion(optional): string
• name(optional): string

{
    "properties":{
        "activeVersion":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "formKey":{
            "type":"string"
        },
        "latestVersion":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "isChild":{
            "type":"string"
        },
        "formFields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GetApplicationsByApplicationIdResponseFormField"
            }
        },
        "childObjects":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GetApplicationsByApplicationIdResponseChildObject"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : childObjects

Type: array

Show Source

• Array of: object GetApplicationsByApplicationIdResponseChildObject

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GetApplicationsByApplicationIdResponseChildObject"
    }
}

Nested Schema : formFields

Type: array

Show Source

• Array of: object GetApplicationsByApplicationIdResponseFormField

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GetApplicationsByApplicationIdResponseFormField"
    }
}

Nested Schema : GetApplicationsByApplicationIdResponseChildObject

Type: object

Show Source

• description(optional): string
• formFields(optional): array formFields
• formKey(optional): string
• isChild(optional): string
• latestVersion(optional): string
• name(optional): string

{
    "properties":{
        "description":{
            "type":"string"
        },
        "formKey":{
            "type":"string"
        },
        "latestVersion":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "isChild":{
            "type":"string"
        },
        "formFields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GetApplicationsByApplicationIdResponseFormField"
            }
        }
    }
}

Nested Schema : formFields

Type: array

Show Source

• Array of: object GetApplicationsByApplicationIdResponseFormField

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GetApplicationsByApplicationIdResponseFormField"
    }
}

Nested Schema : GetApplicationsByApplicationIdResponseFormField

Type: object

Show Source

• defaultValue(optional): string
• fieldKey(optional): string
• isEncrypted(optional): string
• label(optional): string
• length(optional): string
• name(optional): string
• type(optional): string
• variantType(optional): string

{
    "properties":{
        "fieldKey":{
            "type":"string"
        },
        "label":{
            "type":"string"
        },
        "length":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "variantType":{
            "type":"string"
        },
        "defaultValue":{
            "type":"string"
        },
        "isEncrypted":{
            "type":"string"
        }
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

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

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/applications/3"
        }
    ],
    "id": "3",
    "name": "DisconnectedAppInstance1",
    "dataSetName": "DisconnectedAppInstance1",
    "description": "DisconnectedAppInstance1",
    "displayName": "DisconnectedAppInstance1",
    "itResourceKey": "10",
    "itResourceName": "DisconnectedAppInstance1",
    "objectKey": "9",
    "objectName": "DisconnectedAppInstance1",
    "type": "Disconnected",
    "isSoftDelete": "false",
    "accountForm": {
        "activeVersion": "0",
        "description": "DisconnectedAppInstance1 Form",
        "formKey": "18",
        "latestVersion": "0",
        "name": "UD_DIS461",
        "isChild": "false",
        "formFields": [
            {
                "fieldKey": "270",
                "label": "ITResource",
                "length": "0",
                "name": "UD_DIS461_IT",
                "type": "ITResourceLookupField",
                "variantType": "long",
                "defaultValue": "0",
                "isEncrypted": "false"
            },
            {
                "fieldKey": "271",
                "label": "Account Login",
                "length": "256",
                "name": "UD_DIS461_LOGIN",
                "type": "TextField",
                "variantType": "String",
                "defaultValue": "",
                "isEncrypted": "false"
            },
            {
                "fieldKey": "272",
                "label": "Password",
                "length": "125",
                "name": "UD_DIS461_PASSWORD",
                "type": "PasswordField",
                "variantType": "String",
                "defaultValue": "",
                "isEncrypted": "true"
            },
            {
                "fieldKey": "273",
                "label": "Account ID",
                "length": "256",
                "name": "UD_DIS461_ACCOUNTID",
                "type": "TextField",
                "variantType": "String",
                "defaultValue": "",
                "isEncrypted": "false"
            }
        ]
    }
}

Back to Top