Get video feeds
GET/projects/{projectId}/entities/{entityId}/videoFeeds
Base URL: https://api.tinkermode.com
Get a list of video feeds of the entity.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain the key of a user or service account with permissions to read video feeds of the entity or a project API key.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
projectId | integer | Yes | The unique ID for a specified project. | |
entityId | string | Yes | Entity ID (unique within project) |
Query parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
limit | integer | No | default: 25; min: 1 | Maximum number of video feeds to return. |
skip | integer | No | default: 0; min: 0 | Number of video feeds to skip over. |
Responses
200 Successful query for video feeds associated with an entity instance.
Content type: application/json
Represents a video feed
An array of objects with the following shape:
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
displayName | string | No | Display name of the video feed | |
entityId | string | No | read-only (server-generated) | Entity that this entity file belongs to. |
id | string | No | ID of the video feed | |
projectId | integer | No | read-only (server-generated) | Project that this entity file belongs to. |
Response example
[
{
"dataSourceKey": "bu01::a4dd89297bfd::1234",
"description": "Camera 1 of the Robot 1",
"displayName": "Robot 1 - Camera 1",
"entityId": "robot1-1",
"id": "63ce9a3e9bc89f001b228c80",
"projectId": 1
},
{
"dataSourceKey": "bu01::a4dd89297bfd::1235",
"description": "Camera 2 of the Robot 1",
"displayName": "Robot 1 - Camera 2",
"entityId": "robot1-1",
"id": "63ce9a3e9bc89f001b228c7f",
"projectId": 1
}
]401 Authorization is required to access this resource.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
403 Request failed because of denied permission.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
429 Request failed because of rate limit.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
500 An unexpected error has occurred.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
503 The service is temporarily unavailable.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |