Input URI
|
{base url} + DESIGN/STEEL/KDS-41-30-2022/DCTL |
|---|
Active Methods
|
GET,PUT,DELETE |
|---|
JSON Schema
Details
{
"type": "object",
"required": [
"Assign"
],
"additionalProperties": false,
"description": "Definition of Frame (shared structure: T_DCTL_D). Supported methods: GET, PUT.",
"properties": {
"Assign": {
"type": "object",
"description": "Keyed object (dictionary). Each property name is an ID string (e.g., \"1\").",
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1,
"patternProperties": {
"^[0-9]+$": {
"type": "object",
"required": [],
"additionalProperties": false,
"properties": {
"FRAMEX": {
"type": "string",
"description": "X-Direction of Frame",
"default": "Braced Non-sway",
"oneOf": [
{
"title": "Unbraced | Sway",
"const": "Unbraced Sway"
},
{
"title": "Braced | Non-sway",
"const": "Braced Non-sway"
}
]
},
"FRAMEY": {
"type": "string",
"description": "Y-Direction of Frame",
"default": "Braced Non-sway",
"oneOf": [
{
"title": "Unbraced | Sway",
"const": "Unbraced Sway"
},
{
"title": "Braced | Non-sway",
"const": "Braced Non-sway"
}
]
},
"bAUTOKF": {
"type": "boolean",
"description": "Auto Calculate Effective Length Factor",
"default": false
},
"DT": {
"type": "string",
"description": "Design Type",
"default": "3D",
"oneOf": [
{
"title": "3-D",
"const": "3D"
},
{
"title": "X-Z Plane",
"const": "XZ"
},
{
"title": "Y-Z Plane",
"const": "YZ"
},
{
"title": "X-Y Plane",
"const": "XY"
}
]
}
}
}
}
}
}
}
"type": "object",
"required": [
"Assign"
],
"additionalProperties": false,
"description": "Definition of Frame (shared structure: T_DCTL_D). Supported methods: GET, PUT.",
"properties": {
"Assign": {
"type": "object",
"description": "Keyed object (dictionary). Each property name is an ID string (e.g., \"1\").",
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1,
"patternProperties": {
"^[0-9]+$": {
"type": "object",
"required": [],
"additionalProperties": false,
"properties": {
"FRAMEX": {
"type": "string",
"description": "X-Direction of Frame",
"default": "Braced Non-sway",
"oneOf": [
{
"title": "Unbraced | Sway",
"const": "Unbraced Sway"
},
{
"title": "Braced | Non-sway",
"const": "Braced Non-sway"
}
]
},
"FRAMEY": {
"type": "string",
"description": "Y-Direction of Frame",
"default": "Braced Non-sway",
"oneOf": [
{
"title": "Unbraced | Sway",
"const": "Unbraced Sway"
},
{
"title": "Braced | Non-sway",
"const": "Braced Non-sway"
}
]
},
"bAUTOKF": {
"type": "boolean",
"description": "Auto Calculate Effective Length Factor",
"default": false
},
"DT": {
"type": "string",
"description": "Design Type",
"default": "3D",
"oneOf": [
{
"title": "3-D",
"const": "3D"
},
{
"title": "X-Z Plane",
"const": "XZ"
},
{
"title": "Y-Z Plane",
"const": "YZ"
},
{
"title": "X-Y Plane",
"const": "XY"
}
]
}
}
}
}
}
}
}
Request Examples
Example
{
"Assign": {
"1": {
"FRAMEX": "Braced Non-sway",
"FRAMEY": "Braced Non-sway",
"bAUTOKF": true,
"DT": "XZ"
}
}
}
"Assign": {
"1": {
"FRAMEX": "Braced Non-sway",
"FRAMEY": "Braced Non-sway",
"bAUTOKF": true,
"DT": "XZ"
}
}
}
Response Examples
Example
{
"DCTL": {
"1": {
"FRAMEX": "Braced Non-sway",
"FRAMEY": "Braced Non-sway",
"bAUTOKF": true,
"DT": "XZ"
}
}
}
"DCTL": {
"1": {
"FRAMEX": "Braced Non-sway",
"FRAMEY": "Braced Non-sway",
"bAUTOKF": true,
"DT": "XZ"
}
}
}
Specifications
Keyed Object Entry
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
|
Root Object |
||||||||
|
1 |
Keyed object (dictionary). Each property name is an ID string (e.g., "1"). |
"Assign" |
object |
- |
Required |
|||
Item (Value Object Schema)
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
|
General |
||||||||
|
1 |
X-Direction of Frame • Unbraced | Sway: "Unbraced Sway" • Braced | Non-sway: "Braced Non-sway" |
"FRAMEX" |
string |
|
Optional |
|||
|
2 |
Y-Direction of Frame • Unbraced | Sway: "Unbraced Sway" • Braced | Non-sway: "Braced Non-sway" |
"FRAMEY" |
string |
|
Optional |
|||
|
3 |
Auto Calculate Effective Length Factor |
"bAUTOKF" |
boolean |
|
Optional |
|||
|
4 |
Design Type • 3-D: "3D" • X-Z Plane: "XZ" • Y-Z Plane: "YZ" • X-Y Plane: "XY" |
"DT" |
string |
|
Optional |
|||