Previous Topic

Next Topic

Book Contents

Schedule Operation

Description: Asynchronously schedules a project.

Service: Job Service

Style: Document/literal wrapped

Input:

Message: Schedule

Elements:


 Field


 Type


 Description

ProjectObjectId

int

The unique identifier of the project.

NewDataDate

dateTime

The new data date.

Timeout

int

The amount of time in seconds that the server side will wait for the job service to complete before it returns with the current job status. The Timeout parameter is optional. When you use this operation without specifying a Timeout parameter or with a Timeout of 0, the server immediately returns without waiting for the job service to complete.

Output:

Message: ScheduleResponse

Elements:


 Field


 Type


 Description

JobId

string

The unique identifier of the job.

JobStatus


JobStatusType

string
restricted to
Pending
Running
Complete
Failed
Cancelled

Specifies the status of the job.


Copyright information