batch action

Description

Run a batch action on a specified list of objects. This service starts an Asynchronous process.

The type of object and action are defined in the URL as explained as follows.

Object

The {object} URL parameters defines type of object to run the action on, can be:

• uri – documents
• xlink– comments, tasks or workflows

Action

The {action} URL parameter defines the name of the action to run against the specified object type.

It can be one of:

• addlabel
• removelabel
• addversion
• addworkflow
• move
• archive
• usageschema
• usagereport
• validate
• publish

Parameters

Action-specific parameters

Some parameters are only applicable to specific actions, use the following table as guide:

ids

This parameter is a comma-separated list of IDs of each of the objects to process.

All the specified IDs are for objects of the same type, based on the {object} URL parameter. For example, URI ID when the object type is uri. Comment ID or task definition IDs when the object type is xlink.

Action parameters

All the parameters starting with action.* are parameter for the batch action.

Workflow parameters

The action.assignedto, action.due, action.priority, and action.status only apply to the addworkflow action. They have no effect when used with different actions.

When any of them is not specified, the corresponding document workflow value is left unchanged. For example, if the action.priority is not specified, the priority of the matching workflows is left unchanged.

An empty value can be used for the action.assignedto, action.due, and action.priority parameters to remove the value. For example, if action.priority is specified but empty, the matching workflows no longer have a priority value.

Permission

The minimum permission depends on the action and the object as follows:

• administrator: for actions usageschema, usagereport.
• approver: for action addversion.
• manager: for actions addlabel, removelabel on xlink objects where they are not the comment author.
• contributor: for actions addworkflow, move, archive. Also addlabel, removelabel on uri objects and xlink objects where they are the comment author.
• member: for actions validate, publish.

(1) On xlink objects, contributors can only add or remove labels if they are the author of the comment.

Response

<batch-action name="[action]"
              object="[object]"
              ids="[ids]">
 [<thread ...> ... </thread>|
  <check>
    <publish id="[job ID]">
      <parameters> ... </parameters>
      <status>in-progress</status>
      <message logged="false"
               type="in-progress"
               target="starting"
               progress="0">Publish Job started</message>
    </publish>
  </check>]
</batch-action>

Error Handling

No specific errors expected for this service.