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

Sample URI request

To retrieve all the commodity parts for a specific group:

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

To retrieve a specific commodity part for a group:

GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5000)/CommodityParts(<CommodityPartId>)

GET URI Parameter

Parameter

Description

Type

Required

CommodityPartId

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

Integer

Required

Response

Parameter

Description

Type

Notes

CommodityGroupId

A unique ID for the commodity group

Integer

CommodityPartId

A unique ID for the commodity part

String

CommodityPartName

Retrieves the name of the commodity part

ControlStatus

Retrieves the control status of the instance

Integer

KindOfPart

Special function for branches

Integer

Project

Retrieves the project details for the selected commodity group.

String

CommodityRuleId

The rules that is associated to the group which is used to generate commodity code.

Integer

StandardName

Name of the standard

String

AttributeSetId

Integer

E_BENDANGLE

E_BENDANGLE attribute is associated with ATTR_CHAR1 physical attribute for M_PARTS physical table

String

BR_LEGEND

BR_LEGEND attribute is associated with ATTR_CHAR2 physical attribute for M_PARTS physical table

String

ISREDUCING

ISREDUCING attribute is associated with ATTR_CHAR3 physical attribute for M_PARTS physical table

String

PDS_LABEL

PDS_LABEL attribute is associated with ATTR_CHAR5 physical attribute for M_PARTS physical table

String

TRAPHEIGHTTOPTOCEN

TRAPHEIGHTTOPTOCEN attribute is associated with ATTR_CHAR5 physical attribute for M_PARTS physical table

String

Sample Response

{

"@odata.context":

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

"value": [

{

"CommodityGroupId": 5000,

"CommodityPartId": 5393,

"CommodityPartName": "M94",

"Project": "SDB",

"ControlStatus": 1,

"KindOfPart": "VARIABLE",

"CommodityRuleId": 5000,

"StandardName": "ALL",

"AttributeSetId": null,

"E_BENDANGLE": "",

"BR_LEGEND": "",

"ISREDUCING": "",

"PDS_LABEL": "[406]bore to match",

"TRAPHEIGHTTOPTOCEN": ""

}

]

}

  • Dynamic attribute name and it’s label text shall not have spaces (like NPD From) as OData query operation cannot be performed on columns having spaces.

  • Dynamic attribute name and it’s label text shall not start with number (like 1_END_PRP_SP3D) as OData query operation cannot be performed on columns starting with number.