入力 URI
{base url} + DESIGN/STEEL/AIJ-ASD02/CODE-ANAL |
|---|
メソッド
POST |
|---|
JSON スキーマ
リクエストボディのスキーマです。要素の指定の構造は ELEM_SELECTION として併記します。リクエストボディは省略できます。
詳細
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "DESIGN/STEEL/AIJ-ASD02/CODE-ANAL",
"type": "object",
"properties": {
"Argument": {
"type": "object",
"properties": {
"PERFORM_TYPE": {
"description": "ALL | ELEMS | SECTIONS",
"type": "string"
},
"ELEMS": {
"description": "Element No. Object (When PERFORM_TYPE = ELEMS)",
"$ref": "#/ELEM_SELECTION"
},
"SECTIONS": {
"description": "Section No. (When PERFORM_TYPE = SECTIONS)",
"type": "array",
"items": { "type": "integer" }
}
}
}
}
}
"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" }
}
}
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "DESIGN/STEEL/AIJ-ASD02/CODE-ANAL",
"type": "object",
"properties": {
"Argument": {
"type": "object",
"properties": {
"PERFORM_TYPE": {
"description": "ALL | ELEMS | SECTIONS",
"type": "string"
},
"ELEMS": {
"description": "Element No. Object (When PERFORM_TYPE = ELEMS)",
"$ref": "#/ELEM_SELECTION"
},
"SECTIONS": {
"description": "Section No. (When PERFORM_TYPE = SECTIONS)",
"type": "array",
"items": { "type": "integer" }
}
}
}
}
}
"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" }
}
}
例
リクエスト(全要素)
{
"Argument": {
"PERFORM_TYPE": "ALL"
}
}
"Argument": {
"PERFORM_TYPE": "ALL"
}
}
リクエスト(要素番号で指定)
{
"Argument": {
"PERFORM_TYPE": "ELEMS",
"ELEMS": { "TO": "1-20" }
}
}
"Argument": {
"PERFORM_TYPE": "ELEMS",
"ELEMS": { "TO": "1-20" }
}
}
リクエスト(断面番号で指定)
{
"Argument": {
"PERFORM_TYPE": "SECTIONS",
"SECTIONS": [1, 2, 3]
}
}
"Argument": {
"PERFORM_TYPE": "SECTIONS",
"SECTIONS": [1, 2, 3]
}
}
レスポンス
{
"message": "Civil command complete"
}
"message": "Civil command complete"
}
仕様
| No. | 説明 | Key | データ型 | Default | 必須 |
|---|---|---|---|---|---|
|
1 |
照査の対象範囲。 「ALL」:全要素、「ELEMS」:要素番号で指定、「SECTIONS」:断面番号で指定。 リクエストボディを省略して呼び出した場合は「ALL」として扱われる。 |
"PERFORM_TYPE" |
String |
ALL |
オプション |
|
2 |
対象とする要素の指定。PERFORM_TYPE が「ELEMS」のときに使用する。 |
"ELEMS" |
Object |
- |
オプション |
|
3 |
対象とする断面番号のリスト。PERFORM_TYPE が「SECTIONS」のときに使用する。 |
"SECTIONS" |
Array (Integer) |
- |
オプション |
|
4 |
【要素の指定】要素番号のリスト。 |
"KEYS" |
Array (Integer) |
- |
オプション |
|
5 |
【要素の指定】要素番号の範囲。例:1-10 |
"TO" |
String |
- |
オプション |
|
6 |
【要素の指定】構造グループ名。 |
"STRUCTURE_GROUP_NAME" |
String |
- |
オプション |
|
7 |
【レスポンス】処理結果メッセージ。製品名 + " command complete"。 |
"message" |
String |
- |
必須 |