Input URI
|
{base url} + DESIGN/STEEL/KDS-41-30-2022/CODE-REPORT |
|---|
Active Methods
|
POST |
|---|
JSON Schema
Details
"type": "object",
"required": [
"Argument"
],
"additionalProperties": false,
"properties": {
"Argument": {
"type": "object",
"required": [
"REPORT_TYPE",
"CURRENT_MODE",
"EXPORT_PATH",
"OUTPUT_NAME"
],
"additionalProperties": false,
"oneOf": [
{
"required": [
"ELEMS"
]
},
{
"required": [
"SECTIONS"
]
}
],
"properties": {
"REPORT_TYPE": {
"type": "string",
"description": "Report Table Type",
"enum": [
"MEMB",
"PROP"
]
},
"CURRENT_MODE": {
"type": "string",
"description": "Report output mode",
"oneOf": [
{
"title": "Graphic (JPG image)",
"const": "Graphic"
},
{
"title": "Detail (DOC document)",
"const": "Detail"
},
{
"title": "Summary (TXT text)",
"const": "Summary"
}
]
},
"ELEMS": {
"type": "object",
"description": "Element No. Input.",
"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"
]
}
]
}
}
]
},
"SECTIONS": {
"type": "array",
"description": "List of section numbers to include in the report",
"items": {
"type": "integer"
}
},
"EXPORT_PATH": {
"type": "string",
"description": "Directory path to save the report files"
},
"OUTPUT_NAME": {
"type": "string",
"description": "Output file base name. For multiple elements, files are prefixed with index and element number (e.g. 001_E859_filename.jpg, 002_E1_filename.jpg)"
}
}
}
}
}
Request Examples
Example
"Argument": {
"REPORT_TYPE": "MEMB",
"CURRENT_MODE": "Graphic",
"EXPORT_PATH": "C:\\MIDAS\\Result\\",
"OUTPUT_NAME": "out.jpg",
"ELEMS": {
"KEYS": [
888,
1058
]
}
}
}
Response Examples
Example
"SUCCESS": true,
"FILE_PATH": "C:\\MIDAS\\Result\\out.jpg",
"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 |
Table Type • MEMB: "MEMB" • PROP: "PROP" |
"REPORT_TYPE" |
string |
- |
Required |
|||
|
2 |
Report Mode • Graphic (JPG image): "Graphic" • Detail (DOC document): "Detail" • Summary (TXT text): "Summary" |
"CURRENT_MODE" |
string |
- |
Required |
|||
|
oneOf Choose exactly one of the following keys: "ELEMS" or "SECTIONS". |
||||||||
|
3 |
Element Numbers Use either ELEMS or SECTIONS, not both. |
"ELEMS" |
object |
- |
Optional |
|||
|
oneOf Choose exactly one of the following keys: "KEYS", "TO", or "STRUCTURE_GROUP_NAME". |
||||||||
|
3.1 |
Specify Each ID |
"KEYS" |
Array [integer] |
- |
Optional |
|||
|
3.2 |
Specify ID Range |
"TO" |
string |
- |
Optional |
|||
|
3.3 |
Structure Group Name |
"STRUCTURE_GROUP_NAME" |
string |
- |
Optional |
|||
|
4 |
Section Numbers Use either ELEMS or SECTIONS, not both. |
"SECTIONS" |
Array [integer] |
- |
Optional |
|||
|
5 |
Export Path e.g. C:\MIDAS\Report\ |
"EXPORT_PATH" |
string |
- |
Required |
|||
|
6 |
Output File Name |
"OUTPUT_NAME" |
string |
- |
Required |
|||