Read Role
get
/role
Reads Role 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<Role>
Type:
array
Title:
Show Source
List<Role>
-
Array of:
object Role
Title:
Role
Role Entity
Nested Schema : Role
Type:
object
Title:
Role
Role Entity
Show Source
-
CalculateCostFromUnits: boolean
The option that indicates whether costs and quantities are linked, and whether quantities should be updated when costs are updated.
-
CreateDate: string
(date-time)
The date this role was created.
-
CreateUser: string
The name of the user that created this role.
-
Id: string
The short code that uniquely identifies the role.
-
LastUpdateDate: string
(date-time)
The date this role was last updated.
-
LastUpdateUser: string
The name of the user that last updated this role.
-
Name: string
The name of the role. The role name uniquely identifies the role.
-
ObjectId: integer
(int32)
The unique ID generated by the system.
-
ParentObjectId: integer
(int32)
The unique ID of the parent role of this role in the hierarchy.
-
Responsibilities: string
The responsibilities for the role.
-
SequenceNumber: integer
(int32)
The sequence number for sorting.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.