Method: providers.tasks.search

Deprecated: Use taskTrackingInfo.get instead.

HTTP request

GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/tasks:search

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Must be in the format providers/{provider}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project.

Query parameters

Parameters
header

object (DeliveryRequestHeader)

Optional. The standard Delivery API request header.
trackingId

string

Required. The identifier of the set of related Tasks being requested. Tracking IDs are subject to the following restrictions:

  • Must be a valid Unicode string.
  • Limited to a maximum length of 64 characters.
  • Normalized according to Unicode Normalization Form C.
  • May not contain any of the following ASCII characters: '/', ':', '?', ',', or '#'.
pageSize

integer

Optional. The maximum number of Tasks to return. The service may return fewer than this value. If you don't specify this value, then the server determines the number of results to return.
pageToken

string

Optional. A page token, received from a previous tasks.search call. You must provide this value to retrieve the subsequent page.

When paginating, all other parameters provided to tasks.search must match the call that provided the page token.

Request body

The request body must be empty.

Response body

The tasks.search response. It contains the set of Tasks that meet the search criteria in the SearchTasksRequest.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "tasks": [
    {
      object (Task)
    }
  ],
  "nextPageToken": string
}
Fields
tasks[]

object (Task)

The set of Tasks for the requested trackingId. A successful response can also be empty. An empty response indicates that no Tasks are associated with the supplied trackingId.
nextPageToken

string

Pass this token in the SearchTasksRequest to continue to list results. If all results have been returned, then this field is either an empty string, or it doesn't appear in the response.