asn_workspaces_typeahead: Retrieves objects in the workspace based on an...

View source: R/workspaces.R

asn_workspaces_typeaheadR Documentation

Retrieves objects in the workspace based on an auto-completion/typeahead search algorithm. This feature is meant to provide results quickly, so do not rely on this API to provide extremely accurate search results. The result set is limited to a single page of results with a maximum size, so you won't be able to fetch large numbers of results.

Description

Retrieves objects in the workspace based on an auto-completion/typeahead search algorithm. This feature is meant to provide results quickly, so do not rely on this API to provide extremely accurate search results. The result set is limited to a single page of results with a maximum size, so you won't be able to fetch large numbers of results.

Usage

asn_workspaces_typeahead(workspace, ..., options = list())

Arguments

workspace

Id The workspace to fetch objects from.#'

...

Object Parameters for the request type : Enum The type of values the typeahead should return. You can choose from one of the following: custom_field, project, tag, task, and user. Note that unlike in the names of endpoints, the types listed here are in singular form (e.g. 'task'). Using multiple types is not yet supported. [query] : String The string that will be used to search for relevant objects. If an empty string is passed in, the API will currently return an empty result set. [count] : Number The number of results to return. The default is '20' if this parameter is omitted, with a minimum of '1' and a maximum of '100'. If there are fewer results found than requested, all will be returned.

See Also

Other workspaces: asn_workspaces_add_user, asn_workspaces_find_all, asn_workspaces_find_by_id, asn_workspaces_remove_user, asn_workspaces_update, asn_workspaces


datacamp/asana documentation built on Sept. 18, 2023, 8:51 a.m.