Retrieve Commodity Group - Intergraph Smart Reference Data - Help - Intergraph

Intergraph Smart Reference Data REST API (10.2)

Language
English
Product
Intergraph Smart Reference Data
Search by Category
Help
Smart Materials/Smart Reference Data Version
10.2

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 commodity groups:

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

To retrieve commodity group for a specific Id:

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

Parameter

Description

Type

Required

CommodityGroupId

The commodity group 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

CommodityGroupName

Name of the commodity group

String

ControlStatus

Retrieves the control status of the instance

Integer

DisciplineId

Retrieves the discipline details for the selected commodity group.

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

ObjectParameterId

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

Integer

ANGLE

ANGLE attribute is associated with ATTR_CHAR1 physical attribute for M_COMMODITY_GROUPS physical table.

String

CRPF

CRPF attribute is associated with ATTR_NUM1 physical attribute for M_COMMODITY_GROUPS physical table.

Integer

Sample Response

{

"@odata.context":

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

"CommodityGroupId": 5000,

"CommodityGroupName": "B",

"ControlStatus": 1,

"DisciplineId": 5020,

"Project": "SDB",

"CommodityRuleId": 5005,

"StandardName": null,

"ObjectParameterId": null,

"ANGLE": "A",

"CRPF": 1.2

}

To retrieve mapped dynamic attributes for commodity groups:

GET

https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups/Com.Ingr.Srd.V2.DynamicAttributes()/

Sample Response

{

"@odata.context":

"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Com.Ingr.Srd.V2.DynamicAttributesInformation",

"AttributeDetails": [

{

"AttributeName": "ANGLE",

"PhysicalAttribute": "AttributeCharacter1"

},

{

"AttributeName": "CRPF",

"PhysicalAttribute": "AttributeNumber1"

}

]

}

  • 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.