Jump to

• Request
• Response

Read EPSSpendingPlan

get

/epsSpendingPlan

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

Type: array

Title: List<EPSSpendingPlan>

Show Source

• Array of: object EPSSpendingPlan
  Title: EPSSpendingPlan

  EPSSpendingPlan Entity

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

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.

{
    "title":"EPSSpendingPlan",
    "required":[
        "Date",
        "EPSObjectId"
    ],
    "type":"object",
    "properties":{
        "BenefitPlan":{
            "type":"number",
            "description":"The editable monthly profit portion for each month for the EPS.",
            "format":"double"
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this EPS Spending plan was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this EPS Spending plan."
        },
        "Date":{
            "type":"string",
            "description":"The start of a spending/benefit plan time period for the EPS.",
            "format":"date-time"
        },
        "EPSId":{
            "type":"string",
            "description":"The short code assigned to the associated EPS."
        },
        "EPSName":{
            "type":"string",
            "description":"The name of the EPS element associated with this spending plan."
        },
        "EPSObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated EPS for this EPS spending plan.",
            "format":"int32"
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this EPS Spending plan was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this EPS Spending plan."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "SpendingPlan":{
            "type":"number",
            "description":"The editable total monthly expenditure for the EPS.",
            "format":"double"
        }
    },
    "description":"EPSSpendingPlan 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