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 |
|
|
SeqId |
Sequence of the commodity code details. |
Integer |
Required |
|
|
TableDetailId |
A unique ID for the table detail. |
String |
Required |
|
|
UsedForCodeBuilding |
Is the table detail used for building the commodity code? Y or N. |
String |
Required |
Sample Request
PUT https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5018)/CommodityParts(5549)/CommodityCodes(111079)
{
"CommodityCode": "EditCC_DETAILS",
"ControlStatus": 1,
"CommodityCodeDetails": [
{
"ControlStatus":1,
"TableDetailId": 11670,
"UsedForCodeBuilding": "Y"
}]
}
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 |
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": 111079,
"CommodityCode": "EDITCC_DETAILS",
"Project": "SDB",
"DisciplineId": 5020,
"CommodityType": "TB",
"StandardName": null,
"ObjectParameterName": null,
"ControlStatus": 1,
"CommodityGroupId": 5018,
"CommodityPartId": 5549,
"ANGLE": null,
"ASS_NO": null,
"ATTR_X0_": null,
"A_NUM1_DEP": null,
"A_NUM1_N_V": null,
"A_NUM2_DEP": null,
"A_NUM2_INDEP": null,
"A_NUM2_N_V": null,
"A_NUM3_DEP": null,
"BDEPTH": null,
"BDIA": null,
"BOLT_DIA": null,
"CDLST_NUM": null,
"COMMENTS": null,
"DENSITY": null,
"DESIGN_PRESSURE": null,
"DN1": null,
"DN2": null,
"DN3": null,
"E_ANGLE": null,
"MAX_TEMP": null,
"MIN_TEMP": null,
"MULTISIZEOPTION": null,
"NLSDEPNUM": null,
"PCD_SORT": null,
"P_BSE_OD": null,
"RATING": null,
"REQUISITION_IND": null,
"SCH1": null,
"SCH2": null
}
Use the following sample GET method to view the associated commodity code and the Details that you have created:
GET
https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5018)/CommodityParts(5549)/CommodityCodes(<CommodityId>)?$expand=CommodityCodeDetails
Where ?$expand=CommodityCodeDetails is the query to retrieve the associated Details records along with the commodity code.