Function get

Lookup a single Subject in a Search Index.

See

https://docs.globus.org/api/search/reference/get_subject/

  • get(
        index_id: string,
        options?: {
            query: {
                bypass_visible_to?: "true" | "false";
                result_format_version?: string;
                subject: string;
            };
        } & {
            headers?: Headers;
            query?: {
                [key: string]: | undefined
                | null
                | string
                | number
                | boolean
                | (undefined | null | string | number)[];
            };
        },
        sdkOptions?: SDKOptions,
    ): Promise<Response>

  • Parameters

    • index_id: string

      The UUID of the Search index where the lookup will be performed.

    • Optionaloptions: {
          query: {
              bypass_visible_to?: "true" | "false";
              result_format_version?: string;
              subject: string;
          };
      } & {
          headers?: Headers;
          query?: {
              [key: string]: | undefined
              | null
              | string
              | number
              | boolean
              | (undefined | null | string | number)[];
          };
      }
      • Optionalheaders?: Headers
      • Optionalquery?: {
            [key: string]:
                | undefined
                | null
                | string
                | number
                | boolean
                | (undefined | null | string | number)[];
        }
    • OptionalsdkOptions: SDKOptions

    Returns Promise<Response>

Settings

Member Visibility