Input URI
|
{base url} + DESIGN/RC/KDS-41-20-2022/WD-REPORT |
|---|
Active Methods
|
POST |
|---|
JSON Schema
Details
"type": "object",
"required": [
"Argument"
],
"additionalProperties": false,
"properties": {
"Argument": {
"type": "object",
"description": "Generate RC Wall report. If SELECTIONS is omitted or empty, all wall IDs and all stories are included.",
"required": [
"REPORT_TYPE",
"EXPORT_PATH",
"OUTPUT_NAME"
],
"additionalProperties": false,
"properties": {
"REPORT_TYPE": {
"type": "string",
"description": "Wall list identification type",
"enum": [
"WID+STORY",
"WID"
],
"default": "WID+STORY"
},
"CURRENT_MODE_WID_STORY": {
"type": "string",
"description": "Report output mode for WID+STORY (Detail supported)",
"oneOf": [
{
"title": "Graphic (JPG image)",
"const": "Graphic"
},
{
"title": "Detail (DOC document)",
"const": "Detail"
},
{
"title": "Summary (TXT text)",
"const": "Summary"
},
{
"title": "PM Curve (JPG image)",
"const": "PMCurve"
}
]
},
"CURRENT_MODE_WID": {
"type": "string",
"description": "Report output mode for WID (Detail not supported)",
"oneOf": [
{
"title": "Graphic (JPG image)",
"const": "Graphic"
},
{
"title": "Summary (TXT text)",
"const": "Summary"
},
{
"title": "PM Curve (JPG image)",
"const": "PMCurve"
}
]
},
"SELECTIONS": {
"type": "array",
"description": "List of wall and story selections to include in the report. If omitted or empty, all walls and all stories are included.",
"minItems": 0,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"WALL_IDS": {
"type": "object",
"description": "Wall IDs to include in the report. If omitted, all walls are included.",
"additionalProperties": false,
"properties": {
"KEYS": {
"type": "array",
"description": "Specify each Wall ID.",
"items": {
"type": "integer"
}
},
"TO": {
"type": "string",
"description": "Specify Wall ID Range, e.g. '1to20'."
}
},
"oneOf": [
{
"required": [
"KEYS"
],
"not": {
"required": [
"TO"
]
}
},
{
"required": [
"TO"
],
"not": {
"required": [
"KEYS"
]
}
}
]
},
"STORY": {
"type": "array",
"description": "List of story names to include in the report. If omitted, all stories are included.",
"items": {
"type": "string"
}
}
}
}
},
"EXPORT_PATH": {
"type": "string",
"description": "Directory path to save the report files"
},
"OUTPUT_NAME": {
"type": "string",
"description": "Output file base name. For multiple walls, files are prefixed with index and wall identifier, e.g. 001_W100_1F_filename.jpg, 002_W200_2F_filename.jpg."
}
}
}
}
}
Request Examples
Example
"Argument": {
"REPORT_TYPE": "WID+STORY",
"CURRENT_MODE_WID_STORY": "Detail",
"SELECTIONS": [
{
"WALL_IDS": {
"KEYS": [
101,
102
]
},
"STORY": [
"1F",
"2F"
]
},
{
"WALL_IDS": {
"TO": "201to205"
},
"STORY": [
"3F"
]
}
],
"EXPORT_PATH": "C:\\MIDAS\\Report\\",
"OUTPUT_NAME": "RC_Wall_Report"
}
}
Response Examples
Example
"SUCCESS": true,
"FILE_PATH": "C:\\MIDAS\\Result\\result.jpg",
"MESSAGE": ""
}
Specifications
Keyed Object Entry
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
|
Root Object |
||||||||
|
1 |
Generate RC Wall report. If SELECTIONS is omitted or empty, all wall IDs and all stories are included. |
"Argument" |
object |
- |
Required |
|||
Item (Value Object Schema)
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
|
General |
||||||||
|
1 |
Report Type • WID+STORY: "WID+STORY" • WID: "WID" |
"REPORT_TYPE" |
string |
|
Required |
|||
|
2 |
Selections Constraints: • Items: min 0 |
"SELECTIONS" |
Array [object] |
- |
Optional |
|||
|
2.1 |
Wall IDs |
"WALL_IDS" |
object |
- |
Optional |
|||
|
oneOf Choose exactly one of the following keys: "KEYS" or "TO". |
||||||||
|
2.1.1 |
Specify Each Wall ID |
"KEYS" |
Array [integer] |
- |
Optional |
|||
|
2.1.2 |
Specify Wall ID Range |
"TO" |
string |
- |
Optional |
|||
|
2.2 |
Stories |
"STORY" |
Array [string] |
- |
Optional |
|||
|
3 |
Export Path e.g. C:\MIDAS\Report\ |
"EXPORT_PATH" |
string |
- |
Required |
|||
|
4 |
Output File Name |
"OUTPUT_NAME" |
string |
- |
Required |
|||
|
When "REPORT_TYPE" is WID+STORY |
||||||||
|
5 |
Report Mode • Graphic (JPG image): "Graphic" • Detail (DOC document): "Detail" • Summary (TXT text): "Summary" • PM Curve (JPG image): "PMCurve" |
"CURRENT_MODE_WID_STORY" |
string |
- |
Required |
|||
|
When "REPORT_TYPE" is WID |
||||||||
|
6 |
Report Mode • Graphic (JPG image): "Graphic" • Summary (TXT text): "Summary" • PM Curve (JPG image): "PMCurve" |
"CURRENT_MODE_WID" |
string |
- |
Required |
|||