Application Instance Task

Application instance task execution

Get all available task templates for application instance

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Task template ID

namestringRead-onlyRequired

Task template name

descriptionstringRead-onlyRequired

Task template description

403

Invalid credentials

500

Internal Server Error

application/json

get/v3/applicationInstance/task/template

HTTPcURLJavaScriptPython

GET /v3/applicationInstance/task/template HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "description": "text",
    "actions": [
      {
        "idx": 1,
        "actionType": "text",
        "requiredParams": [
          "text"
        ]
      }
    ]
  }
]

Get the last 100 tasks you have created

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Task ID

namestringRead-onlyRequired

Task name

batchIdinteger · integerRead-onlyRequired

The ID of the batch the task belongs to

categoryIdinteger · integerRead-onlyRequired

The ID of the task category. Valid values are:

• 1: game server

entityIdinteger · integerRead-onlyRequired

The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)

currentActionIdxinteger · integerRead-onlyRequired

Currently active action index - relates to the action index as found in the template.

executeAtinteger · integerRead-onlyRequired

Unix timestamp indicating the start of execution.

lastActivityAtinteger · integerRead-onlyRequired

Unix timestamp indicating lastest activity.

finishedAtinteger · integerRead-onlyRequired

Unix timestamp at which the task was finished.

resultCodeinteger · integerRead-onlyRequired

The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done

resultTextstringRead-onlyRequired

The result of the task in message form.

403

Invalid credentials

500

Internal Server Error

application/json

get/v3/applicationInstance/task

HTTPcURLJavaScriptPython

GET /v3/applicationInstance/task HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "batchId": 1,
    "categoryId": 1,
    "entityId": 1,
    "currentActionIdx": 1,
    "executeAt": 1,
    "lastActivityAt": 1,
    "finishedAt": 1,
    "resultCode": 1,
    "resultText": "text"
  }
]

Create a new task batch for given application instance Ids, using the provided task template Id

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

taskTemplateIdstringRequired

Task template ID, as seen in GET /applicationInstance/task/template

applicationInstanceIdsstring[]Optional

Array of application instance IDs to create the tasks for

fleetIdstringOptional

If > 0, we gather all game server IDs for this fleet and add those to the gameServerIds property

regionIdstringOptional

If > 0, we gather all game server IDs for this region and add those to the gameServerIds property

executeAtinteger · integerOptional

A unix timestamp indicating the time at which to execute the task (to schedule tasks for future execution)

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Task Batch ID

createdAtinteger · integerRead-onlyRequired

The unix timestamp at which this batch was created

executeAtinteger · integerRead-onlyRequired

The unix timestamp at which this batch started execution

finishedAtinteger · integerRead-onlyRequired

The unix timestamp at which this batch was finished

numTasksinteger · integerRead-onlyRequired

The total number of tasks in this batch

numTasksOkinteger · integerRead-onlyRequired

The number of successfully executed tasks

numTasksFailedinteger · integerRead-onlyRequired

The number of failed tasks

numTasksCancelledinteger · integerRead-onlyRequired

The number of cancelled tasks

taskIdsinteger · integer[]Read-onlyRequired

All the task IDs in this batch

403

Invalid credentials

422

Unprocessable Entity

500

Internal Server Error

application/json

post/v3/applicationInstance/task

HTTPcURLJavaScriptPython

POST /v3/applicationInstance/task HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 210

{
  "taskTemplateId": "text",
  "applicationInstanceIds": [
    "text"
  ],
  "fleetId": "text",
  "regionId": "text",
  "labels": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "executeAt": 1,
  "taskActionParam": [
    {
      "paramName": "text",
      "paramValue": "text"
    }
  ]
}

[
  {
    "id": 1,
    "createdAt": 1,
    "executeAt": 1,
    "finishedAt": 1,
    "numTasks": 1,
    "numTasksOk": 1,
    "numTasksFailed": 1,
    "numTasksCancelled": 1,
    "taskIds": [
      1
    ]
  }
]

Get the status of a task

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

taskIdintegerRequired

The Id of the task

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Task ID

namestringRead-onlyRequired

Task name

batchIdinteger · integerRead-onlyRequired

The ID of the batch the task belongs to

categoryIdinteger · integerRead-onlyRequired

The ID of the task category. Valid values are:

• 1: game server

entityIdinteger · integerRead-onlyRequired

The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)

currentActionIdxinteger · integerRead-onlyRequired

Currently active action index - relates to the action index as found in the template.

executeAtinteger · integerRead-onlyRequired

Unix timestamp indicating the start of execution.

lastActivityAtinteger · integerRead-onlyRequired

Unix timestamp indicating lastest activity.

finishedAtinteger · integerRead-onlyRequired

Unix timestamp at which the task was finished.

resultCodeinteger · integerRead-onlyRequired

The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done

resultTextstringRead-onlyRequired

The result of the task in message form.

403

Invalid credentials

404

Invalid taskId

500

Internal Server Error

application/json

get/v3/applicationInstance/task/{taskId}

HTTPcURLJavaScriptPython

GET /v3/applicationInstance/task/{taskId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "batchId": 1,
    "categoryId": 1,
    "entityId": 1,
    "currentActionIdx": 1,
    "executeAt": 1,
    "lastActivityAt": 1,
    "finishedAt": 1,
    "resultCode": 1,
    "resultText": "text"
  }
]

Pause the given task if it's not done yet. Or if the task is paused already, resume it.

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

taskIdintegerRequired

The Id of the task

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Task ID

namestringRead-onlyRequired

Task name

batchIdinteger · integerRead-onlyRequired

The ID of the batch the task belongs to

categoryIdinteger · integerRead-onlyRequired

The ID of the task category. Valid values are:

• 1: game server

entityIdinteger · integerRead-onlyRequired

The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)

currentActionIdxinteger · integerRead-onlyRequired

Currently active action index - relates to the action index as found in the template.

executeAtinteger · integerRead-onlyRequired

Unix timestamp indicating the start of execution.

lastActivityAtinteger · integerRead-onlyRequired

Unix timestamp indicating lastest activity.

finishedAtinteger · integerRead-onlyRequired

Unix timestamp at which the task was finished.

resultCodeinteger · integerRead-onlyRequired

The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done

resultTextstringRead-onlyRequired

The result of the task in message form.

403

Invalid credentials

404

Invalid taskId

409

Task cannot be pause

500

Internal Server Error

application/json

put/v3/applicationInstance/task/{taskId}

HTTPcURLJavaScriptPython

PUT /v3/applicationInstance/task/{taskId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "batchId": 1,
    "categoryId": 1,
    "entityId": 1,
    "currentActionIdx": 1,
    "executeAt": 1,
    "lastActivityAt": 1,
    "finishedAt": 1,
    "resultCode": 1,
    "resultText": "text"
  }
]

Cancel the given task

delete

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

taskIdintegerRequired

The Id of the task

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Task ID

namestringRead-onlyRequired

Task name

batchIdinteger · integerRead-onlyRequired

The ID of the batch the task belongs to

categoryIdinteger · integerRead-onlyRequired

The ID of the task category. Valid values are:

• 1: game server

entityIdinteger · integerRead-onlyRequired

The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)

currentActionIdxinteger · integerRead-onlyRequired

Currently active action index - relates to the action index as found in the template.

executeAtinteger · integerRead-onlyRequired

Unix timestamp indicating the start of execution.

lastActivityAtinteger · integerRead-onlyRequired

Unix timestamp indicating lastest activity.

finishedAtinteger · integerRead-onlyRequired

Unix timestamp at which the task was finished.

resultCodeinteger · integerRead-onlyRequired

The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done

resultTextstringRead-onlyRequired

The result of the task in message form.

403

Invalid credentials

404

Invalid taskId

409

Task cannot be cancelled

500

Internal Server Error

application/json

delete/v3/applicationInstance/task/{taskId}

HTTPcURLJavaScriptPython

DELETE /v3/applicationInstance/task/{taskId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "batchId": 1,
    "categoryId": 1,
    "entityId": 1,
    "currentActionIdx": 1,
    "executeAt": 1,
    "lastActivityAt": 1,
    "finishedAt": 1,
    "resultCode": 1,
    "resultText": "text"
  }
]

Get the last 100 task batches you have created

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Task Batch ID

createdAtinteger · integerRead-onlyRequired

The unix timestamp at which this batch was created

executeAtinteger · integerRead-onlyRequired

The unix timestamp at which this batch started execution

finishedAtinteger · integerRead-onlyRequired

The unix timestamp at which this batch was finished

numTasksinteger · integerRead-onlyRequired

The total number of tasks in this batch

numTasksOkinteger · integerRead-onlyRequired

The number of successfully executed tasks

numTasksFailedinteger · integerRead-onlyRequired

The number of failed tasks

numTasksCancelledinteger · integerRead-onlyRequired

The number of cancelled tasks

taskIdsinteger · integer[]Read-onlyRequired

All the task IDs in this batch

403

Invalid credentials

500

Internal Server Error

application/json

get/v3/applicationInstance/taskBatch

HTTPcURLJavaScriptPython

GET /v3/applicationInstance/taskBatch HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "createdAt": 1,
    "executeAt": 1,
    "finishedAt": 1,
    "numTasks": 1,
    "numTasksOk": 1,
    "numTasksFailed": 1,
    "numTasksCancelled": 1,
    "taskIds": [
      1
    ]
  }
]

Get the status of a task batch

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

taskBatchIdintegerRequired

The Id of the task batch

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Task Batch ID

createdAtinteger · integerRead-onlyRequired

The unix timestamp at which this batch was created

executeAtinteger · integerRead-onlyRequired

The unix timestamp at which this batch started execution

finishedAtinteger · integerRead-onlyRequired

The unix timestamp at which this batch was finished

numTasksinteger · integerRead-onlyRequired

The total number of tasks in this batch

numTasksOkinteger · integerRead-onlyRequired

The number of successfully executed tasks

numTasksFailedinteger · integerRead-onlyRequired

The number of failed tasks

numTasksCancelledinteger · integerRead-onlyRequired

The number of cancelled tasks

taskIdsinteger · integer[]Read-onlyRequired

All the task IDs in this batch

403

Invalid credentials

404

Invalid taskBatchId

500

Internal Server Error

application/json

get/v3/applicationInstance/taskBatch/{taskBatchId}

HTTPcURLJavaScriptPython

GET /v3/applicationInstance/taskBatch/{taskBatchId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "createdAt": 1,
    "executeAt": 1,
    "finishedAt": 1,
    "numTasks": 1,
    "numTasksOk": 1,
    "numTasksFailed": 1,
    "numTasksCancelled": 1,
    "taskIds": [
      1
    ]
  }
]