INTRODUCTION
This page provides the MIDAS API JSON Structure manual relative to MIDAS NX series, including CIVIL NX and GEN NX. MIDAS API works based on the RESTFul API, and the manual offers each function's endpoint, method, JSON structure, and examples.
The manual has five sections of End Point, each with its characteristics. The user can find more details on each section.
DOC
This section of End Point works on the Document part. Only working with the POST Method, and The body starts with the "Argument" Key. In the case of the body being empty under the "Argument," the API is designed to work with the empty body such as "{}".
| No. | End Point | Details |
|---|---|---|
1 |
/doc/NEW |
|
2 |
/doc/OPEN |
|
3 |
/doc/CLOSE |
|
4 |
/doc/SAVE |
|
5 |
/doc/SAVEAS |
|
6 |
/doc/STAGAS |
|
7 |
/doc/IMPORT |
|
8 |
/doc/IMPORTMXT |
|
9 |
/doc/EXPORT |
|
10 |
/doc/EXPORTMXT |
|
11 |
/doc/ANAL |
DB
The DB End Point is data saved in a MIDAS NX series file. It is comparable to the MCT/MGT function.
Generally, it consists of the POST/GET/PUT/DELETE Method; however, some essential data when the user creates a new file, such as Unit, Structure Type, etc., only work GET/PUT Method.
When using the GET Method, the first Key indicates the endpoint, and it must start with "Assign" for the first Key using the POST/PUT method.
After that, the JSON body begins with the number Key, which has different meanings depending on the data. For example, the number Key indicates the Section ID Number in the Section, and in the Load Combinations, it indicates created sequences. The unique data, such as Unit, has only "1" data.
After the number Key, the user can check the JSON body structure under the table.
Project
| No. | End Point | Details |
|---|---|---|
1 |
/db/PJCF |
|
2 |
/db/UNIT |
|
3 |
/db/STYP |
|
4 |
/db/STYP-M1ᴴˢ⁾ |
|
5 |
/db/GRUP |
|
6 |
/db/BNGR |
|
7 |
/db/LDGR |
|
8 |
/db/TDGR |
ᴴˢ⁾Hyper-S solver only
View
| No. | End Point | Details |
|---|---|---|
1 |
/db/NPLN |
|
2 |
/db/CO_M |
|
3 |
/db/CO_S |
|
4 |
/db/CO_T |
|
5 |
/db/CO_F |
Structure
| No. | End Point | Details |
|---|---|---|
1 |
/db/SPAN |
|
2 |
/db/STOR |
Node/Element
| No. | End Point | Details |
|---|---|---|
1 |
/db/NODE |
|
2 |
/db/ELEM |
|
3 |
/db/SKEW |
|
4 |
/db/MADO |
|
5 |
/db/SBDO |
|
6 |
/db/DOEL |
Properties
| No. | End Point | Details |
|---|---|---|
1 |
/db/MATL |
|
2 |
/db/MATL-M1ᴴˢ⁾ |
|
3 |
/db/IMFM |
|
4 |
/db/IMFM-M1ᴴˢ⁾ |
|
5 |
/db/TDMF |
|
6 |
/db/TDMT |
|
7 |
/db/TDME |
|
8 |
/db/EDMP |
|
9 |
/db/TMAT |
|
10 |
/db/EPMT |
|
11 |
/db/EPMT-M1ᴴˢ⁾ |
|
12 |
/db/SECT |
Section Properties - DB/User ↗ Section Properties - Combined ↗ Section Properties - PSC Value ↗ Section Properties - Composite - PSC ↗ Section Properties - Composite - Steel ↗ Section Properties - Steel Girder ↗ Section Properties - Tapered - DB/User ↗ Section Properties - Tapered - Value ↗ Section Properties - Tapered - PSC ↗ Section Properties - Tapered - PSC Value ↗ Section Properties - Tapered - Composite PSC ↗ |
13 |
/db/THIK |
|
14 |
/db/TSGR |
|
15 |
/db/SECF |
|
16 |
/db/RPSC |
|
17 |
/db/STRPSSM |
|
18 |
/db/PSSF |
|
19 |
/db/VBEM |
Section Manager - Section for Resultant Forces - Virtual Beam ↗ |
20 |
/db/VSEC |
Section Manager - Section for Resultant Forces - Virtual Section ↗ |
21 |
/db/EWSF |
|
22 |
/db/IEHC |
|
23 |
/db/IEHG |
|
24 |
/db/IEHG-BEAM-M1ᴴˢ⁾ |
|
25 |
/db/IEHG-TRUSS-M1ᴴˢ⁾ |
|
26 |
/db/IEHG-GL-M1ᴴˢ⁾ |
|
27 |
/db/IEHG-PSS-M1ᴴˢ⁾ |
|
28 |
/db/FIMP |
|
29 |
/db/FIBR |
|
30 |
/db/GRDP |
|
31 |
/db/ESSF |
ᴴˢ⁾Hyper-S solver only
Boundary
| No. | End Point | Details |
|---|---|---|
1 |
/db/CONS |
|
2 |
/db/NSPR |
|
3 |
/db/GSTP |
|
4 |
/db/GSPR |
|
5 |
/db/SSPS |
|
6 |
/db/ELNK |
|
7 |
/db/RIGD |
|
8 |
/db/NLLP |
|
9 |
/db/NLNK |
|
10 |
/db/NLNK-M1ᴴˢ⁾ |
|
11 |
/db/CGLP |
|
12 |
/db/FRLS |
|
13 |
/db/OFFS |
|
14 |
/db/PRLS |
|
15 |
/db/MLFC |
|
16 |
/db/SDVI |
|
17 |
/db/SDVE |
|
18 |
/db/SDST |
|
19 |
/db/SDHY |
|
20 |
/db/SDIS |
|
21 |
/db/MCON |
|
22 |
/db/PZEF |
|
23 |
/db/CLDR |
|
24 |
/db/DRLS |
ᴴˢ⁾Hyper-S solver only
Static Loads
| No. | End Point | Details |
|---|---|---|
1 |
/db/STLD |
|
2 |
/db/BODF |
|
3 |
/db/CNLD |
|
4 |
/db/BMLD |
|
5 |
/db/SDSP |
|
6 |
/db/NMAS |
|
7 |
/db/LTOM |
|
8 |
/db/NBOF |
|
9 |
/db/PSLT |
|
10 |
/db/PRES |
|
11 |
/db/PNLD |
|
12 |
/db/PNLA |
|
13 |
/db/FBLD |
|
14 |
/db/FBLA |
|
15 |
/db/FMLD |
|
16 |
/db/POSP |
|
17 |
/db/EPST |
|
18 |
/db/EPSE |
|
19 |
/db/POSL |
Temperature Loads
| No. | End Point | Details |
|---|---|---|
1 |
/db/ETMP |
|
2 |
/db/GTMP |
|
3 |
/db/BTMP |
|
4 |
/db/STMP |
|
5 |
/db/NTMP |
Prestress Loads
| No. | End Point | Details |
|---|---|---|
1 |
/db/TDNT |
|
2 |
/db/TDNA |
|
3 |
/db/TDCS |
|
4 |
/db/TDPL |
|
5 |
/db/PRST |
|
6 |
/db/PTNS |
|
7 |
/db/EXLD |
Moving Loads
| No. | End Point | Details |
|---|---|---|
1 |
/db/MVCD |
|
2 |
/db/LLAN |
|
3 |
/db/LLANch |
|
4 |
/db/LLANid |
|
5 |
/db/LLANtr |
|
6 |
/db/LLANop |
|
7 |
/db/SLAN |
|
8 |
/db/SLANch |
|
9 |
/db/SLANop |
|
10 |
/db/MVHL |
|
11 |
/db/MVHLtr |
|
12 |
/db/MVLD |
|
13 |
/db/MVLDch |
|
14 |
/db/MVLDid |
|
15 |
/db/MVLDbs |
|
16 |
/db/MVLDeu |
|
17 |
/db/MVLDpl |
|
18 |
/db/MVLDtr |
|
19 |
/db/CRGR |
|
20 |
/db/CJFG |
|
21 |
/db/MVHC |
|
22 |
/db/SINF |
|
23 |
/db/MLSP |
|
24 |
/db/MLSR |
|
25 |
/db/DYLA |
|
26 |
/db/IMPF |
|
27 |
/db/DYFG |
|
28 |
/db/DYNF |
Dynamic Loads
| No. | End Point | Details |
|---|---|---|
1 |
/db/SPFC |
Response Spectrum Functions - User Type ↗ Response Spectrum Functions - Korea ↗ Response Spectrum Functions - US ↗ Response Spectrum Functions - Eurocode ↗ Response Spectrum Functions - China ↗ Response Spectrum Functions - Japan ↗ Response Spectrum Functions - India ↗ |
2 |
/db/SPLC |
|
3 |
/db/THGC |
|
4 |
/db/THGC-M1ᴴˢ⁾ |
|
5 |
/db/THOO-M1ᴴˢ⁾ |
|
6 |
/db/THIS |
|
7 |
/db/THIS-M1ᴴˢ⁾ |
|
8 |
/db/THFC |
|
9 |
/db/THGA |
|
10 |
/db/THNL |
|
11 |
/db/THSL |
|
12 |
/db/THMS |
ᴴˢ⁾Hyper-S solver only
Construction Stage Loads
| No. | End Point | Details |
|---|---|---|
1 |
/db/STAG |
|
2 |
/db/CSCS |
|
3 |
/db/TMLD |
|
4 |
/db/STBK |
|
5 |
/db/CMCS |
|
6 |
/db/CRPC |
Heat of Hydration Loads
| No. | End Point | Details |
|---|---|---|
1 |
/db/ETFC |
|
2 |
/db/CCFC |
|
3 |
/db/HECB |
|
4 |
/db/HSPT |
|
5 |
/db/HSFC |
|
6 |
/db/HAHS |
|
7 |
/db/HPCE |
|
8 |
/db/HSTG |
Settlement Loads
| No. | End Point | Details |
|---|---|---|
1 |
/db/SMPT |
|
2 |
/db/SMLC |
Miscellaneous Loads
| No. | End Point | Details |
|---|---|---|
1 |
/db/PLCB |
|
2 |
/db/LDSQ |
|
3 |
/db/WVLD |
|
4 |
/db/IELC |
|
5 |
/db/IFGS |
Large Displacement - Initial Forces for Geometric Stiffness ↗ |
6 |
/db/EFCT |
|
7 |
/db/INMF |
Grid Model Analysis Loads
Analysis
| No. | End Point | Details |
|---|---|---|
1 |
/db/ACTL |
|
2 |
/db/ACTL-M1ᴴˢ⁾ |
|
3 |
/db/PDEL |
|
4 |
/db/BUCK |
|
5 |
/db/EIGV |
|
6 |
/db/EIGV-M1ᴴˢ⁾ |
|
7 |
/db/HHCT |
|
8 |
db/HHCT-M1ᴴˢ⁾ |
|
9 |
/db/MVCT |
|
10 |
/db/MVCTch |
|
11 |
/db/MVCTid |
|
12 |
/db/MVCTbs |
|
13 |
/db/MVCTtr |
|
14 |
/db/SMCT |
|
15 |
/db/NLCT |
|
16 |
/db/NLCT-M1ᴴˢ⁾ |
|
17 |
/db/STCT |
|
18 |
/db/STCT-M1ᴴˢ⁾ |
|
19 |
/db/BCCT |
|
20 |
/db/BCGD-M1ᴴˢ⁾ |
|
21 |
/db/BCGA-M1ᴴˢ⁾ |
ᴴˢ⁾Hyper-S solver only
Analysis Results
| No. | End Point | Details |
|---|---|---|
1 |
/db/LCOM-GEN |
|
2 |
/db/LCOM-CONC |
|
3 |
/db/LCOM-STEEL |
|
4 |
/db/LCOM-SRC |
|
5 |
/db/LCOM-STLCOMP |
|
6 |
/db/LCOM-SEISMIC |
|
7 |
/db/CUTL |
|
8 |
/db/CLWP |
Bridge Specialization Results
| No. | End Point | Details |
|---|---|---|
1 |
/db/GSBG |
|
2 |
/db/GCMB |
|
3 |
/db/CAMB |
|
4 |
/db/ULFC |
Time History Analysis Results
| No. | End Point | Details |
|---|---|---|
1 |
/db/THRE |
|
2 |
/db/THRG |
|
3 |
/db/THRI |
|
4 |
/db/THRS |
Heat of Hydration Results
| No. | End Point | Details |
|---|---|---|
1 |
/db/HHND |
Pushover
| No. | End Point | Details |
|---|---|---|
1 |
/db/POGD |
|
2 |
/db/POGD-M1ᴴˢ⁾ |
|
3 |
/db/IEPI |
|
4 |
/db/PHGE |
|
5 |
/db/POLC |
|
6 |
/db/POLC-M1ᴴˢ⁾ |
ᴴˢ⁾Hyper-S solver only
Design
| No. | End Point | Details |
|---|---|---|
1 |
/db/DCON |
|
2 |
/db/MATD |
|
3 |
/db/RCHK |
|
4 |
/db/LENG |
|
5 |
/db/MEMB |
|
6 |
/db/DCTL |
|
7 |
/db/LTSR |
|
8 |
/db/ULCT |
|
9 |
/db/MBTP |
|
10 |
/db/WMAK |
|
11 |
/db/DSTL |
OPE
OPE indicates operation functions. It contains application functions that can be controlled using a GUI or checked for pre-process values that do not save in the database(DB).
| No. | End Point | Details |
|---|---|---|
1 |
/ope/PROJECTSTATUS |
|
2 |
/ope/DIVIDEELEM |
|
3 |
/ope/SECTPROP |
|
4 |
/ope/USLC |
|
5 |
/ope/LINEBMLD |
|
6 |
/ope/AUTOMESH |
|
7 |
/ope/SSPS |
|
8 |
/ope/EDMP |
|
9 |
/ope/STOR |
|
10 |
/ope/STORY_PARAM |
|
11 |
/ope/STORY_IRR_PARAM |
|
12 |
/ope/STORPROP |
|
13 |
/ope/MEMB |
VIEW
It works in a Model view. Each function can be used independently, however, Capture function can be use d Angle, Active, Display, and Resultgraphic together.
POST
The POST is used to extract the pre/post-processing table generated by calculations. For fully understanding of the usage of POST/TABLE API, please visit here and read carefully: Designing with Intent: The Vision Behind POST/TABLE
Pre-Process Table
| No. | Table Type | Details |
|---|---|---|
1 |
Element Weight | |
2 |
Nodal Body Force | |
3 |
Mass Summary | |
4 |
Load Summary | |
5 |
Material | |
6 |
Section | |
7 |
Restraint Supports | |
8 |
Story Mass Summary | |
9 |
Story Load Summary | |
10 |
Story Weight |
Analysis Result Table
| No. | Table Type | Details |
|---|---|---|
1 |
Reaction-Local Reaction-Global Reaction-Local-Surface Spring |
|
2 |
Displacement-Local Displacement-Global |
|
3 |
Truss Force | |
| Truss Stress | ||
4 |
Cable Force | |
| Cable Configuration | ||
| Cable Efficiency | ||
5 |
Beam Force Beam Force-View by Max Value Item |
|
| Beam Static Prestress | ||
|
Beam Stress Beam Stress-View by Max Value Item Beam Stress-7DOF |
||
| Beam Stress-Equivalent | ||
|
Beam Stress-PSC Beam Stress-PSC 7DOF |
||
6 |
Plate Force-Local | |
| Plate Force-Global | ||
|
Plate Force-Unit Length(Local) Plate Force-Unit Length(Local-View by Max Value Items) Plate Force-Unit Length(UCS) Plate Force-Unit Length(UCS-View by Max Value Items) Plate Force-Unit Length(W-A Moment) |
||
| Plate Stress-Local | ||
| Plate Stress-Global | ||
|
Plate Total Strain-Local Plate Plastic Strain-Local |
||
|
Plate Total Strain-Global Plate Plastic Strain-Global |
||
7 |
Plane Stress Force-Local | |
| Plane Stress Force-Global | ||
| Plane Stress Stress-Local | ||
| Plane Stress Stress-Global | ||
8 |
Plane Strain Force-Local | |
| Plane Strain Force-Global | ||
| Plane Strain Stress-Local | ||
| Plane Strain Stress-Global | ||
9 |
Axisymmetric Force-Local | |
| Axisymmetric Force-Global | ||
| Axisymmetric Stress-Local | ||
| Axisymmetric Stress-Global | ||
10 |
Solid Force-Local | |
| Solid Force-Global | ||
| Solid Stress-Local | ||
| Solid Stress-Global | ||
|
Solid Total Strain-Local Solid Plastic Strain-Local |
||
|
Solid Total Strain-Global Solid Plastic Strain-Global |
||
11 |
Elastic Link View by Max Value Item |
|
12 |
General Link Force General Link Force-View by Max Value Item General Link Deformation |
|
13 |
Resultant Force Resultant Force-View by Max Value Item |
|
14 |
Vibartion Mode-Eigenvalue Vibartion Mode-Participation Vector |
|
15 |
Buckling Mode | |
16 |
Effective Span Length-Truss Effective Span Length-Beam Effective Span Length-Plate |
|
17 |
Nodal Results of RS-Inertia Force Nodal Results of RS-Acceleration |
|
18 |
Tendon Coordinates | |
| Tendon Elongation | ||
| Tendon Arrangement | ||
|
Tendon Loss-Stress Tendon Loss-Force |
||
|
Tendon Weight-Profile Tendon Weight-Property Tendon Weight-Group |
||
| Tendon Stress Limit Check | ||
|
Tendon Approximate Loss-Stress Tendon Approximate Loss-Force |
||
19 |
Composite Section for C.S. Force Composite Section for C.S. Stress |
Composite Section for C.S. (Force and Stress) - Analysis Result Table ↗ |
|
Composite Section for C.S. Self-Constraint Force Composite Section for C.S. Self-Constraint Stress |
Composite Section for C.S. (Self-Constraint Force and Stress) - Analysis Result Table ↗ |
|
20 |
Element Properties at Each Stage | |
| Beam Section Properties at Last Stage | Beam Section Properties at Last Stage - Analysis Result Table ↗ |
|
21 |
Lack of Fit Force-Truss | |
| Lack of Fit Force-Beam | ||
| Lack of Fit Force-Plate | ||
22 |
Equilibrium Element Nodal Force | |
23 |
Initial Element Force | |
24 |
Wall Force/Moment |
Analysis Story Table
| No. | Table Type | Details |
|---|---|---|
1 |
Story Drift (X,Y,Combined) | |
2 |
Story Displacement (X,Y,Combined) | |
3 |
Story Shear(R.S Analysis) - Story Shear(for R.S) Story Shear(R.S.Analysis) - Story Shear Force Coefficient |
Story Shear(R.S Analysis) - Analysis Story Table↗ |
4 |
Story Mode Shape | |
5 |
Story Shear Force Ratio | |
6 |
Story Eccentricity | |
7 |
Overturning Moment | |
8 |
Story Axial Force Sum | |
9 |
Story Stability Coefficient | |
10 |
Torsional Irregularity Check | |
11 |
Torsional Amplification Factor | |
12 |
Stiffness Irregularity Check (Soft Story) | Stiffness Irregularity Check (Soft Story) - Analysis Story Table↗ |
13 |
Capacity Irregularity Check(Weak Story) | Capacity Irregularity Check(Weak Story) - Analysis Story Table↗ |
14 |
Criteria for Regularity in Plan | |
15 |
Ultimate Story Shear For Check |
Time History Result Table
| No. | Table Type | Details |
|---|---|---|
1 |
Displacement Velocity Absolute Acceleration Relative Acceleration |
|
2 |
Beam Force | |
3 |
Truss Force | |
4 |
General Link Force Deformation |
|
5 |
Event Time-Lumped Event Time-Distributed Event Time-Wall Event Time-Truss Event Time-Spring |
|
6 |
Beam Summary-DX Beam Summary-DY Beam Summary-DZ Beam Summary-RY Beam Summary-RZ |
|
7 |
Truss Summary-DX | |
8 |
General Link Summary-DX General Link Summary-DY General Link Summary-DZ General Link Summary-RX General Link Summary-RY General Link Summary-RZ |
|
9 |
Force-Lumped Force-Distributed Force-Wall Force-Truss Force-Spring |
|
10 |
Deformation-Lumped Deformation-Distributed Deformation-Wall Deformation-Truss Deformation-Spring |
|
11 |
Element Rotation-Beam Element Rotation-Wall |
|
12 |
Ductility Factor(D/D1)-Lumped Ductility Factor(D/D1)-Distributed Ductility Factor(D/D1)-Wall Ductility Factor(D/D1)-Truss Ductility Factor(D/D1)-Spring |
|
13 |
Ductility Factor(D/D2)-Lumped Ductility Factor(D/D2)-Distributed Ductility Factor(D/D2)-Wall Ductility Factor(D/D2)-Truss Ductility Factor(D/D2)-Spring |
|
14 |
Estimate Yield Strength | |
15 |
Elastic Modulus Retention Rate ᴶ⁾ | Fiber Section Elastic Modulus Retention Rate - TH Result Table ↗ |
16 |
Maximum Strain of The Cell ᴶ⁾ | Fiber Section Maximum Strain of The Cell - TH Result Table ↗ |
17 |
Event Step ᴶ⁾ | |
18 |
Average Compression Strain ᴶ⁾ | Fiber Section Average Compression Strain - TH Result Table ↗ |
ᴶ⁾ MIDAS CIVIL NX JP Version only
Heat of Hydration Result Table
| No. | Table Type | Details |
|---|---|---|
1 |
Stress-Local Stress-Global |
|
2 |
Temperature | |
3 |
Displacement | |
4 |
Tensile Stress | |
5 |
Pipe Cooling Nodal Temperature |
Time History Text
| No. | Text Type | Details |
|---|---|---|
1 |
Node Results | |
2 |
Element Result(Truss, Beam, Plane Stress/Strain, Solid) | Time History Text - Element Result(Truss, Beam, Plane Stress/Strain, Solid) ↗ |
3 |
Element Result(Plate) | |
4 |
Element Result(Wall) | |
5 |
General Link Result |
Pushover Text
| No. | Text Type | Details |
|---|---|---|
1 |
Displacement Result | |
2 |
Element Result(Beam, Truss) | |
3 |
Element Result(Wall) | |
4 |
General Link Result | |
5 |
Elastic Link Result |
Design
| No. | End Point | Details |
|---|---|---|
1 |
/post/PM |
|
2 |
/post/STEELCODECHECK |
|
3 |
/post/BEAMDESIGNFORCES |
|
4 |
/post/COLUMNDESIGNFORCES |
|
5 |
/post/BRACEDESIGNFORCES |
|
6 |
/post/WALLDESIGNFORCES |
|
7 |
/post/STEELMEMBERDESIGNFORCES |
|
8 |
/post/SRCBEAMDESIGNFORCES |
|
9 |
/post/SRCCOLUMNDESIGNFORCES SRC |
|
10 |
/post/COLDFORMEDSTEELMEMBERDESIGNFORCES |
Cold Formed Design - Cold Formed Steel Member Design Forces ↗ |