Link relation ia:delete-queue-stories

Overview

Delete the stories in this queue

HTTP method

POST

URI template variables

Query parameters

force

Put true to delete stories ignoring errors and return verbose results of operation, false by default.

qkey

Password for key-locked queue.

Request body

In the request body, supply data with the following structure:

  • op, Operation to do on the list of stories. Should be "delete" for this action.

  • stories, List of asset IDs. Also can be a string "all" to do an action on all stories in the queue.

  • stories_keys, List of the passwords for key-locked stories.

Example:

{
  "op": "delete",
  "stories": ["queue1_story3", "queue1_story4"]
}

HTTP response

200 OK

Response body

An ia:queue-stories resource.

If force parameter is true, response will look like the following:

{
    "results": [
        {
            "id": "TEST.QUEUE..522036966.208234.12",
            "deleted": true,
            "error": null
        }
    ],
    "_links": {
        "self": {
            "href": "https://host/..."
        }
    }
}

Available in