Skip to content

SearchAllRelatedItemsRequest

Source code in docs_src/capo_connectcases/types/search_all_related_items_request.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class SearchAllRelatedItemsRequest(TypedDict, closed=True):
    domain_id: "capo_connectcases.types.domain_id.DomainId"
    """<p>The unique identifier of the Cases domain. </p>"""
    max_results: NotRequired["int"]
    """<p>The maximum number of results to return per page.</p>"""
    next_token: NotRequired["capo_connectcases.types.next_token.NextToken"]
    """<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>"""
    filters: NotRequired[
        "capo_connectcases.types.related_item_filter_list.RelatedItemFilterList"
    ]
    """<p>The list of types of related items and their parameters to use for filtering. The filters work as an OR condition: caller gets back related items that match any of the specified filter types.</p>"""
    sorts: NotRequired[
        "capo_connectcases.types.search_all_related_items_sort_list.SearchAllRelatedItemsSortList"
    ]
    """<p>A structured set of sort terms to specify the order in which related items should be returned. Supports sorting by association time or case ID. The sorts work in the order specified: first sort term takes precedence over subsequent terms.</p>"""

domain_id: DomainId

The unique identifier of the Cases domain. 

filters: NotRequired[RelatedItemFilterList]

The list of types of related items and their parameters to use for filtering. The filters work as an OR condition: caller gets back related items that match any of the specified filter types.

max_results: NotRequired[int]

The maximum number of results to return per page.

next_token: NotRequired[NextToken]

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

sorts: NotRequired[SearchAllRelatedItemsSortList]

A structured set of sort terms to specify the order in which related items should be returned. Supports sorting by association time or case ID. The sorts work in the order specified: first sort term takes precedence over subsequent terms.