Get information about a specific task

GET

/tasq/tasks/{ID}

curl --request GET \
  --url https://example.com/api/v1/tasq/tasks/1 \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Authorizations

• JWTCookie

Parameters

Path Parameters

ID

required

integer

ID of the object

Responses

200

Tasks returned

Media typeapplication/json

object

ID

Unique ID of the object

integer

command

Task command

string

state

Task state (0=Queued, 1=Loaded, 2=Running, 3=Completed, 4=Error, 5=Cancelled)

integer

Allowed values: 0 1 2 3 4 5

created

Date string with time

string

nullable /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

updated

Date string with time

string

nullable /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

message

Status message

string

params

Task specific parameters

object

Example

{
  "state": 0
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

404

The requested resource could not be found

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}

503

The database query failed

Media typeapplication/json

object

message

Description of the error

string

Example^generated

{
  "message": "example"
}