Skip to main content
  1. MIDAS Support
  2. Online Help_MIDAS API
  3. JSON Manual
JSON Manual Created Edited

DESIGN/RC/KDS-41-20-2022/CDESIGN : RC Concrete Design Result

Input URI

{base url} + DESIGN/RC/KDS-41-20-2022/CDESIGN



Active Methods

POST



JSON Schema

Details

{
  "type": "object",
  "required": [
    "Argument"
  ],
  "additionalProperties": false,
  "properties": {
    "Argument": {
      "type": "object",
      "required": [
        "EXPORT_PATH",
        "FIGURE_NAME",
        "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"
        },
        "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"
        },
        "SET_HIDDEN": {
          "type": "boolean",
          "description": "Hidden option (true: hidden, false: not hidden)",
          "default": false
        },
        "ACTIVE": {
          "type": "object",
          "description": "View/Active settings. For detailed field specifications, refer to the Active documentation."
        },
        "ANGLE": {
          "type": "object",
          "description": "View/Angle settings. For detailed field specifications, refer to the Angle documentation."
        },
        "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 (25: zoom out, 100: fit, 200: zoom in max)",
          "default": 100,
          "minimum": 25,
          "maximum": 200
        },
        "BGCOLOR_TOP": {
          "type": "object",
          "description": "Background color top (RGB)",
          "properties": {
            "R": {
              "type": "integer",
              "description": "Red component (0-255)",
              "minimum": 0,
              "maximum": 255
            },
            "G": {
              "type": "integer",
              "description": "Green component (0-255)",
              "minimum": 0,
              "maximum": 255
            },
            "B": {
              "type": "integer",
              "description": "Blue component (0-255)",
              "minimum": 0,
              "maximum": 255
            }
          }
        },
        "BGCOLOR_BOTTOM": {
          "type": "object",
          "description": "Background color bottom (RGB)",
          "properties": {
            "R": {
              "type": "integer",
              "description": "Red component (0-255)",
              "minimum": 0,
              "maximum": 255
            },
            "G": {
              "type": "integer",
              "description": "Green component (0-255)",
              "minimum": 0,
              "maximum": 255
            },
            "B": {
              "type": "integer",
              "description": "Blue component (0-255)",
              "minimum": 0,
              "maximum": 255
            }
          }
        },
        "RESULT_GRAPHIC": {
          "type": "object",
          "description": "Concrete design result graphic display settings",
          "required": [
            "LOAD_CASE_COMB"
          ],
          "properties": {
            "LOAD_CASE_COMB": {
              "type": "object",
              "description": "Load case and combinations",
              "required": [
                "TYPE",
                "NAME"
              ],
              "properties": {
                "TYPE": {
                  "type": "string",
                  "description": "Load case type",
                  "oneOf": [
                    {
                      "title": "Concrete Design Load Combination",
                      "const": "CBC"
                    }
                  ]
                },
                "NAME": {
                  "type": "string",
                  "description": "Load name"
                }
              }
            },
            "COMPONENTS": {
              "type": "string",
              "description": "Ratio component to display in concrete design results",
              "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 concrete design result visualization. For detailed field specifications, refer to the Type of Display documentation.",
              "properties": {
                "CONTOUR": {
                  "type": "object",
                  "description": "Display contour visualization"
                },
                "LEGEND": {
                  "type": "object",
                  "description": "Display legend"
                },
                "VALUES": {
                  "type": "object",
                  "description": "Display values"
                }
              }
            },
            "REINFORCEMENT": {
              "type": "boolean",
              "description": "Display reinforcement information",
              "default": true
            },
            "REINFORCEMENT_TYPE": {
              "type": "string",
              "description": "Reinforcement display type",
              "oneOf": [
                {
                  "title": "Rebar",
                  "const": "REBAR"
                },
                {
                  "title": "Area",
                  "const": "AREA"
                },
                {
                  "title": "Ratio(%)",
                  "const": "RATIO"
                }
              ],
              "default": "REBAR"
            },
            "DISPLAY_MEMBERS": {
              "type": "object",
              "description": "Member types to display in results. Only available when Code Checking Ratio is enabled.",
              "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
                },
                "WALL": {
                  "type": "boolean",
                  "description": "Display wall members",
                  "default": true
                }
              }
            },
            "OUTPUT_COMPONENT": {
              "type": "object",
              "description": "Output components for reinforcement results",
              "properties": {
                "RATIO_AXIAL_STRESS": {
                  "type": "boolean",
                  "description": "Ratio of Axial Stress",
                  "default": true
                },
                "MAIN_REBAR": {
                  "type": "boolean",
                  "description": "Main Rebar",
                  "default": true
                },
                "SHEAR_REINFORCEMENT": {
                  "type": "boolean",
                  "description": "Shear Reinforcement",
                  "default": true
                }
              }
            },
            "COLUMN_SECTION_SIZE": {
              "type": "object",
              "description": "Column section size display settings",
              "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",
              "properties": {
                "DECIMAL_PLACES": {
                  "type": "integer",
                  "description": "Number of decimal places for display values",
                  "default": 2,
                  "minimum": 0,
                  "maximum": 15
                },
                "EXPONENTIAL": {
                  "type": "boolean",
                  "description": "Use exponential notation for display",
                  "default": false
                }
              }
            },
            "OUTPUT_SECT_LOCATION": {
              "type": "object",
              "description": "Output section location settings (Beam)",
              "properties": {
                "OPT_I": {
                  "type": "boolean",
                  "description": "Output Start Location",
                  "default": false
                },
                "OPT_CENTER_MID": {
                  "type": "boolean",
                  "description": "Output Center/Mid Location",
                  "default": false
                },
                "OPT_J": {
                  "type": "boolean",
                  "description": "Output End Location",
                  "default": false
                },
                "OPT_MAX": {
                  "type": "boolean",
                  "description": "Max",
                  "default": true
                },
                "OPT_ALL": {
                  "type": "boolean",
                  "description": "All",
                  "default": false
                }
              }
            }
          }
        }
      }
    }
  }
}




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\Images\result.jpg

"EXPORT_PATH"

string

-

Required

2

Smart Report Image Name

"FIGURE_NAME"

string

-

Required

3

Image Width's Pixel Size

Constraints:

• Value Range: >= 100, <= 10000

"WIDTH"

integer

1000

Optional

4

Image Height's Pixel Size

Constraints:

• Value Range: >= 100, <= 10000

"HEIGHT"

integer

1000

Optional

5

Construction Stage Name

"STAGE_NAME"

string

-

Optional

6

Hidden Option

"SET_HIDDEN"

boolean

false

Optional

7

Active *)

"ACTIVE"

object

-

Optional

8

Angle *)

"ANGLE"

object

-

Optional

9

Display Settings *)

"DISPLAY"

object

-

Optional

10

Perspective

"PERSPECTIVE"

boolean

false

Optional

11

Zoom Level

Constraints:

• Value Range: >= 25, <= 200

"ZOOM_LEVEL"

number

100

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

Background Color Bottom

"BGCOLOR_BOTTOM"

object

-

Optional

13.1

Red

Constraints:

• Value Range: >= 0, <= 255

"R"

integer

-

Optional

13.2

Green

Constraints:

• Value Range: >= 0, <= 255

"G"

integer

-

Optional

13.3

Blue

Constraints:

• Value Range: >= 0, <= 255

"B"

integer

-

Optional

14

Result Graphic

"RESULT_GRAPHIC"

object

-

Required

14.1

Current Mode

• Infill Design RC: "INFLL_DESIGN_RC"

"CURRENT_MODE"

string

-

Required

14.2

Load Cases/Combinations

"LOAD_CASE_COMB"

object

-

Required

14.2.1

Load Case Type

• Concrete Design Result Combination: "CBC"

"TYPE"

string

-

Required

14.2.2

Load Name

"NAME"

string

-

Required

14.3

Ratio by Components

"COMPONENTS"

object

-

Optional

14.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"

• SHEAR-Z: "SHEAR-Z"

"COMP"

string

"Combined"

Optional

14.4

Type of Display *)

"TYPE_OF_DISPLAY"

object

-

Optional

14.4.1

Contour

"CONTOUR"

object

-

Optional

14.4.1.1

Check

"OPT_CHECK"

boolean

false

Optional

14.4.1.2

Number of Color

Constraints:

• Value Range: >= 2, <= 20

"NUM_OF_COLOR"

integer

12

Optional

14.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

"vrgb"

Optional

14.4.1.4

Options

"OPTIONS"

object

-

Optional

14.4.1.4.1

Gradient Fill

"GRADIENT_FILL"

boolean

false

Optional

14.4.1.4.2

Contour Fill

"CONTOUR_FILL"

boolean

true

Optional

14.4.2

Values

"VALUES"

object

-

Optional

14.4.2.1

Check

"OPT_CHECK"

boolean

false

Optional

14.4.2.2

Decimal Pt.

Constraints:

• Value Range: >= 0, <= 15

"DECIMAL_PT"

integer

0

Optional

14.4.2.3

Exponential

"VALUE_EXP"

boolean

false

Optional

14.4.2.4

Min/Max Only

"MINMAX_ONLY"

object

-

Optional

14.4.2.4.1

MinMax Type of Values

• Min. & Max: "Min & Max"

• Absolut Max: "Abs Max"

• Maximum: "max"

• MMinimumin: "min"

"MAXMIN"

string

"Min & Max"

Optional

14.4.2.4.2

Limit Scale

"LIMIT_SCALE"

integer

0

Optional

14.4.2.5

Orientation

"SET_ORIENT"

integer

0

Optional

14.4.3

Legend

"LEGEND"

object

-

Optional

14.4.3.1

Check

"OPT_CHECK"

boolean

false

Optional

14.4.3.2

Position

• Right: "right"

• Left: "left"

• Top: "top"

• Bottom: "bottom"

"POSITION"

string

"left"

Optional

14.4.3.3

Exponential

"VALUE_EXP"

boolean

true

Optional

14.4.3.4

Decimal Pt.

Constraints:

• Value Range: >= 0, <= 15

"DECIMAL_PT"

integer

0

Optional

When "COMPONENTS.COMP" is Combined

14.4.4

Reinforcement

"REINFORCEMENT"

object

-

Optional

14.4.4.1

Reinforcement

"CHECK"

boolean

true

Optional

When "COMPONENTS.COMP" is Combined, "REINFORCEMENT.CHECK" is true

14.4.4.2

Reinforcement Type

• Rebar: "REBAR"

• Area: "AREA"

• Ratio(%): "RATIO"

"REINFORCEMENT_TYPE"

string

"REBAR"

Optional

14.4.4.3

DISPLAY_MEMBERS

"DISPLAY_MEMBERS"

object

-

Optional

14.4.4.3.1

Beam

"BEAM"

boolean

true

Optional

14.4.4.3.2

Column

"COLUMN"

boolean

true

Optional

14.4.4.3.3

Brace

"BRACE"

boolean

true

Optional

14.4.4.3.4

Wall

"WALL"

boolean

true

Optional

14.4.4.4

Output Component

"OUTPUT_COMPONENT"

object

-

Optional

14.4.4.4.1

Ratio of Axial Stress

"RATIO_AXIAL_STRESS"

boolean

true

Optional

14.4.4.4.2

Main Rebar

"MAIN_REBAR"

boolean

true

Optional

14.4.4.4.3

Shear Reinforcement

"SHEAR_REINFORCEMENT"

boolean

true

Optional

14.4.4.5

Column Section Size

"COLUMN_SECTION_SIZE"

object

-

Optional

14.4.4.5.1

Scale Factor

Constraints:

• Value Range: >= 0.1, <= 100

"SCALE_FACTOR"

number

1

Optional

14.4.4.6

Value Option

"VALUE_OPTION"

object

-

Optional

14.4.4.6.1

Decimal Pt.

Constraints:

• Value Range: >= 0, <= 15

"DECIMAL_PLACES"

integer

2

Optional

14.4.4.6.2

Exp.

"EXPONENTIAL"

boolean

false

Optional

When "VALUES" is true

14.5

Output Section Location

"OUTPUT_SECT_LOCATION"

object

-

Optional

14.5.1

Ratio by Components

• MAX: "MAX"

• ALL: "ALL"

"OPT_MAX_ALL"

string

"MAX"

Optional

When "VALUES" is true, "OPT_MAX_ALL" is NONE

14.5.2

I

"OPT_I"

boolean

false

Optional

14.5.3

Center

"OPT_CENTER_MID"

boolean

false

Optional

14.5.4

J

"OPT_J"

boolean

false

Optional


- Active ↗

- Angle ↗

- Display ↗

- Type of Display ↗



0
Was this article helpful?