Read ResourceRole
get
/resourceRole
Reads ResourceRole 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<ResourceRole>
Type:
array
Title:
Show Source
List<ResourceRole>
-
Array of:
object ResourceRole
Title:
ResourceRole
ResourceRole Entity
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.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.