Jump to

• Request
• Response

Update Project Baseline

put

/api/restapi/action/baseline

Update a project baseline using either projectBaselineId or the set of parent codes, providing the fields in the body that needs to be updated.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityBaselineInput

Type: object

Title: ApiEntityBaselineInput

This entity represents a Baseline object, a unique Baseline object can be identified by the following combinations of the fields.

• projectBaselineId
• name,projectId
• name,projectCode,workspaceCode

Show Source

• 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)
  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(required): 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(required): integer (int64)
  The unique identifier for the project.
• sourceName: string
  Maximum Length: 255

  Name of baseline or scenario.
• sourceType: string
  Allowed Values: [ "FROM_HISTORY", "BASELINE", "SCENARIO", "CURRENT_SCHEDULE" ]

  Source of the baseline. Default value is CURRENT_SCHEDULE.
• 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)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityBaselineInput",
    "required":[
        "name",
        "projectId"
    ],
    "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":"Identifies the official and unofficial baselines.<br/><b>Original:</b> 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.<br/><b>Current:</b> 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.<br/><b>Other:</b> A third official baseline that can be used for any purpose.<br/><b>Blank:</b> A blank field indicates this is an unofficial baseline, which could become an official baseline if desired.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ORIGINAL",
                "CURRENT",
                "OTHER",
                "NONE"
            ]
        },
        "time":{
            "type":"string",
            "description":"The time at which the snapshot was generated. Allowed format is \"yyyy-MM-dd'T'HH:mm:ss.Z\".",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "status":{
            "type":"string",
            "description":"The status of the baseline process. Valid values are: In Progress, Failed, and Complete.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "IN_PROGRESS",
                "FAILED",
                "COMPLETE"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"A detailed summary for the baseline or snapshot.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "baselineCategoryId":{
            "type":"integer",
            "description":"The system-generated unique identifier of a baseline category.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "baselineCategoryName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the baseline category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectBaselineId":{
            "type":"integer",
            "description":"The system-generated identifier of a baseline.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dataDate":{
            "type":"string",
            "description":"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. <br />The data date is also used for updating the dates of scope assignments and work packages when they are not linked to activities.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "sourceType":{
            "type":"string",
            "description":"Source of the baseline. Default value is CURRENT_SCHEDULE.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "FROM_HISTORY",
                "BASELINE",
                "SCENARIO",
                "CURRENT_SCHEDULE"
            ]
        },
        "sourceName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of baseline or scenario.",
            "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"
            ]
        }
    },
    "description":"This entity represents a Baseline object, a unique Baseline object can be identified by the following combinations of the fields.<ul><li>projectBaselineId</li><li>name,projectId</li><li>name,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Update a Project Baseline

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the Action service.

Back to Top