Tracking operations

Some API requests (opening and closing a pool, archiving a pool or a project, loading multiple tasks, awarding bonuses) are processed as asynchronous operations that run in the background. Operation details (for example, status and creation time) are passed in JSON format.

A JSON sample with operation details and key descriptions are shown below.

You can use the API for tracking operation progress:

Sample operation in JSON

{
  "id" : "57068577e4b0bf7b07a0256f",
  "type" : "TASK_SUITE.BATCH_CREATE",
  "status" : "FAIL",
  "submitted" : "2016-04-07T16:06:15.902",
  "started" : "2016-04-07T16:06:15.902",
  "finished" : "2016-04-07T16:06:15.902",
  "progress" : 100,
  "parameters" : {
    "open_pool" : fase,
    "allow_defaults" : false,
    "skip_invalid_items" : false
  }
  "details" : {
    "total_count" : 2,
    "valid_count" : 0,
    "failed_count" : 2,
    "success_count" : 0,
    "not_valid_count" : 2
  }
}

Keys

Key

Value

Data type

id

Operation ID.

String

type

Operation type:

  • POOL.OPEN — Opening a pool.

  • POOL.CLOSE — Closing a pool.

  • PROJECT.ARCHIVE — Archiving a project.

  • POOL.ARCHIVE — Archiving a pool.

  • TASK_SUITE.BATCH_CREATE — Creating multiple task suites.

String

status

The status of the operation:

  • PENDING — Not started yet.

  • RUNNING — In progress.

  • SUCCESS — Completed sucessfully.

  • FAIL — Not completed.

String

submitted

The UTC date and time the request was sent, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

started

The UTC date and time the operation started, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

finished

The UTC date and time the operation finished, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

progress

The percentage of the operation completed.

Number

parameters

Operation parameters (depending on the operation type).

JSON

details

Details of the operation completion.

JSON