Jump to

• Request
• Response

Create a subscription grouping rule

post

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

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

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 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.
• 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":{
        "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
        },
        "GroupingRuleId":{
            "title":"Grouping Rule ID",
            "type":"integer",
            "description":"The unique identifier of the subscription grouping rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "GroupingRuleName":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the subscription grouping rule.",
            "nullable":false
        },
        "GroupingRuleNumber":{
            "title":"Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of subscription grouping rule.",
            "nullable":false
        },
        "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
            }
        },
        "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
            }
        },
        "Rank":{
            "title":"Rank",
            "type":"integer",
            "description":"The rank of subscription grouping rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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-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":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created 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
        },
        "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
        },
        "GroupingRuleAttrs":{
            "title":"Attributes",
            "type":"string",
            "description":"The grouping rule attributes of the subscription grouping rule.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "GroupingRuleName":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the subscription grouping rule.",
            "nullable":false,
            "x-queryable":true
        },
        "GroupingRuleNumber":{
            "title":"Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of subscription grouping rule.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription grouping rule.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "Rank":{
            "title":"Rank",
            "type":"integer",
            "description":"The rank of subscription grouping rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : 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."
        }
    }
}

Links

LookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO

The following properties are defined on the LOV link relation:

• Source Attribute: EnabledFlag; Target Attribute: LookupCode
• Display Attribute: LookupCode

Back to Top