Jump to

• Request
• Response

Read ResourceRole

get

/resourceRole

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

Type: array

Title: List<ResourceRole>

Show Source

• Array of: object ResourceRole
  Title: ResourceRole

  ResourceRole Entity

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

Nested Schema : ResourceRole

Type: object

Title: ResourceRole

ResourceRole Entity

Show Source

• CreateDate: string (date-time)
  The date this resource role was created.
• CreateUser: string
  The name of the user that created this resource role.
• LastUpdateDate: string (date-time)
  The date this resource role was last updated.
• LastUpdateUser: string
  The name of the user that last updated this resource role.
• Proficiency: string
  The resource's proficiency at performing this role. The values are '1 - Master', '2 - Expert', '3 - Skilled', '4 - Proficient', and '5 - Inexperienced'. If the current user does not have the ViewResourceRoleProficiency global security privilege, this field may not be accessed.
• ResourceId: string
  The short code that uniquely identifies the resource.
• ResourceName: string
  The name of the resource.
• ResourceObjectId: integer (int32)
  The unique ID of the associated resource.
• RoleId: string
  The short code that uniquely identifies the role.
• RoleName: string
  The name of the role. The role name uniquely identifies the role.
• RoleObjectId: integer (int32)
  The unique ID of the associated role.

{
    "title":"ResourceRole",
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this resource role was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this resource role."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this resource role was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this resource role."
        },
        "Proficiency":{
            "type":"string",
            "description":"The resource's proficiency at performing this role. The values are '1 - Master', '2 - Expert', '3 - Skilled', '4 - Proficient', and '5 - Inexperienced'. If the current user does not have the ViewResourceRoleProficiency global security privilege, this field may not be accessed."
        },
        "ResourceId":{
            "type":"string",
            "description":"The short code that uniquely identifies the resource."
        },
        "ResourceName":{
            "type":"string",
            "description":"The name of the resource."
        },
        "ResourceObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated resource.",
            "format":"int32"
        },
        "RoleId":{
            "type":"string",
            "description":"The short code that uniquely identifies the role."
        },
        "RoleName":{
            "type":"string",
            "description":"The name of the role. The role name uniquely identifies the role."
        },
        "RoleObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated role.",
            "format":"int32"
        }
    },
    "description":"ResourceRole 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