Read RoleCodeAssignments
get
/roleCodeAssignment
Reads RoleCodeAssignment objects from the database.
Request
Query Parameters
-
Fields(required): string
Fields to loadExample:
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 conditionExample:
ObjectId desc
Header Parameters
-
Authorization(required):
OAuth token
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK.
Root Schema : List<RoleCodeAssignment>
Type:
array
Title:
Show Source
List<RoleCodeAssignment>
-
Array of:
object RoleCodeAssignment
Title:
RoleCodeAssignment
RoleCodeAssignment Entity
Nested Schema : RoleCodeAssignment
Type:
object
Title:
RoleCodeAssignment
RoleCodeAssignment Entity
Show Source
-
CreateDate: string
(date-time)
The date this code assignment was created.
-
CreateUser: string
The name of the user that created this code assignment.
-
LastUpdateDate: string
(date-time)
The date this code assignment was last updated.
-
LastUpdateUser: string
The name of the user that last updated this code assignment.
-
RoleCodeDescription: string
The description of the associated role code.
-
RoleCodeObjectId: integer
(int32)
The unique ID of the associated role code.
-
RoleCodeTypeName: string
The name of the parent role code type.
-
RoleCodeTypeObjectId: integer
(int32)
The unique ID of the parent role code type.
-
RoleCodeValue: string
The value of the associated role code.
-
RoleId: string
The short code that uniquely identifies the associated role.
-
RoleName: string
The name of the role to which the role code is assigned.
-
RoleObjectId: integer
(int32)
The unique ID of the role to which the role code is assigned.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.