Get Employee Roles
post
/config/sim/v2/employees/getEmployeeRoles
Gets a list of all the roles associated with the given employee in the specified organization
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
objectNum(required):
integer
Example:
1 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(objectNum, 1)
Response
Supported Media Types
- application/json
200 Response
A Collection of Employee Roles.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Employee Role objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Employee Role objects of the organization.
Show Source
-
Array of:
object EmployeeRolev2
Model for an Employee Role Object
Nested Schema : EmployeeRolev2
Type:
objectModel for an Employee Role Object
Show Source
-
hierUnitId:
integer
Unique reference of the hierarchy unit where the employee role is configuredExample:
3599 -
hierUnitObjNum:
integer
Object number of the hierarchy unit where the employee role is configuredExample:
26 -
objectNum:
integer
Unique reference of the employee in the system.Example:
1 -
roleEmployeeId:
integer
Unique reference of Employee Role AssociationExample:
1 -
roleObjNum:
integer
The object number of the role assigned to the employeeExample:
1000