v5.0_Proxy Tally
- Ramya Raman (Unlicensed)
Returns a list of all proxy tally config in the system, with its main configuration data.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/proxy
Example Request
GET
{
"data": [
{
"label": "test_02",
"device": "92081df8-f78d-418e-92b7-87fdab283cd8",
"duration": "Permanent",
"items": [
{
"type": "Tally",
"index": 0,
"color": "#FFDDC2",
"blink": "#AABBC0"
},
{
"type": "Tally",
"index": 1,
"color": "#FFDDC1",
"blink": "#AABBC1"
},
{
"type": "UMD",
"index": 0,
"color": "#FFDDCC",
"blink": "#AABBCC",
"text": ""
},
{
"type": "Timer",
"index": 0,
"color": "#FFDDCC",
"blink": "#AABBCC",
"timestamp": "2020-09-02T08:29:06.000Z"
}
]
},
{
"label": "test_01",
"device": "92081df8-f78d-418e-92b7-87fdab283cd8",
"duration": "Permanent",
"items": [
{
"type": "Tally",
"index": 0,
"color": "#FFDDC0",
"blink": "#AABBC0"
},
{
"type": "Tally",
"index": 1,
"color": "#FFDDC1",
"blink": "#AABBC1"
},
{
"type": "UMD",
"index": 0,
"color": "#FFDDCC",
"blink": "#AABBCC",
"text": ""
},
{
"type": "Timer",
"index": 0,
"color": "#FFDDCC",
"blink": "#AABBCC",
"timestamp": "2020-09-02T08:29:06.000Z"
}
]
}
],
"metadata": {
"item_count": 2,
"total_items": 2,
"total_pages": 1,
"current_page": 1,
"sort_by": [
{
"field": "label",
"direction": "ASC"
}
]
}
}
GET tally/proxy filtered
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns a single proxy tally config in the system filtered by the label and device name, with its main configuration data.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/proxy
Example Request
GET
Body
{
"filter": {
"device": "e106abd2-efcb-485c-a3ab-b36b70e34296",
"label": "test_01"
}
}Response
{
"data": [
{
"label": "test_01",
"device": "e106abd2-efcb-485c-a3ab-b36b70e34296",
"duration": "Permanent",
"items": [
{
"type": "Tally",
"index": 0,
"color": "#FFDDC0",
"blink": "#AABBC0"
},
{
"type": "Tally",
"index": 1,
"color": "#FFDDC1",
"blink": "#AABBC1"
},
{
"type": "UMD",
"index": 0,
"color": "#FFDDCC",
"blink": "#AABBCC",
"text": ""
},
{
"type": "Timer",
"index": 0,
"color": "#FFDDCC",
"blink": "#AABBCC",
"timestamp": "2020-09-02T08:29:06.000Z"
}
]
}
],
"metadata": {
"item_count": 1,
"total_items": 1,
"total_pages": 1,
"current_page": 1,
"sort_by": [
{
"field": "label",
"direction": "ASC"
}
]
}
}
DELETE tally/proxy/{device}/{label}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete a specific proxy tally configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/proxy/{{device}}/{{label}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the proxy tally to be deleted. |
Example Request
DELETE
Add a new proxy tally, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/proxy
Example Request
POST
Body
Response
GET tally/proxy/meta
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns a list of meta data in the system, with its main configuration data.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/proxy/meta
Example Request
GET
DELETE multiple tally/proxy/
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete a multiple proxy tally configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/proxy
Example Request
DELETE
Body
Response
POST multiple tally/proxy
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Add multiple proxy tally, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/proxy
Example Request
POST
Body
Response
PUT tally/proxy/{label} (By Device)
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit a proxy tally configuration by device.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/proxy/{{label}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
label | string | The UUID of the proxy tally to be edited. |
Example Request
PUT
https://192.168.10.53/api/5.0/tally/proxy/test_02
Body
Response
PUT tally/proxy/{label} (By Output)
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit a proxy tally configuration by output.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/proxy/{{label}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
label | string | The UUID of the proxy tally to be edited. |
Example Request
PUT
Body
Response
PUT multiple tally/proxy
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edits multiple proxy tally configuration by output.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/tally/proxy
Example Request
PUT
Body
Response