Link relation ia:copy-queue-stories

Overview

Copy stories from this queue to queue with destination ID.

HTTP method

POST

URI template variables

-

Query parameters

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 "copy" for this action.

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

  • destination, The id of the target queue. Can be the same queue to duplicate stories in the queue.

  • destinationSystemID, The id of the target system, to copy stories between newsroom systems that are connected to the same CloudUX.

  • position, The id of the story where to insert new stories. For queue with INVERTED attribute it inserts stories after specified story, if not INVERTED - before specified story. If this property is ommited stories will be placed into beginning of the queue for INVERTED queue and into the end for not INVERTED queue.

HTTP response

200 OK

Response body

Available in

Description

Copy stories from this queue to queue with destination ID.

Examples

Example:

{
  "op": "copy",
  "stories": ["queue1_story5", "queue1_story6"],
  "destination": "QUEUE2"
}

For QUEUE2 with INVERTED attribute will result to:

QUEUE1 QUEUE2

…​

queue1_story6

queue1_story5

queue1_story5

queue1_story6

queue2_story4

…​

…​

For QUEUE2 without INVERTED attribute will result to:

QUEUE1 QUEUE2

…​

…​

queue1_story5

queues_story4

queue1_story6

queue1_story5

…​

queue1_story6

Example:

{
  "op": "move",
  "stories": ["queue1_story5", "queue1_story6"],
  "destination": "QUEUE2",
  "position": "queue2_story3"
}

For QUEUE2 with INVERTED attribute will result to:

QUEUE1 QUEUE2

…​

…​

queue1_story4

queue2_story3

queue1_story5

queue1_story6

queue1_story6

queue1_story5

queue1_story7

queue2_story2

…​

…​

For QUEUE2 without INVERTED attribute will result to:

QUEUE1 QUEUE2

…​

…​

queue1_story4

queue2_story2

queue1_story5

queue1_story5

queue1_story6

queue1_story6

queue1_story7

queue2_story3