Retrieve Commodity Code Details - Intergraph Smart Reference Data - Customization & Programming - Hexagon

SRD REST API

ft:locale
en-US
Product
Intergraph Smart Reference Data
Search by Category
Customization & Programming
Smart Materials/Smart Reference Data Version
10.6

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

To retrieve a commodity code details for a commodity code:

GET

https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5004)/CommodityParts(5452)/CommodityCodes(86860)/CommodityCodeDetails

Response

Parameter

Description

Type

Notes

CommodityId

A unique ID for the commodity code.

Integer

ControlStatus

Retrieves the control status of the instance.

Integer

SeqId

Sequence of the commodity code detail

Integer

TableDetailId

Reference to the table detail instance

Integer

UsedForCodeBuilding

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

String

Sample response

{

    "@odata.context": 

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

    "value": [

        {

            "CommodityId": 87860,

            "SeqId": 4,

            "TableDetailId": 5610,

            "UsedForCodeBuilding": "Y",

            "ControlStatus": 1

        },

        {

            "CommodityId": 87860,

            "SeqId": 8,

            "TableDetailId": 11191,

            "UsedForCodeBuilding": "Y",

            "ControlStatus": 1

        },

        {

            "CommodityId": 87860,

            "SeqId": 10,

            "TableDetailId": 11712,

            "UsedForCodeBuilding": "Y",

            "ControlStatus": 1

        },

        {

            "CommodityId": 87860,

            "SeqId": 15,

            "TableDetailId": 13647,

            "UsedForCodeBuilding": "N",

            "ControlStatus": 1

        },

        {

            "CommodityId": 87860,

            "SeqId": 16,

            "TableDetailId": 11276,

            "UsedForCodeBuilding": "N",

            "ControlStatus": 1

        }

    ]