Class ListSearchRequest

The request object used for searching through lists.

Constructors

constructor

Properties

additionalProperties? count? listIds? offset? processingTypes? query? sort? attributeTypeMap discriminator mapping

Methods

getAttributeTypeMap

Constructors

constructor

Properties

OptionaladditionalProperties

additionalProperties?: string[]

The property names of any additional list properties to include in the response. Properties that do not exist or that are empty for a particular list are not included in the response. By default, all requests will fetch the following properties for each list: hs_list_size, hs_last_record_added_at, hs_last_record_removed_at, hs_folder_name, and hs_list_reference_count.

Optionalcount

count?: number

The number of lists to include in the response. Defaults to 20 if no value is provided. The max count is 500.

OptionallistIds

listIds?: string[]

The listIds that will be used to filter results by listId. If values are provided, then the response will only include results that have a listId in this array. If no value is provided, or if an empty list is provided, then the results will not be filtered by listId.

Optionaloffset

offset?: number

Value used to paginate through lists. The offset provided in the response can be used in the next request to fetch the next page of results. Defaults to 0 if no offset is provided.

OptionalprocessingTypes

processingTypes?: string[]

The processingTypes that will be used to filter results by processingType. If values are provided, then the response will only include results that have a processingType in this array. If no value is provided, or if an empty list is provided, then results will not be filtered by processingType. Valid processingTypes are: MANUAL, SNAPSHOT, or DYNAMIC.

Optionalquery

query?: string

The query that will be used to search for lists by list name. If no query is provided, then the results will include all lists.

Optionalsort

sort?: string

Static ReadonlyattributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Static Readonlydiscriminator

discriminator: undefined | string = undefined

Static Readonlymapping

mapping: undefined | {
    [index: string]: string;
} = undefined

Methods

StaticgetAttributeTypeMap

  • getAttributeTypeMap(): {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods