Get Structure by Detail¶
Get all organization structure nodes assigned to an application.
Request Format¶
GET https://{apigw-address}/app-portal-service/v2.3/structure-service/structures/detail
Request Parameters (Header)¶
| Name | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| locale | Optional | String | Language code. If unspecified, it is set to English by default.
|
| authorization | Optional | String | User access token. If not empty, return the assets and their parent nodes that are available for the user. |
| needAssociatedAsset | Optional | Boolean | Return the resource information associated to the organization structure node. true for to return, false for not to return. |
Request Parameters (URI)¶
| Name | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| structureRootId | Mandatory | String | Organization structure ID. |
| appId | Mandatory | String | Application ID. |
| orgId | Mandatory | String | OU ID. |
Response Parameters¶
| Name | Data Type | Description |
|---|---|---|
| data | StructureDTO Struct | Organization structure information. |
StructureDTO Struct¶
| Name | Data Type | Description |
|---|---|---|
| id | String | Organization structure ID. |
| parentId | String | Parent node ID |
| name | String | Organization structure name. |
| description | String | Organization structure description. |
| displayOrder | Integer | Sort number. |
| tags | Object | Asset tags. |
| assets | AssetDTO Struct | Asset information. |
| children | Data Struct | Organization structure sub-node. |
| associatedResources | Data Struct | The resource associated with the node. |
AssetDTO Struct¶
| Name | Data Type | Description |
|---|---|---|
| assetId | String | Asset ID. |
| assetName | String | asset name. |
| displayOrder | Integer | Sort number. |
| assetNameJson | Object | asset name, supporting internationalization. |
Error Codes¶
| Error Code | Description |
|---|---|
| 31404 | Organization structure is not assigned to the application. |
| 31520 | The OU does not acquire the application. |
Samples¶
Request Sample¶
url: https://{apigw-address}/app-portal-service/v2.3/structure-service/structures/detail
method: GET
Return Sample¶
{
"code": 0,
"data": {
"children": [
{
"assets": [
{
"assetId": "your_resource_id_1",
"assetNameJson": {
"default": "your_resource_name_1",
"zh_CN": "your_resource_name_zh_1"
},
"displayOrder": 0,
"assetName": "your_resource_name_1"
}
],
"children": [
{
"assets": [
{
"assetId": "your_resource_id_2",
"assetNameJson": {
"default": "your_resource_name_2"
},
"displayOrder": 0,
"assetName": "your_resource_name_2"
},
{
"assetId": "your_resource_id_3",
"assetNameJson": {
"default": "your_resource_name_3"
},
"displayOrder": 0,
"assetName": "your_resource_name_3"
}
],
"children": [],
"name": "your_node_name_1",
"displayOrder": 0,
"description": "",
"id": "your_node_id",
"parentId": "your_parent_node_id",
"tags": {}
}
],
"name": "your_node_name_2",
"displayOrder": 0,
"description": "",
"id": "your_node_id_2",
"parentId": "your_parent_node_id",
"tags": {}
}
],
"name": "your_node_name_3",
"displayOrder": 0,
"description": "",
"id": "your_node_id_3",
"parentId": "",
"tags": {
"key1": "value1"
}
},
"message": "OK"
}