Retrieve Commodity Rules - 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

Sample URI request

To retrieve all the commodity rules in the project:

GET

https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityRules

To retrieve commodity rule for a given commodity rule Id:

GET

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

Get URI Parameter

Parameter

Description

Type

Required

CommodityRuleId

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

Integer

Required

Response

Element

Description

Type

Notes

CommodityRuleId

A unique ID for the commodity rule.

Integer

Project

The project or product group from where the table is retrieved.

String

CommodityRuleName

Name of the commodity rule

String

ControlStatus

Retrieves the control status of the instance.

Sample Response

{

"@odata.context":

"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityRules",

"value": [

{

"CommodityRuleId": 5401,

"Project": "SDB",

"CommodityRuleName": "PLC_RULE",

"ControlStatus": 1,

}

]

}