Create a Budget Plan Snapshot
post
/primeapi/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
Supported Media Types
- application/json
JSON representation of a budget plan object.
Root Schema : ApiEntityCapitalPlanSnapshot
Type:
Show Source
object
-
capitalPlanId:
integer(int64)
The unique identifier of a budget plan.
-
description(optional):
string
A detailed summary for the baseline or snapshot.
-
link(optional):
string(url)
Read Only:
true
-
name:
string
Name for the baseline or snapshot.
-
snapshotCode(optional):
string
Read Only:
true
Code for the baseline or snapshot. -
snapshotId(optional):
integer(int64)
The unique identifier for a baseline or snapshot.
-
time(optional):
object TimezoneSensitiveDateTime
-
type(optional):
string
Read Only:
true
Allowed Values:[ "CAPITAL_PLAN", "PROJECT" ]
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(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityCapitalPlanSnapshot
Type:
Show Source
object
-
capitalPlanId:
integer(int64)
The unique identifier of a budget plan.
-
description(optional):
string
A detailed summary for the baseline or snapshot.
-
link(optional):
string(url)
Read Only:
true
-
name:
string
Name for the baseline or snapshot.
-
snapshotCode(optional):
string
Read Only:
true
Code for the baseline or snapshot. -
snapshotId(optional):
integer(int64)
The unique identifier for a baseline or snapshot.
-
time(optional):
object TimezoneSensitiveDateTime
-
type(optional):
string
Read Only:
true
Allowed Values:[ "CAPITAL_PLAN", "PROJECT" ]
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(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
400 Response
Invalid input for the Action service.