Headers
Header name |
Description |
Required |
Values |
---|---|---|---|
Authorization |
Access token |
Required |
Bearer <access_token> |
Content-Type |
Request type format |
Required |
application/json |
To retrieve a commodity parts with Nls for a specific commodity part:
GET
https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5000)/CommodityParts(<CommodityPartId>)?$expand=CommodityPartNls
To retrieve all commodity parts with NIs for a commodity group:
GET
https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5000)/CommodityParts?$expand=CommodityPartNls
Response
Parameter |
Description |
Type |
Notes |
---|---|---|---|
CommodityGroupId |
A unique ID for the commodity group |
Integer |
|
CommodityPartId |
A unique ID for the commodity part |
String |
|
CommodityPartName |
Retrieves the name of the commodity part |
||
ControlStatus |
Retrieves the control status of the instance |
Integer |
|
KindOfPart |
Special function for branches |
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 |
|
AttributeSetId |
Integer |
||
E_BENDANGLE |
E_BENDANGLE attribute is associated with ATTR_CHAR1 physical attribute for M_PARTS physical table |
String |
|
BR_LEGEND |
BR_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 |
|
NlsId |
Language identifier |
Integer |
|
ShortDescription |
Short description of the table |
Integer |
|
Description |
Description of the table |
Integer |
Sample response
{
"@odata.context":
"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5000)/CommodityParts",
"value": [
{
"CommodityGroupId": 5000,
"CommodityPartId": 5393,
"CommodityPartName": "M94",
"Project": "SDB",
"ControlStatus": 1,
"KindOfPart": "VARIABLE",
"CommodityRuleId": 5000,
"StandardName": "ALL",
"AttributeSetId": null,
"E_BENDANGLE": "",
"BR_LEGEND": "",
"ISREDUCING": "",
"PDS_LABEL": "[406]bore to match",
"TRAPHEIGHTTOPTOCEN": ""
"CommodityPartNls": [
{
"CommodityGroupId": 5000,
"CommodityPartId": 5393,
"NlsId": 20,
"ControlStatus": 1,
"ShortDescription": "90 Dg Mitr 4 Ct 3D",
"Description": "90 Degree Miter 4 Cut R=3D"
}
}
]
}
]
}