Jump to

• Request
• Response

Read UpdateBaselineOption

get

/updateBaselineOption

Reads UpdateBaselineOption objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  Name,ObjectId

• Filter(required): string
  Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:

  Example:

  ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'

• OrderBy(required): string
  OrderBy condition

  Example:

  ObjectId desc

Header Parameters

• Authorization(required):
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : List<UpdateBaselineOption>

Type: array

Title: List<UpdateBaselineOption>

Show Source

• Array of: object UpdateBaselineOption
  Title: UpdateBaselineOption

  UpdateBaselineOption Entity

{
    "title":"List<UpdateBaselineOption>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UpdateBaselineOption"
    }
}

Nested Schema : UpdateBaselineOption

Type: object

Title: UpdateBaselineOption

UpdateBaselineOption Entity

Show Source

• ActivitiesFilter: string
  The option used to update activity IDs of the selected filter when updating the baseline.
• ActivitiesFilterLogic: string
  The option used to update activity filter logic when updating the baseline.
• ActivityCodeAssignments: boolean
  The option used to update activity code assignments when updating the baseline.
• ActivityFilterId: string
  The option used to update activity filter id when updating the baseline.
• ActivityFilterName: string
  The option used to update activity filter name when updating the baseline.
• ActivityInformation: boolean
  The option used to update activity information for existing resource and role assignments when updating the baseline.
• ActivityNotebooks: boolean
  The option used to update activity information for existing resource and role assignments when updating the baseline.
• ActivityRsrcAssignmentCodes: boolean
• ActivityRsrcAssignmentUdfs: boolean
  The option used to update activity resource assignment UDFs when updating the baseline.
• ActivityUdfs: boolean
  The option used to update activity UDFs when updating the baseline
• ActualUnitsCostWoRsrcAssignmnt: boolean
  The option used to update activity actual units and cost without resource assignments when updating the baseline.
• AddNewActivitiesData: boolean
  The option used to add new activities with data when updating the baseline.
• AddNewRsrcRole: boolean
  The option used to add new resource and role assignments when updating the baseline.
• AllActivities: boolean
  The option used to include all activities when updating the baseline.
• BatchModeEnabled: boolean
  The option used to enable the batch update mode when updating the baseline.
• BudgetUnitsCost: boolean
  The option used to update budget units and cost for existing resource and role assignments when updating the baseline.
• BudgetUnitsCostWoRsrcAssignmnt: boolean
  The option used to update activity budget units and cost without resource assignment when updating the baseline.
• Constraints: boolean
  The option used to update activity constraints when updating the baseline
• DatesDurationDatadates: boolean
  The option used to update activity dates, duration, and data dates when updating the baseline
• DeleteNonExistingActivities: boolean
  The option used to delete non existing activities when updating the baseline.
• Expenses: boolean
  The option used to update activity expenses when updating the baseline.
• ExpenseUdfs: boolean
  the option used to update activity expense UDFs when updating the baseline.
• FilteredActivities: boolean
  The option used to include activities in the selected folder when updating the baseline.
• GeneralActivitiInfo: boolean
  The option used to update general activity info when updating the baseline.
• IgnoreLastUpdateDate: boolean
  The option used to ignore LastUpdateDate when updating the baseline.
• IssueUDFs: boolean
  The option used to update the Issue UDFs when updating the baseline.
• NewActivityInformation: boolean
• NewBudgetUnitsCost: boolean
• ObjectId(required): integer (int32)
  The unique ID of the associated user.
• ProjectDetails: boolean
  The option used to update the project details when updating the baseline.
• ProjectRisksIssuesAndThresholds: boolean
  The option used to update the Project Risks Issues and Thresholds when updating the baseline.
• ProjectUDFs: boolean
  The option used to update the project UDFs when updating the baseline.
• Relationships: boolean
  The option used to update activity relationships when updating the baseline.
• RiskAssignments: boolean
  The option used to update risk assignments when updating the baseline.
• RiskUDFs: boolean
  The option used to update the Risks UDFs when updating the baseline.
• Steps: boolean
  The option used to update activity steps when updating the baseline.
• StepsUdf: boolean
  The option used to update activity steps UDFs when updating the baseline.
• UpdateExistingActivities: boolean
  The option used to update existing activities when updating the baseline.
• UpdateExistRsrcRoleAssignment: boolean
  The option used to update existing resource and role assignments when updating the baseline.
• UserName: string
  The user's login name.
• WbsAssignments: boolean
  The option used to update WBS assignments when updating the baseline.
• WbsUDFs: boolean
  The option used to update the WBS UDFs when updating the baseline.
• WorkProductsAndDocuments: boolean
  The option used to update the work products and documents when updating the baseline.
• WPDocumentUDFs: boolean
  The option used to update the WPDocument UDFs when updating the baseline.

{
    "title":"UpdateBaselineOption",
    "required":[
        "ObjectId"
    ],
    "type":"object",
    "properties":{
        "ActivitiesFilter":{
            "type":"string",
            "description":"The option used to update activity IDs of the selected filter when updating the baseline."
        },
        "ActivitiesFilterLogic":{
            "type":"string",
            "description":"The option used to update activity filter logic when updating the baseline."
        },
        "ActivityCodeAssignments":{
            "type":"boolean",
            "description":"The option used to update activity code assignments when updating the baseline."
        },
        "ActivityFilterId":{
            "type":"string",
            "description":"The option used to update activity filter id when updating the baseline."
        },
        "ActivityFilterName":{
            "type":"string",
            "description":"The option used to update activity filter name when updating the baseline."
        },
        "ActivityInformation":{
            "type":"boolean",
            "description":"The option used to update activity information for existing resource and role assignments when updating the baseline."
        },
        "ActivityNotebooks":{
            "type":"boolean",
            "description":"The option used to update activity information for existing resource and role assignments when updating the baseline."
        },
        "ActivityRsrcAssignmentCodes":{
            "type":"boolean"
        },
        "ActivityRsrcAssignmentUdfs":{
            "type":"boolean",
            "description":"The option used to update activity resource assignment UDFs when updating the baseline."
        },
        "ActivityUdfs":{
            "type":"boolean",
            "description":"The option used to update activity UDFs when updating the baseline"
        },
        "ActualUnitsCostWoRsrcAssignmnt":{
            "type":"boolean",
            "description":"The option used to update activity actual units and cost without resource assignments when updating the baseline."
        },
        "AddNewActivitiesData":{
            "type":"boolean",
            "description":"The option used to add new activities with data when updating the baseline."
        },
        "AddNewRsrcRole":{
            "type":"boolean",
            "description":"The option used to add new resource and role assignments when updating the baseline."
        },
        "AllActivities":{
            "type":"boolean",
            "description":"The option used to include all activities when updating the baseline."
        },
        "BatchModeEnabled":{
            "type":"boolean",
            "description":"The option used to enable the batch update mode when updating the baseline."
        },
        "BudgetUnitsCost":{
            "type":"boolean",
            "description":"The option used to update budget units and cost for existing resource and role assignments when updating the baseline."
        },
        "BudgetUnitsCostWoRsrcAssignmnt":{
            "type":"boolean",
            "description":"The option used to update activity budget units and cost without resource assignment when updating the baseline."
        },
        "Constraints":{
            "type":"boolean",
            "description":"The option used to update activity constraints when updating the baseline"
        },
        "DatesDurationDatadates":{
            "type":"boolean",
            "description":"The option used to update activity dates, duration, and data dates when updating the baseline"
        },
        "DeleteNonExistingActivities":{
            "type":"boolean",
            "description":"The option used to delete non existing activities when updating the baseline."
        },
        "ExpenseUdfs":{
            "type":"boolean",
            "description":"the option used to update activity expense UDFs when updating the baseline."
        },
        "Expenses":{
            "type":"boolean",
            "description":"The option used to update activity expenses when updating the baseline."
        },
        "FilteredActivities":{
            "type":"boolean",
            "description":"The option used to include activities in the selected folder when updating the baseline."
        },
        "GeneralActivitiInfo":{
            "type":"boolean",
            "description":"The option used to update general activity info when updating the baseline."
        },
        "IgnoreLastUpdateDate":{
            "type":"boolean",
            "description":"The option used to ignore LastUpdateDate when updating the baseline."
        },
        "IssueUDFs":{
            "type":"boolean",
            "description":"The option used to update the Issue UDFs when updating the baseline."
        },
        "NewActivityInformation":{
            "type":"boolean"
        },
        "NewBudgetUnitsCost":{
            "type":"boolean"
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated user.",
            "format":"int32"
        },
        "ProjectDetails":{
            "type":"boolean",
            "description":"The option used to update the project details when updating the baseline."
        },
        "ProjectRisksIssuesAndThresholds":{
            "type":"boolean",
            "description":"The option used to update the Project Risks Issues and Thresholds when updating the baseline."
        },
        "ProjectUDFs":{
            "type":"boolean",
            "description":"The option used to update the project UDFs when updating the baseline."
        },
        "Relationships":{
            "type":"boolean",
            "description":"The option used to update activity relationships when updating the baseline."
        },
        "RiskAssignments":{
            "type":"boolean",
            "description":"The option used to update risk assignments when updating the baseline."
        },
        "RiskUDFs":{
            "type":"boolean",
            "description":"The option used to update the Risks UDFs when updating the baseline."
        },
        "Steps":{
            "type":"boolean",
            "description":"The option used to update activity steps when updating the baseline."
        },
        "StepsUdf":{
            "type":"boolean",
            "description":"The option used to update activity steps UDFs when updating the baseline."
        },
        "UpdateExistRsrcRoleAssignment":{
            "type":"boolean",
            "description":"The option used to update existing resource and role assignments when updating the baseline."
        },
        "UpdateExistingActivities":{
            "type":"boolean",
            "description":"The option used to update existing activities when updating the baseline."
        },
        "UserName":{
            "type":"string",
            "description":"The user's login name."
        },
        "WPDocumentUDFs":{
            "type":"boolean",
            "description":"The option used to update the WPDocument UDFs when updating the baseline."
        },
        "WbsAssignments":{
            "type":"boolean",
            "description":"The option used to update WBS assignments when updating the baseline."
        },
        "WbsUDFs":{
            "type":"boolean",
            "description":"The option used to update the WBS UDFs when updating the baseline."
        },
        "WorkProductsAndDocuments":{
            "type":"boolean",
            "description":"The option used to update the work products and documents when updating the baseline."
        }
    },
    "description":"UpdateBaselineOption Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top