Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /analytics/rules/rule_delete_tasks/{task_id}

SUMMARY Retrieves the delete the rule task status.

Retrieves the delete rule task status.

Table 1: GET /analytics/rules/rule_delete_tasks/{task_id} resource details:

GET /analytics/rules/rule_delete_tasks/{task_id} resource details
MIME Type

application/json

Table 2: GET /analytics/rules/rule_delete_tasks/{task_id} request parameter details:

GET /analytics/rules/rule_delete_tasks/{task_id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

task_id

path

Required

Number (Integer)

text/plain

null

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.
Table 3: GET /analytics/rules/rule_delete_tasks/{task_id} response codes:

GET /analytics/rules/rule_delete_tasks/{task_id} response codes
HTTP Response Code Unique Code Description

200

The delete task status was retrieved.

404

1002

The delete task status does not exist.

500

1020

An error occurred during the attempt to retrieve the delete task status.

Response Description

A Delete Task Status object and the location header set to the task status url "/api/analytics/rules/rule_delete_tasks/{task_id}". A Delete Task Status object contains the following fields:
  • id - Long - The ID of the task.
  • message - String - The localized task message.
  • status - String - The current state of the task.
  • name - String - The name of the task.
  • created_by - String - The name of the user who started the task.
  • created - Long - The time in milliseconds since epoch since the task was created.
  • started - Long - The time in milliseconds since epoch since the task was started.
  • modified - Long - The time in milliseconds since epoch since the task was modified.
  • completed - Long - The time in milliseconds since epoch since the task was completed.

Response Sample