Retrieve commodity code details based on composite keys - 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)

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

To retrieve specific commodity code details data based on composite keys:

GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5018)/CommodityParts(5549)/CommodityCodes(75362)/CommodityCodeDetails(CommodityId=75362,SeqId=4)

Response

Parameter

Description

Type

Notes

CommodityId

A unique ID for the commodity code.

Integer

SeqId

Rule details identifier

Integer

Generated by the software.

TableDetailId

Reference to the table detail instance

Integer

UsedForCodeBuilding

Is the table detail used for building the commodity code? Y or N

String

Required

ControlStatus

Retrieves the control status of the instance

Integer

Optional

Sample response

{

"@odata.context":

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

"value": [

{

"CommodityId": 75362,

"SeqId": 4,

"TableDetailId": 5610,

"UsedForCodeBuilding": "Y",

"ControlStatus": 1

}

]

}

This is the filtered response using the composite keys i.e. CommodityId=75362,SeqId=4