Class SimpleSearchesClient

Implements

Constructors

constructor

Properties

jsonParseReviver

Methods

processSearchEntry searchEntry

Constructors

constructor

Properties

ProtectedjsonParseReviver

jsonParseReviver: undefined | (key: string, value: any) => any = undefined

Methods

ProtectedprocessSearchEntry

searchEntry

  • searchEntry(
        args: {
            count?: boolean;
            culture?: null | string;
            fields?: null | string[];
            formatFieldValues?: boolean;
            orderby?: string;
            repositoryId: string;
            request: SearchEntryRequest;
            select?: string;
        },
    ): Promise<EntryCollectionResponse>
    • Runs a "simple" search operation on the repository.
    • Returns a truncated search result listing.
    • Search result listing may be truncated, depending on number of results. Additionally, searches may time out if they take too long. Use the other search route to run full searches.
    • Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. The remaining field values can be retrieved via the GET fields route. Null or Empty field values should not be used to determine if a field is assigned to the entry.
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          count?: boolean;
          culture?: null | string;
          fields?: null | string[];
          formatFieldValues?: boolean;
          orderby?: string;
          repositoryId: string;
          request: SearchEntryRequest;
          select?: string;
      }
      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • Optionalculture?: null | string

        (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFieldValues query parameter must be set to true, otherwise culture will not be used for formatting.

      • Optionalfields?: null | string[]

        (optional) Optional array of field names. Field values corresponding to the given field names will be returned for each search result.

      • OptionalformatFieldValues?: boolean

        (optional) Indicates if field values should be formatted. Only applicable if Fields are specified. The default value is false.

      • Optionalorderby?: string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • repositoryId: string

        The requested repository ID.

      • request: SearchEntryRequest

        The Laserfiche search command to run.

      • Optionalselect?: string

        (optional) Limits the properties returned in the result.

    Returns Promise<EntryCollectionResponse>

    A collection of entry search results.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods