Jump to

• Request
• Response

Update a subscription grouping rule set

patch

/crmRestApi/resources/11.13.18.05/subscriptionGroupingRuleSets/{GroupingRuleSetNumber}

Request

Path Parameters

• GroupingRuleSetNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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".
• REST-Framework-Version: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EnabledFlag: boolean
  Title: Enable

  Maximum Length: 1

  Indicates whether the subscription grouping rule set is enabled.
• GroupingRuleSetName: string
  Title: Name

  Maximum Length: 255

  The name of the subscription grouping rule set.
• ObjectVersionNumber: integer (int32)
  The object version number of the subscription grouping rule set.
• Rank: integer (int32)
  Title: Rank

  The rank of subscription grouping rule set.
• ruleBuilderConditions: array Rule Builder Conditions
  Title: Rule Builder Conditions

  The rule builder condition is a filter used to query the usage events for rerating purpose.
• SplittingRuleAttrs: string (byte)
  Title: Additional Attributes

  The splitting rule attributes of subscription grouping rule set.
• subscriptionGroupingRules: array Subscription Grouping Rules
  Title: Subscription Grouping Rules

  The rules used to group various subscription attributes for creation, amendment, and renewal.

{
    "type":"object",
    "properties":{
        "SplittingRuleAttrs":{
            "title":"Additional Attributes",
            "type":"string",
            "description":"The splitting rule attributes of subscription grouping rule set.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "subscriptionGroupingRules":{
            "title":"Subscription Grouping Rules",
            "type":"array",
            "description":"The rules used to group various subscription attributes for creation, amendment, and renewal.",
            "items":{
                "$ref":"#/components/schemas/subscriptionGroupingRuleSets-subscriptionGroupingRules-item-patch-request"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription grouping rule set.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "Rank":{
            "title":"Rank",
            "type":"integer",
            "description":"The rank of subscription grouping rule set.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "EnabledFlag":{
            "title":"Enable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subscription grouping rule set is enabled.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ruleBuilderConditions":{
            "title":"Rule Builder Conditions",
            "type":"array",
            "description":"The rule builder condition is a filter used to query the usage events for rerating purpose.",
            "items":{
                "$ref":"#/components/schemas/subscriptionGroupingRuleSets-ruleBuilderConditions-item-patch-request"
            }
        },
        "GroupingRuleSetName":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the subscription grouping rule set.",
            "nullable":false
        }
    }
}

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

• Array of: object schema

{
    "title":"Rule Builder Conditions",
    "type":"array",
    "description":"The rule builder condition is a filter used to query the usage events for rerating purpose.",
    "items":{
        "$ref":"#/components/schemas/subscriptionGroupingRuleSets-ruleBuilderConditions-item-patch-request"
    }
}

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

• Array of: object schema

{
    "title":"Subscription Grouping Rules",
    "type":"array",
    "description":"The rules used to group various subscription attributes for creation, amendment, and renewal.",
    "items":{
        "$ref":"#/components/schemas/subscriptionGroupingRuleSets-subscriptionGroupingRules-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• ConditionGroupName: string
  Title: Condition Group Name

  Maximum Length: 30

  The condition group name of rule builder condition.
• ConditionGroupType: string
  Title: Condition Group Type

  Maximum Length: 30

  The condition group type of rule builder condition.
• ConditionJson: string (byte)
  Title: Condition JSON

  The condition JSON of rule builder condition.
• ConditionRestQParam: string (byte)
  The query parameter expression of the rule builder condition.
• DisplaySequence: integer (int64)
  Title: Display Sequence

  The display sequence of rule builder condition.
• QualifiedRestObjectName: string
  Title: Qualified Rest Object Name

  Maximum Length: 120

  The qualified REST object name of rule builder condition.
• ReferenceEntityId: integer (int64)
  Title: Object ID

  The unique identifier for the reference entity associated with the rule builder condition.
• ReferenceEntityName: string
  Title: Reference Entity Name

  Maximum Length: 30

  Default Value: OSS_USAGE_EVENT_BATCHES

  The name of the reference entity name associated with the rule builder condition.

{
    "type":"object",
    "properties":{
        "ConditionGroupName":{
            "title":"Condition Group Name",
            "maxLength":30,
            "type":"string",
            "description":"The condition group name of rule builder condition.",
            "nullable":true
        },
        "QualifiedRestObjectName":{
            "title":"Qualified Rest Object Name",
            "maxLength":120,
            "type":"string",
            "description":"The qualified REST object name of rule builder condition.",
            "nullable":true
        },
        "ReferenceEntityId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier for the reference entity associated with the rule builder condition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display sequence of rule builder condition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ConditionJson":{
            "title":"Condition JSON",
            "type":"string",
            "description":"The condition JSON of rule builder condition.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ConditionRestQParam":{
            "type":"string",
            "description":"The query parameter expression of the rule builder condition.",
            "format":"byte",
            "nullable":true
        },
        "ReferenceEntityName":{
            "title":"Reference Entity Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the reference entity name associated with the rule builder condition.",
            "nullable":true,
            "default":"OSS_USAGE_EVENT_BATCHES"
        },
        "ConditionGroupType":{
            "title":"Condition Group Type",
            "maxLength":30,
            "type":"string",
            "description":"The condition group type of rule builder condition.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• EnabledFlag: boolean
  Title: Enable

  Maximum Length: 1

  Indicates whether the subscription grouping rule is enabled.
• GroupingRuleAttrs: string (byte)
  Title: Attributes

  The grouping rule attributes of the subscription grouping rule.
• GroupingRuleName: string
  Title: Name

  Maximum Length: 255

  The name of the subscription grouping rule.
• IgnoreNullValueFlag: boolean
  Title: Ignore Null Values

  Maximum Length: 1

  Indicates whether null value should be ignored for the subscription grouping rule.
• ObjectVersionNumber: integer (int32)
  The object version number of the subscription grouping rule.
• Rank: integer (int64)
  Title: Rank

  The rank of subscription grouping rule.

{
    "type":"object",
    "properties":{
        "IgnoreNullValueFlag":{
            "title":"Ignore Null Values",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether null value should be ignored for the subscription grouping rule.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription grouping rule.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "GroupingRuleName":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the subscription grouping rule.",
            "nullable":false
        },
        "Rank":{
            "title":"Rank",
            "type":"integer",
            "description":"The rank of subscription grouping rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EnabledFlag":{
            "title":"Enable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subscription grouping rule is enabled.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GroupingRuleAttrs":{
            "title":"Attributes",
            "type":"string",
            "description":"The grouping rule attributes of the subscription grouping rule.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the subscription grouping rule set.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the subscription grouping rule set was created.
• EnabledFlag: boolean
  Title: Enable

  Maximum Length: 1

  Indicates whether the subscription grouping rule set is enabled.
• GroupingRuleSetId: integer (int64)
  Title: Grouping Rule Set ID

  The unique identifier of the subscription grouping rule set.
• GroupingRuleSetName: string
  Title: Name

  Maximum Length: 255

  The name of the subscription grouping rule set.
• GroupingRuleSetNumber: string
  Title: Number

  Maximum Length: 30

  The alternate unique identifier of the subscription grouping rule set.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the subscription grouping rule set was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the subscription grouping rule set.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription grouping rule set.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number of the subscription grouping rule set.
• Rank: integer (int32)
  Title: Rank

  The rank of subscription grouping rule set.
• ruleBuilderConditions: array Rule Builder Conditions
  Title: Rule Builder Conditions

  The rule builder condition is a filter used to query the usage events for rerating purpose.
• SelectionCondition: string
  Title: Selection Rule

  Read Only: true

  Maximum Length: 255

  The selection condition of the grouping rule set.
• SplittingRuleAttrs: string (byte)
  Title: Additional Attributes

  The splitting rule attributes of subscription grouping rule set.
• subscriptionGroupingRules: array Subscription Grouping Rules
  Title: Subscription Grouping Rules

  The rules used to group various subscription attributes for creation, amendment, and renewal.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription grouping rule set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the subscription grouping rule set was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription grouping rule set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "GroupingRuleSetNumber":{
            "title":"Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the subscription grouping rule set.",
            "nullable":false,
            "x-queryable":true
        },
        "Rank":{
            "title":"Rank",
            "type":"integer",
            "description":"The rank of subscription grouping rule set.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ruleBuilderConditions":{
            "title":"Rule Builder Conditions",
            "type":"array",
            "description":"The rule builder condition is a filter used to query the usage events for rerating purpose.",
            "items":{
                "$ref":"#/components/schemas/subscriptionGroupingRuleSets-ruleBuilderConditions-item-response"
            }
        },
        "SelectionCondition":{
            "title":"Selection Rule",
            "maxLength":255,
            "type":"string",
            "description":"The selection condition of the grouping rule set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SplittingRuleAttrs":{
            "title":"Additional Attributes",
            "type":"string",
            "description":"The splitting rule attributes of subscription grouping rule set.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "subscriptionGroupingRules":{
            "title":"Subscription Grouping Rules",
            "type":"array",
            "description":"The rules used to group various subscription attributes for creation, amendment, and renewal.",
            "items":{
                "$ref":"#/components/schemas/subscriptionGroupingRuleSets-subscriptionGroupingRules-item-response"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription grouping rule set.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subscription grouping rule set is enabled.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "GroupingRuleSetId":{
            "title":"Grouping Rule Set ID",
            "type":"integer",
            "description":"The unique identifier of the subscription grouping rule set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GroupingRuleSetName":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the subscription grouping rule set.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the subscription grouping rule set was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription grouping rule set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object subscriptionGroupingRuleSets-ruleBuilderConditions-item-response

{
    "title":"Rule Builder Conditions",
    "type":"array",
    "description":"The rule builder condition is a filter used to query the usage events for rerating purpose.",
    "items":{
        "$ref":"#/components/schemas/subscriptionGroupingRuleSets-ruleBuilderConditions-item-response"
    }
}

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

• Array of: object subscriptionGroupingRuleSets-subscriptionGroupingRules-item-response

{
    "title":"Subscription Grouping Rules",
    "type":"array",
    "description":"The rules used to group various subscription attributes for creation, amendment, and renewal.",
    "items":{
        "$ref":"#/components/schemas/subscriptionGroupingRuleSets-subscriptionGroupingRules-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : subscriptionGroupingRuleSets-ruleBuilderConditions-item-response

Type: object

Show Source

• ConditionGroupName: string
  Title: Condition Group Name

  Maximum Length: 30

  The condition group name of rule builder condition.
• ConditionGroupType: string
  Title: Condition Group Type

  Maximum Length: 30

  The condition group type of rule builder condition.
• ConditionId: integer (int64)
  Title: Condition ID

  The condition identifier of rule builder condition.
• ConditionJson: string (byte)
  Title: Condition JSON

  The condition JSON of rule builder condition.
• ConditionNumber: string
  Title: Condition

  Maximum Length: 120

  The condition number of rule builder condition.
• ConditionRestQParam: string (byte)
  The query parameter expression of the rule builder condition.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created a rule builder condition.
• CreationDate: string (date-time)
  Read Only: true

  The date when a rule builder condition was created.
• DisplaySequence: integer (int64)
  Title: Display Sequence

  The display sequence of rule builder condition.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when a rule builder condition was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated a rule builder condition.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the rule builder condition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number updated after every update of a rule builder condition.
• QualifiedRestObjectName: string
  Title: Qualified Rest Object Name

  Maximum Length: 120

  The qualified REST object name of rule builder condition.
• ReferenceEntityId: integer (int64)
  Title: Object ID

  The unique identifier for the reference entity associated with the rule builder condition.
• ReferenceEntityName: string
  Title: Reference Entity Name

  Maximum Length: 30

  Default Value: OSS_USAGE_EVENT_BATCHES

  The name of the reference entity name associated with the rule builder condition.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated a rule builder condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when a rule builder condition was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionGroupName":{
            "title":"Condition Group Name",
            "maxLength":30,
            "type":"string",
            "description":"The condition group name of rule builder condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceEntityId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier for the reference entity associated with the rule builder condition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created a rule builder condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display sequence of rule builder condition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConditionJson":{
            "title":"Condition JSON",
            "type":"string",
            "description":"The condition JSON of rule builder condition.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ConditionRestQParam":{
            "type":"string",
            "description":"The query parameter expression of the rule builder condition.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceEntityName":{
            "title":"Reference Entity Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the reference entity name associated with the rule builder condition.",
            "nullable":true,
            "default":"OSS_USAGE_EVENT_BATCHES",
            "x-queryable":true
        },
        "ConditionGroupType":{
            "title":"Condition Group Type",
            "maxLength":30,
            "type":"string",
            "description":"The condition group type of rule builder condition.",
            "nullable":true,
            "x-queryable":true
        },
        "QualifiedRestObjectName":{
            "title":"Qualified Rest Object Name",
            "maxLength":120,
            "type":"string",
            "description":"The qualified REST object name of rule builder condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a rule builder condition.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ConditionNumber":{
            "title":"Condition",
            "maxLength":120,
            "type":"string",
            "description":"The condition number of rule builder condition.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ConditionId":{
            "title":"Condition ID",
            "type":"integer",
            "description":"The condition identifier of rule builder condition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when a rule builder condition was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the rule builder condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionGroupingRuleSets-subscriptionGroupingRules-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the subscription grouping rule.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the subscription grouping rule was created.
• EnabledFlag: boolean
  Title: Enable

  Maximum Length: 1

  Indicates whether the subscription grouping rule is enabled.
• GroupingRuleAttrs: string (byte)
  Title: Attributes

  The grouping rule attributes of the subscription grouping rule.
• GroupingRuleId: integer (int64)
  Title: Grouping Rule ID

  The unique identifier of the subscription grouping rule.
• GroupingRuleName: string
  Title: Name

  Maximum Length: 255

  The name of the subscription grouping rule.
• GroupingRuleNumber: string
  Title: Number

  Maximum Length: 30

  The alternate unique identifier of subscription grouping rule.
• GroupingRuleSetId: integer (int64)
  Title: Grouping Rule Set ID

  The unique set identifier of the subscription grouping rule.
• IgnoreNullValueFlag: boolean
  Title: Ignore Null Values

  Maximum Length: 1

  Indicates whether null value should be ignored for the subscription grouping rule.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the subscription grouping rule was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the subscription grouping rule.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription grouping rule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number of the subscription grouping rule.
• Rank: integer (int64)
  Title: Rank

  The rank of subscription grouping rule.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription grouping rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the subscription grouping rule was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription grouping rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "GroupingRuleName":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the subscription grouping rule.",
            "nullable":false,
            "x-queryable":true
        },
        "Rank":{
            "title":"Rank",
            "type":"integer",
            "description":"The rank of subscription grouping rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GroupingRuleAttrs":{
            "title":"Attributes",
            "type":"string",
            "description":"The grouping rule attributes of the subscription grouping rule.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "IgnoreNullValueFlag":{
            "title":"Ignore Null Values",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether null value should be ignored for the subscription grouping rule.",
            "nullable":true,
            "x-queryable":true
        },
        "GroupingRuleId":{
            "title":"Grouping Rule ID",
            "type":"integer",
            "description":"The unique identifier of the subscription grouping rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription grouping rule.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "GroupingRuleNumber":{
            "title":"Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of subscription grouping rule.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subscription grouping rule is enabled.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "GroupingRuleSetId":{
            "title":"Grouping Rule Set ID",
            "type":"integer",
            "description":"The unique set identifier of the subscription grouping rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the subscription grouping rule was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription grouping rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

ruleBuilderConditions

Operation: /crmRestApi/resources/11.13.18.05/subscriptionGroupingRuleSets/{GroupingRuleSetNumber}/child/ruleBuilderConditions

Parameters:

• GroupingRuleSetNumber: $request.path.GroupingRuleSetNumber

The rule builder condition is a filter used to query the usage events for rerating purpose.

subscriptionGroupingRules

Operation: /crmRestApi/resources/11.13.18.05/subscriptionGroupingRuleSets/{GroupingRuleSetNumber}/child/subscriptionGroupingRules

Parameters:

• GroupingRuleSetNumber: $request.path.GroupingRuleSetNumber

The rules used to group various subscription attributes for creation, amendment, and renewal.

Back to Top