Jump to

• Request
• Response

View User Baseline Preferences

get

/api/restapi/activity/userBaselinePreferences

Send a request to this endpoint to view the User Baseline Preferences.

Request

Query Parameters

• projectCode(required): string
  The user-specified identifier of a project.
  This is a required field.
• userName(required): string
  User name of application user.
  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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityUserBaseline>

Type: array

Title: List<ApiEntityUserBaseline>

Show Source

• Array of: object ApiEntityUserBaseline
  Title: ApiEntityUserBaseline

{
    "title":"List<ApiEntityUserBaseline>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityUserBaseline",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityUserBaseline

Type: object

Title: ApiEntityUserBaseline

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

  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.
• 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

  Date when the record was last updated.
• userBaselinetype: string
  Allowed Values: [ "USER_BASELINE_1", "USER_BASELINE_2", "USER_BASELINE_3" ]

  The user's first, second, or third preference of user baselines.
• userId: integer (int64)
  The system-generated identifier of a user.
• userName: string
  Maximum Length: 255

  The username a user uses to log in to the system.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityUserBaseline",
    "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",
            "readOnly":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.",
            "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"
            ]
        },
        "userId":{
            "type":"integer",
            "description":"The system-generated identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "userName":{
            "maxLength":"255",
            "type":"string",
            "description":"The username a user uses to log in to the system.",
            "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"
            ]
        },
        "projectBaselineId":{
            "type":"integer",
            "description":"The system-generated identifier of a baseline.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "userBaselinetype":{
            "type":"string",
            "description":"The user's first, second, or third preference of user baselines.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "USER_BASELINE_1",
                "USER_BASELINE_2",
                "USER_BASELINE_3"
            ]
        },
        "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"
            ]
        },
        "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
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested object does not exist, or you do not have access to it.

Back to Top