Create App¶
Create an application for this OU.
Operation Permissions¶
Applications assigned with the Application Registration Administrator policy in the OU.
Request Format¶
POST https://{apigw-address}/enos-app-service/v2.5/apps
Request Parameters(URI)¶
Name |
Location(Path/Query) |
Required/Optional |
Data Type |
Description |
---|---|---|---|---|
orgId |
Query |
Required |
String |
The OU ID which the application belongs to. How to get orgId >> |
Request Parameters(Header)¶
Name |
Required/Optional |
Data Type |
Description |
---|---|---|---|
accept-language |
Optional |
String |
The required language, such as “zh-CN” or “en-US”. If not specified, the default return message will include all available internationalized content. EnOS Supported Languages >> |
Request Parameters(Body)¶
Name |
Required/Optional |
Data Type |
Description |
---|---|---|---|
name |
Required |
StringI18n |
The application name. Internationalized field representation >> |
category |
Required |
Integer |
The application category ID, such as |
type |
Required |
integer |
The application types. |
keyword |
Optional |
String |
The custom unique identifier for the application. |
icon |
Optional |
String |
The application icon, represented as a base64-encoded string of the image data. |
description |
Optional |
StringI18n |
The description of the application. Internationalized field representation >> |
url |
Optional |
String |
The application URL. |
Response Parameters¶
Name |
Data Type |
Description |
---|---|---|
id |
String |
The application ID generated by the system. |
accessKey |
String |
The application accessKey. |
secretKey |
String |
The application secretKey. |
name |
StringI18n |
The application name. |
description |
StringI18n |
The application description. |
categoryId |
String |
The application category ID. |
categoryName |
StringI18n |
The application category name. |
keyword |
String |
The custom unique identifier for the application. |
type |
String |
The application type. |
icon |
String |
The application icon. |
url |
String |
The application URL. |
organizationId |
String |
The OU ID of the application. |
organizationName |
String |
The OU name of the application. |
createdByUserId |
String |
The user ID which the application was created by. |
createdAt |
String |
The time which the application was created on. |
status |
String |
The status of the application, fixed at 2, which means the application has been obtained. |
createdByUserName |
String |
The user name which the application was created by. |
approvedAt |
String |
The time which the application purchase request was approved on. |
Samples¶
Request Sample¶
url: https://{apigw-address}/enos-app-service/v2.5/apps?orgId=yourOrgId
method: POST
request Body:
{
"icon": "",
"name": {
"en_US": "Energy Management",
"zh_CN":"",
"default": "Energy Management"
},
"description": {
"en_US": "Energy Management",
"zh_CN": "",
"default": "Energy Management"
},
"type": 0,
"keyword": "energy-management",
"category": 101,
"url": ""
}
Return Sample¶
{
"code": 0,
"msg": "OK",
"subMsg": null,
"data": {
"id": "abc-applicationID-xyz",
"accessKey": "accesskey-application",
"secretKey": "secretkey-application",
"name": {
"default": "Energy Management",
"en_US": "Energy Management",
},
"description": {
"default": "Energy Management",
"en_US": "Energy Management",
},
"keyword": "energy-management",
"categoryId": 101,
"categoryName": {
"pl_PL": "",
"en_US": "Storage",
"es_ES": "",
"zh_CN": "储能",
"fr_FR": "",
"ja_JP": "",
"de_DE": ""
},
"type": 0,
"icon": "",
"url": "",
"organizationId": "yourorgId",
"organizationName": "Your OU Name",
"createdByUserId": "abc-userID-xyz",
"createdAt": "2024-01-19 08:40:45",
"status": 2,
"createByUserName": null,
"approvedAt": null
}
}