Skip to content

deleteActivityByClientRef

Supported, no replacement yet

This endpoint remains fully supported. No replacement exists in the new API yet, and no action is needed. When a replacement ships you will get 12 months' notice, and this site will be updated.

Reference


/rest/workflow/activity/deleteActivity/{clinetId}/{jobClientRef}/{activityClientRef}/{submitVersion}

DELETE

Deletes the specific activity from the specified jobs.    Looks up the most current version of the job by client ref.  If activityRef is set to -1 all activities on that job are deleted.  If versioning is enabled and the user has the VERCS rights a new version will be created.    

If versioning is enabled and the user doesn't have the rights to create a version an error message will be returned.  If versioning is not enabled the activities will be added without a version being created.

If the submitVersion flag is set to 1 the version will also be submitted (if versioning is switched on).  If set to 0 the version will not be submitted.  If versioning is switched off the submitVersion flag will be ignored.

If activity for given activityRef is not -1 and the activity could not be found NotFound (404) response will be returned.

NOTE: activityClientRef and jobClientRef - need to be URL safe (no characters like '/' etc)

acceptable request representations:

  • delete

/rest/workflow/activity/deleteActivity/234Ref/JCR345/12/1
available response representations:
  • 200 - application/json
{
  "result" : "success or fail",
  "result_msg" : "error message"
}


See the Workflow API matrix for the full list of endpoints in this category.