Jump to

• Request
• Response

Read ResourceCurve

get

/resourceCurve

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

Type: array

Title: List<ResourceCurve>

Show Source

• Array of: object ResourceCurve
  Title: ResourceCurve

  ResourceCurve Entity

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

Nested Schema : ResourceCurve

Type: object

Title: ResourceCurve

ResourceCurve Entity

Show Source

• CreateDate: string (date-time)
  The date this resource curve was created.
• CreateUser: string
  The name of the user that created this resource curve.
• IsDefault: boolean
  The flag that identifies the default curve. The default curve can not be edited.
• LastUpdateDate: string (date-time)
  The date this resource curve was last updated.
• LastUpdateUser: string
  The name of the user that last updated this resource curve.
• Name: string
  The name of the resource curve.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• Values: object Values

{
    "title":"ResourceCurve",
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this resource curve was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this resource curve."
        },
        "IsDefault":{
            "type":"boolean",
            "description":"The flag that identifies the default curve. The default curve can not be edited."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this resource curve was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this resource curve."
        },
        "Name":{
            "type":"string",
            "description":"The name of the resource curve."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "Values":{
            "$ref":"#/components/schemas/Values"
        }
    },
    "description":"ResourceCurve Entity"
}

Nested Schema : Values

Type: object

Show Source

• Value0: number (double)
• Value10: number (double)
• Value100: number (double)
• Value15: number (double)
• Value20: number (double)
• Value25: number (double)
• Value30: number (double)
• Value35: number (double)
• Value40: number (double)
• Value45: number (double)
• Value5: number (double)
• Value50: number (double)
• Value55: number (double)
• Value60: number (double)
• Value65: number (double)
• Value70: number (double)
• Value75: number (double)
• Value80: number (double)
• Value85: number (double)
• Value90: number (double)
• Value95: number (double)

{
    "type":"object",
    "properties":{
        "Value0":{
            "type":"number",
            "format":"double"
        },
        "Value5":{
            "type":"number",
            "format":"double"
        },
        "Value10":{
            "type":"number",
            "format":"double"
        },
        "Value15":{
            "type":"number",
            "format":"double"
        },
        "Value20":{
            "type":"number",
            "format":"double"
        },
        "Value25":{
            "type":"number",
            "format":"double"
        },
        "Value30":{
            "type":"number",
            "format":"double"
        },
        "Value35":{
            "type":"number",
            "format":"double"
        },
        "Value40":{
            "type":"number",
            "format":"double"
        },
        "Value45":{
            "type":"number",
            "format":"double"
        },
        "Value50":{
            "type":"number",
            "format":"double"
        },
        "Value55":{
            "type":"number",
            "format":"double"
        },
        "Value60":{
            "type":"number",
            "format":"double"
        },
        "Value65":{
            "type":"number",
            "format":"double"
        },
        "Value70":{
            "type":"number",
            "format":"double"
        },
        "Value75":{
            "type":"number",
            "format":"double"
        },
        "Value80":{
            "type":"number",
            "format":"double"
        },
        "Value85":{
            "type":"number",
            "format":"double"
        },
        "Value90":{
            "type":"number",
            "format":"double"
        },
        "Value95":{
            "type":"number",
            "format":"double"
        },
        "Value100":{
            "type":"number",
            "format":"double"
        }
    }
}

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