Media

Deprecated

Create a Docviewer or Notorious item (DEPRECATED)

post

DEPRECATED: This endpoint will be removed. Only to be invoked via CCM (Common Cartridge Manager) to create a media object for previewing. This endpoint will not be allowed for any other requestor.

Example:

  curl -X POST -H "Authorization: Basic dev" -H "Content-Type: application/json" --data @data.json "https://lor.instructure.com/api/media"
  data.json:
  {
    "callbackUrl": "wwww.callback-when-finished-url.com",
    "fileName": "name-of-file.pdf",
    "fileUrl": "www.path-to-file.com"
  }

Body

callbackUrlstringRequired

URL for callback on media creation success

fileNamestringRequired

Desired name of file

fileUrlstringRequired

Valid URL for resource to be processed

Responses

200

Media creation request accepted

application/json

4XX

Bad Request

application/json

post

HTTPcURLJavaScriptPython

POST /api/media HTTP/1.1
Host: lor.instructure.com
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "callbackUrl": "wwww.callback-when-finished-url.com",
  "fileName": "name-of-file.pdf",
  "fileUrl": "www.path-to-file.com"
}

{
  "sqsMessageId": "text"
}