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 Service Limits for Specification Header Geometric, use the following query:
GET
https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/SpecificationTypes(5120)/ SpecificationHeaders(6201/SpecificationHeaderGeometrics(13896)/Com.Ingr.Srd.V2.ServiceLimits()/
The sample query to retrieve the Service Limits for a specific Specification Header Geometric of a Specification is:
GET
https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects(‘SDB’)/Disciplines(5020)/Nls(1)/ SpecificationTypes(5120)/SpecificationHeaders(6201)/ SpecificationHeaderGeometrics (<TabId>)/ Com.Ingr.Srd.V2.ServiceLimits()/
Get URI Parameter
Parameter |
Description |
Type |
Required |
---|---|---|---|
TabId |
Sequence of the Geometric to which you want to retrieve the data |
Integer |
Required |
Response
Element |
Description |
Type |
Notes |
---|---|---|---|
GeometricId |
A unique ID for the specification |
Integer |
|
GeometricName |
Sequence of the Specification Detail |
Integer |
|
GeometricDetailId |
A unique ID for the table. |
Integer |
|
UnitSystemId |
Name of the table |
String |
|
UnitSystemName |
A unique ID for the table group. |
Integer |
|
ControlStatus |
Sets the control status of the table group |
Integer |
Default value is 1 |
TEMP |
The attribute code name corresponding to the variable attribute is shown. |
String |
Total available Input attributes are INPUT_1 to INPUT_5 and total available Output attributes are OUTPUT_1 to OUTPUT_15 For Service Limits, on response, all the variable attributes assigned to the table are displayed with attribute code name. The inline sample response shows the available attribute codes (available in italics). |
TEMP_UnitId |
The attribute code name corresponding to the variable attribute (TEMP). |
Integer |
The Attribute’s UnitId is retrieved ‘Table Attributes’ (M_DICT_TAB_ATTRS). If UnitId value is not found, then it will be picked from ‘Attributes’(M_ATTRS). |
TEMP_UnitCode |
The Unit code corresponding to the variable attribute (TEMP). |
String |
The Attribute’s UnitCode is retrieved ‘Table Attributes’ (M_DICT_TAB_ATTRS). If UnitCode value is not found, then it will be picked from ‘Attributes’ (M_ATTRS). |
Sample response
{
"@odata.context":
"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Com.Ingr.Srd.V2.ServiceLimitData",
"ServiceLimitDetails": [
{
"GeometricId": 47702,
"GeometricName": "PT_9CS1S01",
"GeometricDetailId": 2346976,
"UnitSystemId": 5022,
"UnitSystemCode": "IMP",
"ControlStatus": 1,
"TEMP": "100",
"TEMP_UnitId": 5302,
"TEMP_UnitCode": "F",
},
{
"GeometricId": 47702,
"GeometricName": "PT_9CS1S01",
"GeometricDetailId": 2346986,
"UnitSystemId": 5022,
"UnitSystemCode": "IMP",
"ControlStatus": 1,
"TEMP": "-20",
"TEMP_UnitId": 5302,
"TEMP_UnitCode": "F",
}
]
}