Configuration and Content API Guide

Get Employee EMC Visibility

post

/config/sim/v1/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 : EMCVisibilityGetRequestBodyv1

Type: object

The input Body model that needs to be given.

Show Source

include: string

Objects included in the response.

Example: 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
languages: string

If specified, limits the translated strings returned.

Example: en-US, es-ES, es-MX
limit: integer

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

Example: 0
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: objectNum:asc
searchCriteria: string

Search criteria to filter results based on field value.

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":"Search criteria to filter results based on field value."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId",
            "description":"Objects included in the response."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n"
        },
        "languages":{
            "type":"string",
            "example":"en-US, es-ES, es-MX",
            "description":"If specified, limits the translated strings returned."
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index. Not required if paging parameters are not supported."
        },
        "limit":{
            "type":"integer",
            "example":0,
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"string",
            "example":"objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order."
        },
        "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 : EMCVisibilityGetResponseV1

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/EmployeeEMCVisibilityv1"
            }
        },
        "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 EmployeeEMCVisibilityv1

Model for an Employee EMC Visibility Object

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

Nested Schema : EmployeeEMCVisibilityv1

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
hierUnitName: object hierUnitName

A group of string objects representing the name of the hierarchy unit configured languages.
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
        },
        "hierUnitName":{
            "type":"object",
            "description":"A group of string objects representing the name of the hierarchy unit configured languages.",
            "example":{
                "en-US":"Property",
                "de-DE":"Eigentum",
                "es-MX":"Propiedad"
            }
        },
        "propagateToChildren":{
            "description":"Boolean flag indicating if the EMC visibility is propagated to child nodes of the hierarchy unit",
            "type":"boolean",
            "example":true
        }
    }
}

Nested Schema : hierUnitName

Type: object

A group of string objects representing the name of the hierarchy unit configured languages.

Example:

{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "es-MX":"Propiedad"
}