minimusdocs
Help center

Streams

Find or remove logos for streams

POST/streams/logos/

write Change: creates or edits. Scopes

action: find gives every stream without a logo (in the selection, if one is given) the one Minimus finds; with mode: auto it also picks again the ones it found before. action: clear takes back the logos the panel added; a logo you set is never touched. Runs in the background. A selection is the streams ticked (ids) or every stream the list filters select (all_matching: true with filters, less exclude).

Body

  • actionstringrequired
    • find - find
    • clear - clear

    One of: "find" "clear"

  • modestring

    Default: "missing"

  • selectionobject

    The streams a bulk action applies to: the ones ticked (ids), or every stream the list filters select (all_matching: true with filters, which take the list's query parameters), less exclude.

    • idsstring (uuid)[]
    • all_matchingboolean

      Default: false

    • filtersobject
    • excludestring (uuid)[]

Response

202 The background task changing the logos.

  • idstringrequired
  • kindstringrequired

    The kind of task, e.g. bulk_edit, bulk_delete, import.

  • kind_labelstringrequired
  • titlestringrequired
  • subtitlestringrequired
  • statestringrequired

    queued, running, waiting, stalled, completed, failed or cancelled.

  • state_labelstringrequired
  • statusstringrequired

    The task's own status, before it is grouped into state.

  • status_labelstringrequired
  • progressobjectrequired
    • doneintegerrequiredcan be null
    • totalintegerrequiredcan be null
    • percentintegerrequiredcan be null

      0 to 100, null while unknown.

    • phasestringrequired

      What it is doing now, in words; may be empty.

  • messagestringrequired
  • detailsobject[]required
  • errorsobject[]required
  • linkobjectrequiredcan be null

    The dashboard page about it: {path, query, label}, or null.

  • actionsstring[]required

    What the caller may do with it now: cancel, resume, retry.

  • created_by_usernamestringrequiredcan be null
  • created_atstring (date-time)required
  • started_atstring (date-time)requiredcan be null
  • finished_atstring (date-time)requiredcan be null
  • updated_atstring (date-time)required

Errors

  • 400 No stream needs this.
  • 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.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means