Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Returns a list of all tally configurations in the system, with its main configuration data.
Resource
URLconfigurationsURL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/config
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "8cdd830a-02fa-4bd5-b2eb-fd51734a40cc",
"label": "tally2",
"hash": "PLURA",
"groups": [],
"type": "PLURA",
"created": "2023-08-31T18:03:36.174Z",
"modified": "2023-08-31T18:03:47.813Z",
"attributes": {
"ip_address": "1.1.1.1",
"network": "Auto",
"port": 8901,
"serial": null
}
},
{
"uuid": "1e36b981-78b3-4820-8dea-636d79eaecc9",
"label": "tally_edit",
"hash": "TSL",
"groups": [
"grp1"
],
"type": "TSL (UDP)",
"created": "2023-08-25T11:18:05.767Z",
"modified": "2023-08-31T18:08:26.434Z",
"attributes": {
"decay_time": 10,
"port": 8901
}
}
],
"metadata": {
"item_count": 2,
"total_items": 2,
"current_page": 1,
"sort_by": [
{
"label": "ASC"
}
],
"links": {
"current": "http://192.168.10.53/api/5.1/tally/config"
}
}
} |
GET tally/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns an extended single tally configuration configuration view, specified by the required {uuid} parameter.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the desired tally configuration. |
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"uuid": "8cdd830a-02fa-4bd5-b2eb-fd51734a40cc",
"label": "tally2_edit_multi",
"hash": "PLURA",
"groups": [],
"type": "PLURA",
"created": "2023-08-31T18:03:36.174Z",
"modified": "2023-08-31T18:13:04.417Z",
"attributes": {
"ip_address": "1.1.1.1",
"network": "Auto",
"port": 8901,
"serial": null
}
},
"metadata": {}
} |
GET tally/config/meta
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns all meta data used by tally configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/config/meta
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"Types": [
"TSL (UDP)",
"TSL (TCP)",
"PLURA"
]
} |
DELETE tally/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete a specific tally configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the tally to be deleted. |
Example Request
DELETE
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"success": true
},
"metadata": {}
} |
PUT tally/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit a tally configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the tally to be edited. |
Example Request
PUT
Body
| Code Block | ||
|---|---|---|
| ||
{
"label": "tally_edit",
"hash": "TSL",
"groups": [
"grp1"
],
"type": "TSL (UDP)",
"attributes": {
"decay_time": 10,
"port": 8901
}
} |
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"uuid": "1e36b981-78b3-4820-8dea-636d79eaecc9",
"label": "tally_edit",
"hash": "TSL",
"groups": [
"grp1"
],
"type": "TSL (UDP)",
"created": "2023-08-25T11:18:05.767Z",
"modified": "2023-08-31T18:08:26.434Z",
"attributes": {
"decay_time": 10,
"port": 8901
}
},
"metadata": {}
} |
POST tally/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Add a new tally, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/config
Example Request
POST
Body
| Code Block | ||
|---|---|---|
| ||
Response
| Code Block | ||
|---|---|---|
| ||
POST tally/config multi
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Add multiple tally, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/config
Example Request
POST
Body
| Code Block | ||
|---|---|---|
| ||
Response
| Code Block | ||
|---|---|---|
| ||
PUT tally/config multi
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit multiple tally, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/config
Example Request
PUT
Body
| Code Block | ||
|---|---|---|
| ||
[
{
"uuid": "8cdd830a-02fa-4bd5-b2eb-fd51734a40cc",
"label": "tally2_edit_multi",
"hash": "PLURA",
"groups": [],
"type": "PLURA",
"created": "2023-08-31T18:03:36.174Z",
"modified": "2023-08-31T18:03:47.813Z",
"attributes": {
"ip_address": "1.1.1.1",
"network": "Auto",
"port": 8901,
"serial": null
}
},
{
"uuid": "1e36b981-78b3-4820-8dea-636d79eaecc9",
"label": "tally_edit_multi",
"hash": "TSL",
"groups": [
"grp1"
],
"type": "TSL (UDP)",
"created": "2023-08-25T11:18:05.767Z",
"modified": "2023-08-31T18:08:26.434Z",
"attributes": {
"decay_time": 10,
"port": 8901
}
}
] |
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "8cdd830a-02fa-4bd5-b2eb-fd51734a40cc",
"label": "tally2_edit_multi",
"hash": "PLURA",
"groups": [],
"type": "PLURA",
"created": "2023-08-31T18:03:36.174Z",
"modified": "2023-08-31T18:13:04.417Z",
"attributes": {
"ip_address": "1.1.1.1",
"network": "Auto",
"port": 8901,
"serial": null
}
},
{
"uuid": "1e36b981-78b3-4820-8dea-636d79eaecc9",
"label": "tally_edit_multi",
"hash": "TSL",
"groups": [
"grp1"
],
"type": "TSL (UDP)",
"created": "2023-08-25T11:18:05.767Z",
"modified": "2023-08-31T18:13:04.417Z",
"attributes": {
"decay_time": 10,
"port": 8901
}
}
],
"metadata": {}
} |
DELETE tally/config multi
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete multi tally configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/config/{{uuid}}
Example Request
DELETE
Body
| Code Block | ||
|---|---|---|
| ||
{
"data": [
"42f629b7-caeb-448d-8209-3143652547fb",
"502e7551-1461-4168-b4ea-e007e7bd51ad"
]
} |
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"success": true
},
"metadata": {}
} |