Configuration and Content API Guide

Add Roles

post

/config/sim/v2/employees/roles

Add the role to the specified organization.

Request

Supported Media Types

application/json
multipart/form-data

Roles Resource Object

Root Schema : RolesCURequestBodyv2

Type: object

Model for Roles Object

Show Source

actions: array actions

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

Description of the role in no more than 2000 characters

Example: Comment
dataExtensions: array dataExtensions

An array of privileges for access to EMC modules by the role
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 privileges for access to EMC modules by the role
flmModules: array flmModules

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

Role Name
objectNum(required): integer

Object Number of the Role.

Example: 1
operations: array operations

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

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

{
    "description":"Model for Roles Object",
    "type":"object",
    "required":[
        "objectNum",
        "name"
    ],
    "properties":{
        "objectNum":{
            "description":"Object Number of the Role.",
            "type":"integer",
            "example":"1"
        },
        "name":{
            "type":"object",
            "description":"Role Name",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        },
        "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_emcModuleCU"
            }
        },
        "flmModules":{
            "description":"An array of privileges for access to FLM modules by the role",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_flmModuleCU"
            }
        },
        "actions":{
            "description":"An array of privileges for access to EMC modules by the role",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_actionsCU"
            }
        },
        "operations":{
            "description":"An array of privileges for access to EMC modules by the role",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_operationsCU"
            }
        },
        "visibility":{
            "description":"An array of privileges for access to EMC modules by the role",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_visibilityCU"
            }
        },
        "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 privileges for access to EMC modules by the role",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_fieldsCU"
            }
        },
        "dataExtensions":{
            "description":"An array of privileges for access to EMC modules by the role",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_dataExtensionsCU"
            }
        }
    }
}

Nested Schema : actions

Type: array

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

Show Source

Array of: object Role_actionsCU

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

Nested Schema : dataExtensions

Type: array

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

Show Source

Array of: object Role_dataExtensionsCU

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

Nested Schema : emcModules

Type: array

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

Show Source

Array of: object Role_emcModuleCU

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

Nested Schema : fields

Type: array

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

Show Source

Array of: object Role_fieldsCU

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

Nested Schema : flmModules

Type: array

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

Show Source

Array of: object Role_flmModuleCU

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

Nested Schema : name

Type: object

Role Name

Example:

{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}

Nested Schema : operations

Type: array

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

Show Source

Array of: object Role_operationsCU

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

Nested Schema : visibility

Type: array

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

Show Source

Array of: object Role_visibilityCU

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

Nested Schema : Role_actionsCU

Type: object

Show Source

enable: boolean

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

Example: false
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"
        },
        "enable":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag representing the enablement of the action for the role???s users"
        }
    }
}

Nested Schema : Role_dataExtensionsCU

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_emcModuleCU

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "moduleNum":{
            "type":"integer",
            "example":"1",
            "description":"The unique reference 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"
        }
    }
}

Nested Schema : Role_fieldsCU

Type: object

Show Source

controls: array controls

An array of controls for each EMC module
moduleNum: integer

Unique reference of the module

Example: 1

{
    "type":"object",
    "properties":{
        "moduleNum":{
            "type":"integer",
            "example":"1",
            "description":"Unique reference of the module"
        },
        "controls":{
            "type":"array",
            "description":"An array of controls for each EMC module\n",
            "items":{
                "$ref":"#/definitions/Role_fields_controlsCU"
            }
        }
    }
}

Nested Schema : controls

Type: array

An array of controls for each EMC module

Show Source

Array of: object Role_fields_controlsCU

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

Nested Schema : Role_fields_controlsCU

Type: object

Show Source

controlName: string

Name of the field control

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

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

Nested Schema : Role_flmModuleCU

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "moduleNum":{
            "type":"integer",
            "example":"1",
            "description":"The unique reference 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."
        }
    }
}

Nested Schema : Role_operationsCU

Type: object

Show Source

enable: boolean

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

Example: false
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"
        },
        "enable":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag representing the enablement of the operation for the role???s users"
        }
    }
}

Nested Schema : Role_visibilityCU

Type: object

Show Source

hierUnitId: integer

Unique hierarchy unit value.

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."
        },
        "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"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

response object

Root Schema : RolesResponse

Type: object

Show Source

objectNum(required): integer

Object number of the role

Example: 1

{
    "type":"object",
    "required":[
        "objectNum"
    ],
    "properties":{
        "objectNum":{
            "type":"integer",
            "example":"1",
            "description":"Object number of the role"
        }
    }
}

400 Response

400 Bad Request

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"
        }
    }
}