Input URI
|
{base url} + DESIGN/RC/KDS-41-20-2022/HCD-REPORT |
|---|
Active Methods
|
POST |
|---|
JSON Schema
Details
{
"type": "object",
"required": [
"Argument"
],
"additionalProperties": false,
"properties": {
"Argument": {
"type": "object",
"required": [
"CURRENT_MODE",
"EXPORT_PATH",
"OUTPUT_NAME"
],
"additionalProperties": false,
"properties": {
"CURRENT_MODE": {
"type": "string",
"description": "Report output mode",
"enum": [
"Graphic"
]
},
"ELEMS": {
"type": "object",
"description": "Haunched beam elements to include in the report. If omitted, all elements are included.",
"additionalProperties": false,
"properties": {
"KEYS": {
"type": "array",
"description": "Specify Each ID",
"items": {
"type": "integer"
}
},
"TO": {
"type": "string",
"description": "Specify ID Range (e.g., '1to160')"
},
"STRUCTURE_GROUP_NAME": {
"type": "string",
"description": "Specify Structure Group Name"
}
},
"oneOf": [
{
"required": [
"KEYS"
],
"not": {
"anyOf": [
{
"required": [
"TO"
]
},
{
"required": [
"STRUCTURE_GROUP_NAME"
]
}
]
}
},
{
"required": [
"TO"
],
"not": {
"anyOf": [
{
"required": [
"KEYS"
]
},
{
"required": [
"STRUCTURE_GROUP_NAME"
]
}
]
}
},
{
"required": [
"STRUCTURE_GROUP_NAME"
],
"not": {
"anyOf": [
{
"required": [
"KEYS"
]
},
{
"required": [
"TO"
]
}
]
}
}
]
},
"EXPORT_PATH": {
"type": "string",
"description": "Directory path to save the report files (.jpg format)"
},
"OUTPUT_NAME": {
"type": "string",
"description": "Output file base name. For multiple haunched beams, files are prefixed with index and beam number (e.g. 001_HCBM1_filename.jpg, 002_HCBM2_filename.jpg)"
}
}
}
}
}
"type": "object",
"required": [
"Argument"
],
"additionalProperties": false,
"properties": {
"Argument": {
"type": "object",
"required": [
"CURRENT_MODE",
"EXPORT_PATH",
"OUTPUT_NAME"
],
"additionalProperties": false,
"properties": {
"CURRENT_MODE": {
"type": "string",
"description": "Report output mode",
"enum": [
"Graphic"
]
},
"ELEMS": {
"type": "object",
"description": "Haunched beam elements to include in the report. If omitted, all elements are included.",
"additionalProperties": false,
"properties": {
"KEYS": {
"type": "array",
"description": "Specify Each ID",
"items": {
"type": "integer"
}
},
"TO": {
"type": "string",
"description": "Specify ID Range (e.g., '1to160')"
},
"STRUCTURE_GROUP_NAME": {
"type": "string",
"description": "Specify Structure Group Name"
}
},
"oneOf": [
{
"required": [
"KEYS"
],
"not": {
"anyOf": [
{
"required": [
"TO"
]
},
{
"required": [
"STRUCTURE_GROUP_NAME"
]
}
]
}
},
{
"required": [
"TO"
],
"not": {
"anyOf": [
{
"required": [
"KEYS"
]
},
{
"required": [
"STRUCTURE_GROUP_NAME"
]
}
]
}
},
{
"required": [
"STRUCTURE_GROUP_NAME"
],
"not": {
"anyOf": [
{
"required": [
"KEYS"
]
},
{
"required": [
"TO"
]
}
]
}
}
]
},
"EXPORT_PATH": {
"type": "string",
"description": "Directory path to save the report files (.jpg format)"
},
"OUTPUT_NAME": {
"type": "string",
"description": "Output file base name. For multiple haunched beams, files are prefixed with index and beam number (e.g. 001_HCBM1_filename.jpg, 002_HCBM2_filename.jpg)"
}
}
}
}
}
Request Examples
Example
{
"Argument": {
"CURRENT_MODE": "Graphic",
"EXPORT_PATH": "C:\\MIDAS\\Result\\",
"OUTPUT_NAME": "graphic",
"ELEMS": {
"KEYS": [
1073
]
}
}
}
"Argument": {
"CURRENT_MODE": "Graphic",
"EXPORT_PATH": "C:\\MIDAS\\Result\\",
"OUTPUT_NAME": "graphic",
"ELEMS": {
"KEYS": [
1073
]
}
}
}
Response Examples
Example
{
"SUCCESS": true,
"FILE_PATH": "C:\\MIDAS\\Result\\graphic",
"MESSAGE": ""
}
"SUCCESS": true,
"FILE_PATH": "C:\\MIDAS\\Result\\graphic",
"MESSAGE": ""
}
Specifications
Keyed Object Entry
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
|
Root Object |
||||||||
|
1 |
Map of keyed objects where each key is a string identifier. |
"Argument" |
object |
- |
Required |
|||
Item (Value Object Schema)
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
|
General |
||||||||
|
1 |
Report Mode • Graphic: "Graphic" |
"CURRENT_MODE" |
string |
- |
Required |
|||
|
2 |
Element Numbers |
"ELEMS" |
object |
- |
Optional |
|||
|
oneOf Choose exactly one of the following keys: "KEYS", "TO", or "STRUCTURE_GROUP_NAME". |
||||||||
|
2.1 |
Specify Each ID |
"KEYS" |
Array [integer] |
- |
Optional |
|||
|
2.2 |
Specify ID Range |
"TO" |
string |
- |
Optional |
|||
|
2.3 |
Structure Group Name |
"STRUCTURE_GROUP_NAME" |
string |
- |
Optional |
|||
|
3 |
Export Path e.g. C:\MIDAS\Report\ |
"EXPORT_PATH" |
string |
- |
Required |
|||
|
4 |
Output File Name |
"OUTPUT_NAME" |
string |
- |
Required |
|||