GetTaskLog

  • This documentation details the GetTask request and response within the Deliveries API, including JSON representations for clarity.

  • The GetTask request retrieves task details using a taskId and returns information in a structured JSON format encompassing header, request, response, and potential errors.

  • Both the overall GetTask structure and the specific GetTaskRequestLog section are defined with their respective JSON schemas and field explanations, such as header, request, response, and errorResponse.

  • Developers can utilize this information to understand the format of requests and responses when interacting with the Deliveries API for task management.

Details on the GetTask request and response.

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

object (DeliveryRequestHeaderLog)

Request header.
request

object (GetTaskRequestLog)

The request sent to the Deliveries API.
response

object (TaskLog)

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.

GetTaskRequestLog

Details on the GetTask request.

JSON representation 
{
  "taskId": string
}
Fields
taskId

string

The ID of the task to get.