Campaign Manager API

RemoveBatchFromExecutive

This method Removes a batch from the executive. The batch must be in the COMPLETE state before it can be removed. Its signature is:

void RemoveBatchFromExecutive(
   string cmServer,
   string campaignID,
   string batchID,
   UserInfo userInfo
);

Method Parameters

Parameters for this method are shown in the following table.

Parameter

Description

Type

Valid Input

cmServer

The DeltaV node where the Campaign Manager server is located

String

Name of node 

campaignID

Name of the campaign

String

Campaign node

batchID

The batch identifier

String

The batch identifier

userInfo

Credentials of the user. Can be null if not required

UserInfo

UserInfo instance or null