Get User’s Applications¶

Get a list of applications that the current user has permission to access.

Prerequisites¶

The user has logged in to Application Portal and entered an OU. You can log in to Application Portal through the Log In API and select the OU through the Choose Organization API.

Request Format¶

GET http://{apigw-address}/app-portal-service/v2.2/user/app/list

Request Parameters (Header)¶

Name	Required/Optional	Data Type	Description
Authorization	Required	String	The access token generated after the user logs in and selects the OU, represented by Bearer Token, is in the form of `Bearer {your token}`. You can call the Log In or Refresh Access Token API to obtain the access token.

Response Parameters¶

Name	Data Type	Description
apps	AppDTO Struct	The details of the application. AppDTO Struct >>

AppDTO Struct¶

Name	Data Type	Description
id	String	The application ID.
code	String	The application identifier code.
name	String	The application name.
description	String	The application description.
nameJson	I18nString	The application name in multiple languages.
descriptionJson	I18nString	The application description in multiple languages.
displayName	String	The display name of the application.
type	Integer	The application type. `0` means web application. `1` means mobile application.
createdTime	String	The time the application was created
status	Boolean	The application status under the OU. `true` means the application is enabled. `false` means the application is disabled.
order	Integer	The position of the application in the OU. `0` means the first position. The higher the number, the lower the position.
url	String	The URL of the application.
isShortcut	Boolean	Whether the application is a shortcut. `true` means it is a shortcut, `1` means it is not a shortcut.
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 >>

ApplicationCategory Struct¶

Name	Data Type	Description
id	Integer	The application category ID.
name	String	The application category name.

List of Application Categories¶

ID	Name
21	Wind
22	Solar
23	Hydroelectricity
24	Thermal
25	Storage
26	Pile
27	Electricity Sale
28	Distribution Network
29	Micro Intelligent Network
30	Industry Park
31	Smart Building
32	Smart City
33	AI
34	Other
35	Comprehensive
36	Substation

Error Codes¶

Code	Description
31401	Access Token is invalid
31512	Selecting an OU is required

Samples¶

Request Sample¶

url: http://{apigw-address}/app-portal-service/v2.2/user/app/list

method: GET

headers: {"Authorization":"Bearer your_token"}

Return Sample¶

{
  "code": 0,
  "message": "OK",
  "data": {
    "pagination": null,
    "apps": [
      {
        "id": "accessKey",
        "code": "Electricity_Sale",
        "name": "Electricity Sale",
        "description": "Electricity Sale",
        "nameJson": {
          "default": "Electricity Sale"
        },
        "descriptionJson": {
          "default": "Electricity Sale"
        },
        "displayName": "",
        "type": 0,
        "createdTime": "2024-06-24 03:36:16",
        "status": true,
        "order": 1,
        "url": null,
        "isShortcut": false
        "category": {
          "id": 22,
          "name": "Solar",
          "code": null,
          "description": null,
          "nameJson": null,
          "descriptionJson": null
        }
      }
    ]
  }
}