Jump to

• Request
• Response

Read ProjectBudgetChangeLog

get

/projectBudgetChangeLog

Reads ProjectBudgetChangeLog 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<ProjectBudgetChangeLog>

Type: array

Title: List<ProjectBudgetChangeLog>

Show Source

• Array of: object ProjectBudgetChangeLog
  Title: ProjectBudgetChangeLog

  ProjectBudgetChangeLog Entity

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

Nested Schema : ProjectBudgetChangeLog

Type: object

Title: ProjectBudgetChangeLog

ProjectBudgetChangeLog Entity

Show Source

• Amount: number (double)
  The amount of budget change.
• ChangeNumber(required): string
  The change number that is automatically incremented according to when changes are added. This can be changed to any number.
• CreateUser: string
  The name of the user that created this log of budget changes.
• Date: string (date-time)
  The date of this budget change entry.
• IsBaseline: boolean
  The boolean value indicating if this business object is related to a Project or Baseline
• IsTemplate: boolean
  The boolean value indicating if this business object is related to a template Project.
• LastUpdateDate: string (date-time)
  The date this log of budget changes was last updated.
• LastUpdateUser: string
  The name of the user that last updated this log of budget changes.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ProjectId: string
  The short code that uniquely identifies the project.
• ProjectObjectId(required): integer (int32)
  The unique ID of the associated project.
• Reason: string
  The description of the reason for the budget change request.
• Responsible: string
  The person responsible for the change.
• Status: string
  The status of this budget change request. Possible values are 'Pending', 'Approved', and 'Not Approved'.
• WBSCode: string
  The short code assigned to each WBS element for identification. Each WBS element is uniquely identified by concatenating its own code together with its parents' codes.
• WBSName: string
  The name of the WBS element.
• WBSObjectId(required): integer (int32)
  The unique ID of the WBS element to which the budget change log applies.

{
    "title":"ProjectBudgetChangeLog",
    "required":[
        "ChangeNumber",
        "ProjectObjectId",
        "WBSObjectId"
    ],
    "type":"object",
    "properties":{
        "Amount":{
            "type":"number",
            "description":"The amount of budget change.",
            "format":"double"
        },
        "ChangeNumber":{
            "type":"string",
            "description":"The change number that is automatically incremented according to when changes are added. This can be changed to any number."
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this log of budget changes."
        },
        "Date":{
            "type":"string",
            "description":"The date of this budget change entry.",
            "format":"date-time"
        },
        "IsBaseline":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a Project or Baseline"
        },
        "IsTemplate":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a template Project."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this log of budget changes was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this log of budget changes."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ProjectId":{
            "type":"string",
            "description":"The short code that uniquely identifies the project."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        },
        "Reason":{
            "type":"string",
            "description":"The description of the reason for the budget change request."
        },
        "Responsible":{
            "type":"string",
            "description":"The person responsible for the change."
        },
        "Status":{
            "type":"string",
            "description":"The status of this budget change request. Possible values are 'Pending', 'Approved', and 'Not Approved'."
        },
        "WBSCode":{
            "type":"string",
            "description":"The short code assigned to each WBS element for identification. Each WBS element is uniquely identified by concatenating its own code together with its parents' codes."
        },
        "WBSName":{
            "type":"string",
            "description":"The name of the WBS element."
        },
        "WBSObjectId":{
            "type":"integer",
            "description":"The unique ID of the WBS element to which the budget change log applies.",
            "format":"int32"
        }
    },
    "description":"ProjectBudgetChangeLog 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