Get Application Information


Get the information of an application.

Request Format


GET https://{apigw-address}/app-portal-service/v2.3/app/get

Request Parameters (URI)


Name

Location(Path/Query)

Required/Optional

Data Type

Description

orgId

Query

Required

String

OU ID. How to get orgId >>

appId

Query

Required

String

The access key of the application. How to get Access Key >>

Response Parameters


Name

Data Type

Description

id

String

The application ID.

code

String

Application code.

nameJson

Object

The application name in its respective locale’s language. Internationalized name struct >>

displayName

String

The display name of the application.

descriptionJson

Object

The application description in its respective locale’s language.

createdType

Number

Application Type.

  • 0 means this is an application obtained from another OU.

  • 1 means this is an application created in this OU.

  • 2 means this is an application shortcut.

order

number

The order of the application.

category

ApplicationCategory Struct

The application category ID and name. For example, 21 represents “Wind” and 22 represents “Solar”. For details on the structure, see ApplicationCategory Struct. ApplicationCategory Struct >>

isEnable

Boolean

Whether the application is enabled. true for enabled, false for disabled.

isDisplay

Boolean

Whether the application is displayed on the navigation pane. true for displayed. false for not displayed.

tags

Tags List

The list of application tags. Tags List >>

menus

AppResourceDTO Struct

The list of application menus. AppResourceDTO Struct >>

permissions

AppResourceDTO Struct

The list of application permissions. AppResourceDTO Struct >>

ApplicationCategory Struct


Name

Data Type

Description

id

Integer

The application category ID.

name

String

The application category name.

Tags List


Name

Data Type

Description

key

String

The key of a tag.

value

String

The value of a tag.

AppResourceDTO Struct


Name

Data Type

Description

id

String

Menu or permission ID.

code

String

Menu or permission code.

nameJson

Object

The menu or permission name in its respective locale’s language.

descriptionJson

Object

The menu or permission description in its respective locale’s language.

url

String

Menu URL.

displayOrder

Integer

The display order of the menu. The value is an integer starting from 1. The smaller the number is, the higher the place on the menu list.

parentId

String

The parent menu ID.

children

AppResourceDTO Struct

The details of the child menus.

Error Codes


Error Code

Description

31400

Required parameters are missing.

31404

The application does not exist, or the OU does not acquire the application.

Samples

Request Sample


url: /app-portal-service/v2.3/app/get?orgId=your_org_id&appId=your_access_key

method: GET

Return Sample


{
    "code": 0,
    "data": {
        "id": "app_123456",
        "code": "APP_CODE_001",
        "nameJson": {
            "default": "Sample Application"
        },
        "displayName": "Sample App",
        "descriptionJson": {
            "default": "This is a sample application for demonstration."
        },
        "createdType": 1,
        "order": 10,
        "category": {
            "id": 22,
            "name": "Solar",
            "isEnable": true,
            "isDisplay": true,
            "tags": [{
                    "key": "environment",
                    "value": "production"
                },
                {
                    "key": "version",
                    "value": "1.0.0"
                }
            ],
            "permissions": [{
                    "code": "Write",
                    "nameJson": {
                        "default": "Write",
                        "en_US": "WriteUS",
                        "zh_CN": "WriteCN",
                        "es_ES": "WriteES",
                        "ja_JP": "WriteJP"
                    },
                    "displayOrder": 0,
                    "name": "your_menu_name",
                    "id": "your_menu_id",
                    "url": "",
                    "parentId": ""
                },
                {
                    "code": "Read",
                    "nameJson": {
                        "default": "Read",
                        "en_US": "ReadUS",
                        "zh_CN": "ReadCN",
                        "es_ES": "ReadES",
                        "ja_JP": "ReadJP"
                    },
                    "displayOrder": 0,
                    "name": "your_menu_name",
                    "id": "your_menu_id",
                    "url": "",
                    "parentId": ""
                }
            ],
            "menus": [{
                "code": "menu2",
                "nameJson": {
                    "default": "menu2",
                    "en_US": "menu2US",
                    "zh_CN": "menu2CN",
                    "es_ES": "menu2ES",
                    "ja_JP": "menu2JP"
                },
                "children": [{
                    "code": "menu2_1",
                    "nameJson": {
                        "default": "menu2-1",
                        "en_US": "menu2-1US",
                        "es_ES": "menu2-1ES",
                        "ja_JP": "menu2-1JP"
                    },
                    "children": [

                    ],
                    "displayOrder": 1,
                    "name": "your_menu_name",
                    "id": "your_menu_id",
                    "url": "your_menu_url",
                    "parentId": "your_parent_menu_id"
                }],
                "displayOrder": 1,
                "name": "your_menu_name",
                "id": "your_menu_id",
                "url": "",
                "parentId": ""
            }, ]
        },
        "message": "OK"
    }
}