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 and details for given geometric details of 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.GetCommodityCode(FirstSize=1, FirstSizeUnit='in', ShortCode='Eccentric Size Change', OptionCode=1, SecondSize='.5', SecondSizeUnit='in', FluidCode=0, MaximumTemperature=0)/
The sample query to retrieve commodity code and details for given geometric details of a specification:
GET
https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/SpecificationTypes(5120)/SpecificationHeaders(6218)/ Com.Ingr.Srd.V2.GetCommodityCode(FirstSize=1, FirstSizeUnit='in', ShortCode='Eccentric Size Change', OptionCode=1, SecondSize='.5', SecondSizeUnit='in', FluidCode=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 |
||
OptionCode |
Option Code Value |
Integer |
||
SecondSize |
Start of nominal size range 2 |
String |
||
SecondSizeUnit |
Size 2 Unit Code |
String |
||
FluidCode |
Fluid Code value |
Integer |
||
MaximumTemperature |
Maximum Temperature value |
Integer |
Response
Parameter |
Description |
Type |
Notes |
---|---|---|---|
CommodityCode |
Name of the Commodity code |
String |
|
EngineeringTag |
Engineering Tag Value |
String |
|
FirstSizeSchedules |
Available Schedules for Size 1 |
||
SecondSizeSchedules |
Available Schedules for Size 2 |
||
ScheduleShortText |
Schedule Short Description |
String |
|
ScheduleCodeList |
Schedule Codelist Number |
String |
Sample response
{
"@odata.context": "https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Com.Ingr.Srd.V2.SpecificationCommodityCode",
"CommodityCode": "OSGEAM8PEACKABEZ",
"EngineeringTag": "null",
"FirstSizeSchedules": [
{
"ScheduleShortText": "S-XS",
"ScheduleCodeList": "105"
}
],
"SecondSizeSchedules": [
{
"ScheduleShortText": "S-XS",
"ScheduleCodeList": "105"
}
]
}