Jump to

• Request
• Response

Get a rule builder condition

get

/crmRestApi/resources/11.13.18.05/subscriptionGroupingRuleSets/{GroupingRuleSetNumber}/child/ruleBuilderConditions/{ConditionNumber}

Request

Path Parameters

• ConditionNumber(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=
• 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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  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).
• fields: string
  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
• links: string
  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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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-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":{
        "ConditionGroupName":{
            "title":"Condition Group Name",
            "maxLength":30,
            "type":"string",
            "description":"The condition group name of rule builder condition.",
            "nullable":true,
            "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
        },
        "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
        },
        "ConditionJson":{
            "title":"Condition JSON",
            "type":"string",
            "description":"The condition JSON of rule builder condition.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ConditionNumber":{
            "title":"Condition",
            "maxLength":120,
            "type":"string",
            "description":"The condition number of rule builder condition.",
            "nullable":false,
            "x-queryable":true
        },
        "ConditionRestQParam":{
            "type":"string",
            "description":"The query parameter expression of the rule builder condition.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created 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
        },
        "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
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated a rule builder condition.",
            "nullable":false,
            "readOnly":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
        },
        "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
        },
        "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
        },
        "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
        },
        "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."
        }
    }
}

Back to Top