Retrieve Commodity Codes with Nls - Intergraph Smart Reference Data - Help - Intergraph

Intergraph Smart Reference Data REST API (10.1)

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

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

To retrieve only Nls for a specific commodity code:

GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)//CommodityGroups(5018)/CommodityParts(5549)/CommodityCodes(46800)/CommodityCodeNls

To retrieve the commodity codes with Nls for a specific commodity code:

GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5000)/CommodityCode(<CommodityCodeId>)?$expand=CommodityCodeNls

Response

Parameter

Description

Type

Notes

CommodityId

A unique ID for the commodity code.

Integer

CommodityCode

Name of the commodity code

String

Project

Retrieves the project details for the selected commodity code

String

DisciplineId

Retrieves the discipline details for the selected project

Integer

CommodityType

Type of commodity code

String

Available commodity types are TB(Table based), AB(Attribute based), CT(Commodity Type), and OT(Other Type)

StandardName

Name of the standard

String

ObjectParameterName

Name of the object parameter. The id of the part-obj-parm intersection is stored here

String

ControlStatus

Retrieves the control status of the instance

Integer

CommodityGroupId

The commodity group id to which you want to retrieve the data

Integer

CommodityPartId

The object parameter that is associated to the group which is used to generate ident

Integer

NlsId

Language identifier

Integer

ShortDescription

Short description of the commodity code

Integer

Description

Description of the commodity code

Integer

Sample response

{

"@odata.context":

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

"value": [

{

"CommodityId": 46800,

"NlsId": 2,

"ControlStatus": 1,

"ShortDescription": " Bfly Vlv Lug Type , API 609 Cat B , CL150 , FFTBE , Drive, gear operator ASTM A182 Grade F 304 (UNS S30400) , AISI 316L + Stellite Trim ",

"Description": " Butterfly Valve Lug Type , API 609, Category B, Butterfly Valves: Double Flanged, Lug- and Wafer-Type , Class 150 , Flat Face Through Bolt End , Drive, gear operator ASTM A182 Grade F 304 (UNS S30400) , AISI 316L + Stellite Trim "

},

{

"CommodityId": 46800,

"NlsId": 1,

"ControlStatus": 1,

"ShortDescription": " BFYLUG , API 609 Cat B , CL150 , FFTBE , Drive, gear operator , ASTM A182 Grade F 304 (UNS S30400) , AISI 316L + Stellite Trim ",

"Description": " Butterfly valve, lugged , API 609, Category B, Butterfly Valves: Double Flanged, Lug- and Wafer-Type , Class 150 , Flat-face thru-bolted end without bolt holes , Drive, gear operator , ASTM A182 Grade F 304 (UNS S30400) , AISI 316L + Stellite Trim "

},

{

"CommodityId": 46800,

"NlsId": 20,

"ControlStatus": 1,

"ShortDescription": " Lug Butterfly , API 609 Cat B , Class 150 , FFTBE , Gear Operator ASTM A182-F 304 , AISI 316L + Stellite Trim ",

"Description": " Lug Butterfly , API 609 Category B , Class 150 , Flat Face Through Bolted End , Gear Operator ASTM A182-F 304 , AISI 316L + Stellite Trim "

}

]

}