Query Accessible Asset Type¶

Get a list of accessible asset types.

Request Format¶

GET https://{api-gateway}/cds-asset-service/v1.0/accessible-asset-type?action=query

Request Parameters¶

Name	Location	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The organization ID which the asset type belongs to. How to get orgId >>
locale	Query	Optional	String	Use zh-CN, en-US, ja-JP, or es-ES. If not specified, the value is set to en_US by default.
withI18n	Query	Optional	Boolean	Whether to return the internationalization content. The value is `true` or `false`. Default is false.
withElementGroupInfo	Query	Optional	Boolean	Whether to return the visualization group information. The default value is true.

Response Content Type¶

application/json; charset = UTF-8

Response Parameters¶

Name	To Return Definitely/Conditionally	Data Type	Description
mdmType	Definitely	String	The corresponding object type.
modelId	Conditionally	String	The model ID which the asset type is associated with.
amcType	Conditionally	String	The identifier of the corresponding asset type in Configuration Center.
domain	Definitely	String	The identifier of the domain that the asset type belongs to.
domainName	Definitely	String	The name of the domain that the asset type belongs to in the corresponding request language.
domainNameI18n	Conditionally	I18n Struct	Describe the internalization content of the domain name. See I18n Struct.
isSite	Conditionally	Boolean	Whether the asset type is a site type.
isDeviceGroup	Conditionally	Boolean	Whether the asset type is a device group type.
name	Definitely	String	The name of the asset type in the corresponding request language.
nameI18n	Conditionally	I18n Struct	Describe the internalization content of the asset type. See I18n Struct.
icons	Conditionally	Map (The Key and Value are of the String type)	The display icon of the asset type.
dimensions	Conditionally	Map (The Key is of the String type and the Value is a Dimension Struct)	The supported aggregation dimensions. See Dimension Struct.
dimensionPermutation	Conditionally	String	The supported Dimension Combination Attribute of the asset type.
groups	Conditionally	Group Struct	Describe the visualization group information of the asset type. See Group Struct.

I18n Struct ¶

Name	To Return Definitely/Conditionally	Data Type	Description
defaultValue	Definitely	String	The default content.
en_US	Conditionally	String	The English content.
zh_CN	Conditionally	String	The Chinese content.
es_ES	Conditionally	String	The Spanish content.
ja_JP	Conditionally	String	The Japanese content.

Dimension Struct ¶

Name	To Return Definitely/Conditionally	Data Type	Description
name	Definitely	String	The name of the dimension in the corresponding request language.
nameI18n	Conditionally	I18n Struct	Describe the internalization content of dimension name. See I18n Struct.
level	Definitely	String	The level of the dimension. child indicates a one-to-many dimension and self indicates a one-to-one dimension.
attribute	Conditionally	String	The attribute used to describe the dimension identifier.
nameAttribute	Conditionally	String	The attribute used to describe the dimension name.
enumSource	Conditionally	String	The source of the enumeration values of the enumerated dimension.
enumerate	Conditionally	String	The static enumeration values.
recordType	Conditionally	String	The identifier of the record type associated with the enumeration values.
recordMapping	Conditionally	Map (The Key and Value are of the String type)	The fields of the record type associated with the enumeration values.
filters	Conditionally	String	The supported filters of the dimension.
mdmType	Conditionally	String	The corresponding object type of the dimension.

Group Struct ¶

Name	To Return Definitely/Conditionally	Data Type	Description
groupName	Definitely	String	The name of the visualization group in the corresponding request language.
groupNameI18n	Conditionally	I18n Struct	Describe the internalization content of the visualization group name. See I18n Struct.
groupOrder	Definitely	Integer	The order of the visualization group.
elementName	Definitely	String	The name of the element in the visualization group in the corresponding request language.
elementNameI18n	Conditionally	I18n Struct	Describe the internalization content of the element. See I18n Struct.
elementOrder	Definitely	Integer	The order of the element in the visualization group.
area	Definitely	Map (The Key is of the String type and the Value is an Area Struct)	Describe the area in the visualization group. See Area Struct.

Area Struct ¶

Name	To Return Definitely/Conditionally	Data Type	Description
areaName	Definitely	String	The name of the area in the corresponding request language.
areaNameI18n	Conditionally	I18n Struct	Describe the internalization content of the area name. See I18n Struct.
areaOrder	Definitely	Integer	The order of the area.

Response Codes¶

See Common Data Service API Response Codes.

Samples¶

Request Sample¶

GET https://{api-gateway}/cds-asset-service/v1.0/accessible-asset-type?action=query&orgId=yourOrgId

Response Sample¶

{
    "data": [
        {
            "mdmType": "yourMdmType",
            "domain": "solar",
            "domainName": "Solar",
            "isSite": true,
            "name": "*************",
            "dimensions": {
                "inverterModel": {
                    "nameI18n":{},
                    "attribute": "",
                    "nameAttribute":"",
                    "level": "self/child"
                }
            }
        },
        {
            "mdmType": "yourMdmType",
            "domain": "solar",
            "domainName": "Solar",
            "isSite": false,
            "name": "*************"
        }
    ],
   "code": 0,
   "msg": "OK",
   "traceId": "1234567890abcdefghijkl0987654321"
}