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. Enligh as default

en_US for English

zh_CN for Simplified Chinese

es_ES for Spanish

ja_JP for Japanese

authorization

Optional

String

User access token. If not empty, return the assets and their parent nodes that are available for the user

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	tags
assets	AssetDTO Struct	Asset information
children	Data Struct	Organization structure sub-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 purchase 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": "asset1",
                        "assetNameJson": {
                            "default": "assetName1",
                            "zh_CN": "assetNameZh1"
                        },
                        "displayOrder": 0,
                        "assetName": "assetName1"
                    }
                ],
                "children": [
                    {
                        "assets": [
                            {
                                "assetId": "asset2",
                                "assetNameJson": {
                                    "default": "assetName2"
                                },
                                "displayOrder": 0,
                                "assetName": "assetName2"
                            },
                            {
                                "assetId": "asset3",
                                "assetNameJson": {
                                    "default": "assetName3"
                                },
                                "displayOrder": 0,
                                "assetName": "assetName3"
                            }
                        ],
                        "children": [],
                        "name": "structure1",
                        "displayOrder": 0,
                        "description": "",
                        "id": "sgxxxxxxxxxxx1",
                        "parentId": "sgxxxxxxxxx2",
                        "tags": {}
                    }
                ],
                "name": "structure2",
                "displayOrder": 0,
                "description": "",
                "id": "sgxxxxxxxxx2",
                "parentId": "sgxxxxxxxxx3",
                "tags": {}
            }
        ],
        "name": "structure3",
        "displayOrder": 0,
        "description": "",
        "id": "sgxxxxxxxxx3",
        "parentId": "",
        "tags": {
            "key1": "value1"
        }
    },
    "message": "OK"
}