Input URI
{base url} + db/OFFS |
---|
Active Methods
POST, GET, PUT, DELETE |
---|
JSON Schema
Details
"OFFS": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"ITEMS": {
"description": "Items",
"type": "array",
"items": {
"type": "object",
"properties": {
"ID": {
"description": "ID",
"type": "integer"
},
"GROUP_NAME": {
"description": "NameofBoundaryGroup",
"type": "string"
},
"TYPE": {
"description": "TypeofOffset",
"type": "string"
},
"RGDXi": {
"description": "GLOBAL:RGDXi",
"type": "number"
},
"RGDYi": {
"description": "GLOBAL:RGDYi/ELEMENT:RGDYi(Mzi)",
"type": "number"
},
"RGDZi": {
"description": "GLOBAL:RGDZi/ELEMENT:RGDZi(Myi)",
"type": "number"
},
"RGDXj": {
"description": "GLOBAL:RGDXj",
"type": "number"
},
"RGDYj": {
"description": "GLOBAL:RGDYj/ELEMENT:RGDYj(Mzj)",
"type": "number"
},
"RGDZj": {
"description": "GLOBAL:RGDZj/ELEMENT:RGDzj(Myj)",
"type": "number"
}
}
}
}
}
}
}
Examples
Global Type
"Assign": {
"8": {
"ITEMS": [
{
"ID": 1,
"GROUP_NAME": "Service",
"TYPE": "GLOBAL",
"RGDXi": 0.11,
"RGDYi": 0.12,
"RGDZi": 0.13,
"RGDXj": 0.21,
"RGDYj": 0.22,
"RGDZj": 0.23
}
]
}
}
}
Element Type
"Assign": {
"7": {
"ITEMS": [
{
"ID": 1,
"GROUP_NAME": "Service",
"TYPE": "ELEMENT",
"RGDYi": 0.11,
"RGDZi": 0.12,
"RGDYj": 0.21,
"RGDZj": 0.22
}
]
}
}
}
Specifications
No. | Description | Key | Value Type | Default | Required | |
---|---|---|---|---|---|---|
1 |
Beam End Offsets • Insert the data as an object |
"ITEMS" |
Array |
- |
Required |
|
(1) |
Serial Number |
"ID" |
Integer |
0 |
Optional |
|
(2) |
Load Group Name |
"GROUP_NAME" |
String |
Blank |
Optional |
|
(3) |
Reference Coordinate System • Global : "GLOBAL" • Element : "ELEMENT" |
"TYPE" |
String |
- |
Required |
|
Global ¹⁾ |
||||||
(4) |
Vector of the End Offset Distance at N1 end in GCS X-Direction |
"RGDXi" |
Number |
0 |
Optional |
|
(5) |
Vector of the End Offset Distance at N1 end in GCS Y-Direction |
"RGDYi" |
Number |
0 |
Optional |
|
(6) |
Vector of the End Offset Distance at N1 end in GCS Z-Direction |
"RGDZi" |
Number |
0 |
Optional |
|
(7) |
Vector of the End Offset Distance at N2 end in GCS X-Direction |
"RGDXj" |
Number |
0 |
Optional |
|
(8) |
Vector of the End Offset Distance at N2 end in GCS Y-Direction |
"RGDYj" |
Number |
0 |
Optional |
|
(9) |
Vector of the End Offset Distance at N2 end in GCS Z-Direction |
"RGDZj" |
Number |
0 |
Optional |
|
Element ¹⁾ |
||||||
(4) |
End Offset Distance in the Element’s Local (+) X-Y Plane at N1 end |
"RGDYi" |
Number |
0 |
Optional |
|
(5) |
End Offset Distance in the Element’s Local (+) X-Z Plane at N1 end |
"RGDZi" |
Number |
0 |
Optional |
|
(6) |
End Offset Distance in the Element’s Local (+) X-Y Plane at N2 end |
"RGDYj" |
Number |
0 |
Optional |
|
(7) |
End Offset Distance in the Element’s Local (+) X-Z Plane at N2 end |
"RGDZj" |
Number |
0 |
Optional |
¹⁾ At least one of the four keys must be greater than zero.