Jump to

• Request
• Response

Read Resources

get

/resource

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

Type: array

Title: List<Resource>

Show Source

• Array of: object Resource
  Title: Resource

  Resource Entity

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

Nested Schema : Resource

Type: object

Title: Resource

Resource Entity

Show Source

• AutoComputeActuals: boolean
• CalculateCostFromUnits: boolean
• CalendarName: string
• CalendarObjectId: integer (int32)
• CreateDate: string (date-time)
• CreateUser: string
• CurrencyId: string
• CurrencyName: string
• CurrencyObjectId: integer (int32)
• DefaultUnitsPerTime: number (double)
• EffectiveDate: string (date-time)
• EmailAddress: string
• EmployeeId: string
• GUID: string
• Id: string
• IntegratedType: string
• IsActive: boolean
• IsOverTimeAllowed: boolean
• LastUpdateDate: string (date-time)
• LastUpdateUser: string
• Latitude: number (double)
• LocationName: string
• LocationObjectId: integer (int32)
• Longitude: number (double)
• MaxUnitsPerTime: number (double)
• Name: string
• ObjectId: integer (int32)
• OfficePhone: string
• OtherPhone: string
• OvertimeFactor: number (double)
• ParentObjectId: integer (int32)
• PricePerUnit: number (double)
• PrimaryRoleId: string
• PrimaryRoleName: string
• PrimaryRoleObjectId: integer (int32)
• ResourceNotes: string
• ResourceType: string
• SequenceNumber: integer (int32)
• ShiftObjectId: integer (int32)
• TimesheetApprovalManager: string
• TimesheetApprovalManagerObjectId: integer (int32)
• Title: string
• UnitOfMeasureAbbreviation: string
• UnitOfMeasureName: string
• UnitOfMeasureObjectId: integer (int32)
• UserName: string
• UserObjectId: integer (int32)
• UseTimesheets: boolean

{
    "title":"Resource",
    "type":"object",
    "properties":{
        "AutoComputeActuals":{
            "type":"boolean"
        },
        "CalculateCostFromUnits":{
            "type":"boolean"
        },
        "CalendarName":{
            "type":"string"
        },
        "CalendarObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "CreateDate":{
            "type":"string",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string"
        },
        "CurrencyId":{
            "type":"string"
        },
        "CurrencyName":{
            "type":"string"
        },
        "CurrencyObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "DefaultUnitsPerTime":{
            "type":"number",
            "format":"double"
        },
        "EffectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "EmailAddress":{
            "type":"string"
        },
        "EmployeeId":{
            "type":"string"
        },
        "GUID":{
            "type":"string"
        },
        "Id":{
            "type":"string"
        },
        "IntegratedType":{
            "type":"string"
        },
        "IsActive":{
            "type":"boolean"
        },
        "IsOverTimeAllowed":{
            "type":"boolean"
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string"
        },
        "Latitude":{
            "type":"number",
            "format":"double"
        },
        "LocationName":{
            "type":"string"
        },
        "LocationObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "Longitude":{
            "type":"number",
            "format":"double"
        },
        "MaxUnitsPerTime":{
            "type":"number",
            "format":"double"
        },
        "Name":{
            "type":"string"
        },
        "ObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "OfficePhone":{
            "type":"string"
        },
        "OtherPhone":{
            "type":"string"
        },
        "OvertimeFactor":{
            "type":"number",
            "format":"double"
        },
        "ParentObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "PricePerUnit":{
            "type":"number",
            "format":"double"
        },
        "PrimaryRoleId":{
            "type":"string"
        },
        "PrimaryRoleName":{
            "type":"string"
        },
        "PrimaryRoleObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "ResourceNotes":{
            "type":"string"
        },
        "ResourceType":{
            "type":"string"
        },
        "SequenceNumber":{
            "type":"integer",
            "format":"int32"
        },
        "ShiftObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "TimesheetApprovalManager":{
            "type":"string"
        },
        "TimesheetApprovalManagerObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "Title":{
            "type":"string"
        },
        "UnitOfMeasureAbbreviation":{
            "type":"string"
        },
        "UnitOfMeasureName":{
            "type":"string"
        },
        "UnitOfMeasureObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "UseTimesheets":{
            "type":"boolean"
        },
        "UserName":{
            "type":"string"
        },
        "UserObjectId":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Resource 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