Add Commodity Group - Intergraph Smart Reference Data - Version 2016 R4 (8.4) - Administration & Configuration - Intergraph

Intergraph Smart Reference Data REST API 2016 R4 (8.4)

Language
English
Product
Intergraph Smart Reference Data
Search by Category
Administration & Configuration
Smart Materials/Smart Reference Data Version
2016 R4 (8.4)

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

POST body

Element

Description

Type

Required

Notes

CommodityGroupName

Name of the commodity group

String

Required

CommodityRuleId

The rules that is associated to the group to generate commodity code

Integer

Optional

ObjectParameterId

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

Integer

Optional

StandardName

Name of the standard

String

Optional

Information about the standard (DIN, ANSI and so on.)

ControlStatus

Control status of the instance

Integer

Optional

Default value is 1

ANGLE

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

String

Depends on required field of TableAttributes mapping

CRPF

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

Integer

Depends on required field of TableAttributes mapping

Sample request

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

{

"CommodityGroupName": "BZ",

"ControlStatus": 1,

"CommodityRuleId": 5005,

"StandardName": null,

"ObjectParameterId": null,

"ANGLE": "A",

"CRPF": 1.2

}

Response

Parameter

Description

Type

Notes

CommodityGroupId

A unique ID for the commodity group

Integer

CommodityGroupName

Name of the commodity group

String

ControlStatus

Control status of the instance

Integer

DisciplineId

The discipline details for the selected commodity group.

Integer

Project

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": 6588,

"CommodityGroupName": "BZ",

"ControlStatus": 1,

"DisciplineId": 5020,

"Project": "SDB",

"CommodityRuleId": 5005,

"StandardName": null,

"ObjectParameterId": null,

"ANGLE": "A",

"CRPF": 1.2

}