Advanced search reference

Use these search parameters and operators to create precise search queries.

Exact matching

As general guidance, use double quotes only for string fields. Avoid double quotes for numeric, date, and boolean fields. Double quotes have two main uses:

1. Searching for terms with spaces: Use double quotes when searching for multiple words or phrases where order matters.

   Examples:

   • owner="Doe John" finds items where the owner is John Doe. Characters like comma, period, or colon are ignored for the purposes of matching "Doe, John" as the owner of the item.
   • ITEM_DETAILS:DESC_CHANGE="Scratch on aluminum" finds items containing that exact phrase in the field value.

2. Searching for exact words: Use double quotes to find complete words only.

   Examples:

   • red matches "predator" (partial match)
   • "red" matches "blue red wheel" but not "predator"

Asterisks are not needed for partial matches. The search tool automatically uses wildcards when double quotes are not present.

Conditional operators

Use parentheses with conditional operators (AND/OR) to create complex queries. For example, use this search query to find items with a picklist selection that matches the string "Medium", or the word "test" in the Items and BOMs or Change Orders workspaces: (ITEM_DETAILS:PRIORITY=Medium OR test) AND (workspaceId=9 OR workspaceId=8)

Relational operators

Use relational operators (greater than, less than, equal, etc.) with numeric and date fields. For example, use this search query to find items created in January 2019 containing the word "test": test AND createdOn>=2019-01-01 AND createdOn<=2019-01-31

Cross-workspace searching

Limit searches to specific workspaces. Since items cannot belong to multiple workspaces, use OR instead of AND between workspace IDs. For example, use this search query to find items owned by John in workspace 9 or 26: ownerName=John AND (workspaceId=9 OR workspaceId=26)

Sorting

Search results are ranked by relevancy (score) by default. The UI does not currently support custom sorting, but the API supports sorting by the following fields:

• Score (relevancy, not visible in the record information) – default
• Last Modified On
• Created On
• Item Descriptor

Results can be in ascending (asc) or descending (desc) order. For example, use these search queries to find the word "testing" in workspace 9, returning all revisions:

• GET /api/v3/search-results?limit=100&offset=0&query=testing+AND+workspaceId%3D19&revision=2&sort=score asc
• GET /api/v3/search-results?limit=100&offset=0&query=testing+AND+workspaceId%3D19&revision=2&sort=lastModifiedOn desc
• GET /api/v3/search-results?limit=100&offset=0&query=testing+AND+workspaceId%3D19&revision=2&sort=createdOn asc
• GET /api/v3/search-results?limit=100&offset=0&query=testing+AND+workspaceId%3D19&revision=2&sort=itemDescriptor desc

Tips

• By default, search returns only the latest version from revision-controlled workspaces. Use &revision=2 in API calls to get all items, then filter using isLatestVersion and isWorkingVersion fields.

• All conditional operators (AND/OR) must be typed in uppercase.

• Use date ranges to search for specific years or months.

• Type boolean values in either uppercase or lowercase.

• Search is performed across all indexed tabs. As of February 2019, Item Details (excluding classification data) and Attachments (only file titles and filenames) are indexed for search.

• Spaces in search queries without wrapping double quotes act as OR operators.

• The following characters are not allowed in search queries:

  • `
  • (
  • )
  • :
  • <
  • >
  • =
  • \
  • /
  • ]
  • [
  • {
  • }