Jump to

• Request
• Response

Create a Budget Plan Snapshot

post

/api/restapi/action/capitalPlanSnapshot

Send a request to this endpoint to create a budget plan snapshot. 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

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityCapitalPlanSnapshotInput

Type: object

Title: ApiEntityCapitalPlanSnapshotInput

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)
  Read Only: true

  Deprecated. As of 23.10.
  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
  Read Only: true

  Maximum Length: 60

  Deprecated. As of 24.4.
  Code for the baseline or snapshot.
• snapshotId: integer (int64)
  The unique identifier for a baseline or snapshot.
• time: string (date-time)
  Read Only: true

  Deprecated. As of 24.4.
  The time at which the snapshot was generated.
• type: string
  Read Only: true

  Allowed Values: [ "CAPITAL_PLAN", "PROJECT", "PROGRAM", "IDEA" ]

  Deprecated. As of 24.4.
  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)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityCapitalPlanSnapshotInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "name":{
            "maxLength":"255",
            "type":"string",
            "description":"Name for the baseline or snapshot.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "type":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>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.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CAPITAL_PLAN",
                "PROJECT",
                "PROGRAM",
                "IDEA"
            ]
        },
        "time":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>The time at which the snapshot was generated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "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":"<b>Deprecated.</b> As of <i>24.4</i>.</br>Code for the baseline or snapshot.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Create a Budget Plan Snapshot

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root 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
}

400 Response

Invalid input for the Action service.

Back to Top