Retrieve commodity code NIs based on composite Keys - Intergraph Smart Reference Data - Help - Intergraph

Intergraph Smart Reference Data REST API (10.2)

Language
English
Product
Intergraph Smart Reference Data
Search by Category
Help
Smart Materials/Smart Reference Data Version
10.2

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

To retrieve specific commodity code Nls data based on composite keys:

GET

https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5018)/CommodityParts(5549)/CommodityCodes(75362)/CommodityCodeNls(CommodityId=75362,NlsId=1)

Response

Parameter

Description

Type

Notes

CommodityId

A unique ID for the commodity code

Integer

NlsId

Language identifier

Integer

ControlStatus

Retrieves the control status of the instance

Integer

ShortDescription

Short descriptive text

String

Required

Description

Descriptive text

String

Required

Sample response

{

"@odata.context":

"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5018)/CommodityParts(5549)/CommodityCodes(75362)/CommodityCodeNls",

"value": [

{

"CommodityId": 75362,

"NlsId": 1,

"ControlStatus": 1,

"ShortDescription": " BFYLUG , Gen manu , CL1501288 , RFTBE , Drive, gear operator , ASTM A351-CF8M , AISI 316 SS Trim , 316 SS/PTFE ST ",

"Description": " Butterfly valve, lugged , Generic manufacturer , Class 1501288 , Raised-face thru-bolted end without bolt holes , Drive, gear operator , ASTM A351-CF8M , AISI 316 SS Trim , 316 SS/PTFE ST "

}

]

}

This is the filtered response using the composite keys i.e. CommodityId=75362, NlsId =1