Video Plugin

Update a video by ID

PUT

http://localhost:3000/api/plugins/videos/{id}

Updates an existing video record based on the provided ID and metadata.

curl -X PUT 'http://localhost:3000/api/plugins/videos/string' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "title": "string",
  "duration": 0,
  "size": 0,
  "fullUrl": "string",
  "description": "string",
  "storageProvider": "LOCAL",
  "resolution": "string",
  "codec": "string",
  "frameRate": 0,
  "timeSlotId": "string"
}'

const body = `{
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "title": "string",
  "duration": 0,
  "size": 0,
  "fullUrl": "string",
  "description": "string",
  "storageProvider": "LOCAL",
  "resolution": "string",
  "codec": "string",
  "frameRate": 0,
  "timeSlotId": "string"
}`;

const response = await fetch('http://localhost:3000/api/plugins/videos/string', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "title": "string",
  "duration": 0,
  "size": 0,
  "fullUrl": "string",
  "description": "string",
  "storageProvider": "LOCAL",
  "resolution": "string",
  "codec": "string",
  "frameRate": 0,
  "timeSlotId": "string"
}'''

response = requests.put(
    'http://localhost:3000/api/plugins/videos/string',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "title": "string",
  "duration": 0,
  "size": 0,
  "fullUrl": "string",
  "description": "string",
  "storageProvider": "LOCAL",
  "resolution": "string",
  "codec": "string",
  "frameRate": 0,
  "timeSlotId": "string"
}

200

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "title": "string",
  "file": "string",
  "duration": 0,
  "size": 0,
  "fullUrl": "string",
  "description": "string",
  "storageProvider": "LOCAL",
  "resolution": "string",
  "codec": "string",
  "frameRate": 0,
  "timeSlotId": "string"
}

Body

application/json

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

titlestringrequired

Title of the video

recordedAttimestamptz

Date when the video was recorded

durationnumberrequired

Duration of the video in seconds

sizenumberrequired

Size of the video file in bytes

fullUrlstringrequired

Full URL to access the video

descriptionstringrequired

Video description

storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEAN

resolutionstring

Video resolution in format WIDTH:HEIGHT (e.g., 1920:1080, 3840:2160)

codecstring

Video codec used for encoding (e.g., libx264, libx265, vp9)

frameRatenumberrequired

Video frame rate

timeSlotIdstring

The UUID of the associated TimeSlot

Parameters

idstringrequiredpath

Response

200OKVideo

The video has been successfully updated.

Response fields application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

titlestringrequired

Title of the video

filestringrequired

Video file path or identifier

recordedAttimestamptz

Date when the video was recorded

durationnumberrequired

Duration of the video in seconds

sizenumberrequired

Size of the video file in bytes

fullUrlstringrequired

Full URL to access the video

descriptionstringrequired

Video description

storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEAN

resolutionstring

Video resolution in format WIDTH:HEIGHT (e.g., 1920:1080, 3840:2160)

codecstring

Video codec used for encoding (e.g., libx264, libx265, vp9)

frameRatenumberrequired

Video frame rate

timeSlotIdstring

The UUID of the associated TimeSlot

400Bad Request

Invalid input, The response body may contain clues as to what went wrong.

404Not Found

Video record not found.

Stack Overflow Website Demo