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 details 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=CommodityCodeDetails
To retrieve only details 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)/CommodityCodeDetails
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 |
|
SeqId |
Sequence of the commodity code detail |
Integer |
|
TableDetailId |
Reference to the table detail instance |
Integer |
|
UsedForCodeBuilding |
Is the table detail used for building the commodity code? Y or N |
String |
Sample response
{
"@odata.context":
"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5018)/CommodityParts(5549)/CommodityCodes(46800)/CommodityCodeDetails",
"value": [
{
"CommodityId": 46800,
"SeqId": 4,
"TableDetailId": 5610,
"UsedForCodeBuilding": "Y",
"ControlStatus": 1
},
{
"CommodityId": 46800,
"SeqId": 5,
"TableDetailId": 8532,
"UsedForCodeBuilding": "Y",
"ControlStatus": 1
},
{
"CommodityId": 46800,
"SeqId": 7,
"TableDetailId": 11191,
"UsedForCodeBuilding": "Y",
"ControlStatus": 1
},
{
"CommodityId": 46800,
"SeqId": 8,
"TableDetailId": 11671,
"UsedForCodeBuilding": "Y",
"ControlStatus": 1
}
]
}