Get Employee EMC Visibility
post
/config/sim/v2/employees/getEMCVisibility
Gets all the EMC modules visible for the given employee in the specified organization
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : EMCVisibilityGetRequestBodyv2
Type:
objectThe input Body model that needs to be given.
Show Source
-
include:
string
Objects included in responseExample:
hierUnitId -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
langIds:
string
If specified, limits translated strings returned.Example:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
10 -
objectNum(required):
integer
Unique reference of the employee in the system.Example:
1 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field valueExample:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A collection of all visible hierarchy nodes to the particular employee in an organization.
Root Schema : EMCVisibilityv2GetResponse
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 EMC Visibility 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 EMC Visibility objects of the organization.
Show Source
-
Array of:
object EmployeeEMCVisibilityv2
Model for an Employee EMC Visibility Object
Nested Schema : EmployeeEMCVisibilityv2
Type:
objectModel for an Employee EMC Visibility Object
Show Source
-
hierUnitId:
integer
Unique reference of the hierarchy unit where the employee EMC visibility is configuredExample:
3599 -
hierUnitObjNum:
integer
Object number of the hierarchy unit where the employee EMC visibility is configuredExample:
26 -
objectNum:
integer
Unique reference of the employee in the system.Example:
1 -
propagateToChildren:
boolean
Boolean flag indicating if the EMC visibility is propagated to child nodes of the hierarchy unitExample:
true
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html