Jump to

• Request
• Response

Read OverheadCodes

get

/overheadCode

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

Type: array

Title: List<OverheadCode>

Show Source

• Array of: object OverheadCode
  Title: OverheadCode

  OverheadCode Entity

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

Nested Schema : OverheadCode

Type: object

Title: OverheadCode

OverheadCode Entity

Show Source

• CreateDate: string (date-time)
  The date this nonworktype was created.
• CreateUser: string
  The name of the user that created this nonworktype.
• Description(required): string
  The description of the overhead code.
• LastUpdateDate: string (date-time)
  The date this nonworktype was last updated.
• LastUpdateUser: string
  The name of the user that last updated this nonworktype.
• Name(required): string
  The name of the overhead code.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• SequenceNumber: integer (int32)
  The sequence number for sorting.

{
    "title":"OverheadCode",
    "required":[
        "Description",
        "Name"
    ],
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this nonworktype was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this nonworktype."
        },
        "Description":{
            "type":"string",
            "description":"The description of the overhead code."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this nonworktype was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this nonworktype."
        },
        "Name":{
            "type":"string",
            "description":"The name of the overhead code."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for sorting.",
            "format":"int32"
        }
    },
    "description":"OverheadCode 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