Web service API

How to use PageSeeder's Web service API

batch action search

/members/{member}/groups/{group}/batch/{object}/{action}/search [POST]

com.pageseeder.action.RunBatchActionOnSearchResults

Description

Run batch action using search results where the following values are allowed in the URL:

  • object: The type of object to run the action on, can be: "uri", "xlink" ("xlink" only supports actions "addlabel" and "removelabel" and it means a comment, task or workflow).
  • action: The name of the action to run, can be: "addlabel", "removelabel", "addversion", "addworkflow", "move", "archive", "usageschema", "usagereport", "validate", "publish"

This generator does the same as the RunBatchAction  generator but uses the search results to load the ids, using the psid field from each result or the pstaskdefinitionid field for tasks and workflows.

Parameters

NameDescriptionRequiredTypeDefault value
filtersA comma-separated list of field:term pairs to use as filtersnostrings
questionThe question to search fornostring
questionfieldsA comma-separated list of fields to search the question innostringspstitle,pscontent
questionoperator
rangesA comma-separated list of range searchesnostrings
action.assignedtoID of assigned member for workflow - '' means remove (addworkflow only)nostringprevious workflow assigned member
action.comment-groupsThe comma separated list of groups to add comments from current group to (move only)nostring
action.contentThe content as plain text of the version (addversion and addworkflow only)conditionalstring
action.destination-guriidThe the destination folder guri id - required if no uriid (move only)conditionalstring
action.destination-uriidThe the destination folder uri id - required if no guriid (move only)conditionalstring
action.document-typeThe document type to save the schema under (usageschema only)nostring
action.dueWorkflow due date format is yyyy-MM-dd - '' means remove (addworkflow only)nostringprevious workflow due date
action.labelsA comma-separated list of labels to add to the version (addlabel, removelabel, addversion and addworkflow only)conditionalstring
action.log-levelThe level of logging the script should output, can be "info", "verbose", "warn", "error", "debug" (publish only)nostring
action.notifythe notification behavior %normal|announce|minimal|silent (addversion and addworkflow only)nostringsilent
action.param.*Publish script parameters (publish only)nostring
action.priorityPriority for workflow e.g. 'High', 'Medium', 'Low' - '' means remove (addworkflow only)nostringprevious workflow priority
action.projectThe current project (publish only)conditionalstring
action.removexrefsWhether to remove image and outgoing xrefs from the archived documents (archive only)nostringfalse
action.schemaThe name of the schema (usageschema and validate only)conditionalstring
action.search.filtersA comma-separated list of field:term pairs to use as filters (publish only)nostrings
action.search.questionThe question to search for (publish only)nostring
action.search.questionfieldsA comma-separated list of fields to search the question in (publish only)nostrings
action.search.rangesA comma-separated list of range searches (publish only)nostrings
action.statusStatus for workflow e.g. 'Initiated' ,'In Progress', 'Complete', 'Approved', 'Suspended', 'Terminated' (addworkflow only)nostringprevious workflow status
action.targetThe ANT script target (publish only)conditionalstring
action.titleThe version number e.g.: 1.00 (addversion only)conditionalstring
action.typeThe type of script, can be "export", "process", "publish" (publish only)conditionalstring
action.uristatusComma separated list of the status that the URI must have for the workflow to be added (addworkflow only)nostring

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".

Response


   <batch-action name="[action]"
                 object="[object]"
                 ids="[ids]">
     [<thread ...> ... </thread>|
      <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>]
   <batch-action>
 

Error Handling

0x1501 If there is an invalid group specified
0x6502 Missing catalog, please re-index group

Created on , last edited on