Query Meta Attribute


Get meta attributes by object type IDs.

Request Format


GET https://{api-gateway}/cds-meta-service/v1.0/attribute?action=query

Request Parameters


Name

Location

Mandatory/Optional

Data Type

Description

orgId

Query

Mandatory

String

The organization ID which the attribute belongs to. How to get orgId >>

mdmTypes

Query

Mandatory

String

The object type ID which the attribute belongs to. Separate multiple IDs by commas. Up to 100 object type IDs are allowed in a single query. How to get mdmTypes>>

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.

Response Content Type


application/json; charset = UTF-8

Response Codes


See Common Data Service API Response Codes.

Samples

Request Sample


GET https://{api-gateway}/cds-meta-service/v1.0/attribute?action=query&orgId=yourOrgId&mdmTypes=yourMdmType

Response Sample


{
   "data":[
         {
            "mdmType":"yourMdmType",
            "modelId": "yourMdmId",
            "name":"Commissioning Date",
            "attribute":"operativeDate",
            "units":"--",
            "type":"date"
         },
         {
            "mdmType":"yourMdmType",
            "modelId": "yourMdmId",
            "name":"Onboarding Date",
            "attribute":"etlDate",
            "units":"--",
            "type":"date"
         },
         {
            "mdmType":"yourMdmType",
            "modelId": "yourMdmId",
            "name":"objectTypeID",
            "attribute":"objectTypeID",
            "units":"--",
            "type":"string"
         },
         {
            "mdmType":"yourMdmType",
            "modelId": "yourMdmId",
            "name":"Unit Price",
            "attribute":"correctedPrice",
            "units":"--",
            "type":"Double"
         }
   ],
   "code":0,
   "msg":"OK",
   "traceId": "1234567890abcdefghijkl0987654321"
}