Read EPSSpendingPlan
get
/epsSpendingPlan
Reads EPSSpendingPlan 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<EPSSpendingPlan>
Type:
array
Title:
Show Source
List<EPSSpendingPlan>
-
Array of:
object EPSSpendingPlan
Title:
EPSSpendingPlan
EPSSpendingPlan Entity
Nested Schema : EPSSpendingPlan
Type:
object
Title:
EPSSpendingPlan
EPSSpendingPlan Entity
Show Source
-
BenefitPlan: number
(double)
The editable monthly profit portion for each month for the EPS.
-
CreateDate: string
(date-time)
The date this EPS Spending plan was created.
-
CreateUser: string
The name of the user that created this EPS Spending plan.
-
Date(required): string
(date-time)
The start of a spending/benefit plan time period for the EPS.
-
EPSId: string
The short code assigned to the associated EPS.
-
EPSName: string
The name of the EPS element associated with this spending plan.
-
EPSObjectId(required): integer
(int32)
The unique ID of the associated EPS for this EPS spending plan.
-
LastUpdateDate: string
(date-time)
The date this EPS Spending plan was last updated.
-
LastUpdateUser: string
The name of the user that last updated this EPS Spending plan.
-
ObjectId: integer
(int32)
The unique ID generated by the system.
-
SpendingPlan: number
(double)
The editable total monthly expenditure for the EPS.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.