ON THIS PAGE
GET /config/flow_sources/custom_properties/regex_property_delete_tasks/{task_id}
SUMMARY Retrieves the flow regex property delete task status.
Retrieves the flow regex property delete task status.
MIME Type |
---|
application/json |
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. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The delete task status was retrieved. |
|
404 |
1002 |
The requested task status cannot be found. |
422 |
1005 |
The task id is invalid in the request. |
500 |
1020 |
An error occurred during the attempt to retrieve the task status. |
Response Description
- 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
{ "completed": 42, "created": 42, "created_by": "String", "id": 42, "message": "String", "modified": 42, "name": "String", "started": 42, "status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>" }