Jump to

• Request
• Response

Read Timesheet

get

/timesheet

Reads timesheet 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<Timesheet>

Type: array

Title: List<Timesheet>

Show Source

• Array of: object Timesheet
  Title: Timesheet

  Timesheet Entity

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

Nested Schema : Timesheet

Type: object

Title: Timesheet

Timesheet Entity

Show Source

• CreateDate: string (date-time)
  The date this timesheet was created.
• CreateUser: string
  The name of the user that created this timesheet.
• IsDaily: boolean
  The flag that identifies whether timesheet users enter hours daily or by entire timesheet reporting period.
• LastReceivedDate: string (date-time)
  The last date on which the timesheet was submitted by the resource.
• LastUpdateDate: string (date-time)
  The date this timesheet was last updated.
• LastUpdateUser: string
  The name of the user that last updated this timesheet.
• Notes: string
  The notes associated with the timesheet.
• ResourceId: string
  The short code that uniquely identifies the resource.
• ResourceName: string
  The name of the resource.
• ResourceObjectId(required): integer (int32)
  The unique ID of the associated resource.
• Status: string
  The current status of the timesheet: 'Submitted', 'Approved', 'Resource Manager Approved', 'Project Manager Approved', 'Active', or 'Rejected'.
• StatusDate: string (date-time)
  The date on which the status of the timesheet was last changed.
• TimesheetPeriodObjectId(required): integer (int32)
  The unique ID of the timesheet period.

{
    "title":"Timesheet",
    "required":[
        "ResourceObjectId",
        "TimesheetPeriodObjectId"
    ],
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this timesheet was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this timesheet."
        },
        "IsDaily":{
            "type":"boolean",
            "description":"The flag that identifies whether timesheet users enter hours daily or by entire timesheet reporting period."
        },
        "LastReceivedDate":{
            "type":"string",
            "description":"The last date on which the timesheet was submitted by the resource.",
            "format":"date-time"
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this timesheet was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this timesheet."
        },
        "Notes":{
            "type":"string",
            "description":"The notes associated with the timesheet."
        },
        "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"
        },
        "Status":{
            "type":"string",
            "description":"The current status of the timesheet: 'Submitted', 'Approved', 'Resource Manager Approved', 'Project Manager Approved', 'Active', or 'Rejected'."
        },
        "StatusDate":{
            "type":"string",
            "description":"The date on which the status of the timesheet was last changed.",
            "format":"date-time"
        },
        "TimesheetPeriodObjectId":{
            "type":"integer",
            "description":"The unique ID of the timesheet period.",
            "format":"int32"
        }
    },
    "description":"Timesheet 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