Headers
Header name |
Description |
Required |
Values |
---|---|---|---|
Authorization |
Access token |
Required |
Bearer <access_token> |
Content-Type |
Request type format |
Required |
application/json |
PUT body
Element |
Description |
Type |
Required |
Notes |
---|---|---|---|---|
CommodityCode |
Name of the commodity code that you want to edit. |
String |
Optional |
|
ControlStatus |
The control status of the instance |
Integer |
Optional |
Default value is 1 |
CommodityType |
The type of commodity code |
String |
Optional |
Default is TB(Table based). Available commodity types are TB(Table based), AB(Attribute based), CT(Commodity Type), and OT(Other Type). |
StandardName |
Name of the standard |
String |
Optional |
Information about the standard (DIN, ANSI and so on. |
ObjectParameterName |
Name of the object parameter. The id of the part-obj-parm intersection is stored here. |
String |
Optional |
Sample request
POST
https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5018)/CommodityParts(5549)/CommodityCodes
{
"CommodityCode": "Edit_CC",
"ControlStatus": 1,
"CommodityType": "TB",
"StandardName": "ANSI",
"ObjectParameterName":"P_1N_E"
}
Response
Parameter |
Description |
Type |
Notes |
---|---|---|---|
CommodityId |
A unique ID for the commodity code. |
Integer |
|
CommodityCode |
Name of the commodity code. |
String |
|
Project |
Project details for the selected commodity code. |
String |
|
DisciplineId |
Discipline ID 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 |
Control status of the instance. |
Integer |
|
CommodityGroupId |
The commodity group id of the commodity code. |
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/$entity",
"CommodityId": 111378,
"CommodityCode": "EDIT_CC",
"Project": "SDB",
"DisciplineId": 5020,
"CommodityType": "TB",
"StandardName": "ANSI",
"ObjectParameterName": "P_1N_E",
"ControlStatus": 1,
"CommodityGroupId": 5018,
"CommodityPartId": 5549,
"FLUIDCODE": 130,
}
]
}