Skip to main content
Version: 2026.09

Search and favorites

Look up platform objects and remember the ones the caller starred. Methods are on V3Client. Search in the web app is Search.

Starring a Secure Connection is favorite_connection() on the V3Client reference, next to the other remote calls. list_favorites covers systems and resources.

search()​

Searches resources, systems, jobs, modules, and functions.

  • Parameters:

    • q (str) – Query. (required)
    • entity_type (SearchEntityType, optional) – resource, system, job, module, or function.
    • size (int, optional)
    • cursor (str, optional)
    • http_request_timeout_secs (int, optional)

  • Return Type: SearchPage

list_suggested_items()​

Lists systems and resources the platform suggests for the caller.

  • Parameters:

    • item_type (list of SuggestedItemType, optional) – system, resource.
    • signal (list of SuggestionSignal, optional) – recently_viewed, recently_created_by_me, recently_favorited, recently_shared_with_me. recently_shared_with_me applies to resources only.
    • size (int, optional) – Maximum items per group, 1–50.
    • http_request_timeout_secs (int, optional)

  • Return Type: SuggestedItemsDto

Favorites​

favorite_resource()​

  • Parameters:

    • resource_id (str) – (required)
    • http_request_timeout_secs (int, optional)

  • Return Type: None

unfavorite_resource()​

  • Parameters:

    • resource_id (str) – (required)
    • http_request_timeout_secs (int, optional)

  • Return Type: None

favorite_system()​

  • Parameters:

    • system_id (str) – (required)
    • http_request_timeout_secs (int, optional)

  • Return Type: None

unfavorite_system()​

  • Parameters:

    • system_id (str) – (required)
    • http_request_timeout_secs (int, optional)

  • Return Type: None

list_favorites()​

  • Parameters:

    • favorite_type (FavoriteType, optional) – system or resource.
    • cursor (str, optional)
    • size (int, optional)
    • include_total (bool, optional)
    • http_request_timeout_secs (int, optional)

  • Return Type: CursorPageFavoriteDto

list_favorite_ids()​

Returns the caller's favorite ids without the full objects.

  • Return Type: FavoriteIdsDto