Rollback Activity Instances

API Type

REST

HTTP Method

POST

Description

Rolls back a process instance according to a specified instruction. The class WFPartialRollbackInstructionis used to specify detailed information about the instruction.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/RollbackActivityInsts

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/RollbackActivityInsts

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
instruction	Definition: Specifies the instructions for the partial rollback. Type WFPartialRollbackInstruction Allowed Values: A WFPartialRollbackInstruction object.

JavaScript Code Example

$("#btnRollbackActivityInsts").click(function () {
  
 var JSONData = {"PartialRollbackUnits":
    [{"DestinationActivityInstanceID":"DF93620D4ED14458B60857C4EA862702",
    "SourceActivityInstanceIDs":["575CB3B3C2EB495B884B0AD1505D4E0A"]}
    ]};
 
  $.ajax({
    url: 'http://mydomain:9011/AgilePointServer/Workflow/RollbackActivityInsts',
    data: JSON.stringify(JSONData)
  });

});

Output

WFEvent object that provides the status of the transaction. The possible statuses are:

Sent - Indicates event has been sent to engine for processing.
Failed - Indicates event failed to process.
Processed - Indicates event has been processed successfully.
Canceled - Indicates event was canceled.
Deferred - Indicates event does not need to be sent immediately.

JSON Response Body Example

{
  "ActivityInstID":"String content",
  "AutoStart":true,
  "CustomAttributes":[{
    "Name":"String content",
    "Value":{
      "NameValue":{
        "Name":"String content",
        "Value":{
          "NameValue":null
        }
      }
    }
  }],
  "Diagnostic":true,
  "EndDate":"\/Date(928149600000+0000)\/",
  "Entries":2147483647,
  "Error":"String content",
  "EventID":"String content",
  "EventName":"String content",
  "HighPriority":true,
  "ParamsXml":"String content",
  "ParentProcInstID":"String content",
  "ProcDefID":"String content",
  "ProcInstID":"String content",
  "ProcInstName":"String content",
  "Sender":"String content",
  "SentDate":"\/Date(928149600000+0000)\/",
  "SourceWorkItemID":"String content",
  "Status":"String content",
  "TenantID":"String content",
  "UserID":"String content",
  "WorkItemID":"String content",
  "WorkObjectID":"String content",
  "WorkObjectInfo":"String content"
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher