| Name | Role | |
|---|---|---|
| Usage | RoleService | |
| createRole updateRole getRole getRoles getRoleByNamespaceCodeAndName | ||
| RoleQueryResults | Type | Complex |
| ShortName | Name | Type | Description | Required? | Read only? | Cardinality | XML Attribute? | Implementation Notes |
|---|---|---|---|---|---|---|---|---|
| id | Id | String | Unique identifier for this role. | Required | One | No | ||
| name | Name | String | Name for this role. This value will be seen by the users. | Required | One | No | ||
| namespaceCode | Namespace Code | String | Namespace for this role - identifies the system/module to which this role applies | Required | One | No | ||
| description | Description | String | Verbose description of the role and functionally what permissions it implies. | One | No | |||
| kimTypeId | Kim Type Id | String | Type identifier for this role. This will control what additional attributes are available | Required | One | No | ||
| active | Active | boolean | The active indicator for an object. | Required | One | No | ||
| versionNumber | Version Number | Long | Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking. |
One | No | |||
| objectId | Object Id | String | Return the globally unique object id of this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. |
One | No |