Skip to main content
JSON Manual Created Edited

DESIGN/STEEL/KDS-41-30-2022/TABLE : Steel Member Design Forces

Input URI

{base url} + DESIGN/STEEL/KDS-41-30-2022/TABLE



Active Methods

POST



JSON Schema

Details

{
  "type""object",
  "required": [
    "Argument"
  ],
  "additionalProperties"false,
  "properties": {
    "Argument": {
      "type""object",
      "required": [
        "TABLE_TYPE"
      ],
      "additionalProperties"false,
      "properties": {
        "TABLE_NAME": {
          "type""string",
          "description""Response Table Title",
          "default"""
        },
        "TABLE_TYPE": {
          "type""string",
          "description""Result Table Type",
          "enum": [
            "STEELMEMBERDESIGNFORCES"
          ]
        },
        "EXPORT_PATH": {
          "type""string",
          "description""Result Table Save Path"
        },
        "UNIT": {
          "type""object",
          "description""Response Unit Setting",
          "properties": {
            "FORCE": {
              "type""string",
              "description""Force unit"
            },
            "DIST": {
              "type""string",
              "description""Length/Distance unit"
            },
            "HEAT": {
              "type""string",
              "description""Heat unit"
            },
            "TEMP": {
              "type""string",
              "description""Temperature unit"
            }
          },
          "default""System"
        },
        "STYLES": {
          "type""object",
          "description""Response Number Format",
          "properties": {
            "FORMAT": {
              "type""string",
              "description""Number format",
              "enum": [
                "Default",
                "Fixed",
                "Scientific",
                "General"
              ]
            },
            "PLACE": {
              "type""integer",
              "description""Digit place",
              "minimum"0,
              "maximum"15
            }
          },
          "default""System"
        },
        "COMPONENTS": {
          "type""array",
          "description""Components of Result Table",
          "items": {
            "type""string",
            "enum": [
              "Index",
              "Memb",
              "Part",
              "LComName",
              "Type",
              "Fx",
              "Fy",
              "Fz",
              "Mx",
              "My",
              "Mz"
            ]
          }
        },
        "NODE_ELEMS": {
          "type""object",
          "description""Node/Element No. Input",
          "properties": {
            "KEYS": {
              "type""array",
              "description""Specify Each ID",
              "items": {
                "type""integer"
              }
            },
            "TO": {
              "type""string",
              "description""Specify ID Range (e.g., '1to160')"
            },
            "STRUCTURE_GROUP_NAME": {
              "type""string",
              "description""Specify Structure Group Name"
            }
          },
          "oneOf": [
            {
              "required": [
                "KEYS"
              ],
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "TO"
                    ]
                  },
                  {
                    "required": [
                      "STRUCTURE_GROUP_NAME"
                    ]
                  }
                ]
              }
            },
            {
              "required": [
                "TO"
              ],
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "KEYS"
                    ]
                  },
                  {
                    "required": [
                      "STRUCTURE_GROUP_NAME"
                    ]
                  }
                ]
              }
            },
            {
              "required": [
                "STRUCTURE_GROUP_NAME"
              ],
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "KEYS"
                    ]
                  },
                  {
                    "required": [
                      "TO"
                    ]
                  }
                ]
              }
            }
          ]
        },
        "PARTS": {
          "type""array",
          "description""Element Part Number",
          "items": {
            "type""string",
            "enum": [
              "PartI",
              "Part1/4",
              "Part2/4",
              "Part3/4",
              "PartJ"
            ]
          },
          "default": [
            "All"
          ]
        }
      }
    }
  }
}


Request Examples

Example

{
  "Argument": {
    "TABLE_TYPE": "STEELMEMBERDESIGNFORCES",
    "EXPORT_PATH": "C:\\MIDAS\\Result\\SteelMemberForces.json",
    "COMPONENTS": [
      "Index",
      "Memb",
      "Part",
      "LComName",
      "Type",
      "Fx",
      "Fy",
      "Fz",
      "Mx",
      "My",
      "Mz"
    ],
    "PARTS": [
      "All",
      "PartI",
      "Part1/4",
      "Part2/4",
      "Part3/4",
      "PartJ"
    ],
    "NODE_ELEMS": {
      "KEYS": [
        1072
      ]
    }
  }
}


Response Examples

Example

{
  "empty": {
    "FORCE": "KN",
    "DIST": "M",
    "HEAD": [
      "Index",
      "Memb",
      "Part",
      "LComName",
      "Type",
      "Fx",
      "Fy",
      "Fz",
      "Mx",
      "My",
      "Mz"
    ],
    "DATA": [
      [
        "1",
        "1072",
        "I",
        "gLCB183",
        "Max",
        "0.0000",
        "0.0000",
        "-137.7264",
        "0.0000",
        "-144.9112",
        "0.0000"
      ],
      [
        "2",
        "1072",
        "I",
        "gLCB184",
        "Max",
        "0.0000",
        "0.0000",
        "-118.0512",
        "0.0000",
        "-124.2096",
        "0.0000"
      ],
      [
        "3",
        "1072",
        "1/4",
        "gLCB183",
        "Max",
        "0.0000",
        "0.0000",
        "-107.3363",
        "0.0000",
        "-83.5333",
        "0.0000"
      ],
      [
        "4",
        "1072",
        "1/4",
        "gLCB184",
        "Max",
        "0.0000",
        "0.0000",
        "-92.0025",
        "0.0000",
        "-71.6000",
        "0.0000"
      ],
      [
        "5",
        "1072",
        "2/4",
        "gLCB183",
        "Max",
        "0.0000",
        "0.0000",
        "-74.2518",
        "0.0000",
        "-38.0240",
        "0.0000"
      ],
      [
        "6",
        "1072",
        "2/4",
        "gLCB184",
        "Max",
        "0.0000",
        "0.0000",
        "-63.6444",
        "0.0000",
        "-32.5920",
        "0.0000"
      ],
      [
        "7",
        "1072",
        "3/4",
        "gLCB183",
        "Max",
        "0.0000",
        "0.0000",
        "-38.4731",
        "0.0000",
        "-9.7305",
        "0.0000"
      ],
      [
        "8",
        "1072",
        "3/4",
        "gLCB184",
        "Max",
        "0.0000",
        "0.0000",
        "-32.9769",
        "0.0000",
        "-8.3404",
        "0.0000"
      ],
      [
        "9",
        "1072",
        "J",
        "gLCB183",
        "Max",
        "0.0000",
        "0.0000",
        "0.0000",
        "0.0000",
        "0.0000",
        "0.0000"
      ],
      [
        "10",
        "1072",
        "J",
        "gLCB184",
        "Max",
        "0.0000",
        "0.0000",
        "0.0000",
        "0.0000",
        "0.0000",
        "0.0000"
      ]
    ]
  }
}


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

Table Name

Output table title in response

"TABLE_NAME"

string

""

Optional

2

Table Type

• STEELMEMBERDESIGNFORCES: "STEELMEMBERDESIGNFORCES"

"TABLE_TYPE"

string

-

Required

3

Export Path

Optional: Save results to file path

"EXPORT_PATH"

string

-

Optional

4

Unit Settings

"UNIT"

object

System

Optional

4.1

Force unit

"FORCE"

string

-

Optional

4.2

Length/Distance unit

"DIST"

string

-

Optional

4.3

Heat unit

"HEAT"

string

-

Optional

4.4

Temperature unit

"TEMP"

string

-

Optional

5

Number Format

"STYLES"

object

System

Optional

5.1

Number format

• Default: "Default"

• Fixed: "Fixed"

• Scientific: "Scientific"

• General: "General"

"FORMAT"

string

-

Optional

5.2

Digit place

Constraints:

• Value Range: >= 0, <= 15

"PLACE"

integer

-

Optional

6

Components

• Index: "Index"

• Member: "Memb"

• Part: "Part"

• Load Combination Name: "LComName"

• Type: "Type"

• Fx: "Fx"

• Fy: "Fy"

• Fz: "Fz"

• Mx: "Mx"

• My: "My"

• Mz: "Mz"

"COMPONENTS"

Array [string]

-

Optional

7

Node/Element Selection

Use only ONE of the three methods: KEYS, TO, or STRUCTURE_GROUP_NAME

"NODE_ELEMS"

object

-

Optional

oneOf Choose exactly one of the following keys: "KEYS", "TO", or "STRUCTURE_GROUP_NAME".

7.1

Specify Each ID

"KEYS"

Array [integer]

-

Optional

7.2

Specify ID Range (e.g., '1to160')

"TO"

string

-

Optional

7.3

Specify Structure Group Name

"STRUCTURE_GROUP_NAME"

string

-

Optional

8

Element Parts

• PartI: "PartI"

• Part1/4: "Part1/4"

• Part2/4: "Part2/4"

• Part3/4: "Part3/4"

• PartJ: "PartJ"

"PARTS"

Array [string]

["All"]

Optional



0
Was this article helpful?