Input URI
|
{base url} + DESIGN/RC/KDS-41-20-2022/HCBM |
|---|
Active Methods
|
POST,GET,PUT,DELETE |
|---|
JSON Schema
Details
"type": "object",
"required": [
"Assign"
],
"additionalProperties": false,
"properties": {
"Assign": {
"type": "object",
"description": "Keyed object (dictionary). Each property name is an ID string (e.g., \"1\").",
"additionalProperties": false,
"minProperties": 1,
"patternProperties": {
"^[0-9]+$": {
"type": "object",
"required": [
"NAME",
"PART_A",
"PART_B",
"PART_C",
"POS_TYPE"
],
"additionalProperties": false,
"properties": {
"NAME": {
"type": "string",
"description": "Haunch Name"
},
"PART_A": {
"type": "object",
"description": "Element No. Input for Part A (Use only one method)",
"additionalProperties": false,
"required": [
"INPUT_METHOD"
],
"properties": {
"INPUT_METHOD": {
"type": "string",
"description": "Select input method for Part A",
"oneOf": [
{
"title": "Specify each Element ID",
"const": "KEYS"
},
{
"title": "Specify ID range",
"const": "TO"
}
]
},
"KEYS": {
"type": "array",
"items": {
"type": "integer"
},
"minItems": 1,
"description": "Specify each Element ID"
},
"TO": {
"type": "string",
"description": "Specify ID range (e.g. \"101 to 105\")"
}
}
},
"PART_B": {
"type": "object",
"description": "Element No. Input for Part B (Use only one method)",
"additionalProperties": false,
"required": [
"INPUT_METHOD"
],
"properties": {
"INPUT_METHOD": {
"type": "string",
"description": "Select input method for Part B",
"oneOf": [
{
"title": "Specify each Element ID",
"const": "KEYS"
},
{
"title": "Specify ID range",
"const": "TO"
}
]
},
"KEYS": {
"type": "array",
"items": {
"type": "integer"
},
"minItems": 1,
"description": "Specify each Element ID"
},
"TO": {
"type": "string",
"description": "Specify ID range (e.g. \"101 to 105\")"
}
}
},
"PART_C": {
"type": "object",
"description": "Element No. Input for Part C (Use only one method)",
"additionalProperties": false,
"required": [
"INPUT_METHOD"
],
"properties": {
"INPUT_METHOD": {
"type": "string",
"description": "Select input method for Part C",
"oneOf": [
{
"title": "Specify each Element ID",
"const": "KEYS"
},
{
"title": "Specify ID range",
"const": "TO"
}
]
},
"KEYS": {
"type": "array",
"items": {
"type": "integer"
},
"minItems": 1,
"description": "Specify each Element ID"
},
"TO": {
"type": "string",
"description": "Specify ID range (e.g. \"101 to 105\")"
}
}
},
"POS_TYPE": {
"type": "integer",
"description": "Design Position Type",
"oneOf": [
{
"title": "Part 1/2",
"const": 0
},
{
"title": "User",
"const": 1
}
]
},
"L1": {
"type": "number",
"description": "User defined L1 distance",
"default": 1
},
"L2": {
"type": "number",
"description": "User defined L2 distance",
"default": 1
}
}
}
}
}
}
}
Request Examples
Example
"Assign": {
"1": {
"NAME": "h1",
"POS_TYPE": 0,
"L1": 0.5,
"L2": 0.5,
"PART_A": {
"INPUT_METHOD": "KEYS",
"KEYS": [
1065
]
},
"PART_B": {
"INPUT_METHOD": "TO",
"TO": "1066to1071"
},
"PART_C": {
"INPUT_METHOD": "KEYS",
"KEYS": [
1072
]
}
}
}
}
Response Examples
Example
"HCBM": {
"1": {
"NAME": "h1",
"PART_A": {
"INPUT_METHOD": "KEYS",
"KEYS": [
1065
]
},
"PART_B": {
"INPUT_METHOD": "TO",
"TO": "1066to1071"
},
"PART_C": {
"INPUT_METHOD": "KEYS",
"KEYS": [
1072
]
},
"POS_TYPE": 0,
"L1": 0.5,
"L2": 0.5
}
}
}
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 |
Haunch Name |
"NAME" |
string |
- |
Required |
|||
|
2 |
Element No. Input for Part A (Use only one method) |
"PART_A" |
object |
- |
Required |
|||
|
2.1 |
Select input method for Part A • Specify each Element ID: "KEYS" • Specify ID range: "TO" |
"INPUT_METHOD" |
string |
- |
Required |
|||
|
When "INPUT_METHOD" is KEYS |
||||||||
|
2.2 |
Specify each Element ID Constraints: • Items: min 1 |
"KEYS" |
Array [integer] |
- |
Optional |
|||
|
When "INPUT_METHOD" is TO |
||||||||
|
2.3 |
Specify ID range (e.g. "101 to 105") |
"TO" |
string |
- |
Optional |
|||
|
3 |
Element No. Input for Part B (Use only one method) |
"PART_B" |
object |
- |
Required |
|||
|
3.1 |
Select input method for Part B • Specify each Element ID: "KEYS" • Specify ID range: "TO" |
"INPUT_METHOD" |
string |
- |
Required |
|||
|
When "INPUT_METHOD" is KEYS |
||||||||
|
3.2 |
Specify each Element ID Constraints: • Items: min 1 |
"KEYS" |
Array [integer] |
- |
Optional |
|||
|
When "INPUT_METHOD" is TO |
||||||||
|
3.3 |
Specify ID range (e.g. "101 to 105") |
"TO" |
string |
- |
Optional |
|||
|
4 |
Element No. Input for Part C (Use only one method) |
"PART_C" |
object |
- |
Required |
|||
|
4.1 |
Select input method for Part C • Specify each Element ID: "KEYS" • Specify ID range: "TO" |
"INPUT_METHOD" |
string |
- |
Required |
|||
|
When "INPUT_METHOD" is KEYS |
||||||||
|
4.2 |
Specify each Element ID Constraints: • Items: min 1 |
"KEYS" |
Array [integer] |
- |
Optional |
|||
|
When "INPUT_METHOD" is TO |
||||||||
|
4.3 |
Specify ID range (e.g. "101 to 105") |
"TO" |
string |
- |
Optional |
|||
|
5 |
Design Position Type • Part 1/2: "0" • User: "1" |
"POS_TYPE" |
integer |
- |
Required |
|||
|
When "POS_TYPE" is 1 |
||||||||
|
6 |
User defined L1 distance |
"L1" |
number |
|
Optional |
|||
|
7 |
User defined L2 distance |
"L2" |
number |
|
Optional |
|||