入力 URI
{base url} + DESIGN/STEEL/AIJ-ASD02/DREULT |
|---|
メソッド
POST |
|---|
JSON スキーマ
リクエストボディのスキーマです。オブジェクト項目の構造は RGB_BODY/ANGLE/ACTIVE として併記します。SET_MODE は本 API が自動的に「POST」を設定するため、指定しても無視されます。
詳細
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "DESIGN/STEEL/AIJ-ASD02/DREULT",
"type": "object",
"properties": {
"Argument": {
"type": "object",
"properties": {
"EXPORT_PATH": { "description": "Output Path", "type": "string" },
"FIGURE_NAME": { "description": "Figure Name", "type": "string" },
"URL_NAME": { "description": "Url Name", "type": "string" },
"STAGE_NAME": { "description": "Stage Name in view", "type": "string" },
"PERSPECTIVE": { "description": "Perspective", "type": "boolean" },
"SET_HIDDEN": { "description": "Set Hidden Option", "type": "boolean" },
"BGCOLOR_TOP": { "$ref": "#/RGB_BODY" },
"BGCOLOR_BOTTOM": { "$ref": "#/RGB_BODY" },
"WIDTH": { "description": "Export Figure Width Size", "type": "integer" },
"HEIGHT": { "description": "Export Figure Height Size", "type": "integer" },
"ZOOM_LEVEL": { "description": "Zoom Level", "type": "number" },
"ACTIVE": { "$ref": "#/ACTIVE" },
"ANGLE": { "$ref": "#/ANGLE" },
"DISPLAY": { "description": "Display Option", "type": "object" },
"RESULT_GRAPHIC": { "description": "Result Graphic Option", "type": "object" }
}
}
}
}
"RGB_BODY": {
"type": "object",
"properties": {
"R": { "description": "Red", "type": "integer" },
"G": { "description": "Green", "type": "integer" },
"B": { "description": "Blue", "type": "integer" }
}
}
"ANGLE": {
"type": "object",
"properties": {
"HORIZONTAL": { "description": "Horizontal", "type": "number" },
"VERTICAL": { "description": "Vertical", "type": "number" }
}
}
"ACTIVE": {
"type": "object",
"properties": {
"ACTIVE_MODE": { "description": "All | Active | Identity", "type": "string" },
"N_LIST": { "type": "array", "items": { "type": "integer" } },
"E_LIST": { "type": "array", "items": { "type": "integer" } },
"IDENTITY_TYPE": { "type": "string" },
"IDENTITY_LIST": { "type": "array", "items": { "type": "string" } },
"STORY_ACTIVE": { "type": "string" }
},
"required": ["ACTIVE_MODE"]
}
例
リクエスト(最小構成)
"Argument": {
"EXPORT_PATH": "C:\\MIDAS\\Capture\\DesignResult.png",
"WIDTH": 1920,
"HEIGHT": 1080
}
}
リクエスト(表示条件を指定)
"Argument": {
"EXPORT_PATH": "C:\\MIDAS\\Capture\\DesignResult.png",
"WIDTH": 1920,
"HEIGHT": 1080,
"PERSPECTIVE": true,
"SET_HIDDEN": true,
"ZOOM_LEVEL": 100,
"ANGLE": { "HORIZONTAL": 30.0, "VERTICAL": 15.0 },
"BGCOLOR_TOP": { "R": 255, "G": 255, "B": 255 },
"BGCOLOR_BOTTOM": { "R": 255, "G": 255, "B": 255 },
"ACTIVE": {
"ACTIVE_MODE": "Active",
"E_LIST": [1, 2, 3, 4, 5]
},
"RESULT_GRAPHIC": { ... }
}
}
レスポンス
"message": "Civil command complete",
"base64String": "iVBORw0KGgoAAAANSUhEUgAA..."
}
仕様
| No. | 説明 | Key | データ型 | Default | 必須 |
|---|---|---|---|---|---|
|
1 |
画像の出力先パス。 省略した場合はファイル出力を行わず、レスポンスの base64String のみを返す。 |
"EXPORT_PATH" |
String |
- |
オプション |
|
2 |
図の名称(スマートレポートの画像名)。 |
"FIGURE_NAME" |
String |
- |
オプション |
|
3 |
URL の名称。 |
"URL_NAME" |
String |
- |
オプション |
|
4 |
ビューに表示する施工段階の名称。 |
"STAGE_NAME" |
String |
- |
オプション |
|
5 |
透視投影で表示するか。 |
"PERSPECTIVE" |
Boolean |
false |
オプション |
|
6 |
隠線処理を行うか。 |
"SET_HIDDEN" |
Boolean |
false |
オプション |
|
7 |
背景色(上部)。 |
"BGCOLOR_TOP" |
Object |
- |
オプション |
|
8 |
背景色(下部)。 |
"BGCOLOR_BOTTOM" |
Object |
- |
オプション |
|
9 |
出力する画像の幅(ピクセル)。 |
"WIDTH" |
Integer |
- |
オプション |
|
10 |
出力する画像の高さ(ピクセル)。 |
"HEIGHT" |
Integer |
- |
オプション |
|
11 |
ズーム率(%)。 |
"ZOOM_LEVEL" |
Number |
100 |
オプション |
|
12 |
アクティブ表示の設定。 |
"ACTIVE" |
Object |
- |
オプション |
|
13 |
視点角度の設定。 |
"ANGLE" |
Object |
- |
オプション |
|
14 |
表示オプションの設定。 項目が多いため、詳細は「表示オプション」(VIEW/DISPLAY)を参照。 |
"DISPLAY" |
Object |
- |
オプション |
|
15 |
結果グラフィックの設定。等値線・変形図・凡例などを指定する。 項目が多いため、詳細は「結果グラフィック」(VIEW/RESULT-GRAPHIC)を参照。 |
"RESULT_GRAPHIC" |
Object |
- |
オプション |
|
16 |
【背景色】赤成分(0〜255)。 |
"R" |
Integer |
0 |
オプション |
|
17 |
【背景色】緑成分(0〜255)。 |
"G" |
Integer |
0 |
オプション |
|
18 |
【背景色】青成分(0〜255)。 |
"B" |
Integer |
0 |
オプション |
|
19 |
【視点角度】水平方向の回転角。 |
"HORIZONTAL" |
Number |
0 |
オプション |
|
20 |
【視点角度】鉛直方向の回転角。 |
"VERTICAL" |
Number |
0 |
オプション |
|
21 |
【アクティブ表示】アクティブの指定方法。 「All」(全体)「Active」(節点・要素リスト)「Identity」(属性で指定)。 |
"ACTIVE_MODE" |
String |
- |
必須 |
|
22 |
【アクティブ表示】表示する節点番号のリスト。ACTIVE_MODE が「Active」のときに使用する。 |
"N_LIST" |
Array (Integer) |
- |
オプション |
|
23 |
【アクティブ表示】表示する要素番号のリスト。ACTIVE_MODE が「Active」のときに使用する。 |
"E_LIST" |
Array (Integer) |
- |
オプション |
|
24 |
【アクティブ表示】属性の種別。ACTIVE_MODE が「Identity」のときに使用する。 |
"IDENTITY_TYPE" |
String |
- |
オプション |
|
25 |
【アクティブ表示】属性の対象リスト。ACTIVE_MODE が「Identity」のときに使用する。 |
"IDENTITY_LIST" |
Array (String) |
- |
オプション |
|
26 |
【アクティブ表示】階のアクティブ表示のオプション。 |
"STORY_ACTIVE" |
String |
- |
オプション |
|
27 |
【レスポンス】処理結果メッセージ。 |
"message" |
String |
- |
必須 |
|
28 |
【レスポンス】キャプチャした画像の Base64 文字列。 |
"base64String" |
String |
- |
必須 |