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 Commodity Code Options for a Specification, use the following query:
GET
https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/SpecificationTypes(5120)/SpecificationHeaders(6218)/Com.Ingr.Srd.V2.GetCommodityOptions(FirstSize=2, FirstSizeUnit='in',ShortCode='Piping', SecondSize='', SecondSizeUnit=' ', MinimumTemperature=0, MaximumTemperature=0)/
The sample query to retrieve commodity code option code information for a Specification based on the size ranges, S3D short code and temperature limits is:
GET
https://<appserver with domain>/<virtual_directory>/Srd/V2/ Projects('SDB')/Disciplines(5020)/Nls(1)/SpecificationTypes(5120)/SpecificationHeaders(6218)/Com.Ingr.Srd.V2.GetCommodityOptions(FirstSize=2, FirstSizeUnit='in', ShortCode='Piping', SecondSize='', SecondSizeUnit=' ', MinimumTemperature=0, MaximumTemperature=0)/
Get URI Parameter
|
Parameter |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
FirstSize |
Start of nominal size range 1 |
Integer |
Required |
|
|
FirstSizeUnit |
Size 1 Unit Code |
String |
||
|
ShortCode |
Name of the S3D short code |
String |
||
|
SecondSize |
Start of nominal size range 2 |
String |
||
|
SecondSizeUnit |
Size 2 Unit Code |
String |
||
|
MinimumTemperature |
Minimum Temperature value |
Integer |
||
|
MaximumTemperature |
Maximum Temperature value |
Integer |
Response
|
Parameter |
Description |
Type |
Notes |
|---|---|---|---|
|
OptionCode |
Name of Option code |
String |
|
|
OptionCodeShortText |
Option Code short description |
String |
|
|
OptionCodeLongText |
Option Code long description |
String |
Sample response
{
"@odata.context":
"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Collection(Com.Ingr.Srd.V2.SpecificationCommodityOptions)",
"value": [
{
"OptionCode": 1,
"OptionCodeShortText": "Default",
"OptionCodeLongText": "Default"
}
]
}