Read ProjectSpendingPlan
get
/projectSpendingPlan
Reads ProjectSpendingPlan objects from the database.
Request
Query Parameters
-
Fields(required): string
Fields to loadExample:
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 conditionExample:
ObjectId desc
Header Parameters
-
Authorization(required):
OAuth token
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK.
Root Schema : List<ProjectSpendingPlan>
Type:
array
Title:
Show Source
List<ProjectSpendingPlan>
-
Array of:
object ProjectSpendingPlan
Title:
ProjectSpendingPlan
ProjectSpendingPlan Entity
Nested Schema : ProjectSpendingPlan
Type:
object
Title:
ProjectSpendingPlan
ProjectSpendingPlan Entity
Show Source
-
BenefitPlan: number
(double)
The editable monthly profit portion for each month for the project.
-
CreateDate: string
(date-time)
The date this spending plan was created.
-
CreateUser: string
The name of the user that created this spending plan.
-
Date(required): string
(date-time)
The start of a spending/benefit plan time period for the project.
-
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 spending plan was last updated.
-
LastUpdateUser: string
The name of the user that last updated this spending plan.
-
ObjectId: integer
(int32)
The unique ID generated by the system.
-
ProjectId: string
The Project short code that uniquely identifies the project.
-
ProjectObjectId(required): integer
(int32)
The unique ID of the associated project for this project spending plan.
-
SpendingPlan: number
(double)
The editable total monthly expenditure for the project.
-
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 associated WBS for this project spending plan.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.