Configuration and Content API Guide

Get Roles

post

/config/sim/v1/employees/getRoles

Gets all the roles

Request

Supported Media Types

application/json
multipart/form-data

The input Body model that needs to be given.

Root Schema : schema

Type: object

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

{
    "type":"object",
    "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."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of Roles.

Root Schema : RolesGetResponsev1

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 role 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 role objects of the organization.",
            "items":{
                "$ref":"#/definitions/RolesResourceObjectv1"
            }
        },
        "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 role objects of the organization.

Show Source

Array of: object RolesResourceObjectv1

Model for Roles Object

{
    "type":"array",
    "description":"Array of role objects of the organization.",
    "items":{
        "$ref":"#/definitions/RolesResourceObjectv1"
    }
}

Nested Schema : RolesResourceObjectv1

Type: object

Model for Roles Object

Show Source

actions: array actions

An array of enablement of actions that can be performed by the role's users
comment: string

Description of the role in no more than 2000 characters

Example: Comment
dataExtensions: array dataExtensions

An array of data extensions for the Roles
emcControlLevel: integer

Security Level of the role.

Example: 0
emcModules: array emcModules

An array of privileges for access to EMC modules by the role
enableRVCLevelSecurity: boolean

A Boolean flag to restrict employees with this role to perform workstation operations only in revenue centers in which they are an operator.

Example: false
fields: array fields

An array of objects containing the access control to specific fields of the EMC module
flmModules: array flmModules

An array of privileges for access to FLM modules by the role
name: object name

A group of strings representing the name of the role
objectNum: integer

Object Number of the Role.

Example: 1
operations: array operations

An array of enablement of operations that can be performed by the role's users
visibility: array visibility

An array of hierarchy units where the role is visible

{
    "description":"Model for Roles Object",
    "type":"object",
    "properties":{
        "objectNum":{
            "description":"Object Number of the Role.",
            "type":"integer",
            "example":1
        },
        "name":{
            "description":"A group of strings representing the name of the role",
            "type":"object",
            "example":{
                "en-US":"Routing Group",
                "de-DE":"Routing-Gruppe"
            }
        },
        "emcControlLevel":{
            "type":"integer",
            "example":0,
            "description":"Security Level of the role."
        },
        "comment":{
            "type":"string",
            "example":"Comment",
            "description":"Description of the role in no more than 2000 characters"
        },
        "emcModules":{
            "description":"An array of privileges for access to EMC modules by the role",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_emcModule"
            }
        },
        "flmModules":{
            "description":"An array of privileges for access to FLM modules by the role",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_flmModule"
            }
        },
        "actions":{
            "description":"An array of enablement of actions that can be performed by the role's users",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_actions"
            }
        },
        "operations":{
            "description":"An array of enablement of operations that can be performed by the role's users",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_operations"
            }
        },
        "visibility":{
            "description":"An array of hierarchy units where the role is visible",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_visibility"
            }
        },
        "enableRVCLevelSecurity":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag to restrict employees with this role to perform workstation operations only in revenue centers in which they are an operator."
        },
        "fields":{
            "description":"An array of objects containing the access control to specific fields of the EMC module",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_fields"
            }
        },
        "dataExtensions":{
            "description":"An array of data extensions for the Roles",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_dataExtensions"
            }
        }
    }
}

Nested Schema : actions

Type: array

An array of enablement of actions that can be performed by the role's users

Show Source

Array of: object Role_actions

{
    "description":"An array of enablement of actions that can be performed by the role's users",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Role_actions"
    }
}

Nested Schema : dataExtensions

Type: array

An array of data extensions for the Roles

Show Source

Array of: object Role_dataExtensions

{
    "description":"An array of data extensions for the Roles",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Role_dataExtensions"
    }
}

Nested Schema : emcModules

Type: array

An array of privileges for access to EMC modules by the role

Show Source

Array of: object Role_emcModule

{
    "description":"An array of privileges for access to EMC modules by the role",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Role_emcModule"
    }
}

Nested Schema : fields

Type: array

An array of objects containing the access control to specific fields of the EMC module

Show Source

Array of: object Role_fields

{
    "description":"An array of objects containing the access control to specific fields of the EMC module",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Role_fields"
    }
}

Nested Schema : flmModules

Type: array

An array of privileges for access to FLM modules by the role

Show Source

Array of: object Role_flmModule

{
    "description":"An array of privileges for access to FLM modules by the role",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Role_flmModule"
    }
}

Nested Schema : name

Type: object

A group of strings representing the name of the role

Example:

{
    "en-US":"Routing Group",
    "de-DE":"Routing-Gruppe"
}

Nested Schema : operations

Type: array

An array of enablement of operations that can be performed by the role's users

Show Source

Array of: object Role_operations

{
    "description":"An array of enablement of operations that can be performed by the role's users",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Role_operations"
    }
}

Nested Schema : visibility

Type: array

An array of hierarchy units where the role is visible

Show Source

Array of: object Role_visibility

{
    "description":"An array of hierarchy units where the role is visible",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Role_visibility"
    }
}

Nested Schema : Role_actions

Type: object

Show Source

enable: boolean

A Boolean flag representing the enablement of the action for the role's users

Example: false
name: string

The name of the action

Example: key action
privilegeNum: integer

A unique reference of the privilege associated with the action

Example: 3

{
    "type":"object",
    "properties":{
        "privilegeNum":{
            "type":"integer",
            "example":3,
            "description":"A unique reference of the privilege associated with the action"
        },
        "name":{
            "type":"string",
            "example":"key action",
            "description":"The name of the action"
        },
        "enable":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag representing the enablement of the action for the role's users"
        }
    }
}

Nested Schema : Role_dataExtensions

Type: object

Show Source

columnName: string

Name of the extention field

Example: Name of the extention field
value: string

Value of the extention field

Example: Value 1

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "example":"Value 1",
            "description":"Value of the extention field"
        },
        "columnName":{
            "type":"string",
            "example":"Name of the extention field",
            "description":"Name of the extention field"
        }
    }
}

Nested Schema : Role_emcModule

Type: object

Show Source

moduleName: string

The name of the EMC module

Example: Global Access
moduleNum: integer

The unique reference of the EMC module

Example: 1
privileges: string

A string value of 0s & 1s of length 11 representing the enablement or disablement of the privileges associated with the EMC module's access associated with the role

Example: 00000000000
privilegesExt: object Role_emcModule_privilegesExt

An object containing the descriptive options list associated with the EMC module's access associated with the role

{
    "type":"object",
    "properties":{
        "moduleNum":{
            "type":"integer",
            "example":1,
            "description":"The unique reference of the EMC module"
        },
        "moduleName":{
            "type":"string",
            "example":"Global Access",
            "description":"The name of the EMC module"
        },
        "privileges":{
            "type":"string",
            "example":"00000000000",
            "description":"A string value of 0s & 1s of length 11 representing the enablement or disablement of the privileges associated with the EMC module's access associated with the role"
        },
        "privilegesExt":{
            "$ref":"#/definitions/Role_emcModule_privilegesExt"
        }
    }
}

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

add: boolean

A Boolean flag to allow the addition of records of the EMC module for the role's users

Example: false
addOverride: boolean

A Boolean flag representing to allow override of records of the EMC module for the role's users

Example: false
allowDuplicateName: boolean

A Boolean flag representing to allow duplicate names in records for the EMC module for the role's users

Example: false
allowDuplicateObjNum: boolean

A Boolean flag representing to allow duplicate object numbers in records for the EMC module for the role's users

Example: false
delete: boolean

A Boolean flag representing the enablement of the delete records of the EMC module for the role's users

Example: true
edit: boolean

A Boolean flag to allow the editing of records of the EMC module for the role's users

Example: true
fieldLevelSecurity: boolean

A Boolean flag representing the enablement of the field level security for the EMC module for the role's users

Example: false
view: boolean

A Boolean flag to allow the viewing of records of the EMC module for the role's users

Example: true

{
    "type":"object",
    "description":"An object containing the descriptive options list associated with the EMC module's access associated with the role",
    "properties":{
        "view":{
            "type":"boolean",
            "example":true,
            "description":"A Boolean flag to allow the viewing of records of the EMC module for the role's users"
        },
        "edit":{
            "type":"boolean",
            "example":true,
            "description":"A Boolean flag to allow the editing of records of the EMC module for the role's users"
        },
        "add":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag to allow the addition of records of the EMC module for the role's users"
        },
        "delete":{
            "type":"boolean",
            "example":true,
            "description":"A Boolean flag representing the enablement of the delete records of the EMC module for the role's users"
        },
        "addOverride":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag representing to allow override of records of the EMC module for the role's users"
        },
        "allowDuplicateObjNum":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag representing to allow duplicate object numbers in records for the EMC module for the role's users"
        },
        "allowDuplicateName":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag representing to allow duplicate names in records for the EMC module for the role's users"
        },
        "fieldLevelSecurity":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag representing the enablement of the field level security for the EMC module for the role's users"
        }
    }
}

Nested Schema : Role_fields

Type: object

Show Source

controls: array controls

An array of controls for each EMC module
moduleName: string

Name of the EMC module.

Example: Menu Item Masters
moduleNum: integer

Unique reference of the module

Example: 1

{
    "type":"object",
    "properties":{
        "moduleNum":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the module"
        },
        "moduleName":{
            "type":"string",
            "example":"Menu Item Masters",
            "description":"Name of the EMC module."
        },
        "controls":{
            "type":"array",
            "description":"An array of controls for each EMC module\n",
            "items":{
                "$ref":"#/definitions/Role_fields_controls"
            }
        }
    }
}

Nested Schema : controls

Type: array

An array of controls for each EMC module

Show Source

Array of: object Role_fields_controls

{
    "type":"array",
    "description":"An array of controls for each EMC module\n",
    "items":{
        "$ref":"#/definitions/Role_fields_controls"
    }
}

Nested Schema : Role_fields_controls

Type: object

Show Source

controlName: string

Name of the field control

Example: Global Access
controlNum: integer

Unique reference of the field control

Example: 1
privileges: string

A string value of 0's & 1's representing the enablement or disablement of the privileges associated with the field control

Example: 00000000
privilegesExt: object Role_controls_privilegesExt

An object containing the descriptive options list associated with the EMC module's access associated with the role

{
    "type":"object",
    "properties":{
        "controlNum":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the field control"
        },
        "controlName":{
            "type":"string",
            "example":"Global Access",
            "description":"Name of the field control"
        },
        "privileges":{
            "type":"string",
            "example":"00000000",
            "description":"A string value of 0's & 1's representing the enablement or disablement of the privileges associated with the field control"
        },
        "privilegesExt":{
            "$ref":"#/definitions/Role_controls_privilegesExt"
        }
    }
}

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

editable: boolean

A Boolean flag indicating the field is editable

Example: true
exclude: boolean

A Boolean flag indicating if the field is excluded.

Example: false
viewOnly: boolean

A Boolean flag indicating the field is only for Viewing

Example: true

{
    "type":"object",
    "description":"An object containing the descriptive options list associated with the EMC module's access associated with the role",
    "properties":{
        "editable":{
            "type":"boolean",
            "example":true,
            "description":"A Boolean flag indicating the field is editable"
        },
        "viewOnly":{
            "type":"boolean",
            "example":true,
            "description":"A Boolean flag indicating the field is only for Viewing"
        },
        "exclude":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating if the field is excluded."
        }
    }
}

Nested Schema : Role_flmModule

Type: object

Show Source

moduleName: string

The name of the FLM module

Example: Global Access
moduleNum: integer

The unique reference of the FLM module

Example: 1
privileges: string

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
privilegesExt: object Role_flmModule_privilegesExt

An object containing the descriptive options list associated with the FLM module's access associated with the role

{
    "type":"object",
    "properties":{
        "moduleNum":{
            "type":"integer",
            "example":1,
            "description":"The unique reference of the FLM module"
        },
        "moduleName":{
            "type":"string",
            "example":"Global Access",
            "description":"The name of the FLM module"
        },
        "privileges":{
            "type":"string",
            "example":"11110001000",
            "description":"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."
        },
        "privilegesExt":{
            "$ref":"#/definitions/Role_flmModule_privilegesExt"
        }
    }
}

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

add: boolean

A Boolean flag to allow the addition of records of the FLM module for the role's users

Example: false
addOverride: boolean

A Boolean flag representing to allow override of records of the FLM module for the role's users

Example: false
delete: boolean

A Boolean flag representing the enablement of the delete records of the FLM module for the role's users

Example: true
edit: boolean

A Boolean flag to allow the editing of records of the FLM module for the role's users

Example: true
view: boolean

A Boolean flag to allow the viewing of records of the FLM module for the role's users

Example: true

{
    "type":"object",
    "description":"An object containing the descriptive options list associated with the FLM module's access associated with the role",
    "properties":{
        "view":{
            "type":"boolean",
            "example":true,
            "description":"A Boolean flag to allow the viewing of records of the FLM module for the role's users"
        },
        "edit":{
            "type":"boolean",
            "example":true,
            "description":"A Boolean flag to allow the editing of records of the FLM module for the role's users"
        },
        "add":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag to allow the addition of records of the FLM module for the role's users"
        },
        "delete":{
            "type":"boolean",
            "example":true,
            "description":"A Boolean flag representing the enablement of the delete records of the FLM module for the role's users"
        },
        "addOverride":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag representing to allow override of records of the FLM module for the role's users"
        }
    }
}

Nested Schema : Role_operations

Type: object

Show Source

enable: boolean

A Boolean flag representing the enablement of the operation for the role's users

Example: false
name: string

The name of the operation

Example: key action
privilegeNum: integer

A unique reference of the privilege associated with the operation

Example: 3

{
    "type":"object",
    "properties":{
        "privilegeNum":{
            "type":"integer",
            "example":3,
            "description":"A unique reference of the privilege associated with the operation"
        },
        "name":{
            "type":"string",
            "example":"key action",
            "description":"The name of the operation"
        },
        "enable":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag representing the enablement of the operation for the role's users"
        }
    }
}

Nested Schema : Role_visibility

Type: object

Show Source

hierUnitId: integer

Unique hierarchy unit value.

Example: 1
hierUnitName: object hierUnitName

Hier Unit Name
hierUnitObjNum: integer

Hierarchy unit object number

Example: 1
propagateToChildren: integer

A Boolean flag to make the role visible in the selected zones/locations and all children. Deselect to make the role visible only in the selected zone/location

Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value."
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Hierarchy unit object number"
        },
        "hierUnitName":{
            "description":"Hier Unit Name",
            "type":"object",
            "example":{
                "en-US":"Enterprise",
                "de-DE":"Unternehmen",
                "es-MX":"Empresa"
            }
        },
        "propagateToChildren":{
            "type":"integer",
            "example":1,
            "description":"A Boolean flag to make the role visible in the selected zones/locations and all children. Deselect to make the role visible only in the selected zone/location"
        }
    }
}

Nested Schema : hierUnitName

Type: object

Hier Unit Name

Example:

{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}