Create a Project Baseline
post
/primeapi/restapi/action/createBaseline
Send a request to this endpoint to create a project baseline. Baselines are static representations of project plans against which project performance may be benchmarked or measured.
Request
Supported Media Types
- application/json
A baseline time phased data object.
Root Schema : ApiEntityBaseline
Type:
Show Source
object
-
description(optional):
string
A detailed summary for the baseline or snapshot.
-
isBaseline(optional):
boolean
Indicates whether or not an object is a baseline.
-
link(optional):
string(url)
Read Only:
true
-
name:
string
Name for the baseline or snapshot.
-
projectBaselineId(optional):
integer(int64)
The system-generated identifier of a baseline.
-
projectId:
integer(int64)
The unique identifier for the project.
-
snapshotCode(optional):
string
Read Only:
true
Code for the baseline or snapshot. -
snapshotId(optional):
integer(int64)
The unique identifier for a baseline or snapshot.
-
status(optional):
string
Allowed Values:
[ "CURRENT", "ORIGINAL", "IN_PROGRESS", "FAILED" ]
Identifies the original and current baselines.
Original: The baseline that locks down all original values, marking the starting point for requiring change requests for modifications to Scope Items, Work Packages, and Scope Assignments.
Current: The latest baseline set when there is an original baseline. This is also referred to as the active baseline.
Blank: A blank field indicates this is a snapshot, which could be record of a previous baseline or a saved 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 : ApiEntityBaseline
Type:
Show Source
object
-
description(optional):
string
A detailed summary for the baseline or snapshot.
-
isBaseline(optional):
boolean
Indicates whether or not an object is a baseline.
-
link(optional):
string(url)
Read Only:
true
-
name:
string
Name for the baseline or snapshot.
-
projectBaselineId(optional):
integer(int64)
The system-generated identifier of a baseline.
-
projectId:
integer(int64)
The unique identifier for the project.
-
snapshotCode(optional):
string
Read Only:
true
Code for the baseline or snapshot. -
snapshotId(optional):
integer(int64)
The unique identifier for a baseline or snapshot.
-
status(optional):
string
Allowed Values:
[ "CURRENT", "ORIGINAL", "IN_PROGRESS", "FAILED" ]
Identifies the original and current baselines.
Original: The baseline that locks down all original values, marking the starting point for requiring change requests for modifications to Scope Items, Work Packages, and Scope Assignments.
Current: The latest baseline set when there is an original baseline. This is also referred to as the active baseline.
Blank: A blank field indicates this is a snapshot, which could be record of a previous baseline or a saved 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.