@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface GetPropertyListResponse

    Response payload for get_property_list task. Returns identifiers only (not full property objects or scores). Consumers should cache the resolved identifiers and refresh based on cache_valid_until.

    interface GetPropertyListResponse {
        list: PropertyList;
        identifiers?: Identifier[];
        pagination?: PaginationResponse;
        resolved_at?: string;
        cache_valid_until?: string;
        coverage_gaps?: { [k: string]: Identifier[] | undefined };
        ext?: ExtensionObject;
    }
    Index

    Properties

    list identifiers? pagination? resolved_at? cache_valid_until? coverage_gaps? ext?

    Properties

    list: PropertyList
    identifiers?: Identifier[]

    Resolved identifiers that passed filters (if resolve=true). Cache these locally for real-time use.

    pagination?: PaginationResponse
    resolved_at?: string

    When the list was resolved

    cache_valid_until?: string

    Cache expiration timestamp. Re-fetch the list after this time to get updated identifiers.

    coverage_gaps?: { [k: string]: Identifier[] | undefined }

    Properties included in the list despite missing feature data. Only present when a feature_requirement has if_not_covered='include'. Maps feature_id to list of identifiers not covered for that feature.

    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties