Knowledge Base - API

CreateJob (Stateless)

Method

CreateJob(ClientConnectInfo connectinfo, CreateJobParameters parameters)

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

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.

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.