Skip to main content
JSON Manual Created Edited

Beam Diagrams - Result Display

Input URI

{base url} + view/RESULTGRAPHIC



Active Methods

POST



JSON Schema

Details

{
    "RESULTGRAPHIC": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
            "Argument": {
                "type": "object",
                "properties": {
                    "CURRENT_MODE": {
                        "type": "string",
                        "description": "ResultGraphicMode",
                        "enum": [
                            "BeamDiagrams"
                        ]
                    },
                    "LOAD_CASE_COMB": {
                        "type": "object",
                        "description": "LoadCaseandCombinations",
                        "properties": {
                            "TYPE": {
                                "type": "string",
                                "description": "LoadCase",
                                "enum": [
                                    "ST",
                                    "CS",
                                    "RS",
                                    "TH",
                                    "MV",
                                    "SM",
                                    "CB"
                                ]
                            },
                            "MINMAX": {
                                "type": "string",
                                "description": "LoadType",
                                "enum": [
                                    "Max",
                                    "Min",
                                    "All"
                                ]
                            },
                            "NAME": {
                                "type": "string",
                                "description": "LoadName"
                            },
                            "STEP_INDEX": {
                                "type": "integer",
                                "description": "StepofLoadCase"
                            },
                            "OPT_MAXMIN_DIAGRAM": {
                                "type": "boolean",
                                "description": "DisplayAbsoluteMaximumValuesofEnvelope"
                            }
                        }
                    },
                    "COMPONENTS": {
                        "type": "object",
                        "description": "Components",
                        "properties": {
                            "PART": {
                                "type": "string",
                                "description": "PartsNamedefinedintheCompositeSectionforConstructionStage",
                                "enum": [
                                    "Total"
                                ]
                            },
                            "COMP": {
                                "type": "string",
                                "description": "ComponentsName",
                                "enum": [
                                    "Fx",
                                    "Fy",
                                    "Fz",
                                    "Mx",
                                    "My",
                                    "Mz",
                                    "Mb",
                                    "Mt",
                                    "Mw"
                                ]
                            },
                            "OPT_SHOW_TRUSS_FORCES": {
                                "type": "boolean",
                                "description": "ShowTrussForces"
                            },
                            "OPT_ONLY_TRUSS_FORCES": {
                                "type": "boolean",
                                "description": "OnlyTrussForces"
                            }
                        }
                    },
                    "DISPLAY_OPTIONS": {
                        "type": "object",
                        "description": "DisplayOptions",
                        "properties": {
                            "FIDELITY": {
                                "type": "string",
                                "description": "FidelityofDiagram",
                                "enum": [
                                    "Exact",
                                    "5Points"
                                ]
                            },
                            "FILL": {
                                "type": "string",
                                "description": "FillofDiagram",
                                "enum": [
                                    "No",
                                    "Line",
                                    "Solid"
                                ]
                            },
                            "SCALE": {
                                "type": "number",
                                "description": "ScaleofDiagram"
                            }
                        }
                    },
                    "TYPE_OF_DISPLAY": {
                        "type": "object",
                        "description": "TypeofDisplay",
                        "properties": {
                            "CONTOUR": {
                                "type": "object",
                                "description": "ContourDetails"
                            },
                            "DEFORM": {
                                "type": "object",
                                "description": "DeformationDetails"
                            },
                            "VALUES": {
                                "type": "object",
                                "description": "ValuesOutputDetails"
                            },
                            "LEGEND": {
                                "type": "object",
                                "description": "LegendDetails"
                            },
                            "UNDEFORMED": {
                                "type": "boolean",
                                "description": "DisplayUndeformedShape"
                            },
                            "MIRRORED": {
                                "type": "object",
                                "description": "SymmetricModelMirrorDetail"
                            },
                            "OPT_CUR_STEP_FORCE": {
                                "type": "boolean",
                                "description": "CurrentStepForce"
                            },
                            "YIELD_POINT": {
                                "type": "boolean",
                                "description": "YieldPoint"
                            }
                        }
                    },
                    "OUTPUT_SECT_LOCATION": {
                        "type": "object",
                        "description": "OutputSectionLocation",
                        "properties": {
                            "OPT_BY_MEMBER": {
                                "type": "boolean",
                                "description": "ByMember"
                            },
                            "OPT_I": {
                                "type": "boolean",
                                "description": "OutputStartLocation"
                            },
                            "OPT_CENTER_MID": {
                                "type": "boolean",
                                "description": "OutputCenter/MidLocation"
                            },
                            "OPT_J": {
                                "type": "boolean",
                                "description": "OutputEndLocation"
                            },
                            "OPT_MAX_MIN_MAX_ALL": {
                                "type": "string",
                                "description": "OutputSectionLocation",
                                "enum": [
                                    "AbsMax",
                                    "Min/Max",
                                    "All"
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}


Examples

Beam Diagrams

{
    "Argument": {
        "CURRENT_MODE": "BeamDiagrams",
        "LOAD_CASE_COMB": {
            "TYPE": "st",
            "MINMAX": "max",
            "NAME": "dl",
            "STEP_INDEX": 1,
            "OPT_MAXMIN_DIAGRAM": true
        },
        "COMPONENTS": {
            "PART": "total",
            "COMP": "Fx",
            "OPT_SHOW_TRUSS_FORCES": true,
            "OPT_ONLY_TRUSS_FORCES": true
        },
        "DISPLAY_OPTIONS": {
            "FIDELITY": "Exact",
            "FILL": "Solid",
            "SCALE": 1.0
        },
        "TYPE_OF_DISPLAY": {
            "CONTOUR": {
                "OPT_CHECK": true
            },
            "DEFORM": {
                "OPT_CHECK": true
            },
            "VALUES": {
                "OPT_CHECK": true
            },
            "LEGEND": {
                "OPT_CHECK": false
            },
            "MIRRORED": {
                "OPT_CHECK": true
            },
            "UNDEFORMED": {
                "OPT_CHECK": true
            },
            "OPT_CUR_STEP_FORCE": false
        },
        "OUTPUT_SECT_LOCATION": {
            "OPT_I": true,
            "OPT_CENTER_MID": true,
            "OPE_J": true,
            "OPT_MAX_MINMAX_ALL": "absmax",
            "OPT_BY_MEMBER": true
        }
    }
}


Specifications

No. Description Key Value Type Default Required

1

Result Graphic Mode

 • "Beam Diagrams"

"CURRENT_MODE"

String

-

Required

2

Load Case and Combinations

"LOAD_CASE_COMB"

Object

-

Required

(1)

Load Case

 • Static Load: "ST"

 • Construction Stage: "CS"

 • Response Spectrum: "RS"

 • Time History: "TH"

 • Moving Load: "MV"

 • Settlement: "SM"

 • Load Combinations: "CB"

"TYPE"

String

-

Required

(2)

Load Type

 • Envelop Max: "Max"

 • Envelop Min: "Min"

 • Envelop Abs Max: "All"

"MINMAX"

String

"Max"

Optional

(3)

Load Name

"NAME"

String

 -

Required

(4)

Step of Load Case

"STEP_INDEX"

Integer

 -

Required

(5)

Display Absolute Maximum Values of Envelope

"OPT_MAXMIN_DIAGRAM"

Boolean

true

Optional

3

Components

"COMPONENTS"

Object

-

Optional

(1)

Parts Name defined in the Composite Section for Construction Stage

"PART"

String

"Total"

Optional

(2)

Components Name

 • "Fx", "Mx"

 • "Fy", "Fz", "Fyz"

 • "My, "Mz", "Myz"

 • "Mb", "Mt, "Mw"

"COMP"

String

"Fx"

Optional

(3)

Show Truss Forces

"OPT_SHOW_TRUSS_FORCES"

Boolean

false

Optional

(4)

Only Truss Forces

"OPT_ONLY_TRUSS_FORCES"

Boolean

false 

Optional

4

Display Options

"DISPLAY_OPTIONS"

Object

-

Required

(1)

Fidelity of Diagram

 • "Exact"

 • "5 Points"

"FIDELITY"

String

"5 Points"

Optional

(2)

Fill of Diagram

 • No Fill: "No"

 • Line Fill: "Line"

 • Solid Fill: "Solid"

"FILL"

String

"Solid Fill" 

Optional

(3)

Scale of Diagram

"SCALE"

Number

1

Optional

5

Type of Display ¹⁾

"TYPE_OF_DISPLAY"

Object

-

Optional

(1)

Contour Details

"CONTOUR"

Object

-

Optional

(2)

Deformation Details

"DEFORM"

Object

-

Optional

(3)

Values Output Details

"VALUES"

Object

-

Optional

(4)

Legend Details

"LEGEND"

Object

-

Optional

(5)

Display Undeformed Shape

"UNDEFORMED"

Boolean

false

Optional

(6)

Symmetric Model Mirror Detail

"MIRRORED"

Object

-

Optional

(7)

Current Step Force

"OPT_CUR_STEP_FORCE"

Boolean

false

Optional

(8)

Yield Point

"YIELD_POINT"

Boolean

false

Optional

6

Output Section Location

 • When "VALUES" is True

"OUTPUT_SECT_LOCATION"

Object

-

Optional

(1)

By Member

"OPT_BY_MEMBER"

Boolean

false

Optional

Output by Element Locations

(2)

Output Start Location

"OPT_I"

Boolean

false

Optional

(3)

Output Center/Mid Location

"OPT_CENTER_MID"

Boolean

false

Optional

(4)

Output End Location

"OPT_J"

Boolean

false

Optional

Output by Element Values

(2)

Output Section Location

 • "Abs Max"

 • "Min/Max"

 • "All"

"OPT_MAX_MINMAX_ALL"

String

-

Optional



¹⁾ For more details, refer to the Type of Display ↗

0
Was this article helpful?