Retrieve a Commodity Rule with Nls - Intergraph Smart Reference Data - Version 2020 (10.0) - Help - Intergraph

Intergraph Smart Reference Data REST API (2020)

Language
English
Product
Intergraph Smart Reference Data
Search by Category
Help
Smart Materials/Smart Reference Data Version
2020 (10.0)

Sample URI request

GET

https://<appserver with domain>/<virtual_directory>/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityRules(5000)?$expand=CommodityRuleNls

Where ?$expand=CommodityRuleNls is the query to retrieve Nls records along with the commodity rule.

SHARED Tip You can also query by

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

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

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>/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityRules",

"value": [

{

"CommodityRuleId": 5544,

"Project": "SDB",

"CommodityRuleName": "CRNLS",

"ControlStatus": 1,

"CommodityRuleNls@odata.context":

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

"CommodityRuleNls": [

{

"CommodityRuleId": 5544,

"NlsId": 1,

"ControlStatus": 1,

"ShortDescription": "No Rating Fittings",

"Description": "No Rating Fittings"

}

]

}

]

}

Use the following sample GET method to view the associated commodity rule and the commodity rule details that you have created:

GET https://<appserver with domain>/<virtual_directory>/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityRules(5000)?$expand=CommodityRuleDetails

Where ??$expand=CommodityRuleDetails is the query to retrieve the associated commodity rule details records along with the commodity rule.

SHARED Tip You can also query by https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityRules(5000)CommodityRuleDetails URI request.