Input URI
{base url} + /ope/GSBG |
|---|
Active Methods
POST |
|---|
JSON Schema
Details
{
"type": "object",
"additionalProperties": false,
"required": [
"Argument"
],
"properties": {
"Argument": {
"type": "object",
"additionalProperties": false,
"description": "GSBG OPE request argument for Bridge Girder Diagram image generation.",
"required": [
"LC_NAME",
"DGRM_TYPE",
"STAGE_LIST",
"EXPORT_PATH",
"EXTENSION"
],
"properties": {
"LC_NAME": {
"type": "string",
"description": "Load Case/Combination name.",
"x-ui": {
"label": "Load Case/Combination",
"groupId": "DTO_GSBG_GENERAL"
},
"x-dto-group": "DTO_GSBG_GENERAL"
},
"DGRM_TYPE": {
"type": "integer",
"enum": [
0,
1
],
"description": "Diagram Type. 0: Stress, 1: Force.",
"x-ui": {
"label": "Diagram Type",
"groupId": "DTO_GSBG_GENERAL"
},
"x-dto-group": "DTO_GSBG_GENERAL"
},
"BATCH": {
"type": "boolean",
"default": true,
"description": "Batch option. When omitted, the default is treated as true.",
"x-ui": {
"label": "Batch",
"groupId": "DTO_GSBG_GENERAL"
},
"x-dto-group": "DTO_GSBG_GENERAL"
},
"X_AXIS_TYPE": {
"type": "integer",
"enum": [
0,
1
],
"default": 0,
"description": "X-Axis Type. 0: Distance, 1: Node.",
"x-ui": {
"label": "X-Axis Type",
"groupId": "DTO_GSBG_GENERAL"
},
"x-dto-group": "DTO_GSBG_GENERAL"
},
"BRDG_GROUP": {
"type": "string",
"description": "Bridge Girder Element Group. Used only when BATCH is false.",
"x-ui": {
"label": "Bridge Girder Element Group",
"groupId": "DTO_GSBG_GENERAL"
},
"x-dto-group": "DTO_GSBG_GENERAL"
},
"COMPONENTS": {
"type": "integer",
"default": 0,
"description": "Component. Available enum values depend on DGRM_TYPE.",
"x-ui": {
"label": "Components",
"groupId": "DTO_GSBG_COMPONENT"
},
"x-dto-group": "DTO_GSBG_COMPONENT"
},
"7TH_DOF_TYPE": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"default": 0,
"description": "7th DOF Type. Used only when DGRM_TYPE is Stress and COMPONENTS is 7th DOF.",
"x-ui": {
"label": "7th DOF Type",
"groupId": "DTO_GSBG_STRESS_OPTION"
},
"x-dto-group": "DTO_GSBG_STRESS_OPTION"
},
"COMBINED_COMP": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4
],
"default": 0,
"description": "Location for the Display of Stress. Used only when DGRM_TYPE is Stress and COMPONENTS is Combined.",
"x-ui": {
"label": "Location for the Display of Stress",
"groupId": "DTO_GSBG_STRESS_OPTION"
},
"x-dto-group": "DTO_GSBG_STRESS_OPTION"
},
"STRESS_LINE": {
"type": "object",
"additionalProperties": false,
"description": "Allowable Stress Line. The unit of COMP and TENS follows the current system unit settings.",
"properties": {
"OPT_USE": {
"type": "boolean",
"default": false,
"description": "Draw Allowable Stress Line."
},
"COMP": {
"type": "integer",
"description": "Allowable compression stress. Unit follows the current system unit settings."
},
"TENS": {
"type": "integer",
"description": "Allowable tension stress. Unit follows the current system unit settings."
}
},
"allOf": [
{
"if": {
"properties": {
"OPT_USE": {
"const": true
}
},
"required": [
"OPT_USE"
]
},
"then": {
"required": [
"COMP",
"TENS"
]
},
"x-branch-label": "When OPT_USE = True"
},
{
"if": {
"not": {
"properties": {
"OPT_USE": {
"const": true
}
},
"required": [
"OPT_USE"
]
}
},
"then": {
"not": {
"anyOf": [
{
"required": [
"COMP"
]
},
{
"required": [
"TENS"
]
}
]
}
},
"x-branch-label": "When OPT_USE is false or omitted"
}
]
},
"BATCH_LIST": {
"type": "array",
"description": "Batch output list. When BATCH is true or omitted, each item must contain its own COMPONENTS value. COMBINED_COMP or 7TH_DOF_TYPE is also placed in the same item when applicable.",
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"description": "One batch output set. Each item independently defines BRDG_GROUP, SF, GROUP, COMPONENTS, and any component-specific options.",
"required": [
"BRDG_GROUP",
"GROUP",
"COMPONENTS"
],
"properties": {
"BRDG_GROUP": {
"type": "string",
"description": "Bridge Girder Element Group.",
"x-ui": {
"label": "Bridge Girder Element Group",
"groupId": "DTO_GSBG_BATCH_OPTION"
},
"x-dto-group": "DTO_GSBG_BATCH_OPTION"
},
"SF": {
"type": "integer",
"default": 1,
"description": "Scale Factor.",
"x-ui": {
"label": "Scale Factor",
"groupId": "DTO_GSBG_BATCH_OPTION"
},
"x-dto-group": "DTO_GSBG_BATCH_OPTION"
},
"GROUP": {
"type": "string",
"description": "Group Name.",
"x-ui": {
"label": "Group Name",
"groupId": "DTO_GSBG_BATCH_OPTION"
},
"x-dto-group": "DTO_GSBG_BATCH_OPTION"
},
"COMPONENTS": {
"type": "integer",
"default": 0,
"description": "Component. Available enum values depend on DGRM_TYPE.",
"x-ui": {
"label": "Components",
"groupId": "DTO_GSBG_COMPONENT"
},
"x-dto-group": "DTO_GSBG_COMPONENT"
},
"7TH_DOF_TYPE": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"default": 0,
"description": "7th DOF Type. Used only when DGRM_TYPE is Stress and COMPONENTS is 7th DOF.",
"x-ui": {
"label": "7th DOF Type",
"groupId": "DTO_GSBG_STRESS_OPTION"
},
"x-dto-group": "DTO_GSBG_STRESS_OPTION"
},
"COMBINED_COMP": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4
],
"default": 0,
"description": "Location for the Display of Stress. Used only when DGRM_TYPE is Stress and COMPONENTS is Combined.",
"x-ui": {
"label": "Location for the Display of Stress",
"groupId": "DTO_GSBG_STRESS_OPTION"
},
"x-dto-group": "DTO_GSBG_STRESS_OPTION"
}
}
},
"x-ui": {
"label": "Batch List",
"groupId": "DTO_GSBG_BATCH_OPTION"
},
"x-dto-group": "DTO_GSBG_BATCH_OPTION"
},
"STAGE_LIST": {
"type": "array",
"description": "Stage list for diagram generation.",
"items": {
"type": "string"
},
"minItems": 1,
"x-ui": {
"label": "Stages",
"groupId": "DTO_GSBG_STAGE"
},
"x-dto-group": "DTO_GSBG_STAGE"
},
"EXPORT_PATH": {
"type": "string",
"description": "Export path for the generated diagram image.",
"x-ui": {
"label": "Export Path",
"groupId": "DTO_GSBG_EXPORT"
},
"x-dto-group": "DTO_GSBG_EXPORT"
},
"EXTENSION": {
"type": "string",
"enum": [
"bmp",
"jpg",
"emf"
],
"description": "Export image file extension.",
"x-ui": {
"label": "Extension",
"groupId": "DTO_GSBG_EXPORT"
},
"x-dto-group": "DTO_GSBG_EXPORT"
}
},
"allOf": [
{
"if": {
"properties": {
"DGRM_TYPE": {
"const": 0
}
},
"required": [
"DGRM_TYPE"
]
},
"then": {
"properties": {
"COMPONENTS": {
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"description": "Stress Components. 0: Sax, 1: +Sby, 2: -Sby, 3: +Sbz, 4: -Sbz, 5: Combined, 6: 7th DOF."
},
"BATCH_LIST": {
"items": {
"properties": {
"COMPONENTS": {
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"description": "Stress Components. 0: Sax, 1: +Sby, 2: -Sby, 3: +Sbz, 4: -Sbz, 5: Combined, 6: 7th DOF."
}
},
"allOf": [
{
"if": {
"not": {
"properties": {
"COMPONENTS": {
"const": 6
}
},
"required": [
"COMPONENTS"
]
}
},
"then": {
"not": {
"required": [
"7TH_DOF_TYPE"
]
}
},
"x-branch-label": "Within each BATCH_LIST item, 7TH_DOF_TYPE is allowed only when COMPONENTS is 7th DOF"
},
{
"if": {
"not": {
"properties": {
"COMPONENTS": {
"const": 5
}
},
"required": [
"COMPONENTS"
]
}
},
"then": {
"not": {
"required": [
"COMBINED_COMP"
]
}
},
"x-branch-label": "Within each BATCH_LIST item, COMBINED_COMP is allowed only when COMPONENTS is Combined"
}
]
}
}
}
},
"x-branch-label": "When Diagram Type is Stress"
},
{
"if": {
"properties": {
"DGRM_TYPE": {
"const": 1
}
},
"required": [
"DGRM_TYPE"
]
},
"then": {
"properties": {
"COMPONENTS": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"description": "Beam Forces/Moments Components. 0: Fx, 1: Fy, 2: Fz, 3: Mx, 4: My, 5: Mz, 6: Mb, 7: Mt, 8: Mw."
},
"BATCH_LIST": {
"items": {
"properties": {
"COMPONENTS": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"description": "Beam Forces/Moments Components. 0: Fx, 1: Fy, 2: Fz, 3: Mx, 4: My, 5: Mz, 6: Mb, 7: Mt, 8: Mw."
}
},
"not": {
"anyOf": [
{
"required": [
"7TH_DOF_TYPE"
]
},
{
"required": [
"COMBINED_COMP"
]
}
]
}
}
}
}
},
"x-branch-label": "When Diagram Type is Force"
},
{
"if": {
"not": {
"properties": {
"BATCH": {
"const": false
}
},
"required": [
"BATCH"
]
}
},
"then": {
"required": [
"BATCH_LIST"
],
"not": {
"anyOf": [
{
"required": [
"BRDG_GROUP"
]
},
{
"required": [
"COMPONENTS"
]
},
{
"required": [
"7TH_DOF_TYPE"
]
},
{
"required": [
"COMBINED_COMP"
]
}
]
}
},
"x-branch-label": "When BATCH is true or omitted, BRDG_GROUP, COMPONENTS, COMBINED_COMP, and 7TH_DOF_TYPE must be placed inside each BATCH_LIST item"
},
{
"if": {
"properties": {
"BATCH": {
"const": false
}
},
"required": [
"BATCH"
]
},
"then": {
"required": [
"BRDG_GROUP"
],
"not": {
"required": [
"BATCH_LIST"
]
}
},
"x-branch-label": "When BATCH is false"
},
{
"if": {
"properties": {
"DGRM_TYPE": {
"const": 1
}
},
"required": [
"DGRM_TYPE"
]
},
"then": {
"not": {
"required": [
"STRESS_LINE"
]
}
},
"x-branch-label": "STRESS_LINE is not allowed when Diagram Type is Force"
},
{
"if": {
"not": {
"properties": {
"DGRM_TYPE": {
"const": 0
},
"COMPONENTS": {
"const": 6
}
},
"required": [
"DGRM_TYPE",
"COMPONENTS"
]
}
},
"then": {
"not": {
"required": [
"7TH_DOF_TYPE"
]
}
},
"x-branch-label": "7TH_DOF_TYPE is allowed only when Diagram Type is Stress and Stress Component is 7th DOF"
},
{
"if": {
"not": {
"properties": {
"DGRM_TYPE": {
"const": 0
},
"COMPONENTS": {
"const": 5
}
},
"required": [
"DGRM_TYPE",
"COMPONENTS"
]
}
},
"then": {
"not": {
"required": [
"COMBINED_COMP"
]
}
},
"x-branch-label": "COMBINED_COMP is allowed only when Diagram Type is Stress and Stress Component is Combined"
}
]
}
}
}
Request Examples
Stress + BATCH true
{
"Argument": {
"LC_NAME": "LCB_STRENGTH_01",
"DGRM_TYPE": 0,
"BATCH": true,
"X_AXIS_TYPE": 1,
"STRESS_LINE": {
"OPT_USE": true,
"COMP": 210000,
"TENS": 180000
},
"BATCH_LIST": [
{
"BRDG_GROUP": "BG_LEFT",
"SF": 1,
"GROUP": "Stress_Combined_Left",
"COMPONENTS": 5,
"COMBINED_COMP": 4
},
{
"BRDG_GROUP": "BG_RIGHT",
"SF": 2,
"GROUP": "Stress_7thDOF_Right",
"COMPONENTS": 6,
"7TH_DOF_TYPE": 6
},
{
"BRDG_GROUP": "BG_CENTER",
"SF": 1,
"GROUP": "Stress_Axial_Center",
"COMPONENTS": 0
}
],
"STAGE_LIST": [
"CS1",
"CS2",
"FINAL"
],
"EXPORT_PATH": "C:\\Temp\\GSBG\\StressBatch",
"EXTENSION": "emf"
}
}
Stress + BATCH false
{
"Argument": {
"LC_NAME": "LCB_STRENGTH_01",
"DGRM_TYPE": 0,
"BATCH": false,
"X_AXIS_TYPE": 1,
"BRDG_GROUP": "BG_MAIN",
"COMPONENTS": 5,
"COMBINED_COMP": 4,
"STRESS_LINE": {
"OPT_USE": true,
"COMP": 210000,
"TENS": 180000
},
"STAGE_LIST": [
"CS1",
"CS2",
"FINAL"
],
"EXPORT_PATH": "C:\\Temp\\GSBG\\StressSingleCombined",
"EXTENSION": "emf"
}
}
Force + BATCH true
{
"Argument": {
"LC_NAME": "LCB_STRENGTH_01",
"DGRM_TYPE": 1,
"BATCH": true,
"X_AXIS_TYPE": 1,
"BATCH_LIST": [
{
"BRDG_GROUP": "BG_LEFT",
"SF": 1,
"GROUP": "Force_Left_Mw",
"COMPONENTS": 8
},
{
"BRDG_GROUP": "BG_RIGHT",
"SF": 2,
"GROUP": "Force_Right_Mt",
"COMPONENTS": 7
}
],
"STAGE_LIST": [
"CS1",
"CS2",
"FINAL"
],
"EXPORT_PATH": "C:\\Temp\\GSBG\\ForceBatch",
"EXTENSION": "emf"
}
}
Force + BATCH false
{
"Argument": {
"LC_NAME": "LCB_STRENGTH_01",
"DGRM_TYPE": 1,
"BATCH": false,
"X_AXIS_TYPE": 1,
"BRDG_GROUP": "BG_MAIN",
"COMPONENTS": 8,
"STAGE_LIST": [
"CS1",
"CS2",
"FINAL"
],
"EXPORT_PATH": "C:\\Temp\\GSBG\\ForceSingle",
"EXTENSION": "emf"
}
}
Specifications
No. |
Description |
Key |
Value Type |
Default |
Required |
|
|---|---|---|---|---|---|---|
1 |
Load Case/Combination name |
"LC_NAME" |
string |
- |
Required |
|
2 |
Diagram Type • Stress: 0 • Force: 1 |
"DGRM_TYPE" |
integer (enum) |
- |
Required |
|
3 |
Batch option When omitted, the default is treated as true. |
"BATCH" |
boolean |
true |
Optional |
|
4 |
X-Axis Type • Distance: 0 • Node: 1 |
"X_AXIS_TYPE" |
integer (enum) |
0 |
Optional |
|
When BATCH = true | ||||||
5 |
Batch output list. Each item independently defines the target group and component. |
"BATCH_LIST" |
array [object] |
- |
Required |
|
(1) |
Bridge Girder Element Group |
"BRDG_GROUP" |
string |
- |
Required |
|
(2) |
Scale Factor |
"SF" |
integer |
1 |
Optional |
|
(3) |
Group Name |
"GROUP" |
string |
- |
Required |
|
(4) |
Component Stress (DGRM_TYPE = 0) • Sax: 0 • +Sby: 1 • -Sby: 2 • +Sbz: 3 • Sbz" 4 • Combined: 5 • 7th DOF: 6 Force (DGRM_TYPE = 1) • Fx: 0 • Fy: 1 • Fz: 2 • Mx: 3 • My: 4 • Mz: 5 • Mb: 6 • Mt: 7 • Mw: 8 |
"COMPONENTS" |
integer (enum) |
0 |
Required |
|
Within COMPONENTS = 5 (Combined) | ||||||
(5) |
Location for the Display of Stress • Maximum: 0 • 1(-y, +z): 1 • 2(+y, +z): 2 • 3(+y, -z): 3 • 4(-y, -z): 4 |
"COMBINED_COMP" |
integer (enum) |
0 |
Optional |
|
Within COMPONENTS = 6 (7th DOF) | ||||||
(6) |
7th DOF Type • Sax(Warping): 0 • Ssy(Mt): 1 • Ssy(Mw): 2 • Ssz(Mt): 3 • Ssz(Mw): 4 • Combined(Ssy): 5 • Combined(Ssz): 6 |
"7TH_DOF_TYPE" |
integer (enum) |
0 |
Optional |
|
When BATCH = false | ||||||
6 |
Bridge Girder Element Group |
"BRDG_GROUP" |
string |
- |
Required |
|
7 |
Component Stress (DGRM_TYPE = 0) • Sax: 0 • +Sby: 1 • -Sby: 2 • +Sbz: 3 • Sbz" 4 • Combined: 5 • 7th DOF: 6 Force (DGRM_TYPE = 1) • Fx: 0 • Fy: 1 • Fz: 2 • Mx: 3 • My: 4 • Mz: 5 • Mb: 6 • Mt: 7 • Mw: 8 |
"COMPONENTS" |
integer (enum) |
0 |
Optional |
|
When BATCH = false, DGRM_TYPE = 0 (Stress), and COMPONENTS = 5 (Combined) | ||||||
8 |
Location for the Display of Stress • Maximum: 0 • 1(-y, +z): 1 • 2(+y, +z): 2 • 3(+y, -z): 3 • 4(-y, -z): 4 |
"COMBINED_COMP" |
integer (enum) |
0 |
Optional |
|
When BATCH = false, DGRM_TYPE = 0 (Stress), and COMPONENTS = 6 (7th DOF) | ||||||
9 |
7th DOF Type • Sax(Warping): 0 • Ssy(Mt): 1 • Ssy(Mw): 2 • Ssz(Mt): 3 • Ssz(Mw): 4 • Combined(Ssy): 5 • Combined(Ssz): 6 |
"7TH_DOF_TYPE" |
integer (enum) |
0 |
Optional |
|
When DGRM_TYPE = 0 (Stress) | ||||||
10 |
Allowable Stress Line |
"STRESS_LINE" |
object |
- |
Optional |
|
(1) |
Draw Allowable Stress Line |
"OPT_USE" |
boolean |
false |
Optional |
|
When STRESS_LINE.OPT_USE = true | ||||||
(2) |
Compression stress • The product’s system unit settings are applied. |
"COMP" |
integer |
- |
Required |
|
(3) |
Tension stress • The product’s system unit settings are applied. |
"TENS" |
integer |
- |
Required |
|
11 |
Stage list for diagram generation |
"STAGE_LIST" |
array[string] |
- |
Required |
|
12 |
Export path for the generated diagram image |
"EXPORT_PATH" |
string |
- |
Required |
|
13 |
Export image file extension • "bmp" • "jpg" • "emf" |
"EXTENSION" |
enum (string) |
- |
Required |
|