Jump to

• Request
• Response

Read RoleCodeAssignments

get

/roleCodeAssignment

Reads RoleCodeAssignment objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  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 condition

  Example:

  ObjectId desc

Header Parameters

• Authorization:
  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<RoleCodeAssignment>

Type: array

Title: List<RoleCodeAssignment>

Show Source

• Array of: object RoleCodeAssignment
  Title: RoleCodeAssignment

  RoleCodeAssignment Entity

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

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.

{
    "title":"RoleCodeAssignment",
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this code assignment was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this code assignment."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this code assignment was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this code assignment."
        },
        "RoleCodeDescription":{
            "type":"string",
            "description":"The description of the associated role code."
        },
        "RoleCodeObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated role code.",
            "format":"int32"
        },
        "RoleCodeTypeName":{
            "type":"string",
            "description":"The name of the parent role code type."
        },
        "RoleCodeTypeObjectId":{
            "type":"integer",
            "description":"The unique ID of the parent role code type.",
            "format":"int32"
        },
        "RoleCodeValue":{
            "type":"string",
            "description":"The value of the associated role code."
        },
        "RoleId":{
            "type":"string",
            "description":"The short code that uniquely identifies the associated role."
        },
        "RoleName":{
            "type":"string",
            "description":"The name of the role to which the role code is assigned."
        },
        "RoleObjectId":{
            "type":"integer",
            "description":"The unique ID of the role to which the role code is assigned.",
            "format":"int32"
        }
    },
    "description":"RoleCodeAssignment 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