Input URI
|
{base url} + DESIGN/RC/KDS-41-20-2022/DCREM |
|---|
Active Methods
|
POST,GET,PUT,DELETE |
|---|
JSON Schema
Details
{
"type": "object",
"additionalProperties": false,
"required": [
"Assign"
],
"properties": {
"Assign": {
"type": "object",
"description": "Key is an index string (e.g., \"1\"), and each Assign entry is a setting object.",
"minProperties": 1,
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"required": [
"SELECT_ALL"
],
"properties": {
"SELECT_ALL": {
"type": "boolean",
"description": "Apply to all available members."
},
"SELECTED_MEMBERS": {
"type": "object",
"description": "Keyed object of selected member assignments. Each property name is a node ID string (e.g., \"1\"), and each value contains the element list for that node.",
"minProperties": 1,
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"required": [
"ELEM_LIST"
],
"properties": {
"ELEM_LIST": {
"type": "array",
"description": "Array of exactly 2 element numbers where the node is located between them.",
"items": {
"type": "integer"
},
"minItems": 2,
"maxItems": 2
}
}
}
}
},
"allOf": [
{
"if": {
"properties": {
"SELECT_ALL": {
"const": false
}
},
"required": [
"SELECT_ALL"
]
},
"then": {
"required": [
"SELECTED_MEMBERS"
]
}
}
]
}
}
}
}
"type": "object",
"additionalProperties": false,
"required": [
"Assign"
],
"properties": {
"Assign": {
"type": "object",
"description": "Key is an index string (e.g., \"1\"), and each Assign entry is a setting object.",
"minProperties": 1,
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"required": [
"SELECT_ALL"
],
"properties": {
"SELECT_ALL": {
"type": "boolean",
"description": "Apply to all available members."
},
"SELECTED_MEMBERS": {
"type": "object",
"description": "Keyed object of selected member assignments. Each property name is a node ID string (e.g., \"1\"), and each value contains the element list for that node.",
"minProperties": 1,
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"required": [
"ELEM_LIST"
],
"properties": {
"ELEM_LIST": {
"type": "array",
"description": "Array of exactly 2 element numbers where the node is located between them.",
"items": {
"type": "integer"
},
"minItems": 2,
"maxItems": 2
}
}
}
}
},
"allOf": [
{
"if": {
"properties": {
"SELECT_ALL": {
"const": false
}
},
"required": [
"SELECT_ALL"
]
},
"then": {
"required": [
"SELECTED_MEMBERS"
]
}
}
]
}
}
}
}
Request Examples
Example
{
"Assign": {
"1": {
"SELECT_ALL": false,
"SELECTED_MEMBERS": {
"347": {
"ELEM_LIST": [
925,
926
]
},
"364": {
"ELEM_LIST": [
922,
924
]
},
"365": {
"ELEM_LIST": [
924,
925
]
},
"396": {
"ELEM_LIST": [
926,
927
]
}
}
}
}
}
"Assign": {
"1": {
"SELECT_ALL": false,
"SELECTED_MEMBERS": {
"347": {
"ELEM_LIST": [
925,
926
]
},
"364": {
"ELEM_LIST": [
922,
924
]
},
"365": {
"ELEM_LIST": [
924,
925
]
},
"396": {
"ELEM_LIST": [
926,
927
]
}
}
}
}
}
Response Examples
Example
{
"DCREM": {
"1": {
"SELECT_ALL": false,
"SELECTED_MEMBERS": {
"347": {
"ELEM_LIST": [
925,
926
]
},
"364": {
"ELEM_LIST": [
922,
924
]
},
"365": {
"ELEM_LIST": [
924,
925
]
},
"396": {
"ELEM_LIST": [
926,
927
]
}
}
}
}
}
"DCREM": {
"1": {
"SELECT_ALL": false,
"SELECTED_MEMBERS": {
"347": {
"ELEM_LIST": [
925,
926
]
},
"364": {
"ELEM_LIST": [
922,
924
]
},
"365": {
"ELEM_LIST": [
924,
925
]
},
"396": {
"ELEM_LIST": [
926,
927
]
}
}
}
}
}
Specifications
Keyed Object Entry
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
|
Root Object |
||||||||
|
1 |
Key is an index string (e.g., "1"), and each Assign entry is a setting object. |
"Assign" |
object |
- |
Required |
|||
Item (Value Object Schema)
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
|
General |
||||||||
|
1 |
Select All |
"SELECT_ALL" |
boolean |
- |
Required |
|||
|
When "SELECT_ALL" is false |
||||||||
|
2 |
Keyed object of selected member assignments. Each property name is a node ID string (e.g., "1"), and each value contains the element list for that node. Constraints: • Properties: min 1 |
"SELECTED_MEMBERS" |
object |
- |
Required |
|||
|
2.1 |
Elem. List : Array of exactly 2 element numbers where the node is located between them Constraints: • Items: exactly 2 |
"ELEM_LIST" |
Array [integer] |
- |
Required |
|||