minimusdocs
Help center

Streams

Preview renaming many streams

POST/streams/bulk-edit/rename-preview/

write Change: creates or edits. Scopes

What a renaming rule would do to the selection, writing nothing: counts, the first names before and after, the ones refused because the new name is taken, and how many follow a provider's names. The rename itself is a bulk edit with changes.rename. A selection is the streams ticked (ids) or every stream the list filters select (all_matching: true with filters, less exclude).

Body

  • selectionobjectrequired

    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)[]
  • renameobjectrequired

    One renaming rule. Every key is optional; at least one must change something.

    • remove_codeboolean

      Default: false

    • remove_qualityboolean

      Default: false

    • remove_prefixstring[]
    • remove_suffixstring[]
    • replaceobject[]
      • findstringrequired
      • tostring
      • patternboolean

        Default: false

    • casestring

      Default: "keep"

    • tidyboolean

      Default: true

    • add_prefixstring
    • add_suffixstring
    • stop_name_syncboolean

      Default: false

Response

200 OK

  • totalintegerrequired
  • changedintegerrequired
  • unchangedintegerrequired
  • refusedintegerrequired
  • followingintegerrequired

    Streams that follow a provider's names.

  • rowsobject[]required
  • refused_rowsobject[]required

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

What each error means