Get all roles

get

/hcmRestApi/resources/11.13.18.05/rolesLOV

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds all the roles that match the specified primary key criteria.
      Finder Variables
      • RoleId; integer; Surrogate identifier attribute for the role.
    • findByWord Finds all the roles that match the specified word.
      Finder Variables
      • FilterAttributes; string; Filter attributes for the search criteria.
      • SearchTerms; string; Search term criteria to find roles.
      • StartsWithFlag; boolean; Indicates whether the role search is based on the term that begins with the entered value.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AbstractRole; string; Indicates whether the role is an abstract role. Valid values are Y and N.
    • ActiveFlag; boolean; Indicates whether the role is an active role. Valid values are true and false.
    • DataRole; string; Indicates whether the role is a data role. Valid values are Y and N.
    • DelegationAllowed; string; Indicates whether the role can be delegated. Valid values are Y and N.
    • Description; string; Description for the role.
    • DutyRole; string; Indicates whether the role is a duty role. Valid values are Y and N.
    • ExternalRole; string; Indicates whether the role is an external role. Valid values are Y and N.
    • JobRole; string; Indicates whether the role is a job role. Valid values are Y and N.
    • ObjectVersionNumber; integer; Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
    • RoleCode; string; Common Name defined in LDAP.
    • RoleId; integer; Surrogate identifier for the role.
    • RoleName; string; Name of the role.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : rolesLOV
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : rolesLOV-item-response
Type: object
Show Source
  • Title: Abstract Role
    Maximum Length: 30
    Indicates whether the role is an abstract role. Valid values are Y and N.
  • Title: Status
    Maximum Length: 30
    Indicates whether the role is an active role. Valid values are true and false.
  • Title: Data Role
    Maximum Length: 30
    Indicates whether the role is a data role. Valid values are Y and N.
  • Maximum Length: 30
    Indicates whether the role can be delegated. Valid values are Y and N.
  • Title: Description
    Maximum Length: 240
    Description for the role.
  • Maximum Length: 30
    Indicates whether the role is a duty role. Valid values are Y and N.
  • Maximum Length: 30
    Indicates whether the role is an external role. Valid values are Y and N.
  • Title: Job Role
    Maximum Length: 30
    Indicates whether the role is a job role. Valid values are Y and N.
  • Links
  • Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
  • Title: Role Code
    Maximum Length: 240
    Common Name defined in LDAP.
  • Surrogate identifier for the role.
  • Title: Role Name
    Maximum Length: 240
    Name of the role.
Back to Top

Examples

The following example shows how to retrieve all the roles by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/rolesLOV

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "items": [
    {
      "RoleId": 300100123948710,
      "RoleName": " ADV CNTRL INCIDENT AND CONTROL VIEWER CUSTOM - AUDITOR",
      "RoleCode": "ADV_CNTRL_INCIDENT_AND_CONTROL_VIEWER_CUSTOM_AUDITOR",
      "Description": "ADV CNTRL INCIDENT AND CONTROL VIEWER CUSTOM - AUDITOR    ",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 99,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100150840404,
      "RoleName": "110_Custom_Segment_Security",
      "RoleCode": "110_Custom_Segment_Security",
      "Description": "For Test Segment Security",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "N",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 1,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100137470175,
      "RoleName": "11_ProcurementWebServiceRole",
      "RoleCode": "11_PRCPREREQ_WS_JOB_ROLE",
      "Description": "Procurement professional responsible for identifying savings opportunities, determining negotiation strategies, creating request for quote, request for information, request for proposal, or auction events on behalf of their organization and awarding future business typically in the form of contracts or purchase orders to suppliers.",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 123,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100137447335,
      "RoleName": "1_ProcurementRole",
      "RoleCode": "ADV_CNTRL_PON_CATEGORY_MANAGER_JOB_CUSTOM2017Sep221313",
      "Description": "Procurement professional responsible for identifying savings opportunities, determining negotiation strategies, creating request for quote, request for information, request for proposal, or auction events on behalf of their organization and awarding future business typically in the form of contracts or purchase orders to suppliers.",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 82,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100123855606,
      "RoleName": "AAC Application Access Auditor Custom",
      "RoleCode": "AAC_GTG_APPLICATION_ACCESS_AUDITOR_JOB_CUSTOM",
      "Description": "Automation Team Role",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 100,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100172271269,
      "RoleName": "AAC Application Access Auditor Custom1025",
      "RoleCode": "AAC_GTG_APPLICATION_ACCESS_AUDITOR_JOB_CUSTOM1025",
      "Description": "Individual responsible for managing and auditing enterprise advanced access controls.",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 24,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100123943260,
      "RoleName": "AAC Application Access Auditor Custom2017Sep221308",
      "RoleCode": "AAC_GTG_APPLICATION_ACCESS_AUDITOR_JOB_CUSTOM2017Sep221308",
      "Description": "Automation Team Role",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 99,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100148476564,
      "RoleName": "AAC Application Access Auditor Demo",
      "RoleCode": "AACApplicationAccessAuditorDemo",
      "Description": "Individual responsible for managing and auditing enterprise advanced access controls.",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 81,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100176796789,
      "RoleName": "AAC Compliance Manager Custom",
      "RoleCode": "AAC_GTG_COMPLIANCE_MANAGER_JOB_CUSTOM",
      "Description": "Automation Team Role",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 11,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100172376261,
      "RoleName": "AAC Compliance Manager Custom1025",
      "RoleCode": "AAC_GTG_COMPLIANCE_MANAGER_JOB_CUSTOM1025",
      "Description": "Individual responsible for managing enterprise compliance programs.",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 24,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100123829511,
      "RoleName": "AAC Manager System Administrator Composite Custom",
      "RoleCode": "AAC_Manager_System_Administrator_Composite_Custom",
      "Description": "Automation Team Role",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 100,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100172376302,
      "RoleName": "AAC Manager System Administrator Composite Custom1025",
      "RoleCode": "AAC_Manager_System_Administrator_Composite_Custom1025",
      "Description": null,
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 24,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100123856407,
      "RoleName": "AAC Manager System Administrator Composite Custom2017Sep21_0123",
      "RoleCode": "AAC_Manager_System_Administrator_Composite_Custom2017Sep21_0123",
      "Description": "Automation Team Role",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 100,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100123944059,
      "RoleName": "AAC Manager System Administrator Composite Custom2017Sep22_1322",
      "RoleCode": "AAC_Manager_System_Administrator_Composite_Custom2017Sep22_1322",
      "Description": "Automation Team Role",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 99,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100148476473,
      "RoleName": "AAC Manager System Administrator Composite Demo",
      "RoleCode": "AACManagerSystemAdministratorCompositeDemo",
      "Description": "Automation Team Role",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 81,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100124113059,
      "RoleName": "AAC Perspective manager Job Role",
      "RoleCode": "AAC_Perspective_manager_Job_Role",
      "Description": "AAC Perspective manager Job Role",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 99,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100148711716,
      "RoleName": "AAC View Perspective Demo",
      "RoleCode": "AACViewPerspectiveDemo",
      "Description": "Automation Team Role",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 81,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100123833623,
      "RoleName": "AAC View Perspective Hierarchy Custom",
      "RoleCode": "AAC_VIEW_PERSPECTIVE_HIERARCHY_CUSTOM",
      "Description": "Automation Team Role",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 100,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100172423452,
      "RoleName": "AAC View Perspective Hierarchy Custom1025",
      "RoleCode": "AAC_View_Perspective_Hierarchy_Custom1025",
      "Description": null,
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 23,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100123944036,
      "RoleName": "AAC View Perspective Hierarchy Custom2017Sep221319",
      "RoleCode": "AAC_VIEW_PERSPECTIVE_HIERARCHY_CUSTOM2017Sep221319",
      "Description": "Automation Team Role",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 99,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100176669280,
      "RoleName": "AAC View Perspective Hierarchy Custom2018Apr26111742",
      "RoleCode": "AAC_VIEW_PERSPECTIVE_HIERARCHY_CUSTOM2018Apr26111742",
      "Description": "Automation Team Role",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 11,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100169896430,
      "RoleName": "AC Admin Job Role",
      "RoleCode": "AC_CUST_ADMIN_JOB",
      "Description": "Advanced Controls Admin Job Role",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 45,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100168426830,
      "RoleName": "ACERT Access Certification Administrator Custom",
      "RoleCode": "ACERT_Access_Certification_Administrator_Custom",
      "Description": "ACERT Access Certification Administrator Custom ",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 55,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100168426884,
      "RoleName": "ACERT Access Certification Auditor Custom",
      "RoleCode": "ACERT_Access_Certification_Auditor_Custom",
      "Description": "ACERT Access Certification Auditor Custom ",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 53,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "RoleId": 300100171279047,
      "RoleName": "ACERT Access Certification Certifier Custom",
      "RoleCode": "ACERT_ACCESS_CERTIFICATION_CERTIFIER_CUSTOM",
      "Description": "Automation Team Role",
      "ActiveFlag": true,
      "AbstractRole": "N",
      "DataRole": "N",
      "JobRole": "Y",
      "DutyRole": "N",
      "DelegationAllowed": "N",
      "ExternalRole": null,
      "ObjectVersionNumber": 27,
      "links" : [ 
          {
            ...}
      ]
  ]
}
Back to Top