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 |
---|---|---|---|---|
CommodityPartName |
The name of the commodity part |
String |
Required |
|
ControlStatus |
The control status of the instance |
Integer |
Optional |
Default value is 1 |
KidnOfPart |
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. |
AttributeSetId |
Integer |
|||
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 |
Sample Request
POST https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5018)/CommodityParts
{
"CommodityPartName": "BF",
"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 |
Integer |
||
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 |
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",
"Project": "SDB",
"ControlStatus": 1,
"KindOfPart": "VARIABLE",
"CommodityRuleId": 5007,
"StandardName": "ALL",
"AttributeSetId": null,
"E_BENDANGLE": "",
"BR_LEGEND": "",
"ISREDUCING": "",
"PDS_LABEL": "[406]bore to match",
"TRAPHEIGHTTOPTOCEN": ""
}