View Project Baseline By Name
get
/api/restapi/action/baseline
Send a request to this endpoint to get the project baseline by its name.
Request
Query Parameters
-
name(required): string
The user-specified identifier of a project baseline.
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 TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityBaseline
Type:
object
Title:
Show Source
ApiEntityBaseline
-
baselineCategoryId: integer
(int64)
The system-generated unique identifier of a baseline category.
-
baselineCategoryName: string
Minimum Length:
1
Maximum Length:255
The name of the baseline category. -
dataDate: string
(date-time)
The progress point, or "as-of date", for activities in the project. Project status is up-to-date as of the data date. You can set the data date when you schedule the project, or you can set it manually.
The data date is also used for updating the dates of scope assignments and work packages when they are not linked to activities. -
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. -
projectBaselineId: integer
(int64)
The system-generated identifier of a baseline.
-
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.
-
status: string
Allowed Values:
[ "IN_PROGRESS", "FAILED", "COMPLETE" ]
The status of the baseline process. Valid values are: In Progress, Failed, and Complete. -
time: string
(date-time)
The time at which the snapshot was generated. Allowed format is "yyyy-MM-dd'T'HH:mm:ss.Z".
-
type: string
Allowed Values:
[ "ORIGINAL", "CURRENT", "OTHER", "NONE" ]
Identifies the official and unofficial baselines.
Original: A copy of the original project schedule, against which you can evaluate project progress. The original baseline locks down all original values. It marks the starting point for requiring change requests for modifications to Scope Items, Work Packages, and Scope Assignments.
Current: A copy of the latest project schedule. It can only be set when there is an original baseline. This is also referred to as the active baseline.
Other: A third official baseline that can be used for any purpose.
Blank: A blank field indicates this is an unofficial baseline, which could become an official baseline if desired. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
404 Response
The requested object does not exist, or you do not have access to it.