SearchTasksLog

  • This documentation details the SearchTasks request and response within the Deliveries API, including request headers, the request/response content, and potential error responses.

  • SearchTasksRequestLog outlines the structure of the request sent to the API, encompassing fields like trackingId, pageSize, and pageToken for task identification and retrieval parameters.

  • SearchTasksResponseLog describes the API's response structure, primarily containing an array of tasks matching the request's trackingId.

  • The JSON representation for both request and response logs provides a clear schema definition for developers to understand the data format.

Details on the SearchTasks request and response.

JSON representation 
{
  "header": {
    object (DeliveryRequestHeaderLog)
  },
  "request": {
    object (SearchTasksRequestLog)
  },
  "response": {
    object (SearchTasksResponseLog)
  },
  "errorResponse": {
    object (ErrorResponseLog)
  }
}
Fields
header

object (DeliveryRequestHeaderLog)

Request header.
request

object (SearchTasksRequestLog)

The request sent to the Deliveries API.
response

object (SearchTasksResponseLog)

The response returned to the client. It will be unset if the RPC call resulted in an error.
errorResponse

object (ErrorResponseLog)

The error response returned to the client. It will be unset if the RPC call succeeded.

SearchTasksRequestLog

Details on the SearchTasks request.

JSON representation 
{
  "trackingId": string,
  "pageSize": integer,
  "pageToken": string
}
Fields
trackingId

string

Identifier for the related set of tasks that are being requested.
pageSize

integer

The maximum number of Tasks to return. The service may return fewer than this value. If unspecified, the server decides the number of results to return.
pageToken

string

A page token, received from a previous SearchTasks call.

SearchTasksResponseLog

Details on the SearchTasks response.

JSON representation 
{
  "tasks": [
    {
      object (TaskLog)
    }
  ]
}
Fields
tasks[]

object (TaskLog)

The tasks matching the given trackingId.