Retrieve Commodity Rules based on Composite Keys - 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

Sample URI request

GET

https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityRules(5000)/CommodityRuleNls(CommodityRuleId=5000,NlsId=1)

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

Response

Element

Description

Type

Notes

CommodityRuleId

A unique ID for the commodity rule

Integer

NlsId

Language identifier

Integer

ControlStatus

Retrieves the control status of the instance

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)/CommodityRules(5000)/CommodityRuleNls/$entity",

"CommodityRuleId": 5000,

"NlsId": 1,

"ControlStatus": 1,

"ShortDescription": "No Rating Fittings",

"Description": "No Rating Fittings"

}

This is the filtered response using the composite keys i.e. CommodityRuleId=5000 and NlsId=1