Jump to

• Request
• Response

Read ProjectCodes

get

/projectCode

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

Type: array

Title: List<ProjectCode>

Show Source

• Array of: object ProjectCode
  Title: ProjectCode

  ProjectCode Entity

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

Nested Schema : ProjectCode

Type: object

Title: ProjectCode

ProjectCode Entity

Show Source

• CodeTypeName: string
  The name of the parent code type for this code.
• CodeTypeObjectId(required): integer (int32)
  The unique ID of the parent project code type.
• CodeValue(required): string
  The value of the project code.
• CreateDate: string (date-time)
  The date this project code was created.
• CreateUser: string
  The name of the user that created this project code.
• Description: string
  The description of the project code.
• LastUpdateDate: string (date-time)
  The date this project code was last updated.
• LastUpdateUser: string
  The name of the user that last updated this project code.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ParentObjectId: integer (int32)
  The unique ID of the parent project code of this project code in the hierarchy.
• SequenceNumber: integer (int32)
  The sequence number for sorting.
• Weight: number (double)
  The weight for this code value.

{
    "title":"ProjectCode",
    "required":[
        "CodeTypeObjectId",
        "CodeValue"
    ],
    "type":"object",
    "properties":{
        "CodeTypeName":{
            "type":"string",
            "description":"The name of the parent code type for this code."
        },
        "CodeTypeObjectId":{
            "type":"integer",
            "description":"The unique ID of the parent project code type.",
            "format":"int32"
        },
        "CodeValue":{
            "type":"string",
            "description":"The value of the project code."
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this project code was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this project code."
        },
        "Description":{
            "type":"string",
            "description":"The description of the project code."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this project code was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this project code."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ParentObjectId":{
            "type":"integer",
            "description":"The unique ID of the parent project code of this project code in the hierarchy.",
            "format":"int32"
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for sorting.",
            "format":"int32"
        },
        "Weight":{
            "type":"number",
            "description":"The weight for this code value.",
            "format":"double"
        }
    },
    "description":"ProjectCode 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