Input URI
|
{base url} + DESIGN/STEEL/KDS-41-30-2022/DREULT |
|---|
Active Methods
|
POST |
|---|
JSON Schema
Details
"type": "object",
"required": [
"Argument"
],
"additionalProperties": false,
"properties": {
"Argument": {
"type": "object",
"required": [
"EXPORT_PATH",
"RESULT_GRAPHIC"
],
"additionalProperties": false,
"properties": {
"EXPORT_PATH": {
"type": "string",
"description": "Image file save path and file name."
},
"FIGURE_NAME": {
"type": "string",
"description": "Smart report image name."
},
"SET_HIDDEN": {
"type": "boolean",
"description": "Hidden option.",
"default": false
},
"ACTIVE": {
"type": "object",
"description": "View/Active settings. For detailed field specifications, refer to the Active documentation."
},
"WIDTH": {
"type": "integer",
"description": "Image width in pixels.",
"default": 1000,
"minimum": 100,
"maximum": 10000
},
"HEIGHT": {
"type": "integer",
"description": "Image height in pixels.",
"default": 1000,
"minimum": 100,
"maximum": 10000
},
"STAGE_NAME": {
"type": "string",
"description": "Construction stage name."
},
"ANGLE": {
"type": "object",
"description": "View angle settings.",
"required": [],
"additionalProperties": false,
"properties": {
"HORIZONTAL": {
"type": "number",
"description": "Horizontal rotation angle.",
"default": 0
},
"VERTICAL": {
"type": "number",
"description": "Vertical rotation angle.",
"default": 0
}
}
},
"DISPLAY": {
"type": "object",
"description": "View/Display settings. For detailed field specifications, refer to the Display documentation."
},
"PERSPECTIVE": {
"type": "boolean",
"description": "Enable perspective view.",
"default": false
},
"ZOOM_LEVEL": {
"type": "number",
"description": "Zoom level.",
"default": 100,
"minimum": 25,
"maximum": 200
},
"BGCOLOR_TOP": {
"type": "object",
"description": "Top background color.",
"additionalProperties": false,
"properties": {
"R": {
"type": "integer",
"description": "Red component.",
"minimum": 0,
"maximum": 255
},
"G": {
"type": "integer",
"description": "Green component.",
"minimum": 0,
"maximum": 255
},
"B": {
"type": "integer",
"description": "Blue component.",
"minimum": 0,
"maximum": 255
}
}
},
"RESULT_GRAPHIC": {
"type": "object",
"description": "Result graphic display settings.",
"required": [
"CURRENT_MODE",
"LOAD_CASE_COMB"
],
"additionalProperties": false,
"properties": {
"CURRENT_MODE": {
"type": "string",
"description": "Current mode.",
"oneOf": [
{
"title": "Steel Design",
"const": "INFLL_DESIGN_STEEL"
}
]
},
"LOAD_CASE_COMB": {
"type": "object",
"description": "Load cases and combinations.",
"required": [
"TYPE",
"NAME"
],
"additionalProperties": false,
"properties": {
"TYPE": {
"type": "string",
"description": "Load case type.",
"oneOf": [
{
"title": "Steel Design Load Combination",
"const": "CBS"
}
]
},
"NAME": {
"type": "string",
"description": "Load case or combination name."
}
}
},
"COMPONENTS": {
"type": "object",
"description": "Component selection for design result display.",
"required": [],
"additionalProperties": false,
"properties": {
"COMP": {
"type": "string",
"description": "Design component to display.",
"default": "Combined",
"oneOf": [
{
"title": "Axial",
"const": "Axial"
},
{
"title": "Shear-y",
"const": "Shear-y"
},
{
"title": "Shear-z",
"const": "Shear-z"
},
{
"title": "Bend-y",
"const": "Bend-y"
},
{
"title": "Bend-z",
"const": "Bend-z"
},
{
"title": "Combined",
"const": "Combined"
}
]
}
}
},
"TYPE_OF_DISPLAY": {
"type": "object",
"description": "Display options for design result visualization.",
"required": [],
"additionalProperties": false,
"properties": {
"CONTOUR": {
"type": "object",
"description": "Contour display settings.",
"required": [],
"additionalProperties": false,
"properties": {
"OPT_CHECK": {
"type": "boolean",
"description": "Enable contour display.",
"default": false
},
"NUM_OF_COLOR": {
"type": "integer",
"description": "Number of contour colors.",
"default": 12,
"minimum": 2,
"maximum": 20
},
"COLOR_TYPE": {
"type": "string",
"description": "Contour color type.",
"default": "vrgb",
"oneOf": [
{
"title": "V->R->G->B",
"const": "vrgb"
},
{
"title": ">R->G->B",
"const": "rgb"
},
{
"title": "R->B->G",
"const": "rbg"
},
{
"title": "Gray Scaled",
"const": "gray scaled"
}
]
},
"OPTIONS": {
"type": "object",
"description": "Contour options.",
"required": [],
"additionalProperties": false,
"properties": {
"GRADIENT_FILL": {
"type": "boolean",
"description": "Use gradient fill.",
"default": false
},
"CONTOUR_FILL": {
"type": "boolean",
"description": "Use contour fill.",
"default": true
}
}
}
}
},
"VALUES": {
"type": "object",
"description": "Value display settings.",
"required": [],
"additionalProperties": false,
"properties": {
"OPT_CHECK": {
"type": "boolean",
"description": "Enable value display.",
"default": false
},
"DECIMAL_PT": {
"type": "integer",
"description": "Decimal places.",
"default": 0,
"minimum": 0,
"maximum": 15
},
"VALUE_EXP": {
"type": "boolean",
"description": "Use exponential notation.",
"default": false
},
"MINMAX_ONLY": {
"type": "object",
"description": "Min/max display settings.",
"required": [],
"additionalProperties": false,
"properties": {
"MAXMIN": {
"type": "string",
"description": "Min/max display mode.",
"default": "Min & Max",
"oneOf": [
{
"title": "Min. & Max",
"const": "Min & Max"
},
{
"title": "Absolut Max",
"const": "Abs Max"
},
{
"title": "Maximum",
"const": "max"
},
{
"title": "MMinimumin",
"const": "min"
}
]
},
"LIMIT_SCALE": {
"type": "integer",
"description": "Scale limit.",
"default": 0
}
}
},
"SET_ORIENT": {
"type": "integer",
"description": "Value text orientation.",
"default": 0
}
}
},
"LEGEND": {
"type": "object",
"description": "Legend display settings.",
"required": [],
"additionalProperties": false,
"properties": {
"OPT_CHECK": {
"type": "boolean",
"description": "Enable legend display.",
"default": false
},
"POSITION": {
"type": "string",
"description": "Legend position.",
"default": "left",
"oneOf": [
{
"title": "Right",
"const": "right"
},
{
"title": "Left",
"const": "left"
},
{
"title": "Top",
"const": "top"
},
{
"title": "Bottom",
"const": "bottom"
}
]
},
"VALUE_EXP": {
"type": "boolean",
"description": "Use exponential notation for legend values.",
"default": true
},
"DECIMAL_PT": {
"type": "integer",
"description": "Decimal places for legend values.",
"default": 0,
"minimum": 0,
"maximum": 15
}
}
},
"CODE_CHECKING_RATIO": {
"type": "object",
"description": "Steel code checking ratio display settings.",
"required": [],
"additionalProperties": false,
"properties": {
"CHECK": {
"type": "boolean",
"description": "Enable code checking ratio display.",
"default": true
},
"DISPLAY_MEMBERS": {
"type": "object",
"description": "Steel member types to display.",
"required": [],
"additionalProperties": false,
"properties": {
"BEAM": {
"type": "boolean",
"description": "Display beam members.",
"default": true
},
"COLUMN": {
"type": "boolean",
"description": "Display column members.",
"default": true
},
"BRACE": {
"type": "boolean",
"description": "Display brace members.",
"default": true
}
}
},
"COLUMN_SECTION_SIZE": {
"type": "object",
"description": "Column section size display settings.",
"required": [],
"additionalProperties": false,
"properties": {
"SCALE_FACTOR": {
"type": "number",
"description": "Scale factor for column section visualization.",
"default": 1,
"minimum": 0.1,
"maximum": 100
}
}
},
"VALUE_OPTION": {
"type": "object",
"description": "Value display format settings.",
"required": [],
"additionalProperties": false,
"properties": {
"DECIMAL_PLACES": {
"type": "integer",
"description": "Number of decimal places.",
"default": 2,
"minimum": 0,
"maximum": 15
},
"EXPONENTIAL": {
"type": "boolean",
"description": "Use exponential notation.",
"default": false
}
}
}
}
}
}
}
}
}
}
}
}
}
Request Examples
Example
"Argument": {
"EXPORT_PATH": "C:\\MIDAS\\result\\steel design result.jpg",
"SET_HIDDEN": true,
"WIDTH": 1000,
"HEIGHT": 1000,
"PERSPECTIVE": false,
"ZOOM_LEVEL": 100,
"RESULT_GRAPHIC": {
"CURRENT_MODE": "INFLL_DESIGN_STEEL",
"LOAD_CASE_COMB": {
"TYPE": "CBS",
"NAME": "STEEL_gLCB5"
},
"COMPONENTS": {
"COMP": "Combined"
},
"TYPE_OF_DISPLAY": {
"LEGEND": {
"OPT_CHECK": true,
"VALUE_EXP": false,
"DECIMAL_PT": 3
},
"CONTOUR": {
"OPT_CHECK": true,
"OPTIONS": {
"GRADIENT_FILL": true
}
},
"VALUES": {
"OPT_CHECK": true,
"DECIMAL_PT": 5,
"VALUE_EXP": true,
"SET_ORIENT": 15,
"MINMAX_ONLY": {
"MAXMIN": "min",
"LIMIT_SCALE": 5
}
},
"CODE_CHECKING_RATIO": {
"CHECK": true,
"DISPLAY_MEMBERS": {
"COLUMN": true,
"BEAM": false,
"BRACE": true
}
}
}
}
}
}
Response Examples
Example
"message": "MIDAS GEN NX command complete"
}
Specifications
Keyed Object Entry
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
|
Root Object |
||||||||
|
1 |
Map of keyed objects where each key is a string identifier. |
"Argument" |
object |
- |
Required |
|||
Item (Value Object Schema)
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
|
General |
||||||||
|
1 |
Image File Save Path & File Name e.g., C:\MIDAS\Result\image.jpg |
"EXPORT_PATH" |
string |
- |
Required |
|||
|
2 |
Smart Report Image Name |
"FIGURE_NAME" |
string |
- |
Optional |
|||
|
3 |
Hidden Option |
"SET_HIDDEN" |
boolean |
|
Optional |
|||
|
4 |
Active *) |
"ACTIVE" |
object |
- |
Optional |
|||
|
5 |
Image Width Constraints: • Value Range: >= 100, <= 10000 |
"WIDTH" |
integer |
|
Optional |
|||
|
6 |
Image Height Constraints: • Value Range: >= 100, <= 10000 |
"HEIGHT" |
integer |
|
Optional |
|||
|
7 |
Construction Stage Name |
"STAGE_NAME" |
string |
- |
Optional |
|||
|
8 |
Angle |
"ANGLE" |
object |
- |
Optional |
|||
|
8.1 |
Horizontal |
"HORIZONTAL" |
number |
|
Optional |
|||
|
8.2 |
Vertical |
"VERTICAL" |
number |
|
Optional |
|||
|
9 |
Display Settings *) |
"DISPLAY" |
object |
- |
Optional |
|||
|
10 |
Perspective |
"PERSPECTIVE" |
boolean |
|
Optional |
|||
|
11 |
Zoom Level Constraints: • Value Range: >= 25, <= 200 |
"ZOOM_LEVEL" |
number |
|
Optional |
|||
|
12 |
Background Color Top |
"BGCOLOR_TOP" |
object |
- |
Optional |
|||
|
12.1 |
Red Constraints: • Value Range: >= 0, <= 255 |
"R" |
integer |
- |
Optional |
|||
|
12.2 |
Green Constraints: • Value Range: >= 0, <= 255 |
"G" |
integer |
- |
Optional |
|||
|
12.3 |
Blue Constraints: • Value Range: >= 0, <= 255 |
"B" |
integer |
- |
Optional |
|||
|
13 |
Result Graphic |
"RESULT_GRAPHIC" |
object |
- |
Required |
|||
|
13.1 |
Current Mode • Steel Design: "INFLL_DESIGN_STEEL" |
"CURRENT_MODE" |
string |
- |
Required |
|||
|
13.2 |
Load Cases/Combinations |
"LOAD_CASE_COMB" |
object |
- |
Required |
|||
|
13.2.1 |
Load Case Type • Steel Design Load Combination: "CBS" |
"TYPE" |
string |
- |
Required |
|||
|
13.2.2 |
Load Name |
"NAME" |
string |
- |
Required |
|||
|
13.3 |
Components |
"COMPONENTS" |
object |
- |
Optional |
|||
|
13.3.1 |
Ratio by Components • Axial: "Axial" • Shear-y: "Shear-y" • Shear-z: "Shear-z" • Bend-y: "Bend-y" • Bend-z: "Bend-z" • Combined: "Combined" |
"COMP" |
string |
|
Optional |
|||
|
13.4 |
Type of Display |
"TYPE_OF_DISPLAY" |
object |
- |
Optional |
|||
|
13.4.1 |
Contour |
"CONTOUR" |
object |
- |
Optional |
|||
|
13.4.1.1 |
Check |
"OPT_CHECK" |
boolean |
|
Optional |
|||
|
13.4.1.2 |
Number of Color Constraints: • Value Range: >= 2, <= 20 |
"NUM_OF_COLOR" |
integer |
|
Optional |
|||
|
13.4.1.3 |
Color Type • V->R->G->B: "vrgb" • >R->G->B: "rgb" • R->B->G: "rbg" • Gray Scaled: "gray scaled" |
"COLOR_TYPE" |
string |
|
Optional |
|||
|
13.4.1.4 |
Options |
"OPTIONS" |
object |
- |
Optional |
|||
|
13.4.1.4.1 |
Gradient Fill |
"GRADIENT_FILL" |
boolean |
|
Optional |
|||
|
13.4.1.4.2 |
Contour Fill |
"CONTOUR_FILL" |
boolean |
|
Optional |
|||
|
13.4.2 |
Values |
"VALUES" |
object |
- |
Optional |
|||
|
13.4.2.1 |
Check |
"OPT_CHECK" |
boolean |
|
Optional |
|||
|
13.4.2.2 |
Decimal Pt. Constraints: • Value Range: >= 0, <= 15 |
"DECIMAL_PT" |
integer |
|
Optional |
|||
|
13.4.2.3 |
Exponential |
"VALUE_EXP" |
boolean |
|
Optional |
|||
|
13.4.2.4 |
Min/Max Only |
"MINMAX_ONLY" |
object |
- |
Optional |
|||
|
13.4.2.4.1 |
MinMax Type of Values • Min. & Max: "Min & Max" • Absolut Max: "Abs Max" • Maximum: "max" • MMinimumin: "min" |
"MAXMIN" |
string |
|
Optional |
|||
|
13.4.2.4.2 |
Limit Scale |
"LIMIT_SCALE" |
integer |
|
Optional |
|||
|
13.4.2.5 |
Orientation |
"SET_ORIENT" |
integer |
|
Optional |
|||
|
13.4.3 |
Legend |
"LEGEND" |
object |
- |
Optional |
|||
|
13.4.3.1 |
Check |
"OPT_CHECK" |
boolean |
|
Optional |
|||
|
13.4.3.2 |
Position • Right: "right" • Left: "left" • Top: "top" • Bottom: "bottom" |
"POSITION" |
string |
|
Optional |
|||
|
13.4.3.3 |
Exponential |
"VALUE_EXP" |
boolean |
|
Optional |
|||
|
13.4.3.4 |
Decimal Pt. Constraints: • Value Range: >= 0, <= 15 |
"DECIMAL_PT" |
integer |
|
Optional |
|||
|
When "COMP" is Combined |
||||||||
|
13.4.4 |
Code Checking Ratio |
"CODE_CHECKING_RATIO" |
object |
- |
Optional |
|||
|
13.4.4.1 |
Check |
"CHECK" |
boolean |
|
Optional |
|||
|
13.4.4.2 |
Display Members |
"DISPLAY_MEMBERS" |
object |
- |
Optional |
|||
|
13.4.4.2.1 |
Beam |
"BEAM" |
boolean |
|
Optional |
|||
|
13.4.4.2.2 |
Column |
"COLUMN" |
boolean |
|
Optional |
|||
|
13.4.4.2.3 |
Brace |
"BRACE" |
boolean |
|
Optional |
|||
|
13.4.4.3 |
Column Section Size |
"COLUMN_SECTION_SIZE" |
object |
- |
Optional |
|||
|
13.4.4.3.1 |
Scale Factor Constraints: • Value Range: >= 0.1, <= 100 |
"SCALE_FACTOR" |
number |
|
Optional |
|||
|
13.4.4.4 |
Value Option |
"VALUE_OPTION" |
object |
- |
Optional |
|||
|
13.4.4.4.1 |
Decimal Places Constraints: • Value Range: >= 0, <= 15 |
"DECIMAL_PLACES" |
integer |
|
Optional |
|||
|
13.4.4.4.2 |
Exponential |
"EXPONENTIAL" |
boolean |
|
Optional |
|||
- Active ↗