1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Resource Roles

Get all resource roles

get

/crmRestApi/resources/11.13.18.05/resourceRoles

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

    • AllActiveResourceRolesRowFinder Finds all active resource roles.
      Finder Variables
      • PrimaryKey Finds resource role details using primary key.
        Finder Variables
        • RoleId; integer; The unique identifier of the resource role used to find the resource.
      • ResourceRoleCodeRowFinder Finds resource role details using resource role code.
        Finder Variables
        • RoleCode; string; The unique identifier for the resource role.
      • RoleCode; string; Finds resource role details using the role code and the role type code.
        Finder Variables
        • RoleCode; string; The unique identifier for the resource role.
        • RoleTypeCode; string; The role type code for the resource role.
    • 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:
      • ActiveFlag; boolean; Flag to indicate if role is active.
      • AdministratorFlag; boolean; Flag indicating if this role is an administrator role or not.
      • CreatedBy; string; Who column: indicates the user who created the row.
      • CreationDate; string; Who column: indicates the date and time of the creation of the row.
      • LastUpdateDate; string; Who column: indicates the date and time of the last update of the row.
      • LastUpdateLogin; string; Who column: indicates the session login associated to the user who last updated the row.
      • LastUpdatedBy; string; Who column: indicates the user who last updated the row.
      • LeadFlag; boolean; Flag indicating if this role is a leader role or not.
      • ManagerFlag; boolean; Flag indicating if this role is a manager role or not.
      • MemberFlag; boolean; Flag indicating if this role is a member role or not.
      • ObjectVersionNumber; integer; Used to implement optimistic locking. This number is incremented every time that 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; Unqiue code for a resource role.
      • RoleCodeTypeSwitcher; string; The switcher used for the role type code list of values.
      • RoleDescription; string; Description for role.
      • RoleId; integer; Unique identifier for the role.
      • RoleName; string; Resource role name.
      • RoleTypeCode; string; Role type identifier.
      • SeededFlag; boolean; Flag indicating pre-defined role types.
    • 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 : resourceRoles
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : resourceRoles-item-response
    Type: object
    Show Source
    • Title: Active Flag
      Maximum Length: 1
      Default Value: true
      Flag to indicate if role is active.
    • Title: Administrator
      Maximum Length: 1
      Default Value: false
      Flag indicating if this role is an administrator role or not.
    • Title: Created By
      Read Only: true
      Maximum Length: 64
      Who column: indicates the user who created the row.
    • Title: Creation Date
      Read Only: true
      Who column: indicates the date and time of the creation of the row.
    • Title: Last Update Date
      Read Only: true
      Who column: indicates the date and time of the last update of the row.
    • Title: Last Updated By
      Read Only: true
      Maximum Length: 64
      Who column: indicates the user who last updated the row.
    • Read Only: true
      Maximum Length: 32
      Who column: indicates the session login associated to the user who last updated the row.
    • Title: Lead
      Maximum Length: 1
      Default Value: false
      Flag indicating if this role is a leader role or not.
    • Links
    • Title: Manager
      Maximum Length: 1
      Default Value: false
      Flag indicating if this role is a manager role or not.
    • Title: Member
      Maximum Length: 1
      Default Value: true
      Flag indicating if this role is a member role or not.
    • Read Only: true
      Used to implement optimistic locking. This number is incremented every time that 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: 30
      Unqiue code for a resource role.
    • Title: Role Code Type Switcher
      Read Only: true
      The switcher used for the role type code list of values.
    • Title: Role Description
      Maximum Length: 120
      Description for role.
    • Title: Role ID
      Read Only: true
      Unique identifier for the role.
    • Title: Role Name
      Maximum Length: 60
      Resource role name.
    • Title: Role Type
      Maximum Length: 240
      Role type identifier.
    • Title: System
      Read Only: true
      Maximum Length: 1
      Default Value: false
      Flag indicating pre-defined role types.
    Back to Top

    Examples

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

    cURL Command

    curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceRoles

    Example of Response Body

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

    {
    "items": [
        {
            "RoleId": 300100026992351,
            "RoleCode": "ExtnAutoRole ",
            "RoleTypeCode": "SALES",
            "SeededFlag": false,
            "MemberFlag": true,
            "AdministratorFlag": false,
            "LeadFlag": false,
            "ManagerFlag": false,
            "ActiveFlag": true,
            "ObjectVersionNumber": 2,
            "RoleName": "ExtnAutoRole",
            "RoleDescription": null,
            "CreatedBy": "FUSION",
            "CreationDate": "2013-08-22T07:26:41+00:00",
            "LastUpdatedBy": "FUSION",
            "LastUpdateDate": "2013-08-22T07:30:01+00:00",
            "LastUpdateLogin": "E46AC425367457F6E0435260F00A682D",
            "RoleCodeTypeSwitcher": "LOV_RoleTypeCodeVal",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceRoles/ExtnAutoRole%20",
                    "name": "resourceRoles",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceRoles/ExtnAutoRole%20",
                    "name": "resourceRoles",
                    "kind": "item"
                }
            ]
        },...
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceRoles",
            "name": "resourceRoles",
            "kind": "collection"
        }
    ]
}
    Back to Top