minimusdocs
Help center

TV shows

Match files to a TV show's episodes

POST/tv/series/{id}/import/plan/

write Change: creates or edits. Scopes

Lists the files at a source and says which season and episode each looks like; nothing is created. source: node (server and a path in its incoming folder), s3 (storage and a path prefix), url (urls, one link per line) or upload (files: [{name, size}]). Send the reviewed list to …/import/.

Path parameters

  • idstring (uuid)required

    The TV show's id.

Body

  • sourcestringrequired
    • node - node
    • s3 - s3
    • url - url
    • upload - upload

    One of: "node" "s3" "url" "upload"

  • serverstring (uuid)can be null
  • storagestring (uuid)can be null
  • pathstring
  • urlsstring
  • filesobject[]

Response

200 OK

  • itemsobject[]required
    • refstringrequired

      What to send back in items: a path, key or link.

    • namestringrequired
    • sizeintegerrequired
    • seasonintegerrequiredcan be null
    • episodeintegerrequiredcan be null
    • matchedbooleanrequired

      A season and episode were read from it.

    • duplicatebooleanrequired

      An earlier file claims the same episode.

    • existingobjectrequiredcan be null

      The episode the show already has there.

      • idstring (uuid)required
      • namestringrequired
      • mediastringrequiredcan be null

        Its file's state, null without one.

  • ignoredintegerrequired

    Files left out: not video files.

  • truncatedbooleanrequired

    The source holds more than limit files.

  • limitintegerrequired

Errors

  • 400 Something sent is not valid. Each field that is wrong is named with what is wrong.
  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 404 Nothing with this id, or nothing the account can see.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.
  • 502 The server or the bucket could not be read.

What each error means