Skip to content

HubSpot: Pipeline governance schemas (part 4)

33 HubSpot schemas with complete fields and constraints.

← Pipeline governance operations · All schemas

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT

FieldTypePresenceDescription and constraints
$objectRoot
coalescingRefineByJSONOptionalCriteria used to refine the filter by coalescing, which can include various timestamp operations.
coalescingRefineBy (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
coalescingRefineBy (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
coalescingRefineBy (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
coalescingRefineBy (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
coalescingRefineBy (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
coalescingRefineBy (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
coalescingRefineBy (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
coalescingRefineBy (oneOf 8)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
coalescingRefineBy (oneOf 9)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
filterTypestringRequired within parentThe type of filter being applied. Defaults to 'FORM_SUBMISSION_ON_PAGE'.
Default: FORM_SUBMISSION_ON_PAGE
One of: FORM_SUBMISSION_ON_PAGE
formIdstringOptionalThe unique identifier of the form being filtered.
operatorstringRequired within parentThe operation to apply, which can be either 'FILLED_OUT' or 'NOT_FILLED_OUT'.
One of: FILLED_OUT, NOT_FILLED_OUT
pageIdstringRequired within parentThe unique identifier of the page where the form submission is being filtered.
pruningRefineByJSONOptionalCriteria used to refine the filter by pruning, which can include various timestamp operations.
pruningRefineBy (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (oneOf 8)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
pruningRefineBy (oneOf 9)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT

FieldTypePresenceDescription and constraints
$objectRoot
coalescingRefineByJSONOptionalAn object used to refine the filter by coalescing criteria. It can be one of several types, such as occurrences or timestamp-based refinements.
coalescingRefineBy (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
coalescingRefineBy (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
coalescingRefineBy (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
coalescingRefineBy (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
coalescingRefineBy (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
coalescingRefineBy (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
coalescingRefineBy (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
coalescingRefineBy (oneOf 8)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
coalescingRefineBy (oneOf 9)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
filterTypestringRequired within parentA string that specifies the type of filter. The default value is 'FORM_SUBMISSION'.
Default: FORM_SUBMISSION
One of: FORM_SUBMISSION
formIdstringOptionalA string representing the unique identifier of the form.
operatorstringRequired within parentA string that specifies the operation to apply, with valid values being 'FILLED_OUT' or 'NOT_FILLED_OUT'.
One of: FILLED_OUT, NOT_FILLED_OUT
pruningRefineByJSONOptionalAn object used to refine the filter by pruning criteria. It can be one of several types, such as occurrences or timestamp-based refinements.
pruningRefineBy (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (oneOf 8)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
pruningRefineBy (oneOf 9)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST

FieldTypePresenceDescription and constraints
$objectRoot
filterTypestringRequired within parentA string that specifies the type of filter being applied. The default value is 'IN_LIST'.
Default: IN_LIST
One of: IN_LIST
listIdstringRequired within parentA string representing the unique identifier of the list to be used in the filter.
metadataModelOptionalExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST metadata
operatorstringRequired within parentA string that defines the operator used in the filter.

Referenced models: Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST metadata

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT

FieldTypePresenceDescription and constraints
$objectRoot
eventTypeIdintegerRequired within parentA string that uniquely identifies the type of event to be filtered. This property is used to specify which event type the filter applies to.
Format: int32
filterLinesarrayRequired within parentAn array of filter lines that contain the metadata for the event filter. Each item in the array is a detailed specification of the criteria used to filter events.
filterLines[]ModelEach itemExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item
filterTypestringRequired within parentA string representing the type of filter. It is a required field and typically has a default value specific to the filter type.
Default: INTEGRATION_EVENT
One of: INTEGRATION_EVENT

Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW

FieldTypePresenceDescription and constraints
$objectRoot
coalescingRefineByJSONOptionalAn optional refinement criterion that can be one of several predefined schemas, used to further refine the filter results.
coalescingRefineBy (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
coalescingRefineBy (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
coalescingRefineBy (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
coalescingRefineBy (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
coalescingRefineBy (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
coalescingRefineBy (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
coalescingRefineBy (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
coalescingRefineBy (oneOf 8)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
coalescingRefineBy (oneOf 9)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
enableTrackingbooleanOptionalA boolean indicating whether tracking is enabled for this filter.
filterTypestringRequired within parentA string representing the type of filter. Default value is 'PAGE_VIEW'.
Default: PAGE_VIEW
One of: PAGE_VIEW
operatorstringRequired within parentA string representing the operator used in the filter.
pageUrlstringRequired within parentA string representing the URL of the page to be filtered.
pruningRefineByJSONOptionalAn optional refinement criterion that can be one of several predefined schemas, used to prune the filter results.
pruningRefineBy (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (oneOf 8)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
pruningRefineBy (oneOf 9)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY

FieldTypePresenceDescription and constraints
$objectRoot
filterTypestringRequired within parentA string indicating the type of filter, which is 'PRIVACY' for this component.
Default: PRIVACY
One of: PRIVACY
operatorstringRequired within parentA string specifying the operator to be used in conjunction with the privacyName for filtering.
privacyNamestringRequired within parentA string representing the name of the privacy setting to be used in the filter.

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY

FieldTypePresenceDescription and constraints
$objectRoot
filterTypestringRequired within parentA string indicating the type of filter. The default value is 'PROPERTY'.
Default: PROPERTY
One of: PROPERTY
operationJSONRequired within parentDefines the operation to be performed on the property. This can be one of several operation types, such as boolean, number, string, date, and more, each with its own specific behavior.
operation (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL
operation (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER
operation (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING
operation (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME
operation (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE
operation (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED
operation (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE
operation (oneOf 8)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE
operation (oneOf 9)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED
operation (oneOf 10)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION
operation (oneOf 11)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY
operation (oneOf 12)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED
operation (oneOf 13)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING
operation (oneOf 14)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE
operation (oneOf 15)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE
operation (oneOf 16)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
operation (oneOf 17)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
operation (oneOf 18)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING
operation (oneOf 19)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER
propertystringRequired within parentA string representing the name of the property to be filtered.

Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether to include objects that have no value set for the property.
operationTypestringRequired within parentA string indicating the type of operation. The default and only valid value is 'ALL_PROPERTY_TYPES'.
Default: ALL_PROPERTY
One of: ALL_PROPERTY
operatorstringRequired within parentA string representing the operator to be used in the operation.

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects with no value set should be included in the operation.
operationTypestringRequired within parentA string representing the type of operation. The default value is 'BOOLEAN'.
Default: BOOL
One of: BOOL
operatorstringRequired within parentA string indicating the operator used in the boolean operation.
valuebooleanRequired within parentA boolean representing the value to be used in the operation.

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE

FieldTypePresenceDescription and constraints
$objectRoot
fiscalYearStartstringOptionalA string indicating the start month of the fiscal year. Valid values include 'JANUARY', 'FEBRUARY', 'MARCH', 'APRIL', 'MAY', 'JUNE', 'JULY', 'AUGUST', 'SEPTEMBER', 'OCTOBER', 'NOVEMBER', and 'DECEMBER'.
One of: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether to include objects that have no value set for the property.
operationTypestringRequired within parentA string indicating the type of operation, which is always 'CALENDAR_DATE'.
Default: CALENDAR_DATE
One of: CALENDAR_DATE
operatorstringRequired within parentA string representing the operator used in the operation.
timeUnitstringRequired within parentA string specifying the unit of time for the operation.
timeUnitCountintegerOptionalAn integer specifying the count of the time units for the operation.
Format: int32
useFiscalYearbooleanOptionalA boolean indicating whether the fiscal year should be used.

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE

FieldTypePresenceDescription and constraints
$objectRoot
comparisonPropertyNamestringRequired within parentA string specifying the name of the property to be used for comparison.
defaultComparisonValuestringOptionalA string representing the default value to be used for comparison if no other value is set.
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects with no value set should be included in the operation.
operationTypestringRequired within parentA string indicating the type of operation. The default value is 'COMPARATIVE_DATE'.
Default: COMPARATIVE_DATE
One of: COMPARATIVE_DATE
operatorstringRequired within parentA string representing the operator used for comparison.

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED

FieldTypePresenceDescription and constraints
$objectRoot
comparisonPropertyNamestringRequired within parentA string representing the name of the property to compare against.
defaultComparisonValuestringOptionalAn optional value used as a default for comparison if the comparison property is not set.
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects without a value set for the property should be included in the operation.
operationTypestringRequired within parentA string that specifies the type of operation. The default value is 'COMPARATIVE_PROPERTY_UPDATED'.
Default: COMPARATIVE_PROPERTY_UPDATED
One of: COMPARATIVE_PROPERTY_UPDATED
operatorstringRequired within parentA string that defines the operator used in the comparison.

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING

FieldTypePresenceDescription and constraints
$objectRoot
comparisonPropertyNamestringRequired within parentA string specifying the name of the property to be compared.
defaultComparisonValuestringOptionalThe default value to be used for comparison if the property value is not set, represented as a string.
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether to include objects that have no value set for the property.
operationTypestringRequired within parentA string indicating the type of operation, which is 'COMPARATIVE_STRING' by default.
Default: COMPARATIVE_STRING
One of: COMPARATIVE_STRING
operatorstringRequired within parentThe operator used for the comparison operation. It is a string value.

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE

FieldTypePresenceDescription and constraints
$objectRoot
dayintegerRequired within parentAn integer representing the day involved in the date operation.
Format: int32
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects without a set value should be included in the operation.
monthstringRequired within parentA string representing the month involved in the date operation.
operationTypestringRequired within parentA string indicating the type of operation, which is always 'DATE'.
Default: DATE
One of: DATE
operatorstringRequired within parentA string representing the operator used in the date operation.
yearintegerRequired within parentAn integer representing the year involved in the date operation.
Format: int32

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects without a set value should be included in the operation.
operationTypestringRequired within parentA string indicating the type of operation, which is always 'DATETIME' for this component.
Default: DATETIME
One of: DATETIME
operatorstringRequired within parentA string representing the operator used in the datetime operation.
requiresTimeZoneConversionbooleanRequired within parentA boolean specifying whether the datetime operation requires conversion based on time zones.
timestampintegerRequired within parentAn integer representing the timestamp involved in the operation, formatted as an int64.
Format: int64

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects with no value set should be included in the operation.
operationTypestringRequired within parentA string representing the type of operation, defaulting to 'ENUMERATION'.
Default: ENUMERATION
One of: ENUMERATION
operatorstringRequired within parentA string indicating the operator used in the operation.
valuesarrayRequired within parentAn array of strings representing the values involved in the enumeration operation.
values[]stringEach item

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects with no value set should be included in the operation.
operationTypestringRequired within parentA string indicating the type of operation, which is 'MULTISTRING' by default.
Default: MULTISTRING
One of: MULTISTRING
operatorstringRequired within parentA string representing the operator used for the operation.
valuesarrayRequired within parentAn array of strings representing the values to be used in the operation.
values[]stringEach item

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects with no value set should be included in the operation.
operationTypestringRequired within parentA string indicating the type of operation. The default value is 'NUMBER'.
Default: NUMBER
One of: NUMBER
operatorstringRequired within parentA string representing the operator used in the operation.
valuenumberRequired within parentA number representing the value used in the operation.

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether to include objects that do not have a value set.
lowerBoundintegerRequired within parentAn integer representing the lower bound of the range.
Format: int64
operationTypestringRequired within parentA string that specifies the type of operation. The default value is 'RANGED_NUMBER'.
Default: NUMBER_RANGED
One of: NUMBER_RANGED
operatorstringRequired within parentA string representing the operator used in the operation.
upperBoundintegerRequired within parentAn integer representing the upper bound of the range.
Format: int64

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects with no value set should be included.
lowerBoundintegerRequired within parentAn integer representing the lower bound of the date range, in int64 format.
Format: int64
operationTypestringRequired within parentA string that specifies the type of operation, with a default value of 'RANGED_DATE'.
Default: RANGED_DATE
One of: RANGED_DATE
operatorstringRequired within parentA string representing the operator used in the operation.
requiresTimeZoneConversionbooleanRequired within parentA boolean indicating whether the operation requires time zone conversion.
upperBoundintegerRequired within parentAn integer representing the upper bound of the date range, in int64 format.
Format: int64

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether to include objects that do not have a value set for the property being operated on.
numberOfDaysintegerRequired within parentAn integer specifying the number of days that define the rolling date range.
Format: int32
operationTypestringRequired within parentA string indicating the type of operation, which is 'ROLLING_DATE_RANGE' by default.
Default: ROLLING_DATE_RANGE
One of: ROLLING_DATE_RANGE
operatorstringRequired within parentA string representing the operator used in the operation.
requiresTimeZoneConversionbooleanRequired within parentA boolean indicating whether the operation requires conversion based on time zone.

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether to include objects that have no value set for the property.
numberOfDaysintegerRequired within parentAn integer specifying the number of days over which the rolling update operation is applied.
Format: int32
operationTypestringRequired within parentA string indicating the type of operation. The default value is 'ROLLING_PROPERTY_UPDATED'.
Default: ROLLING_PROPERTY_UPDATED
One of: ROLLING_PROPERTY_UPDATED
operatorstringRequired within parentA string representing the operator used in the operation.

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects without a value set for the property should be included in the operation.
operationTypestringRequired within parentA string indicating the type of operation, which is always 'STRING' for this component.
Default: STRING
One of: STRING
operatorstringRequired within parentA string representing the operator to be used in the operation. The specific operators are not detailed in the spec.
valuestringRequired within parentA string representing the value to be used in the operation.

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY

FieldTypePresenceDescription and constraints
$objectRoot
filterTypestringRequired within parentA string that specifies the type of filter being used. The default value is 'SURVEY_MONKEY', indicating that this filter is for SurveyMonkey data.
Default: SURVEY_MONKEY
One of: SURVEY_MONKEY
operatorstringRequired within parentA string that defines the operation or condition to apply when filtering the survey data.
surveyIdstringRequired within parentA string representing the unique identifier of the SurveyMonkey survey to be filtered.

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE

FieldTypePresenceDescription and constraints
$objectRoot
filterTypestringRequired within parentA string indicating the type of filter. Defaults to 'SURVEY_MONKEY_VALUE'.
Default: SURVEY_MONKEY_VALUE
One of: SURVEY_MONKEY_VALUE
operatorstringRequired within parentA string that specifies the operator used in the filter, determining how the survey data is evaluated against the filter criteria.
surveyAnswerColIdstringOptionalA string representing the column identifier of the survey answer, used for filtering specific responses.
surveyAnswerRowIdstringOptionalA string representing the row identifier of the survey answer, used for filtering specific responses.
surveyIdstringRequired within parentA string representing the unique identifier of the SurveyMonkey survey.
surveyQuestionstringRequired within parentA string specifying the question within the survey to filter responses by.
valueComparisonJSONRequired within parentAn object that defines the operation for comparing survey answer values. It can be one of several types, such as number, string, or date operations.
valueComparison (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL
valueComparison (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER
valueComparison (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING
valueComparison (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME
valueComparison (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE
valueComparison (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED
valueComparison (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE
valueComparison (oneOf 8)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE
valueComparison (oneOf 9)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED
valueComparison (oneOf 10)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION
valueComparison (oneOf 11)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY
valueComparison (oneOf 12)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED
valueComparison (oneOf 13)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING
valueComparison (oneOf 14)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE
valueComparison (oneOf 15)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE
valueComparison (oneOf 16)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
valueComparison (oneOf 17)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
valueComparison (oneOf 18)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING
valueComparison (oneOf 19)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER

Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS

FieldTypePresenceDescription and constraints
$objectRoot
coalescingRefineByJSONOptionalAn object that specifies refinement criteria for coalescing events. It can be one of several predefined schemas such as PublicNumOccurrencesRefineBy or PublicTimePointOperation.
coalescingRefineBy (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
coalescingRefineBy (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
coalescingRefineBy (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
coalescingRefineBy (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
coalescingRefineBy (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
coalescingRefineBy (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
coalescingRefineBy (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
coalescingRefineBy (oneOf 8)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
coalescingRefineBy (oneOf 9)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
eventTypeIdstringOptionalA string representing the unique identifier for the event type.
filterLinesarrayRequired within parentAn array of objects, each conforming to the PublicEventFilterMetadata schema, representing the individual filter lines that make up the unified events filter.
filterLines[]ModelEach itemExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item
filterTypestringRequired within parentA string indicating the type of filter. The default value is 'UNIFIED_EVENTS'.
Default: UNIFIED_EVENTS
One of: UNIFIED_EVENTS
pruningRefineByJSONOptionalAn object that specifies refinement criteria for pruning events. It can be one of several predefined schemas such as PublicNumOccurrencesRefineBy or PublicTimePointOperation.
pruningRefineBy (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (oneOf 8)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
pruningRefineBy (oneOf 9)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item

FieldTypePresenceDescription and constraints
$objectRoot
operationJSONRequired within parentAn object that defines the operation to be performed on the specified property. This operation can be one of several types, such as boolean, number, string, or date operations, among others.
operation (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL
operation (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER
operation (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING
operation (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME
operation (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE
operation (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED
operation (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE
operation (oneOf 8)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE
operation (oneOf 9)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED
operation (oneOf 10)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION
operation (oneOf 11)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY
operation (oneOf 12)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED
operation (oneOf 13)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING
operation (oneOf 14)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE
operation (oneOf 15)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE
operation (oneOf 16)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
operation (oneOf 17)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
operation (oneOf 18)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING
operation (oneOf 19)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER
propertystringRequired within parentA string representing the specific property of the event that the filter is targeting.

Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR

FieldTypePresenceDescription and constraints
$objectRoot
filterTypestringRequired within parentA string that specifies the type of filter. The default value is 'WEBINAR'.
Default: WEBINAR
One of: WEBINAR
operatorstringRequired within parentA string representing the operator used in the filter.
webinarIdstringOptionalA string that uniquely identifies the webinar to be filtered.

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED

FieldTypePresenceDescription and constraints
$objectRoot
filterBranchOperatorstringRequired within parentA string representing the operator used within the filter branch.
filterBranchTypestringRequired within parentA string indicating the type of the filter branch. Defaults to 'RESTRICTED'.
Default: RESTRICTED
One of: RESTRICTED
filterBranchesarrayRequired within parentAn array of nested filter branches. Each item can be one of several types, including 'PublicOrFilterBranch', 'PublicAndFilterBranch', 'PublicNotAllFilterBranch', 'PublicNotAnyFilterBranch', 'PublicRestrictedFilterBranch', 'PublicUnifiedEventsFilterBranch', or 'PublicAssociationFilterBranch'.
filterBranches[]JSONEach item
filterBranches[] (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR
filterBranches[] (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND
filterBranches[] (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL
filterBranches[] (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY
filterBranches[] (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED
filterBranches[] (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
filterBranches[] (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION
filtersarrayRequired within parentAn array of filters applied within this branch. Each filter can be one of several types, such as 'PublicPropertyFilter', 'PublicAssociationInListFilter', 'PublicPageViewAnalyticsFilter', 'PublicCtaAnalyticsFilter', 'PublicEventAnalyticsFilter', 'PublicFormSubmissionFilter', 'PublicFormSubmissionOnPageFilter', 'PublicIntegrationEventFilter', 'PublicEmailSubscriptionFilter', 'PublicCommunicationSubscriptionFilter', 'PublicSurveyMonkeyFilter', 'PublicSurveyMonkeyValueFilter', 'PublicWebinarFilter', 'PublicEmailEventFilter', 'PublicPrivacyAnalyticsFilter', 'PublicAdsSearchFilter', 'PublicAdsTimeFilter', 'PublicInListFilter', 'PublicUnifiedEventsFilter', or 'PublicConstantFilter'.
filters[]JSONEach item
filters[] (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY
filters[] (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
filters[] (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
filters[] (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA
filters[] (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT
filters[] (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
filters[] (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT
filters[] (oneOf 8)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
filters[] (oneOf 9)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
filters[] (oneOf 10)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
filters[] (oneOf 11)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
filters[] (oneOf 12)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
filters[] (oneOf 13)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR
filters[] (oneOf 14)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
filters[] (oneOf 15)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY
filters[] (oneOf 16)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
filters[] (oneOf 17)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME
filters[] (oneOf 18)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST
filters[] (oneOf 19)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
filters[] (oneOf 20)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT

Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED

FieldTypePresenceDescription and constraints
$objectRoot
coalescingRefineByJSONOptionalAn optional refinement criterion that allows for additional filtering based on coalescing logic. This can be one of several predefined refinement schemas.
coalescingRefineBy (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
coalescingRefineBy (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
coalescingRefineBy (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
coalescingRefineBy (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
coalescingRefineBy (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
coalescingRefineBy (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
coalescingRefineBy (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
coalescingRefineBy (oneOf 8)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
coalescingRefineBy (oneOf 9)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
eventTypeIdstringRequired within parentA string representing the unique identifier for the event type that this filter branch is targeting.
filterBranchOperatorstringRequired within parentA string that specifies the operator used to combine multiple filter branches within this component.
filterBranchTypestringRequired within parentA string indicating the type of filter branch, which is 'UNIFIED_EVENTS' for this component.
Default: UNIFIED_EVENTS
One of: UNIFIED_EVENTS
filterBranchesarrayRequired within parentAn array of nested filter branches, each of which can be a complex filter structure involving various logical operators.
filterBranches[]JSONEach item
filterBranches[] (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR
filterBranches[] (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND
filterBranches[] (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL
filterBranches[] (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY
filterBranches[] (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED
filterBranches[] (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
filterBranches[] (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION
filtersarrayRequired within parentAn array of filters that apply specific conditions to the unified events. Each filter can be one of several types, such as property filters or event analytics filters.
filters[]JSONEach item
filters[] (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY
filters[] (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
filters[] (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
filters[] (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA
filters[] (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT
filters[] (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
filters[] (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT
filters[] (oneOf 8)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
filters[] (oneOf 9)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
filters[] (oneOf 10)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
filters[] (oneOf 11)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
filters[] (oneOf 12)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
filters[] (oneOf 13)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR
filters[] (oneOf 14)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
filters[] (oneOf 15)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY
filters[] (oneOf 16)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
filters[] (oneOf 17)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME
filters[] (oneOf 18)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST
filters[] (oneOf 19)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
filters[] (oneOf 20)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT
operatorstringRequired within parentA string that specifies the logical operator for the filter branch, with valid values including 'HAS_COMPLETED' and 'HAS_NOT_COMPLETED'.
One of: HAS_COMPLETED, HAS_NOT_COMPLETED
pruningRefineByJSONOptionalAn optional refinement criterion that allows for additional filtering based on pruning logic. This can be one of several predefined refinement schemas.
pruningRefineBy (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (oneOf 8)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
pruningRefineBy (oneOf 9)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT

FieldTypePresenceDescription and constraints
$objectRoot
endpointBehaviorstringOptionalA string describing the behavior of the endpoint in the context of the time point operation.
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether to include objects with no value set in the operation.
operationTypestringRequired within parentA string indicating the type of operation, defaulting to 'TIME_POINT'.
Default: TIME_POINT
One of: TIME_POINT
operatorstringRequired within parentA string representing the operator used in the time point operation.
propertyParserstringOptionalA string specifying the parser used for the property in the operation.
timePointJSONRequired within parentDefines the specific time point for the operation. It can be one of several types, including PublicDatePoint, PublicIndexedTimePoint, or PublicPropertyReferencedTime.
timePoint (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE
timePoint (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED
timePoint (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED
typestringRequired within parentA string representing the type of the time point operation.

Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE

FieldTypePresenceDescription and constraints
$objectRoot
dayintegerRequired within parentAn integer representing the day component of the date.
Format: int32
hourintegerOptionalAn integer representing the hour component of the time.
Format: int32
millisecondintegerOptionalAn integer representing the millisecond component of the time.
Format: int32
minuteintegerOptionalAn integer representing the minute component of the time.
Format: int32
monthintegerRequired within parentAn integer representing the month component of the date.
Format: int32
secondintegerOptionalAn integer representing the second component of the time.
Format: int32
timeTypestringRequired within parentA string indicating the type of time representation.
Default: DATE
One of: DATE
timezoneSourcestringOptionalA string specifying the source of the timezone information.
yearintegerRequired within parentAn integer representing the year component of the date.
Format: int32
zoneIdstringRequired within parentA string representing the identifier for the timezone.

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED

FieldTypePresenceDescription and constraints
$objectRoot
indexReferenceJSONRequired within parentA reference point for indexing the time, which can be one of several predefined time references such as 'NOW', 'TODAY', 'WEEK', etc.
indexReference (oneOf 1)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: NOW
indexReference (oneOf 2)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: TODAY
indexReference (oneOf 3)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference day Of Week: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY, reference Type: WEEK
indexReference (oneOf 4)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: FISCAL QUARTER
indexReference (oneOf 5)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: FISCAL YEAR
indexReference (oneOf 6)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: YEAR
indexReference (oneOf 7)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: QUARTER
indexReference (oneOf 8)ModelAlternativeExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: MONTH
offsetModelOptionalExpand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED offset
timeTypestringRequired within parentA string representing the type of time point, which is always 'INDEXED'.
Default: INDEXED
One of: INDEXED
timezoneSourcestringOptionalA string indicating the source of the timezone information.
zoneIdstringRequired within parentA string representing the identifier for the timezone.

Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: FISCAL QUARTER, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: FISCAL YEAR, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED offset, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: MONTH, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: NOW, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: QUARTER, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: TODAY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference day Of Week: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY, reference Type: WEEK, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: YEAR

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.