Method
CancelJob(ClientConnectInfo connectinfo, CancelJobParameters parameters)
This method cancels an in-progress job.
Parameters
ClientConnectInfo
The ClientConnectInfo class represents the base type for parameters needed to connect to the integration environment.
Properties
The following table outlines properties included in the base ClientConnectInfo class and all ClientConnectionInfo-derived classed used to connect to specific host systems.
|
Data Type |
Property |
Description |
|---|---|---|
|
string |
AuthUserName |
Returns or sets the user name to authenticate the caller to the service. The most common case will be that the user account specified here will be used as the service account for the backing service (such as the CRM web services); any existing server-side credentials will be ignored. |
|
string |
AuthPassword |
Returns or sets the password to authenticate the caller to the service. |
CancelJobParameters
An instance of CancelJobParameters is passed into the CancelJob method to identify the specific job that should be canceled.
Constructors
CancelJobParameters()
CancelJobParameters(Guid jobId)
Properties
|
Data Type |
Properties |
Description |
|---|---|---|
|
Guid |
JobId |
Returns or sets the ID of the job to cancel. |
Inheritance
JobParameters
The JobParameters class is an abstract class utilized by other parameter classes relating to job methods. It does not contain any unique properties.
Returns
CancelJobResult
An instance of CancelJobResult is returned from the CancelJob method.
Properties
|
Data Type |
Property |
Description |
|---|---|---|
|
Status
Valid values include:
|
The current status of the specified job. |
Inheritance
JobResult
The JobResult class is utilized by various job subclasses. It offers information about the ID of the job being worked with and the date of its creation.
Properties
|
Data Type |
Property |
Description |
|---|---|---|
|
Guid |
JobId |
Returns or sets the unique ID of the specified job. |
|
DateTime |
CreatedDate |
Returns or sets the date the specified job was created. |