Version | Change |
---|---|
release-2020-12 | Initial support |
Required scope:
public-api:write
Description
The video import does both create and update videos. The import remembers theexternalId
/ systemName
pair and if an import matches an existing pair, it will update (Hint: consider how to rebuild the externalId when you want to update videos). The video import in Livingdocs is asynchronous. You post a batch of videos that you want to import and get back an id with which you can query later to get your result.Use Cases
Endpoint
POST /api/v1/import/videos
Parameters
Name | Type | Required | Notes |
---|---|---|---|
systemName | string | x | Identifier for the system you are importing from, e.g. an archive |
webhook | uri | Endpoint at the importing system that gets notified by POST when import job is done. Notification contains the id of the import job, the state and an overview. | |
context | object | An object that is passed as context in the body of the request to the webhook. Limited to 8192 Bytes. | |
videos | array | x | An array of videos to import. Each entry is an object with the following keys, all of which are required:
|
Example Request
{
"systemName": "identifier-for-your-system",
"webhook": "https://my-domain.com/webhooks/video-import",
"context": {
"myIdentifier": "some-identifier-sent-to-the-webhook"
},
"videos": [
{
"url": "https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4",
"id": "123abc",
"fileName": "foo",
"metadata": {
"title": "sample video",
"credit": "LC"
}
}
]
}
Response
Required scope:
public-api:write
Description
You can use this endpoint to check for the status and/or result of a video import.Endpoint
GET /api/v1/import/videos/status
Parameters
Name | Type | Required | Notes |
---|---|---|---|
?id | string | x | The id that Livingdocs provided you for your prior call to /api/v1/import/videos |