Method: providers.tasks.patch

  • This endpoint updates existing Task data using an HTTP PATCH request to the specified URL.

  • Requests must include path and query parameters, including a task.name for identification and an updateMask specifying the fields to be modified.

  • The request body should contain the updated Task data in JSON format according to the provided schema.

  • Successful responses will contain the updated Task data, reflecting the changes made.

Updates Task data.

HTTP request

PATCH https://fleetengine.googleapis.com/v1/{task.name=providers/*/tasks/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
task.name

string

Must be in the format providers/{provider}/tasks/{task}.

Query parameters

Parameters
header

object (DeliveryRequestHeader)

Optional. The standard Delivery API request header.

updateMask

string (FieldMask format)

Required. The field mask that indicates which Task fields to update. Note: The updateMask must contain at least one field.

This is a comma-separated list of fully qualified names of fields. Example: "taskOutcome,taskOutcomeTime,taskOutcomeLocation".

Request body

The request body contains an instance of Task.

Response body

If successful, the response body contains an instance of Task.