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",
"LC_TYPE",
"DGRM_TYPE",
"STAGE_LIST"
],
"properties": {
"LC_NAME": {
"type": "string",
"description": "Load Case/Combination name only. The type of this name is specified by LC_TYPE."
},
"LC_TYPE": {
"type": "string",
"enum": [
"ST",
"CS",
"CB"
],
"description": "Load Case/Combination type. Temporary enum. ST: Static Load Case, CS: Construction Stage Load Case, CB: Load Combination."
},
"DGRM_TYPE": {
"type": "integer",
"enum": [
0,
1
],
"description": "Diagram Type. 0: Stress, 1: Force."
},
"BATCH": {
"type": "boolean",
"default": true,
"description": "Batch option. When omitted, the default is treated as true."
},
"X_AXIS_TYPE": {
"type": "integer",
"enum": [
0,
1
],
"default": 0,
"description": "X-Axis Type. 0: Distance, 1: Node."
},
"BRDG_GROUP": {
"type": "string",
"description": "Bridge Girder Element Group. Used only when BATCH is false."
},
"COMPONENTS": {
"type": "integer",
"default": 0,
"description": "Component. Stress values: 0: Sax, 1: +Sby, 2: -Sby, 3: +Sbz, 4: -Sbz, 5: Combined, 6: 7th DOF. Force values: 0: Fx, 1: Fy, 2: Fz, 3: Mx, 4: My, 5: Mz, 6: Mb, 7: Mt, 8: Mw.",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
]
},
"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."
},
"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."
},
"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."
}
}
},
"BATCH_LIST": {
"type": "array",
"description": "Batch output list. Each item contains one Bridge Girder Element Group, Scale Factor, and Group Name set.",
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"description": "One batch output set. BRDG_GROUP, SF, and GROUP are grouped together for each generated diagram output.",
"required": [
"BRDG_GROUP",
"GROUP"
],
"properties": {
"BRDG_GROUP": {
"type": "string",
"description": "Bridge Girder Element Group."
},
"SF": {
"type": "integer",
"default": 1,
"description": "Scale Factor."
},
"GROUP": {
"type": "string",
"description": "Group Name."
}
}
}
},
"STAGE_LIST": {
"type": "array",
"description": "Stage list for diagram generation.",
"items": {
"type": "string"
},
"minItems": 1
}
}
}
}
}
Request Examples
Stress + BATCH true
{
"Argument": {
"LC_NAME": "LCB_STRENGTH_01",
"DGRM_TYPE": 0,
"BATCH": true,
"X_AXIS_TYPE": 0,
"COMPONENTS": 5,
"COMBINED_COMP": 0,
"STRESS_LINE": {
"OPT_USE": true,
"COMP": 24000,
"TENS": 54000
},
"BATCH_LIST": [
{
"BRDG_GROUP": "BG_LEFT",
"SF": 1,
"GROUP": "Stress_Left_Girder"
},
{
"BRDG_GROUP": "BG_RIGHT",
"SF": 1,
"GROUP": "Stress_Right_Girder"
}
],
"STAGE_LIST": [
"CS1",
"CS2",
"FINAL"
],
"EXPORT_PATH": "C:\\Temp\\GSBG\\StressBatch",
"EXTENSION": "jpg"
}
}
Stress + BATCH false
{
"Argument": {
"LC_NAME": "LCB_SERVICE_01",
"DGRM_TYPE": 0,
"BATCH": false,
"X_AXIS_TYPE": 1,
"BRDG_GROUP": "BG_MAIN",
"COMPONENTS": 6,
"7TH_DOF_TYPE": 3,
"STRESS_LINE": {
"OPT_USE": true,
"COMP": 22000,
"TENS": 16000
},
"STAGE_LIST": [
"CS1",
"CS2",
"FINAL"
],
"EXPORT_PATH": "C:\\Temp\\GSBG\\StressSingle",
"EXTENSION": "bmp"
}
}
Force + BATCH true
{
"Argument": {
"LC_NAME": "LCB_STRENGTH_01",
"DGRM_TYPE": 1,
"BATCH": true,
"X_AXIS_TYPE": 0,
"COMPONENTS": 8,
"BATCH_LIST": [
{
"BRDG_GROUP": "BG_LEFT",
"SF": 1,
"GROUP": "Force_Left_Girder"
},
{
"BRDG_GROUP": "BG_RIGHT",
"SF": 2,
"GROUP": "Force_Right_Girder"
}
],
"STAGE_LIST": [
"CS1",
"CS2",
"FINAL"
],
"EXPORT_PATH": "C:\\Temp\\GSBG\\ForceBatch",
"EXTENSION": "emf"
}
}
Force + BATCH false
{
"Argument": {
"LC_NAME": "LCB_SERVICE_01",
"DGRM_TYPE": 1,
"BATCH": false,
"X_AXIS_TYPE": 1,
"BRDG_GROUP": "BG_MAIN",
"COMPONENTS": 5,
"STAGE_LIST": [
"CS1",
"CS2",
"FINAL"
],
"EXPORT_PATH": "C:\\Temp\\GSBG\\ForceSingle",
"EXTENSION": "jpg"
}
}
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 | "BATCH" | boolean | true | Optional | |||
4 | X-Axis Type • Distance: 0 • Node: 1 | "X_AXIS_TYPE" | integer (enum) | 0 | Optional | |||
When DGRM_TYPE = 0 (Stress) | ||||||||
5 | Stress Components • Sax: 0 • +Sby: 1 • -Sby: 2 • +Sbz: 3 • -Sbz: 4 • Combined: 5 • 7th DOF: 6 | "COMPONENTS" | integer (enum) | 0 | Optional | |||
When DGRM_TYPE = 0 (Stress) and COMPONENTS = 5 (Combined) | ||||||||
6 | 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 DGRM_TYPE = 0 (Stress) and COMPONENTS = 6 (7th DOF) | ||||||||
7 | 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 | |||
8 | Allowable Stress Line. The unit of COMP and TENS follows the current system unit settings. | "STRESS_LINE" | object | - | Optional | |||
(1) | Draw Allowable Stress Line. | "OPT_USE" | boolean | false | Optional | |||
When STRESS_LINE.OPT_USE = true | ||||||||
(2) | Allowable compression stress Unit follows the system unit settings | "COMP" | integer | - | Required | |||
(3) | Allowable tension stress Unit follows the system unit settings | "TENS" | integer | - | Required | |||
When DGRM_TYPE = 1 (Force) | ||||||||
9 | Beam Forces/Moments Components • 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 = true | ||||||||
10 | Batch output list | "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 | |||
When BATCH = false | ||||||||
11 | Bridge Girder Element Group | "BRDG_GROUP" | string | - | Required | |||
12 | Stage list for diagram generation | "STAGE_LIST" | array[string] | - | Required | |||
13 | Export path for the generated diagram image | "EXPORT_PATH" | string | - | Required | |||
14 | Export image file extension • bmp • jpg • emf | "EXTENSION" | enum (string) | - | Required | |||