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 Specification Header Geometrics for a specific Specification:
GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/SpecificationTypes(5120)/SpecificationHeaders(6201)/SpecificationHeaderGeometrics
To retrieve a specific Specification Header Geometric for a Specification:
GET
//<appserver with domain>/<virtual_directory>/Srd/V2/Projects(‘SDB’)/Disciplines(5020)/Nls(1)/SpecificationTypes(5120)/SpecificationHeaders(6201)/SpecificationHeaderGeometrics(<TabId>)
Get URI Parameter
|
Parameter |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
TabId |
Sequence of the Geometric to which you want to retrieve the data |
Integer |
Required |
Response
|
Element |
Description |
Type |
Notes |
|---|---|---|---|
|
SpecificationHeaderId |
A unique ID for the specification |
Integer |
|
|
ShortCode |
Name of the short code |
String |
User defined short code. Users can also enter the wild card characters ('%' or '_'). |
|
TabId |
Sequence ID of geometric table |
Integer |
Generated by the software |
|
UnitSystemId |
A unique ID of unit system |
Integer |
|
|
UnitSystemCode |
Name (Code) of the Unit System |
String |
|
|
KindOf |
Kind of geometric |
String |
|
|
TableName |
The name of the geometric table |
String |
|
|
TableId |
A unique ID for the geometric |
Integer |
|
|
SizeFrom1 |
Start of nominal size range 1 |
String |
|
|
SizeTo1 |
End of nominal size range 1 |
String |
|
|
SizeFrom2 |
Start of nominal size range 2 |
String |
|
|
SizeTo2 |
End of nominal size range 2 |
String |
|
|
ControlStatus |
Control status of the specification header geometric |
Integer |
|
|
Filter |
Indicator whether the geometric table is used as filter for spec item ident on header level |
String |
|
|
CreateIdentInd |
Indicator for ident creation |
String |
If this checkbox is checked-on, then the corresponding user-defined Geometric would be considered for Ident creation using the new functionality of creation of Idents using Spec Header Geometrics |
|
CommodityGroupName |
Name of the commodity group |
String |
|
|
CommodityPartName |
Name of the commodity part |
String |
|
|
SDBInfo |
String |
||
|
ComponentGroupId |
A unique ID for the component group |
Integer |
|
|
Preference |
Single digit number for preference |
Integer |
Sample response
{
"@odata.context":
"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/SpecificationTypes(5120)/ SpecificationHeaders(6201)/SpecificationHeaderGeometrics",
"value": [
{
"SpecificationHeaderId": 6201,
"ShortCode": "90%",
"TabId": 8610,
"UnitSystemId": 5001,
"UnitSystemCode": "IMP/MET",
"KindOf": "Branches",
"TableName": "BR9CS1S01",
"TableId": 5324,
"SizeFrom1": ".5",
"SizeTo1": "24",
"SizeFrom2": ".5",
"SizeTo2": "24",
"ControlStatus": 1,
"Filter": "ON",
"CreateIdentIndicator": "N",
" CommodityGroupName": null,
"CommodityPartName": null,
"SDBInfo": null,
"ComponentGroupId": null,
"Preference": null
}
]
}