Get a video feed

GET/projects/{projectId}/entities/{entityId}/videoFeeds/{videoFeedId}

Base URL: https://api.tinkermode.com

Return the video feed with the specified ID.

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)
`videoFeedId`	string	Yes		The unique ID for a specified video feed.

Responses

`200` Successfully retrieved the video feed with specified ID.

Content type: application/json

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
}

`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.

`404` The requested videoFeed does not exist or is not accessible.

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.