入力 URI
{base url} + DESIGN/STEEL/AIJ-ASD02/CODE-REPORT |
|---|
メソッド
POST |
|---|
JSON スキーマ
リクエストボディのスキーマです。オブジェクト項目の構造は ELEM_SELECTION／DETAIL_POSITIONS として併記します。レスポンスは入れ子のないオブジェクトで返されます。
詳細
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "DESIGN/STEEL/AIJ-ASD02/CODE-REPORT",
"type": "object",
"properties": {
"Argument": {
"type": "object",
"properties": {
"REPORT_TYPE": { "description": "MEMB | PROP", "type": "string" },
"EXPORT_PATH": { "description": "Export Path", "type": "string" },
"OUTPUT_NAME": { "description": "Output File Name", "type": "string" },
"CURRENT_MODE": { "description": "Graphic | Detail | Summary | PMCurve", "type": "string" },
"CURRENT_MODE_MEMB": { "description": "Report Mode (MEMB)", "type": "string" },
"CURRENT_MODE_PROP": { "description": "Report Mode (PROP)", "type": "string" },
"ELEMS": { "$ref": "#/ELEM_SELECTION" },
"SECTIONS": { "type": "array", "items": { "type": "integer" } },
"DETAIL_POSITIONS": { "$ref": "#/DETAIL_POSITIONS" }
},
"required": ["REPORT_TYPE", "EXPORT_PATH", "OUTPUT_NAME"]
}
}
}
"ELEM_SELECTION": {
"type": "object",
"properties": {
"KEYS": { "type": "array", "items": { "type": "integer" } },
"TO": { "description": "Element range (e.g. 1-10)", "type": "string" },
"STRUCTURE_GROUP_NAME": { "type": "string" }
}
}
"DETAIL_POSITIONS": {
"type": "object",
"properties": {
"END_I": { "description": "Include End I position", "type": "boolean" },
"MID": { "description": "Include Mid position", "type": "boolean" },
"END_J": { "description": "Include End J position", "type": "boolean" }
}
}
例
リクエスト（部材ごと・詳細）
"Argument": {
"REPORT_TYPE": "MEMB",
"EXPORT_PATH": "C:\\MIDAS\\Report\\",
"OUTPUT_NAME": "SteelCodeCheck",
"CURRENT_MODE_MEMB": "Detail",
"ELEMS": { "TO": "1-20" }
}
}
リクエスト（断面ごと・要約）
"Argument": {
"REPORT_TYPE": "PROP",
"EXPORT_PATH": "C:\\MIDAS\\Report\\",
"OUTPUT_NAME": "SteelCodeCheck_Prop",
"CURRENT_MODE_PROP": "Summary",
"SECTIONS": [1, 2, 3]
}
}
レスポンス（成功）
"SUCCESS": true,
"FILE_PATH": "C:\\MIDAS\\Report\\SteelCodeCheck.pdf",
"MESSAGE": ""
}
レスポンス（失敗）
"SUCCESS": false,
"FILE_PATH": "",
"MESSAGE": "No design result."
}
仕様
| No. | 説明 | Key | データ型 | Default | 必須 |
|---|---|---|---|---|---|
|
1 |
レポートの出力単位。 「MEMB」：部材ごと、「PROP」：断面ごと。 |
"REPORT_TYPE" |
String |
- |
必須 |
|
2 |
レポートの出力先フォルダのパス。 例：C:\MIDAS\Report\ |
"EXPORT_PATH" |
String |
- |
必須 |
|
3 |
出力するファイルの名称。 |
"OUTPUT_NAME" |
String |
- |
必須 |
|
4 |
レポートの表示形式。 「Graphic」（図表）「Detail」（詳細）「Summary」（要約）「PMCurve」（PM 曲線）。 REPORT_TYPE 別の指定（CURRENT_MODE_MEMB／CURRENT_MODE_PROP）が無い場合に使用される。 |
"CURRENT_MODE" |
String |
- |
ｵﾌﾟｼｮﾝ |
|
5 |
REPORT_TYPE が「MEMB」のときのレポート表示形式。 |
"CURRENT_MODE_MEMB" |
String |
- |
ｵﾌﾟｼｮﾝ |
|
6 |
REPORT_TYPE が「PROP」のときのレポート表示形式。 |
"CURRENT_MODE_PROP" |
String |
- |
ｵﾌﾟｼｮﾝ |
|
7 |
対象とする要素の指定。REPORT_TYPE が「MEMB」のときに使用する。 省略した場合は全要素が対象となる。 |
"ELEMS" |
Object |
- |
ｵﾌﾟｼｮﾝ |
|
8 |
対象とする断面番号のリスト。REPORT_TYPE が「PROP」のときに使用する。 省略した場合は全断面が対象となる。 |
"SECTIONS" |
Array (Integer) |
- |
ｵﾌﾟｼｮﾝ |
|
9 |
詳細レポートに出力する部材位置の指定。 RC 梁設計の MEMB モードで使用する。 |
"DETAIL_POSITIONS" |
Object |
- |
ｵﾌﾟｼｮﾝ |
|
10 |
【要素の指定】要素番号のリスト。 |
"KEYS" |
Array (Integer) |
- |
ｵﾌﾟｼｮﾝ |
|
11 |
【要素の指定】要素番号の範囲。例：1-10 |
"TO" |
String |
- |
ｵﾌﾟｼｮﾝ |
|
12 |
【要素の指定】構造グループ名。 |
"STRUCTURE_GROUP_NAME" |
String |
- |
ｵﾌﾟｼｮﾝ |
|
13 |
【出力位置】I 端を出力に含めるか。 |
"END_I" |
Boolean |
true |
ｵﾌﾟｼｮﾝ |
|
14 |
【出力位置】中央部を出力に含めるか。 |
"MID" |
Boolean |
false |
ｵﾌﾟｼｮﾝ |
|
15 |
【出力位置】J 端を出力に含めるか。 |
"END_J" |
Boolean |
false |
ｵﾌﾟｼｮﾝ |
|
16 |
【レスポンス】レポートの生成に成功したか。 |
"SUCCESS" |
Boolean |
- |
必須 |
|
17 |
【レスポンス】生成されたファイルのフルパス。 生成に失敗した場合は空文字列となる。 |
"FILE_PATH" |
String |
- |
必須 |
|
18 |
【レスポンス】エラーまたは情報メッセージ。 |
"MESSAGE" |
String |
"" |
ｵﾌﾟｼｮﾝ |