tasks

Update a task

Update an existing task. Null, or absent, leaves a field unchanged.

200: the stored task after the update. 400: the task is not Union-backed and the request names Union fields. 403: the caller is not a superuser. 404: no task of this name. 409: a concurrent update changed a field this request was setting; an error naming it and what it changed to. 422: the body does not match the variant its type names. 424: Union could not be reached to verify the entity. 503: the row was busy on every attempt; retry.

post/tasks/{taskName}

Request

  • Base URL: https://api.cloud.wherobots.com
  • URL: https://api.cloud.wherobots.com/tasks/{taskName}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

taskNamestring required

The name of the task.

Request body

displayNamestring nullable
descriptionstring nullable
regionsstring[] nullable
availableOrganizationIdsstring[] nullable
type'uniontask' required
unionProjectstring nullable
unionNamestring nullable
unionVersionstring nullable

Response

Successful Response

taskIdstring nullable
organizationIdstring nullable
namestring required
displayNamestring required
descriptionstring nullable
regionsstring[]
outputSchemaTaskSchemaOutput

Changes

No recorded changes to this operation across all 1 revision of this API.