This is currently in development and has not been released yet.

This API is intended for internal use only. There are no use cases for external access.

See the internal documentation on the video transcoding pipeline.

1 Overview
2 Using the API
- 2.1 HTTP Request
- 2.2 HTTP Response
- 2.3 Error messages

Overview

This API is used to update the EXTERNAL_MEDIA table in SQL Server to reflect changes made to tracked files in S3.

This was designed to support internal features and does not support any third-party callers as of this writing.

Using the API

This API does not use API Keys for authentication, in order to simplify the S3 design.

Instead, it relies on a hashed signature to verify access to the requested record in EXTERNAL_MEDIA.

HTTP Request

The URI provides control data and authentication parameters:

POST /API/ExternalMedia/UpdateMetadata
?id={id}
&authHash={authHash}

Parameter	Notes

Parameter

Notes

{id}

The EXTERNAL_MEDIA_ID primary key value of the record to update.

{authHash}

The result of SHA256(S3_SORT_KEY + SECURITY_GUID).

Used to authenticate access to the record, assuming that only a client with access to the LearningBuilder database can obtain these values.

The request body contains a JSON object of the properties to update:

{ 
  TRANSCODING_STATUS = "SUBMITTED, ERROR, or COMPLETE",
  FILE_SIZE_BYTES = {number},
  FILE_NAME = "{string}",
  VIDEO_DURATION_SEC = {number},
  TRANSCODED_S3_PATH = "{string}"
}

HTTP Response

On success, the response is 200 OK with no body.

If an error occurs, then an appropriate status code is used and the body contains the error message.

Error messages

Error	Reason / How to fix

Error	Reason / How to fix