Schedule Operation
Description: Asynchronously schedules a project.
Service: Job Service
Style: Document/literal wrapped
Input:
Message: Schedule
Elements:
|
|
|
|---|---|---|
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. The unique identifier must must match the value of the EPS ProjectObjectId field and can be identified by running the ReadEPS operation. If no ProjectObjectId is provided, the schedule operation will use the scheduling options of the first project in the EPS (according to the default sorting of proj_short_name). |
PortfolioObjectId | int | A comma separated list of the unique identifiers of the portfolios to be scheduled. You must also supply at least one ProjectObjectId or EPSObjectId to determine which project's scheduling options should be honored. |
ProjectCodeObjectId | int | A comma separated list of the unique identifiers of the project code values you want to use to select the projects you want to schedule. You must also supply at least one ProjectObjectId or EPSObjectId to determine which project's scheduleing 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:
|
|
|
|---|---|---|
JobId | string | The unique identifier of the job. |
JobStatus |
| Specifies the status of the job. |
Last Published Thursday, April 3, 2025