1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Subscription Grouping Rule Sets

Get all subscription grouping rule sets

get

/crmRestApi/resources/11.13.18.05/subscriptionGroupingRuleSets

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

    • GroupingRuleSetNumbersAltKey Find grouping rule set numbers with an alternate key.
      Finder Variables
      • GroupingRuleSetNumber; string; The alternate key to find grouping rule set number.
    • PrimaryKey Finds grouping rule sets with a group rule set identifier.
      Finder Variables
      • GroupingRuleSetId; integer; The grouping rule set identifier.
  • 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:
    • EnabledFlag; boolean; Indicates whether the subscription grouping rule set is enabled.
    • GroupingRuleSetId; integer; The unique identifier of the subscription grouping rule set.
    • GroupingRuleSetName; string; The name of the subscription grouping rule set.
    • GroupingRuleSetNumber; string; The alternate unique identifier of the subscription grouping rule set.
    • Rank; integer; The rank of subscription grouping rule set.
  • 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 : subscriptionGroupingRuleSets
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : subscriptionGroupingRuleSets-item-response
Type: object
Show Source
Nested Schema : Rule Builder Conditions
Type: array
Title: Rule Builder Conditions
The rule builder condition is a filter used to query the usage events for rerating purpose.
Show Source
Nested Schema : Subscription Grouping Rules
Type: array
Title: Subscription Grouping Rules
The rules used to group various subscription attributes for creation, amendment, and renewal.
Show Source
Nested Schema : subscriptionGroupingRuleSets-ruleBuilderConditions-item-response
Type: object
Show Source
Nested Schema : subscriptionGroupingRuleSets-subscriptionGroupingRules-item-response
Type: object
Show Source
Links
getOmOssAttrMap
This method lets you get the order management to subscription management attribute mapping.
getPublishedStatus
This method gets you the published status of the grouping rule sets.
publishGroupingRuleSets
This method lets you publish the grouping rule sets.
updateOmOssAttrMap
This method lets you update the order management to subscription management attribute mapping.
Back to Top

Examples

The following example shows how to get all subscription grouping rule sets 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/subscriptionGroupingRuleSets

Example of Response Body

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

{
    "items": [
        {
            "GroupingRuleSetId": 300100627494854,
            "GroupingRuleSetName": "Sub Per Account",
            "GroupingRuleSetNumber": "GRPS-1",
            "Rank": 1,
            "EnabledFlag": true,
            "CreatedBy": "CONMGR",
            "CreationDate": "2025-02-05T21:18:42+00:00",
            "LastUpdateDate": "2025-02-05T21:18:42.147+00:00",
            "LastUpdatedBy": "CONMGR",
            "LastUpdateLogin": "2BA14A20037E4190E063682D060A2131",
            "ObjectVersionNumber": 1,
            "SelectionCondition": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionGroupingRuleSets/GRPS-1",
                    "name": "subscriptionGroupingRuleSets",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionGroupingRuleSets/GRPS-1",
                    "name": "subscriptionGroupingRuleSets",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionGroupingRuleSets/GRPS-1/child/ruleBuilderConditions",
                    "name": "ruleBuilderConditions",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionGroupingRuleSets/GRPS-1/child/subscriptionGroupingRules",
                    "name": "subscriptionGroupingRules",
                    "kind": "collection"
                },
                {
                    "rel": "enclosure",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionGroupingRuleSets/GRPS-1/enclosure/SplittingRuleAttrs",
                    "name": "SplittingRuleAttrs",
                    "kind": "other"
                }
            ]
        },...
    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionGroupingRuleSets",
            "name": "subscriptionGroupingRuleSets",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionGroupingRuleSets/action/getOmOssAttrMap",
            "name": "getOmOssAttrMap",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionGroupingRuleSets/action/getPublishedStatus",
            "name": "getPublishedStatus",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionGroupingRuleSets/action/publishGroupingRuleSets",
            "name": "publishGroupingRuleSets",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionGroupingRuleSets/action/updateOmOssAttrMap",
            "name": "updateOmOssAttrMap",
            "kind": "other"
        }
    ]
}
Back to Top