Retrieve Specific NLS Data 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

GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5018)/CommodityParts(5547)/CommodityPartNls(CommodityPartId=5547,NlsId=1)

Response

Parameter

Description

Type

Notes

CommodityGroupId

A unique ID for the commodity group

Integer

CommodityPartId

A unique ID for the commodity part

String

NlsId

Language identifier

Integer

Required

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(5547)/CommodityPartNls/$entity",

"CommodityGroupId": 5018,

"CommodityPartId": 5547,

"NlsId": 1,

"ControlStatus": 1,

"ShortDescription": "Butterfly Vlv",

"Description": "Butterfly Valve"

}