Edit Commodity Part with Nls - 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

PUT body

Element

Description

Type

Required

Notes

CommodityPartName

The name of the commodity part

String

Optional

ControlStatus

The control status of the instance

Integer

Optional

Default value is 1

KindOfPart

Special function for branches

Integer

Optional

Default value is VARIABLE

CommodityRuleId

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

Integer

Optional

Mandatory, if table detail based commodity codes shall be built.

StandardName

Name of the standard

String

Optional

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

E_BENDANGLE

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

String

Depends on required field of TableAttributes mapping

BR_LEGEND

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

String

Depends on required field of TableAttributes mapping

ISREDUCING

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

String

Depends on required field of TableAttributes mapping

PDS_LABEL

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

String

Depends on required field of TableAttributes mapping

TRAPHEIGHTTOPTOCEN

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

String

Depends on required field of TableAttributes mapping

NlsId

Language identifier

Integer

Required

ShortDescription

Short description of the table

String

Required

Description

Description of the table

String

Required

Sample Request

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

{

"CommodityPartName": "BF_Update",

"ControlStatus": 1,

"KindOfPart": "VARIABLE",

"CommodityRuleId": 5007,

"StandardName": "ALL",

"AttributeSetId": null,

"E_BENDANGLE": "",

"BR_LEGEND": "",

"ISREDUCING": "",

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

"TRAPHEIGHTTOPTOCEN": "",

"CommodityPartNls": [

{

"CommodityGroupId": 5018,

"CommodityPartId": 5547,

"NlsId": 1,

"ControlStatus": 1,

"ShortDescription": "Butterfly Vlv",

"Description": "Butterfly Valve"

}

]

}

Response

Parameter

Description

Type

Notes

CommodityGroupId

A unique ID for the commodity group

Integer

CommodityPartId

A unique ID for the commodity part

String

CommodityPartName

The name of the commodity part

Project

The project details for the selected commodity group

String

ControlStatus

The control status of the instance

Integer

KindOfPart

Special function for branches

Integer

CommodityRuleId

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

Integer

StandardName

Name of the standard

String

AttributeSetId

E_BENDANGLE

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

String

BR_LEGEND

IBR_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(5018)/CommodityParts/$entity",

"CommodityGroupId": 5018,

"CommodityPartId": 14016,

"CommodityPartName": "BF_UPDATE",

"Project": "SDB",

"ControlStatus": 1,

"KindOfPart": "VARIABLE",

"CommodityRuleId": 5007,

"StandardName": "ALL",

"AttributeSetId": null,

"E_BENDANGLE": "",

"BR_LEGEND": "",

"ISREDUCING": "",

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

"TRAPHEIGHTTOPTOCEN": ""

}