Jump to

• Request
• Response

View Snapshots by Budget Plan ID

get

/api/restapi/action/snapshot/capitalPlan/{capitalPlanId}

Send a request to this endpoint to view snapshots associated to a budget plan with an ID value matching the value of the {id} path parameter. Budget plan snapshots capture the state of an approved budget plan at a particular point in time. Use budget plan snapshots to capture the history of a portfolio budget plan and monitor the progress of projects included in the plan.

Request

Path Parameters

• capitalPlanId(required): integer(int64)
  View Budget Plan Snapshots

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityCapitalPlanSnapshot>

Type: array

Title: List<ApiEntityCapitalPlanSnapshot>

Show Source

• Array of: object ApiEntityCapitalPlanSnapshot
  Title: ApiEntityCapitalPlanSnapshot

{
    "title":"List<ApiEntityCapitalPlanSnapshot>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCapitalPlanSnapshot",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCapitalPlanSnapshot

Type: object

Title: ApiEntityCapitalPlanSnapshot

Show Source

• capitalPlanId: integer (int64)
  The unique identifier of a budget plan.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  A detailed summary for the baseline or snapshot.
• 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.
• snapshotCode: string
  Maximum Length: 60

  Code for the baseline or snapshot.
• snapshotId: integer (int64)
  The unique identifier for a baseline or snapshot.
• time: string (date-time)
  The time at which the snapshot was generated.
• type: string
  Allowed Values: [ "CAPITAL_PLAN", "PROJECT", "PROGRAM", "IDEA" ]

  Identifies the type of the baseline. Valid values are Original, Current, or Blank. Original baselines mark the starting point for recurring change requests for modifications to Scope Items, Work Packages, and Scope Assignments. Current baselines indicate the latest set baseline when a related original baseline exists. Blank baselines indicate the baseline is a snapshot.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityCapitalPlanSnapshot",
    "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":"Identifies the type of the baseline. Valid values are Original, Current, or Blank. Original baselines mark the starting point for recurring change requests for modifications to Scope Items, Work Packages, and Scope Assignments. Current baselines indicate the latest set baseline when a related original baseline exists. Blank baselines indicate the baseline is a snapshot.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CAPITAL_PLAN",
                "PROJECT",
                "PROGRAM",
                "IDEA"
            ]
        },
        "time":{
            "type":"string",
            "description":"The time at which the snapshot was generated.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"A detailed summary for the baseline or snapshot.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "capitalPlanId":{
            "type":"integer",
            "description":"The unique identifier of a budget plan.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "snapshotId":{
            "type":"integer",
            "description":"The unique identifier for a baseline or snapshot.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "snapshotCode":{
            "maxLength":"60",
            "type":"string",
            "description":"Code for the baseline or snapshot.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested portfolio snapshot transfer does not exist or you do not have access to it.

Back to Top