Schedule Operation

Description: Asynchronously schedules a project.

Service: Job Service

Style: Document/literal wrapped

Input:

Message: Schedule

Elements:


 Field


 Type


 Description

ProjectObjectId

int

A comma separated list of the unique identifiers of the projects to be scheduled. If more than one identifier is supplied, the schedule operation will use the scheduling options of the first project in the list.

EPSObjectId

int

A comma separated list of the unique identifiers of the EPS nodes to be scheduled. You must also supply at least one ProjectObjectId to determine which project's scheduling options should be honored.

PortfolioObjectId

int

A comma separated list of the unique identifiers of the portfolios to be scheduled. You must also supply at least one ProjectObjectId to determine which project's scheduling options should be honored.

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

JobStatusType

string
restricted to
'Pending'
'Running'
'Complete'
'Failed'
'Cancelled'
'Completed With Errors'

 

Specifies the status of the job.



Legal Notices | Your Privacy Rights
Copyright © 2008, 2023

Last Published Wednesday, February 1, 2023