Get Structure by App¶
Get the organization structure root node assigned to an application.
Request Format¶
GET https://{apigw-address}/app-portal-service/v2.3/structure-service/structures/app
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 visible organization structures of the user in the application. |
Request Parameters (URI)¶
Name | Mandatory/Optional | Data Type | Description |
---|---|---|---|
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 | structure tags. |
Samples¶
Request Sample¶
url: https://{apigw-address}/app-portal-service/v2.3/structure-service/structures/app
method: GET
Return Sample¶
{
"code": 0,
"data": [
{
"name": "your_structure_name",
"displayOrder": 0,
"description": "",
"id": "your_structure_id",
"parentId": "",
"tags": {
"key1": "value1"
}
}
],
"message": "OK"
}