Read ProjectCodes
get
/projectCode
Reads ProjectCode objects from the database.
Request
Query Parameters
-
Fields(required): string
Fields to loadExample:
Name,ObjectId
-
Filter: 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: string
OrderBy conditionExample:
ObjectId desc
Header Parameters
-
Authorization:
OAuth token
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK.
Root Schema : List<ProjectCode>
Type:
array
Title:
Show Source
List<ProjectCode>
-
Array of:
object ProjectCode
Title:
ProjectCode
ProjectCode Entity
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.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.