Class Search

searchTypes

quick

• quick(text: string): Promise<unknown>

  Do a "quick" search for an ID or Case Number

  Parameters

  • text: string

    text to search the system for

  Returns Promise<unknown>

  Returns Promise object that represents a collection of the currently authenticated user's notifications

execute

• execute(
      searchId: number,
      options?: {
          EmployeeSid?: number;
          ExcludeEmptyXY?: boolean;
          Extent?: Object;
          Frequency?: boolean;
          IdsOnly?: boolean;
          IncludeSearchOrder?: boolean;
          MaxResults?: number;
          ResultFields?: string[];
          TotalOnly?: boolean;
      },
  ): Promise<unknown>

  Execute a saved search

  Parameters

  • searchId: number

    SearchId to execute
  • Optionaloptions: {
        EmployeeSid?: number;
        ExcludeEmptyXY?: boolean;
        Extent?: Object;
        Frequency?: boolean;
        IdsOnly?: boolean;
        IncludeSearchOrder?: boolean;
        MaxResults?: number;
        ResultFields?: string[];
        TotalOnly?: boolean;
    }

    Other options. See: /{subdirectory}/apidocs/#/service-info/Ams/Search

  Returns Promise<unknown>

  Returns Promise object that represents a list of Objects

getSaved

• getSaved(
      searchType: string,
      applyToEntities?: string[],
      employeeSid?: number,
      domainId?: number,
  ): Promise<unknown>

  Get a list of the saved searches by search type and specific entity types OR employeeSid/domainId. You cannot search for saved searches by both specific entity type AND employeeSid/domainId.

  Parameters

  • searchType: string

    Get the saved searches for a particular type
  • OptionalapplyToEntities: string[]

    Restrict GIS searches to specified entity types
  • OptionalemployeeSid: number

    The employee SID to retrieve the searches as
  • OptionaldomainId: number

    The domain ID of the domain to search

  Returns Promise<unknown>

  Returns Promise object that represents a collection of SearchDefinitionName

convertToQuery

• convertToQuery(
      searchIds: number[],
      saveQuery?: boolean,
      addEurl?: boolean,
      allowMultipleBooleanValues?: boolean,
      allowEmptyQuery?: boolean,
  ): Promise<unknown>

  Convert a search definition to a query

  Parameters

  • searchIds: number[]

    searchIds to convert
  • saveQuery: boolean = false

    Automatically save a query which converts with no errors, default is false
  • addEurl: boolean = false
  • allowMultipleBooleanValues: boolean = false

    Use all values for boolean fields even though a boolean should only have one value, default is false and will only use the first boolean value
  • allowEmptyQuery: boolean = false

    Create default filter when no filter is found, default is false

  Returns Promise<unknown>

  Returns Promise object that represents a SearchToQueryResult list

deleteDefinitions

• deleteDefinitions(searchIds: number[]): Promise<unknown>

  Delete search definitions

  Parameters

  • searchIds: number[]

    SearchIds to get.

  Returns Promise<unknown>

  Returns Promise object that represents a list (dictionary) of search IDs and deletion success boolean

getDefinition

• getDefinition(searchId: number, employeeSid?: number): Promise<unknown>

  Get a search definition

  Parameters

  • searchId: number

    SearchId to get.
  • OptionalemployeeSid: number

    Enforces employee security settings on search definition if provided.

  Returns Promise<unknown>

  Returns Promise object that represents a SearchDefinition object

getDefinitionNames

• getDefinitionNames(searchIds: number[]): Promise<unknown>

  Get search definition names

  Parameters

  • searchIds: number[]

    SearchIds to get.

  Returns Promise<unknown>

  Returns Promise object that represents a collection of SearchDefinitionNames

getDefinitions

• getDefinitions(searchIds: number[], employeeSid?: number): Promise<unknown>

  Get search definitions

  Parameters

  • searchIds: number[]

    SearchIds to get.
  • OptionalemployeeSid: number

    Enforces employee security settings on search definition if provided.

  Returns Promise<unknown>

  Returns Promise object that represents a collection of SearchDefinition objects

saveDefinition

• saveDefinition(
      searchFor: string,
      options?: Object,
      searchId?: number,
  ): Promise<unknown>

  Save a search definition

  Parameters

  • searchFor: string

    Name of type to search for from searchTypes
  • Optionaloptions: Object

    Other options. See: /{subdirectory}/apidocs/#/service-info/Ams/Search
  • searchId: number = 0

    SearchId to update. Defaults to "0" which is "Create new saved search"

  Returns Promise<unknown>

  Returns Promise object that represents a SearchDefinitionName object

disableServices

• disableServices(searchIds: number[]): Promise<unknown>

  Disable Service URLs on Saved Searches

  Parameters

  • searchIds: number[]

    Search IDs to enable eURL on

  Returns Promise<unknown>

  Returns Promise object that represents a dictionary of SearchIds and EURL booleans

displayFields

• displayFields(searchType: string): Promise<unknown>

  Get a list display fields for a Search Type

  Parameters

  • searchType: string

    Restrict GIS searches to specified entity types

  Returns Promise<unknown>

  Returns Promise object that represents a collection of SearchDisplayFields

enableServices

• enableServices(searchIds: number[]): Promise<unknown>

  Enable Service URLs on Saved Searches

  Parameters

  • searchIds: number[]

    Search IDs to enable eURL on

  Returns Promise<unknown>

  Returns Promise object that represents a dictionary of SearchIds and EURL booleans

types

• types(): Promise<unknown>

  Get a list search types

  Returns Promise<unknown>

  Returns Promise object that represents a collection of SearchTypeInfo objects