Create a Schedule Scenario
post
/api/restapi/scheduleScenario
Send a request to this endpoint to create a schedule scenario.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityScheduleScenarioInput
Type:
object
Title:
ApiEntityScheduleScenarioInput
This entity represents a ScheduleScenario object, a unique ScheduleScenario object can be identified by the following combinations of the fields.
Show Source
- scenarioId
- name,projectId
- name,projectCode,workspaceCode
-
description: string
Minimum Length:
0
Maximum Length:4000
A detailed summary for the baseline or snapshot. - hidden: boolean
-
name(required): string
Maximum Length:
255
Name for the baseline or snapshot. -
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectId(required): integer
(int64)
The unique identifier for the project.
-
scenarioId: integer
(int64)
The system-generated unique identifier of the schedule scenario.
-
sourceName: string
Name of baseline or scenario.
-
sourceType: string
Allowed Values:
[ "BASELINE", "SCENARIO", "CURRENT_SCHEDULE", "FROM_HISTORY" ]
The source type of the schedule scenario. Default Value is CURRENT_SCHEDULE. -
time: string
(date-time)
The time at which the scenario was generated. Allowed format is "yyyy-MM-dd'T'HH:mm:ss.Z".
-
type: string
Allowed Values:
[ "WHAT_IF", "RETIRED", "CLOSED" ]
The type of the scenario. A scenario can have a type of What-if, Closed, or Retired. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of the project's workspace.
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityScheduleScenario
Type:
object
Title:
Show Source
ApiEntityScheduleScenario
-
description: string
Minimum Length:
0
Maximum Length:4000
A detailed summary for the baseline or snapshot. - hidden: boolean
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
name: string
Maximum Length:
255
Name for the baseline or snapshot. -
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
scenarioId: integer
(int64)
The system-generated unique identifier of the schedule scenario.
-
sourceDescription: string
The source of the schedule scenario.
-
status: string
Allowed Values:
[ "IN_PROGRESS", "FAILED", "COMPLETE" ]
The status of the scenario. A scenario can have a status of In Progress, Failed, or Complete. -
time: string
(date-time)
The time at which the scenario was generated. Allowed format is "yyyy-MM-dd'T'HH:mm:ss.Z".
-
type: string
Allowed Values:
[ "WHAT_IF", "RETIRED", "CLOSED" ]
The type of the scenario. A scenario can have a type of What-if, Closed, or Retired. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of the project's workspace.
400 Response
Invalid input for the Schedule Scenario service. Verify the request contains valid data, then resubmit the request.