1. Configuration and Content API Guide
  2. Tasks
  3. v2
  4. Employees
  5. Roles

Get Roles

post

/config/sim/v2/employees/getRoles

Gets all the roles

Request

Supported Media Types
Body ()
The input Body model that needs to be given.
Root Schema : schema
Type: object
Show Source
  • If specified, limits the data returned to these fields.
    Example: hierUnitId, objectNum, name
  • 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
  • If specified, limits translated strings returned
    Example: 1,2,3
  • If using paging, number of results returned in this page.
    Example: 100
  • Starting resource record index. Not required if paging parameters are not supported
    Example: 0
  • Sorts the response by the specified field name and sort order.
    Example: hierUnitId:asc
  • If specified, returns records that match the criteria.
    Example: where equals(hierUnitId, 7)
Back to Top

Response

Supported Media Types

200 Response

A collection of Roles.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Array of role objects of the organization.
Show Source
Nested Schema : RolesResourceObjectv2
Type: object
Model for Roles Object
Show Source
Nested Schema : actions
Type: array
An array of enablement of actions that can be performed by the role's users
Show Source
Nested Schema : dataExtensions
Type: array
An array of data extensions for the Roles
Show Source
Nested Schema : emcModules
Type: array
An array of privileges for access to EMC modules by the role
Show Source
Nested Schema : fields
Type: array
An array of objects containing the access control to specific fields of the EMC module
Show Source
Nested Schema : flmModules
Type: array
An array of privileges for access to FLM modules by the role
Show Source
Nested Schema : name
Type: object
Role Name
Example:
{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}
Nested Schema : operations
Type: array
An array of enablement of operations that can be performed by the role's users
Show Source
Nested Schema : visibility
Type: array
An array of hierarchy units where the role is visible
Show Source
Nested Schema : Role_actions
Type: object
Show Source
  • A Boolean flag representing the enablement of the action for the role's users
    Example: false
  • The name of the action
    Example: key action
  • A unique reference of the privilege associated with the action
    Example: 3
Nested Schema : Role_dataExtensions
Type: object
Show Source
Nested Schema : Role_emcModule
Type: object
Show Source
Nested Schema : Role_emcModule_privilegesExt
Type: object
An object containing the descriptive options list associated with the EMC module's access associated with the role
Show Source
  • A Boolean flag to allow the addition of records of the EMC module for the role's users
    Example: false
  • A Boolean flag representing to allow override of records of the EMC module for the role's users
    Example: false
  • A Boolean flag representing to allow duplicate names in records for the EMC module for the role's users
    Example: false
  • A Boolean flag representing to allow duplicate object numbers in records for the EMC module for the role's users
    Example: false
  • A Boolean flag representing the enablement of the delete records of the EMC module for the role's users
    Example: true
  • A Boolean flag to allow the editing of records of the EMC module for the role's users
    Example: true
  • A Boolean flag representing the enablement of the field level security for the EMC module for the role's users
    Example: false
  • A Boolean flag to allow the viewing of records of the EMC module for the role's users
    Example: true
Nested Schema : Role_fields
Type: object
Show Source
Nested Schema : controls
Type: array
An array of controls for each EMC module
Show Source
Nested Schema : Role_fields_controls
Type: object
Show Source
Nested Schema : Role_controls_privilegesExt
Type: object
An object containing the descriptive options list associated with the EMC module's access associated with the role
Show Source
Nested Schema : Role_flmModule
Type: object
Show Source
  • The name of the FLM module
    Example: Global Access
  • The unique reference of the FLM module
    Example: 1
  • A string value of 0s & 1s of length 11 representing the enablement or disablement of the privileges associated with the FLM module's access associated with the role. Bit positions 1, 2, 3, 4 and 8 represent view, edit, add, delete and addOverride respectively.
    Example: 11110001000
  • Role_flmModule_privilegesExt
    An object containing the descriptive options list associated with the FLM module's access associated with the role
Nested Schema : Role_flmModule_privilegesExt
Type: object
An object containing the descriptive options list associated with the FLM module's access associated with the role
Show Source
  • A Boolean flag to allow the addition of records of the FLM module for the role's users
    Example: false
  • A Boolean flag representing to allow override of records of the FLM module for the role's users
    Example: false
  • A Boolean flag representing the enablement of the delete records of the FLM module for the role's users
    Example: true
  • A Boolean flag to allow the editing of records of the FLM module for the role's users
    Example: true
  • A Boolean flag to allow the viewing of records of the FLM module for the role's users
    Example: true
Nested Schema : Role_operations
Type: object
Show Source
  • A Boolean flag representing the enablement of the operation for the role's users
    Example: false
  • The name of the operation
    Example: key action
  • A unique reference of the privilege associated with the operation
    Example: 3
Nested Schema : Role_visibilityv2
Type: object
Show Source
Back to Top