Retrieve Commodity Codes with Geometrics - 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 commodity code along with the geometrics

GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)//CommodityGroups(5018)/CommodityParts(5549)/CommodityCodes(46800)?$expand=CommodityCodeGeometrics

To retrieve only geometrics for a specific commodity code:

GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5018)/CommodityParts(5549)/CommodityCodes(46800)/CommodityCodeGeometrics

Response

Parameter

Description

Type

Notes

CommodityId

A unique ID for the commodity code.

Integer

CommodityCode

Name of the commodity code.

String

Project

Retrieves the project details for the selected commodity code.

String

DisciplineId

Retrieves the discipline details for the selected project.

Integer

CommodityType

Type of commodity code.

String

Available commodity types are TB(Table based), AB(Attribute based), CT(Commodity Type), and OT(Other Type).

StandardName

Name of the standard

String

ObjectParameterName

Name of the object parameter. The id of the part-obj-parm intersection is stored here.

String

ControlStatus

Retrieves the control status of the instance.

Integer

CommodityGroupId

The commodity group id to which you want to retrieve the data.

Integer

CommodityPartId

The object parameter that is associated to the group which is used to generate ident.

Integer

GeometricId

Reference to the

Geometric instance.

Integer

IdentKey

Is the geometric has been used for building the ident?

String

Sample response

{

"@odata.context":

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

"value": [

{

"CommodityId": 46800,

"CommodityCode": "VYLAA2DFTBARL1ABZZZ",

"Project": "SDB",

"DisciplineId": 5020,

"CommodityType": "TB",

"StandardName": null,

"ObjectParameterName": "P_1N_E",

"ControlStatus": 1,

"CommodityGroupId": 5018,

"CommodityPartId": 5549,

"CommodityCodeGeometrics@odata.context":

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

"CommodityCodeGeometrics": [

{

"CommodityId": 46800,

"GeometricId": 5002,

"IdentKey": "ON"

},

{

"CommodityId": 46800,

"GeometricId": 11122,

"IdentKey": "OFF"

}

]

}

]

}