Headers
Header name |
Description |
Required |
Values |
---|---|---|---|
Authorization |
Access token |
Required |
Bearer <access_token> |
Content-Type |
Request type format |
Required |
application/json |
Sample URI request
To retrieve all the commodity codes:
GET
https:///<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5018)/CommodityParts(5549)/CommodityCodes
To retrieve a specific commodity code for a give commodity id:
GET
https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5018)/CommodityParts(5549)/CommodityCodes(<CommodityId>)
GET URI Parameter
Parameter |
Description |
Type |
Required |
---|---|---|---|
CommodityId |
The commodity code id to which you want to retrieve the data |
Integer |
Required |
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 |
|
FLUIDCODE |
The attribute code name corresponding to the variable attribute is shown. |
Integer |
Total available attribute characters are AttributeCharacter1 to AttributeCharacter15 and total available attribute numbers are AttributeNumber1 to AttributeNumber15 For commodity codes, on response, all the variable attributes assigned in the table attributes are displayed with attribute code name. The inline sample response shows the available attribute codes (highlighted in yellow). |
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": 111079,
"CommodityCode": "TEST_CC2_UPDATE2",
"Project": "SDB",
"DisciplineId": 5020,
"CommodityType": "TB",
"StandardName": "ANSI",
"ObjectParameterName": "P_1N_E",
"ControlStatus": 1,
"CommodityGroupId": 5018,
"CommodityPartId": 5549,
"FLUIDCODE": 130,
}
]
}
-
Dynamic attribute name and it’s label text shall not have spaces (like NPD From) as OData query operation cannot be performed on columns having spaces.
-
Dynamic attribute name and it’s label text shall not start with number (like 1_END_PRP_SP3D) as OData query operation cannot be performed on columns starting with number.