Jump to

• Request
• Response

Read ResourceRate

get

/resourceRate

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

Type: array

Title: List<ResourceRate>

Show Source

• Array of: object ResourceRate
  Title: ResourceRate

  ResourceRate Entity

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

Nested Schema : ResourceRate

Type: object

Title: ResourceRate

ResourceRate Entity

Show Source

• CreateDate: string (date-time)
  The date this resource rate was created.
• CreateUser: string
  The name of the user that created this resource rate.
• EffectiveDate: string (date-time)
  The effective date for the resource price and maximum units per time.
• LastUpdateDate: string (date-time)
  The date this resource rate was last updated.
• LastUpdateUser: string
  The name of the user that last updated this resource rate.
• MaxUnitsPerTime: number (double)
  The maximum work units per time this resource can perform on all their assigned activities. For example, a person working full time could perform 8 hours of work per day. A department of five people may perform at 5 days per day.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• PricePerUnit: number (double)
  The non-overtime price per time for the resource. This price is used to compute costs for any activities the resource is assigned to. In general, cost = units * price per time.
• PricePerUnit2: number (double)
  The non-overtime price per time for the resource. This price is used to compute costs for any activities the resource is assigned to. In general, cost = units * price per time.
• PricePerUnit3: number (double)
  The non-overtime price per time for the resource. This price is used to compute costs for any activities the resource is assigned to. In general, cost = units * price per time.
• PricePerUnit4: number (double)
  The non-overtime price per time for the resource. This price is used to compute costs for any activities the resource is assigned to. In general, cost = units * price per time.
• PricePerUnit5: number (double)
  The non-overtime price per time for the resource. This price is used to compute costs for any activities the resource is assigned to. In general, cost = units * price per time.
• ResourceId: string
  The short code that uniquely identifies the resource.
• ResourceName: string
  The name of the resource.
• ResourceObjectId: integer (int32)
  The unique ID of the associated resource.
• ShiftPeriodObjectId: integer (int32)
  The unique ID of the associated shift.

{
    "title":"ResourceRate",
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this resource rate was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this resource rate."
        },
        "EffectiveDate":{
            "type":"string",
            "description":"The effective date for the resource price and maximum units per time.",
            "format":"date-time"
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this resource rate was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this resource rate."
        },
        "MaxUnitsPerTime":{
            "type":"number",
            "description":"The maximum work units per time this resource can perform on all their assigned activities. For example, a person working full time could perform 8 hours of work per day. A department of five people may perform at 5 days per day.",
            "format":"double"
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "PricePerUnit":{
            "type":"number",
            "description":"The non-overtime price per time for the resource. This price is used to compute costs for any activities the resource is assigned to. In general, cost = units * price per time.",
            "format":"double"
        },
        "PricePerUnit2":{
            "type":"number",
            "description":"The non-overtime price per time for the resource. This price is used to compute costs for any activities the resource is assigned to. In general, cost = units * price per time.",
            "format":"double"
        },
        "PricePerUnit3":{
            "type":"number",
            "description":"The non-overtime price per time for the resource. This price is used to compute costs for any activities the resource is assigned to. In general, cost = units * price per time.",
            "format":"double"
        },
        "PricePerUnit4":{
            "type":"number",
            "description":"The non-overtime price per time for the resource. This price is used to compute costs for any activities the resource is assigned to. In general, cost = units * price per time.",
            "format":"double"
        },
        "PricePerUnit5":{
            "type":"number",
            "description":"The non-overtime price per time for the resource. This price is used to compute costs for any activities the resource is assigned to. In general, cost = units * price per time.",
            "format":"double"
        },
        "ResourceId":{
            "type":"string",
            "description":"The short code that uniquely identifies the resource."
        },
        "ResourceName":{
            "type":"string",
            "description":"The name of the resource."
        },
        "ResourceObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated resource.",
            "format":"int32"
        },
        "ShiftPeriodObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated shift.",
            "format":"int32"
        }
    },
    "description":"ResourceRate 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