GetJobStatus (Stateless)

Method

GetJobStatus(ClientConnectInfo connectinfo, JobStatusParameters parameters)

This method is used to get the status of an existing 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.

JobStatusParameters

An instance of JobStatusParameters is passed into the GetJobStatus method. It includes the contextual information required to get the status of an existing job.

Constructors

JobStatusParameters()

JobStatusParameters(Guid jobId)

Properties

Data Type	Property	Description
Guid	JobId	Returns or sets the ID of the job to retrieve the status of.
bool	OmitResults	Returns or sets whether results for each parameter should be omitted.

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

JobStatusResult

An instance of JobStatusResult is returned by the GetJobStatus method. It contains information about a specified job.

Properties

Data Type	Property	Description
DateTime	ModifiedDate	Returns a timestamp for the last change made as a result of the job.
JobStatus	Status	Returns a value indicating the status of the specified job.
Int	ParametersCurrentIndex	Returns a value indicating which parameter is being executed.
Int	ParametersRemaining	Returns a value indicating the remaining number of parameters to execute.
Int	ParametersTotal	Returns a value indicating the total number of parameters in the job.
ConfigurationResult[]	Results	Returns an array containing information about each executed parameter.

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.