Jump to

• Request
• Response

View a Schedule Scenario By Name

get

/api/restapi/scheduleScenario

Send a request to this endpoint to view the schedule scenario by its name.

Request

Query Parameters

• name(required): string
  The user-specified unique identifier of a schedule scenario.
  This is a required field.
• projectCode(required): string
  The user-specified identifier of a project.
  This is a required field.
• workspaceCode(required): string
  The user-specified identifier of a workspace.
  This is a required field.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityScheduleScenario

Type: object

Title: ApiEntityScheduleScenario

Show Source

• description: string
  Minimum Length: 0

  Maximum Length: 4000

  A detailed summary for the baseline or snapshot.
• hidden: boolean
  Indicates if a scenario is hidden on the Activities page.
• 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.

{
    "title":"ApiEntityScheduleScenario",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "name":{
            "maxLength":255,
            "type":"string",
            "description":"Name for the baseline or snapshot.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "type":{
            "type":"string",
            "description":"The type of the scenario. A scenario can have a type of What-if, Closed, or Retired.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "WHAT_IF",
                "RETIRED",
                "CLOSED"
            ]
        },
        "time":{
            "type":"string",
            "description":"The time at which the scenario was generated. Allowed format is \"yyyy-MM-dd'T'HH:mm:ss.Z\".",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "status":{
            "type":"string",
            "description":"The status of the scenario. A scenario can have a status of In Progress, Failed, or Complete.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "IN_PROGRESS",
                "FAILED",
                "COMPLETE"
            ]
        },
        "scenarioId":{
            "type":"integer",
            "description":"The system-generated unique identifier of the schedule scenario.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "hidden":{
            "type":"boolean",
            "description":"Indicates if a scenario is hidden on the Activities page.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "sourceDescription":{
            "type":"string",
            "description":"The source of the schedule scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"A detailed summary for the baseline or snapshot.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of the project's workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested object does not exist, or you do not have access to it.

Back to Top