Jump to

• Request
• Response

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

Body ()

A request body

Root Schema : EMCVisibilityGetRequestBody

Type: object

The input Body model that needs to be given.

Show Source

• include: string
  Objects included in response
• 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 translated strings returned
• limit: integer
  If using paging, number of results returned in this page.
• 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
• orderBy: string
  Sorts the response by the specified field name and sort order.
• searchCriteria: string
  Search criteria to filter results based on field value

{
    "description":"The input Body model that needs to be given.",
    "type":"object",
    "required":[
        "objectNum"
    ],
    "properties":{
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "description":"Objects included in 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",
            "description":"If specified, limits translated strings returned"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "description":"Sorts the response by the specified field name and sort order.",
            "type":"string"
        },
        "objectNum":{
            "type":"integer",
            "description":"Unique reference of the employee in the system.",
            "example":1
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of all visible hierarchy nodes to the particular employee in an organization.

Body ()

Root Schema : EmployeeEMCVisibility

Type: object

Model for an Employee EMC Visibility Object

Show Source

• hierObjNum(required): integer
  Object number of the hierarchy unit where the employee EMC visibility is configured

  Example: 26
• hierUnitId(required): integer
  Unique reference of the hierarchy unit where the employee EMC visibility is configured

  Example: 3599
• hierUnitName(required): object HierUnitNameTranslatedString
  A string that contains translations of hierarchy unit name into multiple languages
• objectNum(required): integer
  Unique reference of the employee in the system.

  Example: 1
• propagateToChildren(required): 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",
    "required":[
        "hierUnitId",
        "objectNum",
        "hierObjNum",
        "hierUnitName",
        "propagateToChildren"
    ],
    "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
        },
        "hierObjNum":{
            "description":"Object number of the hierarchy unit where the employee EMC visibility is configured",
            "type":"integer",
            "example":26
        },
        "hierUnitName":{
            "$ref":"#/definitions/HierUnitNameTranslatedString"
        },
        "propagateToChildren":{
            "description":"Boolean flag indicating if the EMC visibility is propagated to child nodes of the hierarchy unit",
            "type":"boolean",
            "example":true
        }
    }
}

Nested Schema : HierUnitNameTranslatedString

Type: object

A string that contains translations of hierarchy unit name into multiple languages

Example:

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

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response 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 problem

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

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top