Skip to main content
JSON Manual Created Edited

Steel Design Result

Input URI

/DESIGN/STEEL/KDS-41-30-2022/DREULT



Active Methods

POST



JSON Schema

Details

{}




Specifications

Keyed Object Entry

No. Description Key Value Type Default Required

Root Object

1

Root argument object

"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

-

Optional

3

Hidden Option

"SET_HIDDEN"

boolean

false

Optional

4

Image Width's Pixel Size

Constraints:

• Value Range: >= 100, <= 10000

"WIDTH"

integer

1000

Optional

5

Image Height's Pixel Size

Constraints:

• Value Range: >= 100, <= 10000

"HEIGHT"

integer

1000

Optional

6

Construction Stage Name

"STAGE_NAME"

string

-

Optional

7

Active *)

"ACTIVE"

object

-

Optional

8

Angle

"ANGLE"

object

-

Optional

8.1

Horizontal

"HORIZONTAL"

number

45

Optional

8.2

Vertical

"VERTICAL"

number

60

Optional

9

Display Settings *)

"DISPLAY"

object

-

Optional

10

Perspective

"PERSPECTIVE"

boolean

true

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

-

Required

12.2

Green

Constraints:

• Value Range: >= 0, <= 255

"G"

integer

-

Required

12.3

Blue

Constraints:

• Value Range: >= 0, <= 255

"B"

integer

-

Required

13

Background Color Bottom

"BGCOLOR_BOTTOM"

object

-

Optional

13.1

Red

Constraints:

• Value Range: >= 0, <= 255

"R"

integer

-

Required

13.2

Green

Constraints:

• Value Range: >= 0, <= 255

"G"

integer

-

Required

13.3

Blue

Constraints:

• Value Range: >= 0, <= 255

"B"

integer

-

Required

14

Result Graphic

"RESULT_GRAPHIC"

object

-

Required

14.1

Current Mode

"CURRENT_MODE"

string

-

Required

14.2

Load Cases/Combinations

"LOAD_CASE_COMB"

object

-

Required

14.2.1

Load Case Type

• CBC: "CBC"

• CBS: "CBS"

"TYPE"

string

-

Required

14.2.2

Load Name

"NAME"

string

-

Required

14.3

Components

"COMPONENTS"

object

-

Required

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"

"COMPONENTS"

string

"Combined"

Required

14.4

Type of Display *)

"TYPE_OF_DISPLAY"

object

-

Required

14.4.1

Contour

"CONTOUR"

object

-

Optional

14.4.1.1

Enable Contour

"OPT_CHECK"

boolean

true

Optional

14.4.1.2

Number of Colors

Constraints:

• Value Range: >= 2, <= 20

"NUM_OF_COLOR"

integer

6

Optional

14.4.1.3

Color Type

• RGB: "rgb"

• Index: "index"

"COLOR_TYPE"

string

"rgb"

Optional

14.4.1.4

Contour 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

false

Optional

14.4.2

Values

"VALUES"

object

-

Optional

14.4.2.1

Enable Values

"OPT_CHECK"

boolean

true

Optional

14.4.2.2

Decimal Point

Constraints:

• Value Range: >= 0, <= 15

"DECIMAL_PT"

integer

5

Optional

14.4.2.3

Value Exponential

"VALUE_EXP"

boolean

true

Optional

14.4.2.4

Min/Max Only

"MINMAX_ONLY"

object

-

Optional

14.4.2.4.1

Max/Min Mode

• Abs Max: "absmax"

• Max: "max"

• Min: "min"

"MAXMIN"

string

"absmax"

Optional

14.4.2.4.2

Limit Scale

"LIMIT_SCALE"

number

5

Optional

14.4.2.5

Set Orientation

"SET_ORIENT"

number

15

Optional

14.4.3

Legend

"LEGEND"

object

-

Optional

14.4.3.1

Enable Legend

"OPT_CHECK"

boolean

true

Optional

14.4.3.2

Position

• Left: "left"

• Right: "right"

• Top: "top"

• Bottom: "bottom"

"POSITION"

string

"right"

Optional

14.4.3.3

Legend Exponential

"VALUE_EXP"

boolean

true

Optional

14.4.3.4

Legend Decimal Point

Constraints:

• Value Range: >= 0, <= 15

"DECIMAL_PT"

integer

2

Optional

When "CURRENT_MODE" is INFLL_DESIGN_STEEL

14.4.4

Code Checking Ratio

"CODE_CHECKING_RATIO"

object

-

Optional

14.4.4.1

Check

"CHECK"

boolean

true

Optional

14.4.4.2

Display Members

"DISPLAY_MEMBERS"

object

-

Optional

14.4.4.2.1

Beam

"BEAM"

boolean

true

Optional

14.4.4.2.2

Column

"COLUMN"

boolean

true

Optional

14.4.4.2.3

Brace

"BRACE"

boolean

true

Optional

14.4.4.3

Column Section Size

"COLUMN_SECTION_SIZE"

object

-

Optional

14.4.4.3.1

Scale Factor

Constraints:

• Value Range: >= 0.1, <= 100

"SCALE_FACTOR"

number

1

Optional

14.4.4.4

Value Option

"VALUE_OPTION"

object

-

Optional

14.4.4.4.1

Decimal Places

Constraints:

• Value Range: >= 0, <= 15

"DECIMAL_PLACES"

integer

2

Optional

14.4.4.4.2

Exponential

"EXPONENTIAL"

boolean

false

Optional

When "CURRENT_MODE" is INFLL_DESIGN_RC,INFLL_DESIGN_SRC

14.4.5

Reinforcement

"REINFORCEMENT"

object

-

Optional

14.4.5.1

Check

"CHECK"

boolean

true

Optional

14.4.5.2

Reinforcement Type

• Rebar: "REBAR"

"REINFORCEMENT_TYPE"

string

"REBAR"

Optional

14.4.5.3

Display Members

"DISPLAY_MEMBERS"

object

-

Optional

14.4.5.3.1

Beam

"BEAM"

boolean

true

Optional

14.4.5.3.2

Column

"COLUMN"

boolean

true

Optional

14.4.5.3.3

Brace

"BRACE"

boolean

true

Optional

14.4.5.3.4

Wall

"WALL"

boolean

true

Optional

14.4.5.4

Output Component

"OUTPUT_COMPONENT"

object

-

Optional

14.4.5.4.1

Ratio Axial Stress

"RATIO_AXIAL_STRESS"

boolean

true

Optional

14.4.5.4.2

Main Rebar

"MAIN_REBAR"

boolean

true

Optional

14.4.5.4.3

Shear Reinforcement

"SHEAR_REINFORCEMENT"

boolean

true

Optional

14.4.5.5

Column Section Size

"COLUMN_SECTION_SIZE"

object

-

Optional

14.4.5.5.1

Scale Factor

Constraints:

• Value Range: >= 0.1, <= 100

"SCALE_FACTOR"

number

1

Optional

14.4.5.6

Value Option

"VALUE_OPTION"

object

-

Optional

14.4.5.6.1

Decimal Places

Constraints:

• Value Range: >= 0, <= 15

"DECIMAL_PLACES"

integer

2

Optional

14.4.5.6.2

Exponential

"EXPONENTIAL"

boolean

true

Optional

When "CURRENT_MODE" is INFLL_DESIGN_RC,INFLL_DESIGN_SRC

14.5

Output Section Location

"OUTPUT_SECT_LOCATION"

object

-

Optional

14.5.1

I End

"OPT_I"

boolean

false

Optional

14.5.2

Center/Mid

"OPT_CENTER_MID"

boolean

false

Optional

14.5.3

J End

"OPT_J"

boolean

false

Optional

14.5.4

Max/All

• Max: "Max"

• All: "All"

"OPT_MAX_ALL"

string

"Max"

Optional



- Active ↗

- Display ↗

- Type of Display ↗



0
Was this article helpful?