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 codes with layouts for a specific commodity code:
GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)//CommodityGroups(5018)/CommodityParts(5549)/CommodityCodes(46800)?$expand=CommodityCodeLayouts
To retrieve only layouts for a specific commodity code:
GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)//CommodityGroups(5018)/CommodityParts(5549)/CommodityCodes(46800)CommodityCodeLayouts
Response
Parameter |
Description |
Type |
Notes |
---|---|---|---|
CommodityId |
A unique ID for the commodity code |
Integer |
|
CommodityCode |
Name of the commodity code |
String |
|
Project |
Retrieves the project details for the selected commodity code |
String |
|
DisciplineId |
Retrieves the discipline details for the selected project |
Integer |
|
CommodityType |
Type of commodity code |
String |
Available commodity types are TB(Table based), AB(Attribute based), CT(Commodity Type), and OT(Other Type). |
StandardName |
Name of the standard |
String |
|
ObjectParameterName |
Name of the object parameter. The id of the part-obj-parm intersection is stored here |
String |
|
ControlStatus |
Retrieves the control status of the instance |
Integer |
|
CommodityGroupId |
The commodity group id to which you want to retrieve the data |
Integer |
|
CommodityPartId |
The object parameter that is associated to the group which is used to generate ident |
Integer |
|
NlsId |
Language identifier |
Integer |
|
LayoutShort |
Short description of the layout |
String |
LayoutShort accepts only the first 4000 characters. |
LayoutLong |
Description of the layout |
String |
LayoutLong accepts only the first 4000 characters. |
Sample response
{
"@odata.context":
"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5018)/CommodityParts(5549)/CommodityCodes",
"value": [
{
"CommodityId": 46800,
"CommodityCode": "VYLAA2DFTBARL1ABZZZ",
"Project": "SDB",
"DisciplineId": 5020,
"CommodityType": "TB",
"StandardName": null,
"ObjectParameterName": "P_1N_E",
"ControlStatus": 1,
"CommodityGroupId": 5018,
"CommodityPartId": 5549,
"CommodityCodeLayouts@odata.context":
"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5018)/CommodityParts(5549)/CommodityCodes(46800)(46800)/CommodityCodeLayouts",
"CommodityCodeLayouts": [
{
"CommodityId": 46800,
"NlsId": 20,
"ControlStatus": 1,
"LayoutShort": "ASTM A182-F 304, Gear Operator, AISI 316L + Stellite Trim",
"LayoutLong": "ASTM A182-F 304, Gear Operator, AISI 316L + Stellite Trim"
} ]
}
]
}