Task API

Version: 0.0.2

Trigger an asynchronous execution of a task

POST

/compute/orgs/{org_id}/{topic}/{task}

Trigger an asynchronous task within a specific topic for a designated organization. The task, topic, and organization ID are supplied as path parameters. A JSON request body, referencing the ExecuteTaskRequest schema and containing task-specific parameters, is required for this operation. Upon successful start, a 303 response is returned. The URL of the status endpoint for the newly created job is indicated in the Location header of the response.

Request

Path parameters

org_iduuid

Required

The organization identifier

topicstring

Required

The compute topic

taskstring

Required

The compute task

Body parameters

parametersobject

Required

Additional propertiesstring

This schema accepts user-defined additional properties along with the documented schema. The additional properties must match the specified type where one is provided.

Example body

{
  "parameters": {
    "Additional properties": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

Responses

303

303 response

400

The request could not be processed due to invalid syntax, malformed or missing required parameters

Response schema

statusinteger

typestring

titlestring

detailstring

Example response

{
  "status": 0,
  "type": "string",
  "title": "string",
  "detail": "string",
  "additionalProp1": "string",
  "additionalProp2": "number",
  "additionalProp3": "boolean"
}

401

Unauthorized

Response schema

statusinteger

typestring

titlestring

detailstring

Example response

{
  "status": 0,
  "type": "string",
  "title": "string",
  "detail": "string",
  "additionalProp1": "string",
  "additionalProp2": "number",
  "additionalProp3": "boolean"
}

403

Forbidden

Response schema

statusinteger

typestring

titlestring

detailstring

Example response

{
  "status": 0,
  "type": "string",
  "title": "string",
  "detail": "string",
  "additionalProp1": "string",
  "additionalProp2": "number",
  "additionalProp3": "boolean"
}

404

The specified resource was not found

Response schema

statusinteger

typestring

titlestring

detailstring

Example response

{
  "status": 0,
  "type": "string",
  "title": "string",
  "detail": "string",
  "additionalProp1": "string",
  "additionalProp2": "number",
  "additionalProp3": "boolean"
}

422

Validation error

Response schema

statusinteger

typestring

titlestring

detailstring

Example response

{
  "status": 0,
  "type": "string",
  "title": "string",
  "detail": "string",
  "additionalProp1": "string",
  "additionalProp2": "number",
  "additionalProp3": "boolean"
}

429

API gateway rate limit exceeded

Response schema

statusinteger

typestring

titlestring

detailstring

Example response

{
  "status": 0,
  "type": "string",
  "title": "string",
  "detail": "string",
  "additionalProp1": "string",
  "additionalProp2": "number",
  "additionalProp3": "boolean"
}