Jump to

• Request
• Response

Get Roles

post

/config/sim/v1/getRoles

Gets all the roles

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Roles Get Request Body

Root Schema : RolesGetRequestBody

Type: object

Show Source

• include(optional): string
  Example: locations
• languages(optional): string
  If specified, limits translated strings returned.

  Example: en-US, es-SS,lt-LT
• limit(optional): integer
  Number of results returned in this page. Not required if paging parameters are not supported.

  Example: 10
• offset(optional): integer
  Starting resource record index. Not required if paging parameters are not supported

  Example: 2
• orderBy(optional): string
  Sorts the response by the specified field name and sort order.

  Example: items.objectNum:asc
• searchCriteria(optional): string
  Search criteria to filter results based on field value

  Example: where equals(active,1)

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "example":2,
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Number of results returned in this page. Not required if paging parameters are not supported."
        },
        "orderBy":{
            "type":"string",
            "example":"items.objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order."
        },
        "searchCriteria":{
            "type":"string",
            "example":"where equals(active,1)",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "example":"locations"
        },
        "languages":{
            "type":"string",
            "example":"en-US, es-SS,lt-LT",
            "description":"If specified, limits translated strings returned."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of Report Groups objects of the organization

Body ()

Root Schema : RolesGetResponse

Type: object

Show Source

• count(optional): integer
  Current response recount count.

  Example: 9
• hasMore(optional): boolean
  Flag indicating if there are more objects to fetch.

  Example: true
• items(optional): array items
  Array of role objects of the organization.
• limit(optional): integer
  Server page size

  Example: 10
• offset(optional): integer
  Starting resource record index

  Example: 0
• totalResults(optional): 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 recount count."
        },
        "items":{
            "type":"array",
            "description":"Array of role objects of the organization.",
            "items":{
                "$ref":"#/definitions/RolesResourceObject"
            }
        },
        "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 RolesResourceObject
  Model for Roles Object

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

Nested Schema : RolesResourceObject

Type: object

Model for Roles Object

Show Source

• actions(optional): array actions
  An array of privileges for access to EMC modules by the role
• comment(optional): string
  Description of the role in no more than 2000 characters

  Example: Comment
• dataExtentions(optional): array dataExtentions
  An array of privileges for access to EMC modules by the role
• emcControlLevel(optional): integer
  Security Level of the role.

  Example: 0
• emcModules(optional): array emcModules
  An array of privileges for access to EMC modules by the role
• enableRVCLevelSecurity(optional): 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(optional): array fields
  An array of privileges for access to EMC modules by the role
• hierUnitId(optional): integer
  unique hierarchy unit value

  Example: 1
• name: object name
  A group of strings representing the name of the role
• objectNum: integer
  Object Number of the Role.

  Example: 1
• operations(optional): array operations
  An array of privileges for access to EMC modules by the role
• visibility(optional): 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":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"unique hierarchy unit value"
        },
        "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"
            }
        },
        "actions":{
            "description":"An array of privileges for access to EMC modules by the role",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_actions"
            }
        },
        "operations":{
            "description":"An array of privileges for access to EMC modules by the role",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_operations"
            }
        },
        "visibility":{
            "description":"An array of privileges for access to EMC modules by the role",
            "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 privileges for access to EMC modules by the role",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_fields"
            }
        },
        "dataExtentions":{
            "description":"An array of privileges for access to EMC modules by the role",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role_dataExtentions"
            }
        }
    }
}

Nested Schema : actions

Type: array

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

Show Source

• Array of: object Role_actions

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

Nested Schema : dataExtentions

Type: array

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

Show Source

• Array of: object Role_dataExtentions

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

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 privileges for access to EMC modules by the role

Show Source

• Array of: object Role_fields

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

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 privileges for access to EMC modules by the role

Show Source

• Array of: object Role_operations

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

Nested Schema : visibility

Type: array

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

Show Source

• Array of: object Role_visibility

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

Nested Schema : Role_actions

Type: object

Show Source

• enable(optional): boolean
  A Boolean flag representing the enablement of the action for the role???s users

  Example: false
• name(optional): string
  The name of the action

  Example: key action
• privilegeNum(optional): 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_dataExtentions

Type: object

Show Source

• columnName(optional): string
  Name of the extention field

  Example: Name of the extention field
• value(optional): 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(optional): string
  The name of the EMC module

  Example: Global Access
• moduleNum(optional): integer
  The unique reference of the EMC module

  Example: 1
• privileges(optional): string
  A string value of 0???s & 1???s representing the enablement or disablement of the privileges associated with the EMC module???s access associated with the role

  Example: 00000000
• privilegesExt(optional): 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":"00000000",
            "description":"A string value of 0???s & 1???s 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(optional): boolean
  A Boolean flag to allow the addition of records of the EMC module for the role???s users

  Example: false
• addOverride(optional): boolean
  A Boolean flag representing to allow override of records of the EMC module for the role???s users

  Example: false
• allowDuplicateName(optional): boolean
  A Boolean flag representing to allow duplicate names in records for the EMC module for the role???s users

  Example: false
• allowDuplicateObjNum(optional): boolean
  A Boolean flag representing to allow duplicate object numbers in records for the EMC module for the role???s users

  Example: false
• delete(optional): boolean
  A Boolean flag representing the enablement of the delete records of the EMC module for the role???s users

  Example: true
• edit(optional): boolean
  A Boolean flag to allow the editing of records of the EMC module for the role???s users

  Example: true
• fieldLevelSecurity(optional): boolean
  A Boolean flag representing the enablement of the field level security for the EMC module for the role???s users

  Example: false
• view(optional): 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(optional): array controls
  An array of controls for each EMC module
• moduleName(optional): string
  moduleName Name of the EMC module.

  Example: Menu Item Masters
• moduleNum(optional): 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":"moduleName  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(optional): string
  Name of the field control

  Example: Global Access
• controlNum(optional): integer
  Unique reference of the field control

  Example: 1
• privileges(optional): 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(optional): 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(optional): boolean
  A Boolean flag indicating the field is editable

  Example: true
• exclude(optional): boolean
  A Boolean flag indicating if the field is excluded.

  Example: false
• viewOnly(optional): 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_operations

Type: object

Show Source

• enable(optional): boolean
  A Boolean flag representing the enablement of the operation for the role???s users

  Example: false
• name(optional): string
  The name of the operation

  Example: key action
• privilegeNum(optional): 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(optional): integer
  Unique hierarchy unit value.

  Example: 1
• hierUnitName(optional): object TranslatedString_HierUnitName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the hierarchy unit configured languages
• hierUnitObjNum(optional): integer
  Hierarchy unit object number

  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":{
            "$ref":"#/definitions/TranslatedString_HierUnitName"
        }
    }
}

Nested Schema : TranslatedString_HierUnitName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A group of string objects representing the name of the hierarchy unit configured languages",
    "example":{
        "en-US":"Enterprise",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

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

Example:

{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): 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",
    "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"
        }
    }
}

404 Response

404 Requested resource not found

Back to Top