Knowledge Base - API

CreateJob

Method

CreateJob(CreateJobParameters parameters)

Creates a new job for the specified header record in the integration system.

Parameters

The CreateJob() method requires the parameters parameter of type CreateJobParameters.

CreateJobParameters

An instance of CreateJobParameters is passed into the CreateJob method to provide the necessary information for a new job.

Properties

Data Type

Property

Description

Bool

ContinueOnError

Returns or sets job behavior after encountering an error. If true, the job will proceed after encountering an error.

ParametersBase[]

Parameters

Returns or sets an array of parameters to execute.

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

CreateJobResult

An instance of CreateJobResult is returned by the CreateJob method. It does not contain any unique properties.

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.