v4
Retrieve a list of ingest point tasks.
Request
Request syntax:
GET /managed-slicer/ingest-points/tasks
Response
The response for a successful request contains the following properties:
| Name | Data Type | Description |
|---|---|---|
| @id | String | Indicates the relative path to this endpoint. |
| @type | String | Returns Collection. |
| items | List of Dictionaries | Contains a list of your tasks. |
| total_items | Number | Indicates the total number of tasks. |
items List
The items list describes each task through the following properties:
| Name | Data Type | Description | ||
|---|---|---|---|---|
| @id | String | Indicates a relative path that returns this resource. | ||
| @type | String | Returns ReservedEndpointTask. | ||
| id | String | Indicates the task's system-defined ID. | ||
| operation | String | Indicates the type of operation that was performed. Valid values are: CREATE | UPDATE | DELETE |
| state | String | Indicates the task's current state. Learn more. | ||
| timestamp | Number | Indicates the timestamp, in Unix time (seconds), at which the task was initiated. |
Sample Request/Response
The code below (Python 3) shows how to retrieve a list of your ingest point tasks.
This code imports names from the api_auth module for V4 APIs (see below).
🦉
API Auth for Classic Authentication (V4 APIs)
Open Recipe
import json
import requests
from api_auth import APICredentials, APIParams
class Tasks:
def __init__(self):
self.host = "https://services.uplynk.com"
def run(self):
"""
Get all ingest point tasks.
"""
self._get_all_ingest_point_tasks()
def _get_all_ingest_point_tasks(self):
url = "{}{}".format(self.host, "/api/v4/managed-slicer/ingest-points/tasks")
response = requests.get(
url, params=APIParams(APICredentials()).get_params({})
)
print(response.json())
Tasks().run()
Response:
{
"@id": "/api/v4/managed-slicer/ingest-points/tasks",
"@type": "Collection",
"items": [{
"@id": "/api/v4/managed-slicer/ingest-points/tasks/5eead8d6-79e3-4a3d-915e-a886199dfde0",
"@type": "ReservedEndpointTask",
"id": "5eead8d6-79e3-4a3d-915e-a886199dfde0",
"state": "COMPLETED",
"operation": "DELETE",
"timestamp": 1664900951
}, {
"@id": "/api/v4/managed-slicer/ingest-points/tasks/7c401e2e-d53f-4b82-9ba2-f89cb00d245a",
"@type": "ReservedEndpointTask",
"id": "7c401e2e-d53f-4b82-9ba2-f89cb00d245a",
"state": "COMPLETED",
"operation": "CREATE",
"timestamp": 1663974437
}, {
"@id": "/api/v4/managed-slicer/ingest-points/tasks/5e395271-b1d3-44c2-ab1b-a55b1d1b96e6",
"@type": "ReservedEndpointTask",
"id": "5e395271-b1d3-44c2-ab1b-a55b1d1b96e6",
"state": "COMPLETED",
"operation": "CREATE",
"timestamp": 1663976769
}, {
"@id": "/api/v4/managed-slicer/ingest-points/tasks/64242fbe-0bc3-47e4-ae5a-6a1461165421",
"@type": "ReservedEndpointTask",
"id": "64242fbe-0bc3-47e4-ae5a-6a1461165421",
"state": "COMPLETED",
"operation": "CREATE",
"timestamp": 1664392131
}, {
"@id": "/api/v4/managed-slicer/ingest-points/tasks/c0b71aba-5799-4816-9fa3-271959be8d1a",
"@type": "ReservedEndpointTask",
"id": "c0b71aba-5799-4816-9fa3-271959be8d1a",
"state": "COMPLETED",
"operation": "CREATE",
"timestamp": 1664470813
}, {
"@id": "/api/v4/managed-slicer/ingest-points/tasks/d8454e1c-8b47-4a3b-8d57-e6875c39a220",
"@type": "ReservedEndpointTask",
"id": "d8454e1c-8b47-4a3b-8d57-e6875c39a220",
"state": "COMPLETED",
"operation": "CREATE",
"timestamp": 1664822066
}, {
"@id": "/api/v4/managed-slicer/ingest-points/tasks/5e80862f-7863-4482-89ad-796715b31547",
"@type": "ReservedEndpointTask",
"id": "5e80862f-7863-4482-89ad-796715b31547",
"state": "COMPLETED",
"operation": "CREATE",
"timestamp": 1664822095
}, {
"@id": "/api/v4/managed-slicer/ingest-points/tasks/49a72797-755b-4550-a384-ba78931431b2",
"@type": "ReservedEndpointTask",
"id": "49a72797-755b-4550-a384-ba78931431b2",
"state": "COMPLETED",
"operation": "CREATE",
"timestamp": 1664836080
}
],
"total_items": 8
}