HubSpot: Event definitions schemas (part 1)

53 HubSpot schemas with complete fields and constraints.

← Event definitions operations · All schemas

Create Property — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`description`	string	Optional	A string providing additional information about the property.
`label`	string	Required within parent	A string representing the display name of the property. This field is required.
`name`	string	Optional	A string representing the unique name of the property.
`options`	array	Optional	An array of OptionInput objects that define the possible values for the property.
`options[]`	Model	Each item	Expand Create Property — request body — body options item
`type`	string	Required within parent	A string indicating the data type of the property. This field is required.

Referenced models: Create Property — request body — body options item

Create Property — request body — body options item

Field	Type	Presence	Description and constraints
`$`	object	Root
`description`	string	Optional	A string providing additional information about the option.
`displayOrder`	integer	Required within parent	An integer indicating the order in which the option should be displayed relative to other options. Format: int32
`hidden`	boolean	Required within parent	A boolean indicating whether the option is hidden from view.
`label`	string	Required within parent	A string representing the display label for the option.
`value`	string	Required within parent	A string representing the unique value associated with the option.

Create Property — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A HubSpot property
`archived`	boolean	Optional	Indicates whether the property is archived.
`archivedAt`	string	Optional	The date and time when this property was archived, in ISO 8601 format. Format: date-time
`calculated`	boolean	Optional	Indicates whether the property is calculated.
`calculationFormula`	string	Optional	The formula used to calculate the property's value, if applicable.
`createdAt`	string	Optional	The date and time when this property was created, in ISO 8601 format. Format: date-time
`createdUserId`	string	Optional	The ID of the user who created this property.
`currencyPropertyName`	string	Optional	The name of the currency property associated with this property.
`dataSensitivity`	string	Optional	The sensitivity level of the data, with valid values including 'non_sensitive', 'sensitive', and 'highly_sensitive'. Known values: highly_sensitive, non_sensitive, sensitive
`dateDisplayHint`	string	Optional	A hint for displaying date properties, with valid values including 'absolute', 'absolute_with_relative', 'time_since', and 'time_until'. Known values: absolute, absolute_with_relative, time_since, time_until
`description`	string	Required within parent	A description of the property.
`displayOrder`	JSON	Optional
`displayOrder (anyOf 1)`	integer	Alternative	The order in which this property is displayed relative to other properties. Format: int32
`displayOrder (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`externalOptions`	boolean	Optional	Indicates whether the property options are external.
`fieldType`	string	Required within parent	The field type of the property.
`formField`	boolean	Optional	Indicates whether the property is a form field.
`groupName`	string	Required within parent	The name of the group to which this property belongs.
`hasUniqueValue`	boolean	Optional	Indicates whether the property has a unique value.
`hidden`	boolean	Optional	Indicates whether the property is hidden.
`hubspotDefined`	boolean	Optional	Indicates whether the property is defined by HubSpot.
`label`	string	Required within parent	The display label for the property.
`modificationMetadata`	Model	Optional	Expand Create Property — response body — modification Metadata
`name`	string	Required within parent	The unique name of the property.
`numberDisplayHint`	string	Optional	A hint for displaying number properties, with valid values including 'unformatted', 'formatted', 'currency', 'percentage', 'duration', and 'probability'. Known values: currency, duration, formatted, percentage, probability, unformatted
`options`	array	Required within parent	An array of options available for this property, applicable if the property supports multiple values.
`options[]`	Model	Each item	Expand Create Property — response body — options item
`referencedObjectType`	string	Optional	The type of object that this property references.
`sensitiveDataCategories`	array	Optional	An array of categories indicating the sensitivity of the data.
`sensitiveDataCategories[]`	string	Each item
`showCurrencySymbol`	boolean	Optional	Indicates whether a currency symbol is shown for the property.
`textDisplayHint`	string	Optional	A hint for displaying text properties, with valid values including 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', and 'postal_code'. Known values: domain_name, email, ip_address, multi_line, phone_number, physical_address, postal_code, unformatted_single_line
`type`	string	Required within parent	The data type of the property.
`updatedAt`	string	Optional	The date and time when this property was last updated, in ISO 8601 format. Format: date-time
`updatedUserId`	string	Optional	The ID of the user who last updated this property.

Referenced models: Create Property — response body — modification Metadata, Create Property — response body — options item

Create Property — response body — modification Metadata

Field	Type	Presence	Description and constraints
`$`	object	Root
`archivable`	boolean	Required within parent	A boolean indicating whether the property can be archived.
`readOnlyDefinition`	boolean	Required within parent	A boolean indicating whether the definition of the property is read-only.
`readOnlyOptions`	boolean	Optional	A boolean indicating whether the options of the property are read-only.
`readOnlyValue`	boolean	Required within parent	A boolean indicating whether the value of the property is read-only.

Create Property — response body — options item

Field	Type	Presence	Description and constraints
`$`	object	Root	A HubSpot property option
`description`	string	Optional	A detailed description of the option, providing additional context.
`displayOrder`	JSON	Optional
`displayOrder (anyOf 1)`	integer	Alternative	An integer that determines the order in which the option appears relative to other options. Format: int32
`displayOrder (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`hidden`	boolean	Required within parent	A boolean indicating whether the option is hidden from users.
`label`	string	Required within parent	The display name of the option, shown to users.
`value`	string	Required within parent	The internal value associated with the option, used in data processing.

Create — event Definitions create Event Definition — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`customMatchingId`	Model	Optional	Expand Update event definition — response body — custom Matching Id
`description`	string	Optional	A string providing a description of the event type.
`includeDefaultProperties`	boolean	Required within parent	A boolean indicating whether default properties should be included.
`label`	string	Required within parent	A string representing the label of the event type.
`name`	string	Optional	A string representing the name of the event type.
`primaryObject`	string	Optional	A string indicating the primary object associated with the event type.
`propertyDefinitions`	array	Required within parent	An array of property definitions, each represented by an ExternalBehavioralEventPropertyCreate object.
`propertyDefinitions[]`	Model	Each item	Expand Create Property — request body — body

Referenced models: Create Property — request body — body, Update event definition — response body — custom Matching Id

List event definitions — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`paging`	Model	Optional	Expand List event definitions — response body — paging
`results`	array	Required within parent	An array containing the external behavioral event type definitions returned in the current page.
`results[]`	Model	Each item	Expand Update event definition — response body
`total`	JSON	Required within parent
`total (anyOf 1)`	integer	Alternative	The total number of external behavioral event type definitions available. Format: int32
`total (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List event definitions — response body — paging, Update event definition — response body

List event definitions — response body — paging

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
`next`	Model	Optional	Expand List event definitions — response body — paging next
`prev`	Model	Optional	Expand List event definitions — response body — paging prev

Referenced models: List event definitions — response body — paging next, List event definitions — response body — paging prev

List event definitions — response body — paging next

Field	Type	Presence	Description and constraints
`$`	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
`after`	string	Required within parent	A string token used as a cursor to fetch the next page of results. This token is typically returned in the response of a paginated API call.
`link`	string	Optional	A URL string that points to the next page of results. Clients can use this link to make a request for the subsequent set of data.

List event definitions — response body — paging prev

Field	Type	Presence	Description and constraints
`$`	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
`before`	string	Required within parent	A string token used as a cursor to fetch the previous page of results.
`link`	string	Optional	A URL string that provides the link to access the previous page of results.

Update event definition — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`description`	string	Optional	A description of the event that will be shown as help text in HubSpot.
`detailTemplate`	string	Optional	The rendering template for the body of the CRM timeline activity card.
`headerTemplate`	string	Optional	The rendering template for the header of the CRM timeline activity card.
`label`	string	Optional	Human readable label for the event. Used in HubSpot UI.
`propertyOrder`	array	Required within parent	Specifies the ordering and visibility of event properties when rendered on the CRM timeline activity card.
`propertyOrder[]`	Model	Each item	Expand Update event definition — request body — body property Order item

Referenced models: Update event definition — request body — body property Order item

Update event definition — request body — body property Order item

Field	Type	Presence	Description and constraints
`$`	object	Root
`description`	string	Optional	A string providing a detailed description of the property.
`displayOrder`	integer	Optional	An integer indicating the order in which the property should be displayed. Format: int32
`hidden`	boolean	Optional	A boolean indicating whether the property is hidden from view.
`label`	string	Optional	A human-readable label for the property, represented as a string.
`name`	string	Required within parent	The unique name of the property being modified. It is a required string field.
`options`	array	Optional	An array of OptionInput objects, each representing possible options for the property.
`options[]`	Model	Each item	Expand Create Property — request body — body options item

Referenced models: Create Property — request body — body options item

Update event definition — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`archived`	boolean	Required within parent	A boolean indicating whether the event type is archived.
`associations`	array	Required within parent	An array of association definitions related to the event type.
`associations[]`	Model	Each item	Expand Update event definition — response body — associations item
`comboEventRules`	Model	Optional	Expand Update event definition — response body — combo Event Rules
`createdAt`	string	Optional	A string representing the date and time when the event type was created, in ISO 8601 format. Format: date-time
`createdUserId`	JSON	Optional
`createdUserId (anyOf 1)`	integer	Alternative	An integer representing the ID of the user who created the event type. Format: int32
`createdUserId (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`customMatchingId`	Model	Optional	Expand Update event definition — response body — custom Matching Id
`description`	string	Optional	A string providing a description of the event type.
`detailTemplate`	string	Optional	The rendering template for the body of the CRM timeline activity card.
`fullyQualifiedName`	string	Required within parent	A string representing the fully qualified name of the event type.
`headerTemplate`	string	Optional	The rendering template for the header of the CRM timeline activity card.
`id`	string	Required within parent	A string representing the unique identifier of the event type.
`labels`	Model	Required within parent	Expand Update event definition — response body — labels
`name`	string	Required within parent	A string representing the name of the event type.
`objectTypeId`	string	Required within parent	A string representing the object type ID associated with the event type.
`primaryObject`	string	Optional	A string representing the primary object associated with the event type.
`primaryObjectId`	string	Optional	A string representing the ID of the primary object associated with the event type.
`properties`	array	Required within parent	An array of property objects associated with the event type.
`properties[]`	Model	Each item	Expand Create Property — response body
`trackingType`	string	Optional	A string indicating the tracking type of the event. Valid values include 'VISITED_URL', 'CLICKED_ELEMENT', 'CUSTOM_SCRIPT', 'MANUAL', 'IMPORT', 'PROPERTY_CHANGE', 'COMBO_EVENT'. Known values: APP_EVENT, AUTOCAPTURE_EVENT, CLICKED_ELEMENT, COMBO_EVENT, CUSTOM_SCRIPT, CUSTOM_SIGNAL, IMPORT, MANUAL, POLLING, PROPERTY_CHANGE, VISITED_URL, WEBHOOK
`updatedAt`	string	Optional	A string representing the date and time when the event type was last updated, in ISO 8601 format. Format: date-time
`updatedUserId`	JSON	Optional
`updatedUserId (anyOf 1)`	integer	Alternative	An integer representing the ID of the user who last updated the event type. Format: int32
`updatedUserId (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Update event definition — response body — labels, Update event definition — response body — custom Matching Id, Update event definition — response body — combo Event Rules, Update event definition — response body — associations item, Create Property — response body

Update event definition — response body — associations item

Field	Type	Presence	Description and constraints
`$`	object	Root	The definition of an association
`allowsCustomLabels`	boolean	Required within parent	A boolean indicating if custom labels are allowed for this association.
`cardinality`	string	Required within parent	The nature of the association in terms of cardinality, which can be 'ONE_TO_ONE' or 'ONE_TO_MANY'. Known values: ONE_TO_MANY, ONE_TO_ONE
`category`	string	Required within parent	The category of the association, indicating whether it is defined by HubSpot, the user, an integrator, or for work purposes. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
`fromObjectType`	string	Optional	The type of object from which the association originates. Valid values include various HubSpot object types such as 'CONTACT', 'COMPANY', 'DEAL', etc. Known values: ABANDONED_CART, ACCEPTANCE_TEST, AD, AD_ACCOUNT, AD_CAMPAIGN, AD_GROUP, AI_FORECAST, ALL_PAGES, APPROVAL, APPROVAL_STEP, ATTRIBUTION, AUDIENCE, AUTOMATION_JOURNEY, AUTOMATION_PLATFORM_FLOW, AUTOMATION_PLATFORM_FLOW_ACTION, BET_ALERT, BET_DELIVERABLE_SERVICE, BLOG_LISTING_PAGE, BLOG_POST, CALL, CAMPAIGN, CAMPAIGN_BUDGET_ITEM, CAMPAIGN_SPEND_ITEM, CAMPAIGN_STEP, CAMPAIGN_TEMPLATE, CAMPAIGN_TEMPLATE_STEP, CART, CASE_STUDY, CHATFLOW, CLIP, CMS_URL, COMBO_EVENT_CONFIGURATION, COMMERCE_PAYMENT, COMMUNICATION, COMPANY, CONTACT, CONTACT_CREATE_ATTRIBUTION, CONTENT, CONTENT_AUDIT, CONTENT_AUDIT_PAGE, CONVERSATION, CONVERSATION_INBOX, CONVERSATION_SESSION, CRM_OBJECTS_DUMMY_TYPE, CRM_PIPELINES_DUMMY_TYPE, CTA, CTA_VARIANT, DATA_PRIVACY_CONSENT, DATA_SYNC_STATE, DEAL, DEAL_CREATE_ATTRIBUTION, DEAL_REGISTRATION, DEAL_SPLIT, DISCOUNT, DISCOUNT_CODE, DISCOUNT_TEMPLATE, EMAIL, ENGAGEMENT, EXPORT, EXTERNAL_WEB_URL, FEE, FEEDBACK_SUBMISSION, FEEDBACK_SURVEY, FILE_MANAGER_FILE, FILE_MANAGER_FOLDER, FOLDER, FORECAST, FORM, FORM_SUBMISSION_INBOUNDDB, GOAL_TARGET, GOAL_TARGET_GROUP, GOAL_TEMPLATE, GSC_PROPERTY, HUB, IMPORT, INVOICE, KEYWORD, KNOWLEDGE_ARTICLE, LANDING_PAGE, LEAD, LINE_ITEM, MARKETING_CALENDAR, MARKETING_CAMPAIGN_UTM, MARKETING_EMAIL, MARKETING_EVENT, MARKETING_EVENT_ATTENDANCE, MARKETING_SMS, MEDIA_BRIDGE, MEETING_EVENT, MIC, NOTE, OBJECT_LIST, ORDER, OWNER, PARTNER_ACCOUNT, PARTNER_CLIENT, PARTNER_CLIENT_REVENUE, PARTNER_SERVICE, PAYMENT_LINK, PAYMENT_SCHEDULE, PAYMENT_SCHEDULE_INSTALLMENT, PERMISSIONS_TESTING, PLAYBOOK, PLAYBOOK_QUESTION, PLAYBOOK_SUBMISSION, PLAYBOOK_SUBMISSION_ANSWER, PLAYLIST, PLAYLIST_FOLDER, PODCAST_EPISODE, PORTAL, PORTAL_OBJECT_SYNC_MESSAGE, POSTAL_MAIL, PRIVACY_SCANNER_COOKIE, PRODUCT, PRODUCT_OR_FOLDER, PROPERTY_INFO, PROSPECTING_AGENT_CONTACT_ASSIGNMENT, PUBLISHING_TASK, QUARANTINED_SUBMISSION, QUOTA, QUOTE, QUOTE_FIELD, QUOTE_MODULE, QUOTE_MODULE_FIELD, QUOTE_TEMPLATE, RESTORABLE_CRM_OBJECT, ROSTER, ROSTER_MEMBER, SALES_DOCUMENT, SALES_TASK, SALES_WORKLOAD, SALESFORCE_SYNC_ERROR, SCHEDULING_PAGE, SCHEMAS_BACKEND_TEST, SCORE_CONFIGURATION, SEQUENCE, SEQUENCE_ENROLLMENT, SEQUENCE_STEP, SEQUENCE_STEP_ENROLLMENT, SERVICE, SITE_PAGE, SNIPPET, SOCIAL_BROADCAST, SOCIAL_CHANNEL, SOCIAL_POST, SOCIAL_PROFILE, SOX_PROTECTED_DUMMY_TYPE, SOX_PROTECTED_TEST_TYPE, SUBMISSION_TAG, SUBSCRIPTION, TASK, TASK_TEMPLATE, TAX, TEMPLATE, TICKET, UNKNOWN, UNSUBSCRIBE, USER, VIEW, VIEW_BLOCK, WEB_INTERACTIVE
`fromObjectTypeId`	string	Required within parent	The object type ID from which the association originates.
`hasAllAssociatedObjects`	boolean	Required within parent	A boolean indicating if all associated objects are included in the association.
`hasCascadingDeletes`	boolean	Required within parent	A boolean indicating if cascading deletes are enabled for this association.
`hasUserEnforcedMaxFromObjectIds`	boolean	Required within parent	A boolean indicating if there is a user-enforced maximum on the number of 'from' object IDs.
`hasUserEnforcedMaxToObjectIds`	boolean	Required within parent	A boolean indicating if there is a user-enforced maximum on the number of 'to' object IDs.
`hidden`	boolean	Required within parent	A boolean indicating if the association is hidden.
`hiddenReason`	string	Optional	The reason why the association is hidden, if applicable. Valid values include 'DEFAULT', 'INTERNAL', and 'USER_CONFIGURED'. Known values: DEFAULT, INTERNAL, USER_CONFIGURED
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	The unique identifier for this association definition. Format: int32
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`inverseAllowsCustomLabels`	boolean	Required within parent	A boolean indicating if custom labels are allowed for the inverse association.
`inverseCardinality`	string	Required within parent	The cardinality of the inverse association, which can also be 'ONE_TO_ONE' or 'ONE_TO_MANY'. Known values: ONE_TO_MANY, ONE_TO_ONE
`inverseHasAllAssociatedObjects`	boolean	Required within parent	A boolean indicating if all associated objects are included in the inverse association.
`inverseId`	JSON	Required within parent
`inverseId (anyOf 1)`	integer	Alternative	The unique identifier for the inverse of this association definition. Format: int32
`inverseId (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`inverseLabel`	string	Optional	A human-readable label for the inverse association.
`inverseName`	string	Required within parent	The name of the inverse association.
`isDefault`	boolean	Required within parent	A boolean indicating if this association is the default association.
`isInversePrimary`	boolean	Required within parent	A boolean indicating if the inverse association is the primary association.
`isPrimary`	boolean	Required within parent	A boolean indicating if this association is the primary association.
`label`	string	Optional	A human-readable label for the association.
`maxFromObjectIds`	JSON	Required within parent
`maxFromObjectIds (anyOf 1)`	integer	Alternative	The maximum number of object IDs that can be associated in the 'from' direction. Format: int32
`maxFromObjectIds (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`maxToObjectIds`	JSON	Required within parent
`maxToObjectIds (anyOf 1)`	integer	Alternative	The maximum number of object IDs that can be associated in the 'to' direction. Format: int32
`maxToObjectIds (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`name`	string	Required within parent	The name of the association.
`portalUniqueIdentifier`	string	Required within parent	A unique identifier for the association within the portal.
`readOnly`	boolean	Required within parent	A boolean indicating if the association is read-only.
`toObjectType`	string	Optional	The type of object to which the association points. Valid values include various HubSpot object types such as 'CONTACT', 'COMPANY', 'DEAL', etc. Known values: ABANDONED_CART, ACCEPTANCE_TEST, AD, AD_ACCOUNT, AD_CAMPAIGN, AD_GROUP, AI_FORECAST, ALL_PAGES, APPROVAL, APPROVAL_STEP, ATTRIBUTION, AUDIENCE, AUTOMATION_JOURNEY, AUTOMATION_PLATFORM_FLOW, AUTOMATION_PLATFORM_FLOW_ACTION, BET_ALERT, BET_DELIVERABLE_SERVICE, BLOG_LISTING_PAGE, BLOG_POST, CALL, CAMPAIGN, CAMPAIGN_BUDGET_ITEM, CAMPAIGN_SPEND_ITEM, CAMPAIGN_STEP, CAMPAIGN_TEMPLATE, CAMPAIGN_TEMPLATE_STEP, CART, CASE_STUDY, CHATFLOW, CLIP, CMS_URL, COMBO_EVENT_CONFIGURATION, COMMERCE_PAYMENT, COMMUNICATION, COMPANY, CONTACT, CONTACT_CREATE_ATTRIBUTION, CONTENT, CONTENT_AUDIT, CONTENT_AUDIT_PAGE, CONVERSATION, CONVERSATION_INBOX, CONVERSATION_SESSION, CRM_OBJECTS_DUMMY_TYPE, CRM_PIPELINES_DUMMY_TYPE, CTA, CTA_VARIANT, DATA_PRIVACY_CONSENT, DATA_SYNC_STATE, DEAL, DEAL_CREATE_ATTRIBUTION, DEAL_REGISTRATION, DEAL_SPLIT, DISCOUNT, DISCOUNT_CODE, DISCOUNT_TEMPLATE, EMAIL, ENGAGEMENT, EXPORT, EXTERNAL_WEB_URL, FEE, FEEDBACK_SUBMISSION, FEEDBACK_SURVEY, FILE_MANAGER_FILE, FILE_MANAGER_FOLDER, FOLDER, FORECAST, FORM, FORM_SUBMISSION_INBOUNDDB, GOAL_TARGET, GOAL_TARGET_GROUP, GOAL_TEMPLATE, GSC_PROPERTY, HUB, IMPORT, INVOICE, KEYWORD, KNOWLEDGE_ARTICLE, LANDING_PAGE, LEAD, LINE_ITEM, MARKETING_CALENDAR, MARKETING_CAMPAIGN_UTM, MARKETING_EMAIL, MARKETING_EVENT, MARKETING_EVENT_ATTENDANCE, MARKETING_SMS, MEDIA_BRIDGE, MEETING_EVENT, MIC, NOTE, OBJECT_LIST, ORDER, OWNER, PARTNER_ACCOUNT, PARTNER_CLIENT, PARTNER_CLIENT_REVENUE, PARTNER_SERVICE, PAYMENT_LINK, PAYMENT_SCHEDULE, PAYMENT_SCHEDULE_INSTALLMENT, PERMISSIONS_TESTING, PLAYBOOK, PLAYBOOK_QUESTION, PLAYBOOK_SUBMISSION, PLAYBOOK_SUBMISSION_ANSWER, PLAYLIST, PLAYLIST_FOLDER, PODCAST_EPISODE, PORTAL, PORTAL_OBJECT_SYNC_MESSAGE, POSTAL_MAIL, PRIVACY_SCANNER_COOKIE, PRODUCT, PRODUCT_OR_FOLDER, PROPERTY_INFO, PROSPECTING_AGENT_CONTACT_ASSIGNMENT, PUBLISHING_TASK, QUARANTINED_SUBMISSION, QUOTA, QUOTE, QUOTE_FIELD, QUOTE_MODULE, QUOTE_MODULE_FIELD, QUOTE_TEMPLATE, RESTORABLE_CRM_OBJECT, ROSTER, ROSTER_MEMBER, SALES_DOCUMENT, SALES_TASK, SALES_WORKLOAD, SALESFORCE_SYNC_ERROR, SCHEDULING_PAGE, SCHEMAS_BACKEND_TEST, SCORE_CONFIGURATION, SEQUENCE, SEQUENCE_ENROLLMENT, SEQUENCE_STEP, SEQUENCE_STEP_ENROLLMENT, SERVICE, SITE_PAGE, SNIPPET, SOCIAL_BROADCAST, SOCIAL_CHANNEL, SOCIAL_POST, SOCIAL_PROFILE, SOX_PROTECTED_DUMMY_TYPE, SOX_PROTECTED_TEST_TYPE, SUBMISSION_TAG, SUBSCRIPTION, TASK, TASK_TEMPLATE, TAX, TEMPLATE, TICKET, UNKNOWN, UNSUBSCRIBE, USER, VIEW, VIEW_BLOCK, WEB_INTERACTIVE
`toObjectTypeId`	string	Required within parent	The object type ID to which the association points.

Update event definition — response body — combo Event Rules

Field	Type	Presence	Description and constraints
`$`	object	Root
`composingRules`	array	Required within parent	An array of ComboEventRule objects that define the individual rules composing this branch.
`composingRules[]`	Model	Each item	Expand Update event definition — response body — combo Event Rules composing Rules item
`operationType`	string	Required within parent	The type of logical operation applied to the rule branches and composing rules. Valid values are 'AND' and 'OR'. Known values: AND, OR
`ruleBranches`	array	Required within parent	An array of nested ComboEventRuleBranch objects, allowing for hierarchical rule definitions.
`ruleBranches[]`	Model	Each item	Expand Update event definition — response body — combo Event Rules

Referenced models: Update event definition — response body — combo Event Rules composing Rules item, Update event definition — response body — combo Event Rules

Update event definition — response body — combo Event Rules composing Rules item

Field	Type	Presence	Description and constraints
`$`	object	Root
`count`	JSON	Required within parent
`count (anyOf 1)`	integer	Alternative	An integer specifying the number of times the event must occur for the rule to be satisfied. Format: int32
`count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`eventTypeId`	string	Required within parent	The unique identifier for the type of event this rule applies to.
`lookbackWindowDays`	JSON	Optional
`lookbackWindowDays (anyOf 1)`	integer	Alternative	An integer representing the number of days to look back when evaluating the rule. Format: int32
`lookbackWindowDays (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`propertyFilters`	array	Required within parent	An array of property filters that must be satisfied for the rule to apply. Each filter specifies conditions on event properties.
`propertyFilters[]`	Model	Each item	Expand Update event definition — response body — combo Event Rules composing Rules item property Filters item

Referenced models: Update event definition — response body — combo Event Rules composing Rules item property Filters item

Update event definition — response body — combo Event Rules composing Rules item property Filters item

Field	Type	Presence	Description and constraints
`$`	object	Root
`context`	Model	Optional	Expand Update event definition — response body — combo Event Rules composing Rules item property Filters item context
`filterInsightsId`	JSON	Optional
`filterInsightsId (anyOf 1)`	integer	Alternative	An integer representing the ID for insights related to the filter. Format: int32
`filterInsightsId (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`filterType`	string	Required within parent	A string that specifies the type of filter being applied. The default value is 'PROPERTY'. Known values: PROPERTY Default: PROPERTY
`frameworkFilterId`	JSON	Optional
`frameworkFilterId (anyOf 1)`	integer	Alternative	An integer that uniquely identifies the framework filter. Format: int64
`frameworkFilterId (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`operation`	JSON	Required within parent	Defines the operation to be performed on the property. It can be one of several types, such as BoolPropertyOperation, NumberPropertyOperation, StringPropertyOperation, etc.
`operation (anyOf 1)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool
`operation (anyOf 2)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: number
`operation (anyOf 3)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: string
`operation (anyOf 4)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: IS AFTER, IS AFTER DATE, IS BEFORE, IS BEFORE DATE, IS EQUAL TO, property Type: datetime
`operation (anyOf 5)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: IS BETWEEN, IS NOT BETWEEN, property Type: datetime-ranged
`operation (anyOf 6)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: IS AFTER, IS BEFORE, property Type: datetime-comparative
`operation (anyOf 7)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: IS EQUAL TO, IS NOT EQUAL TO, property Type: bool-comparative
`operation (anyOf 8)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: number-comparative
`operation (anyOf 9)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: string-comparative
`operation (anyOf 10)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: IS AFTER, IS BEFORE, property Type: property-updated-comparative
`operation (anyOf 11)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: datetime-rolling
`operation (anyOf 12)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: NOT UPDATED IN LAST X DAYS, UPDATED IN LAST X DAYS, property Type: rolling-property-updated
`operation (anyOf 13)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: enumeration
`operation (anyOf 14)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: IS BLANK, IS KNOWN, IS NOT BLANK, IS UNKNOWN, property Type: alltypes
`operation (anyOf 15)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: IS BETWEEN, IS NOT BETWEEN, property Type: number-ranged
`operation (anyOf 16)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring
`operation (anyOf 17)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / month: APR, AUG, DEC, FEB, JAN, JUL, JUN, MAR, MAY, NOV, OCT, SEP, operator: AFTER, BEFORE, EQUAL, property Type: date
`operation (anyOf 18)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: calendar-date, time Unit: DAY, MONTH, QUARTER, WEEK, YEAR
`operation (anyOf 19)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint
`operation (anyOf 20)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / lowerBoundEndpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS BETWEEN, IS NOT BETWEEN, property Type: rangedtime, upper Bound Endpoint Behavior: EXCLUSIVE, INCLUSIVE
`operation (anyOf 21)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: DOES NOT MATCH REGEX, MATCHES REGEX, property Type: regex
`property`	string	Required within parent	A string representing the name of the property to which the filter is applied.

Update event definition — response body — combo Event Rules composing Rules item property Filters item context

Field	Type	Presence	Description and constraints
`$`	object	Root
`objectTypeId`	string	Required within parent	A string that uniquely identifies the type of object to which the property filter is applied.

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint

Field	Type	Presence	Description and constraints
`$`	object	Root
`defaultValue`	string	Optional	A string indicating the default value used in the operation.
`endpointBehavior`	string	Required within parent	A string indicating the endpoint behavior, with possible values 'INCLUSIVE' and 'EXCLUSIVE'. Known values: EXCLUSIVE, INCLUSIVE
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean indicating whether to include objects with no value set.
`operationType`	string	Required within parent	A string indicating the type of operation.
`operator`	string	Required within parent	A string specifying the operator used in the operation, with possible values 'IS_BEFORE' and 'IS_AFTER'. Known values: IS_AFTER, IS_BEFORE
`operatorName`	string	Required within parent	A string representing the name of the operator.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyParser`	string	Required within parent	A string specifying the property parser, with possible values 'VALUE', 'UPDATED_AT', 'ANNIVERSARY', 'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION', and 'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION'. Known values: ANNIVERSARY, ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION, UPDATED_AT, VALUE, VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION
`propertyType`	string	Required within parent	A string indicating the type of property, defaulting to 'timepoint'. Known values: timepoint Default: timepoint
`renderSpec`	string	Optional	A string representing the rendering specification.
`timePoint`	JSON	Required within parent	A reference to a time point, which can be a DatePoint, IndexedTimePoint, or PropertyReferencedTime.
`timePoint (anyOf 1)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: DATE, timezone Source: CUSTOM, PORTAL, USER
`timePoint (anyOf 2)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER
`timePoint (anyOf 3)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: PROPERTY REFERENCED, timezone Source: CUSTOM, PORTAL, USER
`type`	string	Required within parent	A string representing the type of the operation.

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: DATE, timezone Source: CUSTOM, PORTAL, USER

Field	Type	Presence	Description and constraints
`$`	object	Root
`day`	JSON	Required within parent
`day (anyOf 1)`	integer	Alternative	An integer representing the day component of the date. Format: int32
`day (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`hour`	JSON	Optional
`hour (anyOf 1)`	integer	Alternative	An integer representing the hour component of the time. Format: int32
`hour (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`millisecond`	JSON	Optional
`millisecond (anyOf 1)`	integer	Alternative	An integer representing the millisecond component of the time. Format: int32
`millisecond (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`minute`	JSON	Optional
`minute (anyOf 1)`	integer	Alternative	An integer representing the minute component of the time. Format: int32
`minute (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`month`	JSON	Required within parent
`month (anyOf 1)`	integer	Alternative	An integer representing the month component of the date. Format: int32
`month (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`second`	JSON	Optional
`second (anyOf 1)`	integer	Alternative	An integer representing the second component of the time. Format: int32
`second (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`timeType`	string	Required within parent	A string indicating the type of time representation, with a default value of 'DATE'. Known values: DATE Default: DATE
`timezoneSource`	string	Required within parent	A string specifying the source of the timezone information. Valid values include 'CUSTOM', 'USER', and 'PORTAL'. Known values: CUSTOM, PORTAL, USER
`year`	JSON	Required within parent
`year (anyOf 1)`	integer	Alternative	An integer representing the year component of the date. Format: int32
`year (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`zoneId`	string	Required within parent	A string representing the identifier for the timezone.

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER

Field	Type	Presence	Description and constraints
`$`	object	Root
`indexReference`	JSON	Required within parent	An object that serves as the reference point for the indexed time, which can be one of several types such as NowReference, TodayReference, WeekReference, MonthReference, QuarterReference, FiscalQuarter, YearReference, or FiscalYear.
`indexReference (anyOf 1)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER index Reference reference Type: NOW
`indexReference (anyOf 2)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER index Reference reference Type: TODAY
`indexReference (anyOf 3)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER index Reference day Of Week: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY, reference Type: WEEK
`indexReference (anyOf 4)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER index Reference reference Type: MONTH
`indexReference (anyOf 5)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER index Reference reference Type: QUARTER
`indexReference (anyOf 6)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER index Reference reference Type: FISCAL QUARTER
`indexReference (anyOf 7)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER index Reference reference Type: YEAR
`indexReference (anyOf 8)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER index Reference reference Type: FISCAL YEAR
`offset`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER offset
`shouldGenerateRefreshTime`	boolean	Optional	A boolean indicating whether a refresh time should be generated.
`timeType`	string	Required within parent	A string indicating the type of time point, defaulting to 'INDEXED'. Known values: INDEXED Default: INDEXED
`timezoneSource`	string	Required within parent	A string specifying the source of the timezone, with possible values including 'CUSTOM', 'USER', and 'PORTAL'. Known values: CUSTOM, PORTAL, USER
`zoneId`	string	Required within parent	A string representing the identifier of the timezone.

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER index Reference day Of Week: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY, reference Type: WEEK

Field	Type	Presence	Description and constraints
`$`	object	Root
`dayOfWeek`	string	Required within parent	A string representing the day of the week. Valid values include 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', and 'SUNDAY'. Known values: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY
`hour`	JSON	Optional
`hour (anyOf 1)`	integer	Alternative	An integer representing the hour of the day. Format: int32
`hour (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`millisecond`	JSON	Optional
`millisecond (anyOf 1)`	integer	Alternative	An integer representing the millisecond within the second. Format: int32
`millisecond (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`minute`	JSON	Optional
`minute (anyOf 1)`	integer	Alternative	An integer representing the minute within the hour. Format: int32
`minute (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`referenceType`	string	Required within parent	A string indicating the type of reference, which is 'WEEK' by default. Known values: WEEK Default: WEEK
`second`	JSON	Optional
`second (anyOf 1)`	integer	Alternative	An integer representing the second within the minute. Format: int32
`second (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER index Reference reference Type: FISCAL QUARTER

Field	Type	Presence	Description and constraints
`$`	object	Root
`day`	JSON	Required within parent
`day (anyOf 1)`	integer	Alternative	An integer representing the day of the fiscal quarter. Format: int32
`day (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`hour`	JSON	Optional
`hour (anyOf 1)`	integer	Alternative	An integer representing the hour of the day. Format: int32
`hour (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`millisecond`	JSON	Optional
`millisecond (anyOf 1)`	integer	Alternative	An integer representing the millisecond within the second. Format: int32
`millisecond (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`minute`	JSON	Optional
`minute (anyOf 1)`	integer	Alternative	An integer representing the minute within the hour. Format: int32
`minute (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`month`	JSON	Required within parent
`month (anyOf 1)`	integer	Alternative	An integer representing the month of the fiscal quarter. Format: int32
`month (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`referenceType`	string	Required within parent	A string that indicates the type of reference, which is 'FISCAL_QUARTER' for this component. Known values: FISCAL_QUARTER Default: FISCAL_QUARTER
`second`	JSON	Optional
`second (anyOf 1)`	integer	Alternative	An integer representing the second within the minute. Format: int32
`second (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER index Reference reference Type: FISCAL YEAR

Field	Type	Presence	Description and constraints
`$`	object	Root
`day`	JSON	Required within parent
`day (anyOf 1)`	integer	Alternative	An integer representing the day of the fiscal year. Format: int32
`day (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`hour`	JSON	Optional
`hour (anyOf 1)`	integer	Alternative	An integer representing the hour component of the time. Format: int32
`hour (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`millisecond`	JSON	Optional
`millisecond (anyOf 1)`	integer	Alternative	An integer representing the millisecond component of the time. Format: int32
`millisecond (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`minute`	JSON	Optional
`minute (anyOf 1)`	integer	Alternative	An integer representing the minute component of the time. Format: int32
`minute (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`month`	JSON	Required within parent
`month (anyOf 1)`	integer	Alternative	An integer representing the month of the fiscal year. Format: int32
`month (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`referenceType`	string	Required within parent	A string indicating the type of reference, defaulting to 'FISCAL_YEAR'. Known values: FISCAL_YEAR Default: FISCAL_YEAR
`second`	JSON	Optional
`second (anyOf 1)`	integer	Alternative	An integer representing the second component of the time. Format: int32
`second (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER index Reference reference Type: MONTH

Field	Type	Presence	Description and constraints
`$`	object	Root
`day`	JSON	Required within parent
`day (anyOf 1)`	integer	Alternative	An integer representing the day of the month. Format: int32
`day (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`hour`	JSON	Optional
`hour (anyOf 1)`	integer	Alternative	An integer representing the hour of the day. Format: int32
`hour (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`millisecond`	JSON	Optional
`millisecond (anyOf 1)`	integer	Alternative	An integer representing the millisecond within the second. Format: int32
`millisecond (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`minute`	JSON	Optional
`minute (anyOf 1)`	integer	Alternative	An integer representing the minute within the hour. Format: int32
`minute (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`referenceType`	string	Required within parent	A string that specifies the type of reference, which is 'MONTH' for this component. Known values: MONTH Default: MONTH
`second`	JSON	Optional
`second (anyOf 1)`	integer	Alternative	An integer representing the second within the minute. Format: int32
`second (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER index Reference reference Type: NOW

Field	Type	Presence	Description and constraints
`$`	object	Root
`hour`	JSON	Optional
`hour (anyOf 1)`	integer	Alternative	An integer representing the hour of the current time. Format: int32
`hour (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`millisecond`	JSON	Optional
`millisecond (anyOf 1)`	integer	Alternative	An integer representing the millisecond of the current time. Format: int32
`millisecond (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`minute`	JSON	Optional
`minute (anyOf 1)`	integer	Alternative	An integer representing the minute of the current time. Format: int32
`minute (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`referenceType`	string	Required within parent	A string indicating the type of reference, which is always 'NOW' for this component. Known values: NOW Default: NOW
`second`	JSON	Optional
`second (anyOf 1)`	integer	Alternative	An integer representing the second of the current time. Format: int32
`second (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER index Reference reference Type: QUARTER

Field	Type	Presence	Description and constraints
`$`	object	Root
`day`	JSON	Required within parent
`day (anyOf 1)`	integer	Alternative	An integer representing the day of the month. Format: int32
`day (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`hour`	JSON	Optional
`hour (anyOf 1)`	integer	Alternative	An integer representing the hour of the day. Format: int32
`hour (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`millisecond`	JSON	Optional
`millisecond (anyOf 1)`	integer	Alternative	An integer representing the millisecond of the second. Format: int32
`millisecond (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`minute`	JSON	Optional
`minute (anyOf 1)`	integer	Alternative	An integer representing the minute of the hour. Format: int32
`minute (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`month`	JSON	Required within parent
`month (anyOf 1)`	integer	Alternative	An integer representing the month of the quarter. Format: int32
`month (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`referenceType`	string	Required within parent	A string that specifies the type of reference. The default value is 'QUARTER'. Known values: QUARTER Default: QUARTER
`second`	JSON	Optional
`second (anyOf 1)`	integer	Alternative	An integer representing the second of the minute. Format: int32
`second (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER index Reference reference Type: TODAY

Field	Type	Presence	Description and constraints
`$`	object	Root
`hour`	JSON	Optional
`hour (anyOf 1)`	integer	Alternative	An integer representing the hour of the day. Format: int32
`hour (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`millisecond`	JSON	Optional
`millisecond (anyOf 1)`	integer	Alternative	An integer representing the millisecond within the second. Format: int32
`millisecond (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`minute`	JSON	Optional
`minute (anyOf 1)`	integer	Alternative	An integer representing the minute within the hour. Format: int32
`minute (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`referenceType`	string	Required within parent	A string indicating the type of reference, which is always 'TODAY'. Known values: TODAY Default: TODAY
`second`	JSON	Optional
`second (anyOf 1)`	integer	Alternative	An integer representing the second within the minute. Format: int32
`second (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER index Reference reference Type: YEAR

Field	Type	Presence	Description and constraints
`$`	object	Root
`day`	JSON	Required within parent
`day (anyOf 1)`	integer	Alternative	An integer representing the day of the month. Format: int32
`day (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`hour`	JSON	Optional
`hour (anyOf 1)`	integer	Alternative	An integer representing the hour of the day. Format: int32
`hour (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`millisecond`	JSON	Optional
`millisecond (anyOf 1)`	integer	Alternative	An integer representing the millisecond within the second. Format: int32
`millisecond (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`minute`	JSON	Optional
`minute (anyOf 1)`	integer	Alternative	An integer representing the minute within the hour. Format: int32
`minute (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`month`	JSON	Required within parent
`month (anyOf 1)`	integer	Alternative	An integer representing the month of the year. Format: int32
`month (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`referenceType`	string	Required within parent	A string indicating the type of reference, which is 'YEAR' by default. Known values: YEAR Default: YEAR
`second`	JSON	Optional
`second (anyOf 1)`	integer	Alternative	An integer representing the second within the minute. Format: int32
`second (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER offset

Field	Type	Presence	Description and constraints
`$`	object	Root
`days`	JSON	Optional
`days (anyOf 1)`	integer	Alternative	An integer representing the number of days for the time offset. Format: int32
`days (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`hours`	JSON	Optional
`hours (anyOf 1)`	integer	Alternative	An integer representing the number of hours for the time offset. Format: int32
`hours (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`milliseconds`	JSON	Optional
`milliseconds (anyOf 1)`	integer	Alternative	An integer representing the number of milliseconds for the time offset. Format: int32
`milliseconds (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`minutes`	JSON	Optional
`minutes (anyOf 1)`	integer	Alternative	An integer representing the number of minutes for the time offset. Format: int32
`minutes (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`months`	JSON	Optional
`months (anyOf 1)`	integer	Alternative	An integer representing the number of months for the time offset. Format: int32
`months (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`quarters`	JSON	Optional
`quarters (anyOf 1)`	integer	Alternative	An integer representing the number of quarters for the time offset. Format: int32
`quarters (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`seconds`	JSON	Optional
`seconds (anyOf 1)`	integer	Alternative	An integer representing the number of seconds for the time offset. Format: int32
`seconds (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`weeks`	JSON	Optional
`weeks (anyOf 1)`	integer	Alternative	An integer representing the number of weeks for the time offset. Format: int32
`weeks (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`years`	JSON	Optional
`years (anyOf 1)`	integer	Alternative	An integer representing the number of years for the time offset. Format: int32
`years (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: PROPERTY REFERENCED, timezone Source: CUSTOM, PORTAL, USER

Field	Type	Presence	Description and constraints
`$`	object	Root
`property`	string	Required within parent	A string that indicates the property name used for referencing the time.
`referenceType`	string	Required within parent	A string that defines the type of reference, with valid values including 'VALUE', 'UPDATED_AT', 'ANNIVERSARY', 'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION', and 'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION'. Known values: ANNIVERSARY, ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION, UPDATED_AT, VALUE, VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION
`timeType`	string	Required within parent	A string indicating the type of time reference, with a default value of 'PROPERTY_REFERENCED'. Known values: PROPERTY_REFERENCED Default: PROPERTY_REFERENCED
`timezoneSource`	string	Required within parent	A string specifying the source of the timezone, which can be 'CUSTOM', 'USER', or 'PORTAL'. Known values: CUSTOM, PORTAL, USER
`zoneId`	string	Required within parent	A string representing the identifier of the timezone.

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / lowerBoundEndpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS BETWEEN, IS NOT BETWEEN, property Type: rangedtime, upper Bound Endpoint Behavior: EXCLUSIVE, INCLUSIVE

Field	Type	Presence	Description and constraints
`$`	object	Root
`defaultValue`	string	Optional	A string representing the default value for the operation.
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean indicating whether to include objects that have no value set.
`lowerBoundEndpointBehavior`	string	Required within parent	A string indicating the behavior of the lower bound endpoint, with valid values 'INCLUSIVE' and 'EXCLUSIVE'. Known values: EXCLUSIVE, INCLUSIVE
`lowerBoundTimePoint`	JSON	Required within parent	The lower bound time point for the operation, which can be a DatePoint, IndexedTimePoint, or PropertyReferencedTime.
`lowerBoundTimePoint (anyOf 1)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: DATE, timezone Source: CUSTOM, PORTAL, USER
`lowerBoundTimePoint (anyOf 2)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER
`lowerBoundTimePoint (anyOf 3)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: PROPERTY REFERENCED, timezone Source: CUSTOM, PORTAL, USER
`operationType`	string	Required within parent	A string indicating the type of operation being performed.
`operator`	string	Required within parent	A string representing the operator used in the operation. Valid values include 'IS_BETWEEN' and 'IS_NOT_BETWEEN'. Known values: IS_BETWEEN, IS_NOT_BETWEEN
`operatorName`	string	Required within parent	A string representing the name of the operator used in the operation.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyParser`	string	Required within parent	A string that specifies the parser for the property. Valid values include 'VALUE', 'UPDATED_AT', 'ANNIVERSARY', 'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION', and 'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION'. Known values: ANNIVERSARY, ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION, UPDATED_AT, VALUE, VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION
`propertyType`	string	Required within parent	A string that specifies the type of property, with a default value of 'rangedtime'. Known values: rangedtime Default: rangedtime
`renderSpec`	string	Optional	A string that provides specifications for rendering.
`type`	string	Required within parent	A string indicating the type of the operation.
`upperBoundEndpointBehavior`	string	Required within parent	A string indicating the behavior of the upper bound endpoint, with valid values 'INCLUSIVE' and 'EXCLUSIVE'. Known values: EXCLUSIVE, INCLUSIVE
`upperBoundTimePoint`	JSON	Required within parent	The upper bound time point for the operation, which can be a DatePoint, IndexedTimePoint, or PropertyReferencedTime.
`upperBoundTimePoint (anyOf 1)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: DATE, timezone Source: CUSTOM, PORTAL, USER
`upperBoundTimePoint (anyOf 2)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: INDEXED, timezone Source: CUSTOM, PORTAL, USER
`upperBoundTimePoint (anyOf 3)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint time Point time Type: PROPERTY REFERENCED, timezone Source: CUSTOM, PORTAL, USER

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / month: APR, AUG, DEC, FEB, JAN, JUL, JUN, MAR, MAY, NOV, OCT, SEP, operator: AFTER, BEFORE, EQUAL, property Type: date

Field	Type	Presence	Description and constraints
`$`	object	Root
`day`	JSON	Required within parent
`day (anyOf 1)`	integer	Alternative	An integer specifying the day component of the date. Format: int32
`day (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`defaultValue`	string	Optional	A string representing the default value to use if no specific value is set.
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean indicating whether to include objects that have no value set for the property.
`month`	string	Required within parent	An integer specifying the month component of the date. Known values: APR, AUG, DEC, FEB, JAN, JUL, JUN, MAR, MAY, NOV, OCT, SEP
`operationType`	string	Required within parent	A string indicating the type of operation being performed.
`operator`	string	Required within parent	A string representing the operation to be performed, with valid values including 'IS_BEFORE', 'IS_AFTER', and 'IS_EQUAL_TO'. Known values: AFTER, BEFORE, EQUAL
`operatorName`	string	Required within parent	A string that provides a human-readable name for the operator.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyType`	string	Required within parent	A string indicating the type of property, which defaults to 'date'. Known values: date Default: date
`renderSpec`	string	Optional	A string that specifies how the operation should be rendered or displayed.
`year`	JSON	Required within parent
`year (anyOf 1)`	integer	Alternative	An integer specifying the year component of the date. Format: int32
`year (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: DOES NOT MATCH REGEX, MATCHES REGEX, property Type: regex

Field	Type	Presence	Description and constraints
`$`	object	Root
`caseSensitive`	boolean	Required within parent	A boolean indicating whether the regex matching should be case-sensitive.
`defaultValue`	string	Optional	A string specifying the default value to be used if no value is set.
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean that determines whether objects with no value set should be included in the operation.
`operationType`	string	Required within parent	A string indicating the type of operation being performed.
`operator`	string	Required within parent	A string specifying the operation to perform, with valid values being 'MATCHES_REGEX' and 'DOES_NOT_MATCH_REGEX'. Known values: DOES_NOT_MATCH_REGEX, MATCHES_REGEX
`operatorName`	string	Required within parent	A string representing the name of the operator used in the operation.
`pattern`	string	Required within parent	A string representing the regex pattern to be used in the operation.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyType`	string	Required within parent	A string indicating the type of property operation, which is 'regex' for this component. Known values: regex Default: regex
`renderSpec`	string	Optional	A string that may define how the operation is rendered, though its specific use is not detailed.

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: IS AFTER, IS AFTER DATE, IS BEFORE, IS BEFORE DATE, IS EQUAL TO, property Type: datetime

Field	Type	Presence	Description and constraints
`$`	object	Root
`defaultValue`	string	Optional	A string representing the default value for the operation.
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean indicating whether to include objects that have no value set for the property.
`operationType`	string	Required within parent	A string indicating the type of operation being performed.
`operator`	string	Required within parent	A string representing the operation to be performed, such as 'IS_BEFORE', 'IS_AFTER', 'IS_EQUAL_TO', 'IS_BEFORE_DATE', or 'IS_AFTER_DATE'. Known values: IS_AFTER, IS_AFTER_DATE, IS_BEFORE, IS_BEFORE_DATE, IS_EQUAL_TO
`operatorName`	string	Required within parent	A string representing the name of the operator used in the operation.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyType`	string	Required within parent	A string indicating the type of property, with a default value of 'datetime'. Known values: datetime Default: datetime
`renderSpec`	string	Optional	A string specifying the rendering specification for the operation.
`requiresTimeZoneConversion`	boolean	Required within parent	A boolean indicating whether the operation requires time zone conversion.
`timestamp`	JSON	Required within parent
`timestamp (anyOf 1)`	integer	Alternative	An integer representing the timestamp for the operation, in int64 format. Format: int64
`timestamp (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: IS AFTER, IS BEFORE, property Type: datetime-comparative

Field	Type	Presence	Description and constraints
`$`	object	Root
`comparisonPropertyName`	string	Required within parent	A string specifying the name of the property to be compared against.
`defaultComparisonValue`	string	Optional	A string representing the default value to compare against if the comparison property is not set.
`defaultValue`	string	Optional	A string representing the default value to use if no specific comparison value is set.
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean indicating whether to include objects that do not have a value set for the property being compared.
`operationType`	string	Required within parent	A string indicating the type of operation being performed.
`operator`	string	Required within parent	A string representing the comparison operator used in the operation. Valid values include 'IS_BEFORE' and 'IS_AFTER'. Known values: IS_AFTER, IS_BEFORE
`operatorName`	string	Required within parent	A string representing the name of the operator used in the operation.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyType`	string	Required within parent	A string indicating the type of property operation, which is 'datetime-comparative' for this component. Known values: datetime-comparative Default: datetime-comparative
`renderSpec`	string	Optional	A string providing specifications for rendering the operation.

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: IS AFTER, IS BEFORE, property Type: property-updated-comparative

Field	Type	Presence	Description and constraints
`$`	object	Root
`comparisonPropertyName`	string	Required within parent	A string representing the name of the property to compare against.
`defaultComparisonValue`	string	Optional	A string that specifies the default comparison value to use if no comparison value is set.
`defaultValue`	string	Optional	A string that specifies the default value to use if no value is set.
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean indicating whether to include objects that have no value set for the property.
`operationType`	string	Required within parent	A string representing the type of operation being performed.
`operator`	string	Required within parent	A string that defines the comparison operator to use, with valid values being 'IS_BEFORE' and 'IS_AFTER'. Known values: IS_AFTER, IS_BEFORE
`operatorName`	string	Required within parent	A string that provides a human-readable name for the operator.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyType`	string	Required within parent	A string that specifies the type of property operation, with a default value of 'property-updated-comparative'. Known values: property-updated-comparative Default: property-updated-comparative
`renderSpec`	string	Optional	A string that defines the rendering specification for the operation.

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: IS BETWEEN, IS NOT BETWEEN, property Type: datetime-ranged

Field	Type	Presence	Description and constraints
`$`	object	Root
`defaultValue`	string	Optional	A string representing the default value for the operation.
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean indicating whether to include objects that have no value set for the property.
`lowerBoundTimestamp`	JSON	Required within parent
`lowerBoundTimestamp (anyOf 1)`	integer	Alternative	An integer representing the lower bound of the date range as a Unix timestamp in milliseconds. Format: int64
`lowerBoundTimestamp (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`operationType`	string	Required within parent	A string representing the type of operation being performed.
`operator`	string	Required within parent	A string representing the operation to be performed, with valid values including 'IS_BETWEEN' and 'IS_NOT_BETWEEN'. Known values: IS_BETWEEN, IS_NOT_BETWEEN
`operatorName`	string	Required within parent	A string representing the name of the operator used in the operation.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyType`	string	Required within parent	A string indicating the type of property, defaulting to 'datetime-ranged'. Known values: datetime-ranged Default: datetime-ranged
`renderSpec`	string	Optional	A string specifying the rendering specification for the operation.
`requiresTimeZoneConversion`	boolean	Required within parent	A boolean indicating whether time zone conversion is required for this operation.
`upperBoundTimestamp`	JSON	Required within parent
`upperBoundTimestamp (anyOf 1)`	integer	Alternative	An integer representing the upper bound of the date range as a Unix timestamp in milliseconds. Format: int64
`upperBoundTimestamp (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: IS BETWEEN, IS NOT BETWEEN, property Type: number-ranged

Field	Type	Presence	Description and constraints
`$`	object	Root
`defaultValue`	string	Optional	A string representing the default value for the operation.
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean indicating whether objects with no value set should be included in the operation.
`lowerBound`	JSON	Required within parent
`lowerBound (anyOf 1)`	number	Alternative	A number that specifies the lower bound of the range.
`lowerBound (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`operationType`	string	Required within parent	A string that describes the type of operation being performed.
`operator`	string	Required within parent	A string that defines the operation to be performed, with valid values including 'IS_BETWEEN' and 'IS_NOT_BETWEEN'. Known values: IS_BETWEEN, IS_NOT_BETWEEN
`operatorName`	string	Required within parent	A string representing the name of the operator used in the operation.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyType`	string	Required within parent	A string that specifies the type of property operation, with a default value of 'number-ranged'. Known values: number-ranged Default: number-ranged
`renderSpec`	string	Optional	A string that provides specifications for rendering the operation.
`upperBound`	JSON	Required within parent
`upperBound (anyOf 1)`	number	Alternative	A number that specifies the upper bound of the range.
`upperBound (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: IS BLANK, IS KNOWN, IS NOT BLANK, IS UNKNOWN, property Type: alltypes

Field	Type	Presence	Description and constraints
`$`	object	Root
`coalescingRefineBy`	JSON	Required within parent	An object used to refine the operation by coalescing, which can be one of several types such as NumOccurrencesRefineBy or SetOccurrencesRefineBy.
`coalescingRefineBy (anyOf 1)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring coalescing Refine By type: Num Occurrences Refine By
`coalescingRefineBy (anyOf 2)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring coalescing Refine By type: Set Occurrences Refine By
`defaultValue`	string	Optional	A string specifying the default value for the operation.
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean indicating whether objects with no value set should be included in the operation.
`operationType`	string	Required within parent	A string indicating the type of operation being performed.
`operator`	string	Required within parent	A string representing the operation to be performed, with valid values including 'IS_KNOWN', 'IS_UNKNOWN', 'IS_BLANK', and 'IS_NOT_BLANK'. Known values: IS_BLANK, IS_KNOWN, IS_NOT_BLANK, IS_UNKNOWN
`operatorName`	string	Required within parent	A string representing the name of the operator used in the operation.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyType`	string	Required within parent	A string indicating the type of property, with a default value of 'alltypes'. Known values: alltypes Default: alltypes
`pruningRefineBy`	JSON	Optional	An object used to refine the operation by pruning, which can be one of several types such as RelativeComparativeTimestampRefineBy or AbsoluteRangedTimestampRefineBy.
`pruningRefineBy (anyOf 1)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By comparison: AFTER, BEFORE, type: Relative Comparative Timestamp Refine By
`pruningRefineBy (anyOf 2)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By range Type: BETWEEN, NOT BETWEEN, type: Relative Ranged Timestamp Refine By
`pruningRefineBy (anyOf 3)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By comparison: AFTER, BEFORE, type: Absolute Comparative Timestamp Refine By
`pruningRefineBy (anyOf 4)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By range Type: BETWEEN, NOT BETWEEN, type: Absolute Ranged Timestamp Refine By
`pruningRefineBy (anyOf 5)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By type: All History Refine By
`pruningRefineBy (anyOf 6)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint
`pruningRefineBy (anyOf 7)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / lowerBoundEndpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS BETWEEN, IS NOT BETWEEN, property Type: rangedtime, upper Bound Endpoint Behavior: EXCLUSIVE, INCLUSIVE
`renderSpec`	string	Optional	A string providing specifications for rendering the operation.

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: IS EQUAL TO, IS NOT EQUAL TO, property Type: bool-comparative

Field	Type	Presence	Description and constraints
`$`	object	Root
`comparisonPropertyName`	string	Required within parent	A string specifying the name of the property to compare against.
`defaultValue`	string	Optional	A string representing the default value to use if no value is set.
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean indicating whether objects with no value set for the property should be included in the operation.
`operationType`	string	Required within parent	A string specifying the type of operation being performed.
`operator`	string	Required within parent	A string representing the comparison operator to be used. Valid values are 'IS_EQUAL_TO' and 'IS_NOT_EQUAL_TO'. Known values: IS_EQUAL_TO, IS_NOT_EQUAL_TO
`operatorName`	string	Required within parent	A string representing the name of the operator used in the operation.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyType`	string	Required within parent	A string indicating the type of property operation, defaulting to 'bool-comparative'. Known values: bool-comparative Default: bool-comparative
`renderSpec`	string	Optional	A string that may define how the operation should be rendered, though specifics are not detailed in the spec.

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / operator: NOT UPDATED IN LAST X DAYS, UPDATED IN LAST X DAYS, property Type: rolling-property-updated

Field	Type	Presence	Description and constraints
`$`	object	Root
`defaultValue`	string	Optional	A string that provides a default value for the operation.
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean indicating whether objects with no value set should be included in the operation.
`numberOfDays`	JSON	Required within parent
`numberOfDays (anyOf 1)`	integer	Alternative	An integer representing the number of days to consider for the operation. Format: int32
`numberOfDays (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`operationType`	string	Required within parent	A string that specifies the type of operation being performed.
`operator`	string	Required within parent	A string specifying the operation to be performed, with valid values being 'UPDATED_IN_LAST_X_DAYS' and 'NOT_UPDATED_IN_LAST_X_DAYS'. Known values: NOT_UPDATED_IN_LAST_X_DAYS, UPDATED_IN_LAST_X_DAYS
`operatorName`	string	Required within parent	A string representing the name of the operator used in the operation.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyType`	string	Required within parent	A string indicating the type of property operation, which is 'rolling-property-updated'. Known values: rolling-property-updated Default: rolling-property-updated
`renderSpec`	string	Optional	A string that specifies the rendering specification for the operation.

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool

Field	Type	Presence	Description and constraints
`$`	object	Root
`defaultValue`	string	Optional	A string representing the default value for the operation.
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean indicating whether to include objects that have no value set for the property.
`operationType`	string	Required within parent	A string indicating the type of operation being performed.
`operator`	string	Required within parent	A string representing the operation to be performed, with valid values including 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'HAS_EVER_BEEN_EQUAL_TO', and 'HAS_NEVER_BEEN_EQUAL_TO'. Known values: HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO, IS_EQUAL_TO, IS_NOT_EQUAL_TO
`operatorName`	string	Required within parent	A string representing the name of the operator used in the operation.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyType`	string	Required within parent	A string indicating the type of property, with a default value of 'bool'. Known values: bool Default: bool
`renderSpec`	string	Optional	A string specifying the rendering specification for the operation.
`value`	boolean	Required within parent	A boolean indicating the value to be used in the operation.

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Field	Type	Presence	Description and constraints
`$`	object	Root
`aspect`	string	Required within parent	Known values: TIMERANGE_END, TIMERANGE_START
`qualifier`	string	Optional

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: calendar-date, time Unit: DAY, MONTH, QUARTER, WEEK, YEAR

Field	Type	Presence	Description and constraints
`$`	object	Root
`defaultValue`	string	Optional	A string representing the default value for the operation.
`fiscalYearStart`	string	Optional	A string that defines the starting month of the fiscal year, with options such as 'JANUARY', 'FEBRUARY', 'MARCH', etc. Known values: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean that determines whether objects with no value set should be included in the operation.
`operationType`	string	Required within parent	A string that specifies the type of operation being performed.
`operator`	string	Required within parent	A string that indicates the operation to be performed, with possible values including 'IN_THIS_TIME_UNIT', 'IN_THIS_TIME_UNIT_SO_FAR', 'IN_NEXT_TIME_UNIT', 'IN_LAST_TIME_UNIT', and 'IN_LAST_TIME_UNIT_SO_FAR'. Known values: IN_LAST_TIME_UNIT, IN_LAST_TIME_UNIT_SO_FAR, IN_NEXT_TIME_UNIT, IN_THIS_TIME_UNIT, IN_THIS_TIME_UNIT_SO_FAR
`operatorName`	string	Required within parent	A string representing the name of the operator used in the operation.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyType`	string	Required within parent	A string that specifies the type of property operation, defaulting to 'calendar-date'. Known values: calendar-date Default: calendar-date
`renderSpec`	string	Optional	A string specifying the rendering specification for the operation.
`timeUnit`	string	Required within parent	A string representing the unit of time for the operation, which can be 'DAY', 'WEEK', 'MONTH', 'QUARTER', or 'YEAR'. Known values: DAY, MONTH, QUARTER, WEEK, YEAR
`timeUnitCount`	JSON	Required within parent
`timeUnitCount (anyOf 1)`	integer	Alternative	An integer specifying the number of time units to consider in the operation. Format: int32
`timeUnitCount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`useFiscalYear`	boolean	Required within parent	A boolean indicating whether the fiscal year should be used in the operation.

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: datetime-rolling

Field	Type	Presence	Description and constraints
`$`	object	Root
`defaultValue`	string	Optional	A string representing the default value for the operation.
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean indicating whether to include objects that have no value set for the property.
`numberOfDays`	JSON	Required within parent
`numberOfDays (anyOf 1)`	integer	Alternative	An integer specifying the number of days for the rolling date range operation. Format: int32
`numberOfDays (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`operationType`	string	Required within parent	A string indicating the type of operation being performed.
`operator`	string	Required within parent	A string specifying the operation to perform, with valid values including 'IS_LESS_THAN_X_DAYS_AGO', 'IS_MORE_THAN_X_DAYS_AGO', 'IS_LESS_THAN_X_DAYS_FROM_NOW', and 'IS_MORE_THAN_X_DAYS_FROM_NOW'. Known values: IS_LESS_THAN_X_DAYS_AGO, IS_LESS_THAN_X_DAYS_FROM_NOW, IS_MORE_THAN_X_DAYS_AGO, IS_MORE_THAN_X_DAYS_FROM_NOW
`operatorName`	string	Required within parent	A string representing the name of the operator used in the operation.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyType`	string	Required within parent	A string indicating the type of property, with a default value of 'datetime-rolling'. Known values: datetime-rolling Default: datetime-rolling
`renderSpec`	string	Optional	A string that specifies the rendering specification for the operation.
`requiresTimeZoneConversion`	boolean	Required within parent	A boolean indicating whether the operation requires time zone conversion.

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: enumeration

Field	Type	Presence	Description and constraints
`$`	object	Root
`defaultValue`	string	Optional	A string representing the default value for the operation.
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean indicating whether to include objects that have no value set for the property.
`operationType`	string	Required within parent	A string indicating the type of operation being performed.
`operator`	string	Required within parent	A string specifying the operation to perform, with valid values including 'IS_ANY_OF', 'IS_NONE_OF', 'IS_EXACTLY', 'IS_NOT_EXACTLY', 'CONTAINS_ALL', 'DOES_NOT_CONTAIN_ALL', 'HAS_EVER_BEEN_ANY_OF', 'HAS_NEVER_BEEN_ANY_OF', 'HAS_EVER_BEEN_EXACTLY', 'HAS_NEVER_BEEN_EXACTLY', 'HAS_EVER_CONTAINED_ALL', and 'HAS_NEVER_CONTAINED_ALL'. Known values: CONTAINS_ALL, DOES_NOT_CONTAIN_ALL, HAS_EVER_BEEN_ANY_OF, HAS_EVER_BEEN_EXACTLY, HAS_EVER_CONTAINED_ALL, HAS_NEVER_BEEN_ANY_OF, HAS_NEVER_BEEN_EXACTLY, HAS_NEVER_CONTAINED_ALL, IS_ANY_OF, IS_EXACTLY, IS_NONE_OF, IS_NOT_EXACTLY
`operatorName`	string	Required within parent	A string representing the name of the operator used in the operation.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyType`	string	Required within parent	A string indicating the type of property, which is 'enumeration' for this operation. Known values: enumeration Default: enumeration
`renderSpec`	string	Optional	A string that specifies the rendering specifications for the operation.
`values`	array	Required within parent	An array of strings representing the values to be used in the operation.
`values[]`	string	Each item

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring

Field	Type	Presence	Description and constraints
`$`	object	Root
`coalescingRefineBy`	JSON	Required within parent	A refinement option for coalescing operations, which can be either 'NumOccurrencesRefineBy' or 'SetOccurrencesRefineBy'.
`coalescingRefineBy (anyOf 1)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring coalescing Refine By type: Num Occurrences Refine By
`coalescingRefineBy (anyOf 2)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring coalescing Refine By type: Set Occurrences Refine By
`defaultValue`	string	Optional	A default value to be used if no other value is set.
`includeObjectsWithNoValueSet`	boolean	Required within parent	A boolean indicating whether objects with no value set should be included in the operation.
`operationType`	string	Required within parent	The type of operation being performed.
`operator`	string	Required within parent	The operator used in the operation. Valid values include 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'CONTAINS', 'CONTAINS_EXACTLY', 'DOES_NOT_CONTAIN', 'DOES_NOT_CONTAIN_EXACTLY', 'STARTS_WITH', and 'ENDS_WITH'. Known values: CONTAINS, CONTAINS_EXACTLY, DOES_NOT_CONTAIN, DOES_NOT_CONTAIN_EXACTLY, ENDS_WITH, IS_EQUAL_TO, IS_NOT_EQUAL_TO, STARTS_WITH
`operatorName`	string	Required within parent	The name of the operator used in the operation.
`propertyAspect`	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
`propertyType`	string	Required within parent	The type of property being operated on, which is 'multistring' for this operation. Known values: multistring Default: multistring
`pruningRefineBy`	JSON	Optional	A refinement option that further specifies the operation, which can be one of several types such as 'RelativeComparativeTimestampRefineBy', 'RelativeRangedTimestampRefineBy', 'AbsoluteComparativeTimestampRefineBy', 'AbsoluteRangedTimestampRefineBy', 'AllHistoryRefineBy', 'TimePointOperation', or 'RangedTimeOperation'.
`pruningRefineBy (anyOf 1)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By comparison: AFTER, BEFORE, type: Relative Comparative Timestamp Refine By
`pruningRefineBy (anyOf 2)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By range Type: BETWEEN, NOT BETWEEN, type: Relative Ranged Timestamp Refine By
`pruningRefineBy (anyOf 3)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By comparison: AFTER, BEFORE, type: Absolute Comparative Timestamp Refine By
`pruningRefineBy (anyOf 4)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By range Type: BETWEEN, NOT BETWEEN, type: Absolute Ranged Timestamp Refine By
`pruningRefineBy (anyOf 5)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By type: All History Refine By
`pruningRefineBy (anyOf 6)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / endpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS AFTER, IS BEFORE, property Type: timepoint
`pruningRefineBy (anyOf 7)`	Model	Alternative	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / lowerBoundEndpointBehavior: EXCLUSIVE, INCLUSIVE, operator: IS BETWEEN, IS NOT BETWEEN, property Type: rangedtime, upper Bound Endpoint Behavior: EXCLUSIVE, INCLUSIVE
`renderSpec`	string	Optional	A specification for how the operation should be rendered.
`values`	array	Required within parent	An array of string values that are involved in the operation.
`values[]`	string	Each item

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring coalescing Refine By type: Num Occurrences Refine By

Field	Type	Presence	Description and constraints
`$`	object	Root
`maxOccurrences`	JSON	Optional
`maxOccurrences (anyOf 1)`	integer	Alternative	An integer indicating the maximum number of times an event can occur. Format: int32
`maxOccurrences (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`minOccurrences`	JSON	Optional
`minOccurrences (anyOf 1)`	integer	Alternative	An integer indicating the minimum number of times an event must occur. Format: int32
`minOccurrences (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`type`	string	Required within parent	A string that specifies the type of refinement, which is 'NumOccurrencesRefineBy'. Known values: NumOccurrencesRefineBy Default: NumOccurrencesRefineBy

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring coalescing Refine By type: Set Occurrences Refine By

Field	Type	Presence	Description and constraints
`$`	object	Root
`setType`	string	Required within parent	A string that indicates the set type for the refinement operation. Valid values include 'ALL', 'ALL_INCLUDE_EMPTY', 'ANY', 'NONE', 'NONE_EXCLUDE_EMPTY', and 'ANY_INCLUDE_EMPTY'. Known values: ALL, ALL_INCLUDE_EMPTY, ANY, ANY_INCLUDE_EMPTY, NONE, NONE_EXCLUDE_EMPTY
`type`	string	Required within parent	A string that specifies the type of refinement operation. The default value is 'SetOccurrencesRefineBy'. Known values: SetOccurrencesRefineBy Default: SetOccurrencesRefineBy

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By comparison: AFTER, BEFORE, type: Absolute Comparative Timestamp Refine By

Field	Type	Presence	Description and constraints
`$`	object	Root
`comparison`	string	Required within parent	A string indicating the type of comparison to be made with the timestamp. Valid values are 'BEFORE' and 'AFTER'. Known values: AFTER, BEFORE
`timestamp`	JSON	Required within parent
`timestamp (anyOf 1)`	integer	Alternative	An integer representing the specific timestamp to be used in the comparison, formatted as an int64. Format: int64
`timestamp (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`type`	string	Required within parent	A string that specifies the type of refinement, with a default value of 'AbsoluteComparativeTimestampRefineBy'. Known values: AbsoluteComparativeTimestampRefineBy Default: AbsoluteComparativeTimestampRefineBy

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By comparison: AFTER, BEFORE, type: Relative Comparative Timestamp Refine By

Field	Type	Presence	Description and constraints
`$`	object	Root
`comparison`	string	Required within parent	A string indicating the type of comparison to be made, with valid values being 'BEFORE' or 'AFTER'. Known values: AFTER, BEFORE
`timeOffset`	Model	Required within parent	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By comparison: AFTER, BEFORE, type: Relative Comparative Timestamp Refine By time Offset
`type`	string	Required within parent	A string indicating the type of refinement operation, which is 'RelativeComparativeTimestampRefineBy'. Known values: RelativeComparativeTimestampRefineBy Default: RelativeComparativeTimestampRefineBy

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By comparison: AFTER, BEFORE, type: Relative Comparative Timestamp Refine By time Offset

Field	Type	Presence	Description and constraints
`$`	object	Root
`amount`	JSON	Required within parent
`amount (anyOf 1)`	integer	Alternative	An integer specifying the amount of time to offset, measured in the unit defined by the timeUnit property. Format: int64
`amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`offsetDirection`	string	Required within parent	A string indicating the direction of the time offset. Valid values are 'PAST' and 'FUTURE'. Known values: FUTURE, PAST
`timeUnit`	string	Required within parent	A string representing the unit of time for the offset. Valid values include 'WEEKS', 'DAYS', 'HOURS', and 'MINUTES'. Known values: DAYS, HOURS, MINUTES, WEEKS

Report an issue with this page