Configuration and Content API Guide

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 : schema

Type: object

The input Body model that needs to be given.

Show Source

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 returned

Example: 1,2,3
limit: integer

If using paging, number of results returned in this page.

Example: 100
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 supported

Example: 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)

{
    "description":"The input Body model that needs to be given.",
    "type":"object",
    "required":[
        "objectNum"
    ],
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(objectNum, 1)",
            "description":"If specified, returns records that match the criteria."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId, objectNum, name",
            "description":"If specified, limits the data returned to these fields."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"If this value is specified, the include parameter is ignored.\n<table>\n<tr>\n  <td><b>Value</b></td>\n  <td><b>Description</b></td>\n</tr>\n<tr>\n  <td>basic</td>\n  <td>Forces the response to include all fields except option string details</td>\n</tr>\n<tr>\n  <td>detailed</td>\n  <td>Forces the response to include all fields including option string details</td>\n</tr>\n</table>\n"
        },
        "langIds":{
            "type":"string",
            "description":"If specified, limits translated strings returned",
            "example":"1,2,3"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":100
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order.",
            "example":"hierUnitId:asc"
        },
        "objectNum":{
            "type":"integer",
            "description":"Unique reference of the employee in the system.",
            "example":1
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A Collection of Employee EMC Visibilties.

Root Schema : schema

Type: object

Show Source

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 size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Employee EMC Visibility objects of the organization.",
            "items":{
                "$ref":"#/definitions/EmployeeEMCVisibilityv2"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Employee EMC Visibility objects of the organization.

Show Source

Array of: object EmployeeEMCVisibilityv2

Model for an Employee EMC Visibility Object

{
    "type":"array",
    "description":"Array of Employee EMC Visibility objects of the organization.",
    "items":{
        "$ref":"#/definitions/EmployeeEMCVisibilityv2"
    }
}

Nested Schema : EmployeeEMCVisibilityv2

Type: object

Model for an Employee EMC Visibility Object

Show Source

hierUnitId: integer

Unique reference of the hierarchy unit where the employee EMC visibility is configured

Example: 3599
hierUnitObjNum: integer

Object number of the hierarchy unit where the employee EMC visibility is configured

Example: 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 unit

Example: true

{
    "description":"Model for an Employee EMC Visibility Object",
    "type":"object",
    "properties":{
        "objectNum":{
            "description":"Unique reference of the employee in the system.",
            "type":"integer",
            "example":1
        },
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the employee EMC visibility is configured",
            "type":"integer",
            "example":3599
        },
        "hierUnitObjNum":{
            "description":"Object number of the hierarchy unit where the employee EMC visibility is configured",
            "type":"integer",
            "example":26
        },
        "propagateToChildren":{
            "description":"Boolean flag indicating if the EMC visibility is propagated to child nodes of the hierarchy unit",
            "type":"boolean",
            "example":true
        }
    }
}

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