ewms*.icecube.aq/v1/
task-directives
- POST /v1/query/task-directives
Queries and returns a list of task directive objects based on the provided criteria. See FindObject, TaskDirectiveObject.
Example request:
POST /v1/query/task-directives HTTP/1.1 Host: example.com Content-Type: application/json { "query": {}, "projection": [ "string" ], "after": "string" }
- Status Codes:
200 OK –
Matching task directives and pagination metadata.
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "task_directives": [ { "task_id": "string", "workflow_id": "string", "cluster_locations": [ "string" ], "task_image": "string", "task_args": "string", "task_env": {}, "init_image": "string", "init_args": "string", "init_env": {}, "timestamp": 1.0, "input_queues": [ "string" ], "output_queues": [ "string" ] } ], "next_after": "string" }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
- GET /v1/task-directives/{task_id}
Retrieves the task directive that matches the specified task ID. See TaskDirectiveObject.
- Parameters:
task_id (string) – The ID of the task directive
Example request:
GET /v1/task-directives/{task_id} HTTP/1.1 Host: example.com
- Status Codes:
200 OK –
The matching task directive
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "task_id": "string", "workflow_id": "string", "cluster_locations": [ "string" ], "task_image": "string", "task_args": "string", "task_env": {}, "init_image": "string", "init_args": "string", "init_env": {}, "timestamp": 1.0, "input_queues": [ "string" ], "output_queues": [ "string" ] }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
Not found
Example response:
HTTP/1.1 404 Not Found Content-Type: application/json { "code": 1, "error": "string" }
- POST /v1/task-directives/{task_id}/actions/add-workers
Creates a new taskforce (and associated workers) for an existing task directive. See TaskforceObject.
- Parameters:
task_id (string) – The ID of the task directive to which the taskforce (and workers) will be added.
Example request:
POST /v1/task-directives/{task_id}/actions/add-workers HTTP/1.1 Host: example.com Content-Type: application/json { "cluster_location": "string", "n_workers": 1 }
- Status Codes:
200 OK –
The created taskforce object with its details.
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "taskforce_uuid": "string", "task_id": "string", "workflow_id": "string", "timestamp": 1.0, "priority": 1, "collector": "string", "schedd": "string", "n_workers": 1, "pilot_config": { "tag": "string", "image_source": "cvmfs", "environment": {}, "input_files": [ "string" ] }, "worker_config": { "do_transfer_worker_stdouterr": true, "max_worker_runtime": 1, "n_cores": 1, "priority": 1, "worker_disk": "string", "worker_memory": "string", "condor_requirements": "string" }, "cluster_id": 1, "submit_dict": {}, "job_event_log_fpath": "string", "phase": "pre-mq-activation", "phase_change_log": [ { "target_phase": "string", "timestamp": 1.0, "was_successful": true, "source_event_time": 1.0, "source_entity": "string", "context": "string" } ], "compound_statuses": {}, "top_task_errors": {} }
Unprocessable Entity
Example response:
HTTP/1.1 422 Unprocessable Entity Content-Type: application/json { "code": 1, "error": "string" }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
Not found
Example response:
HTTP/1.1 404 Not Found Content-Type: application/json { "code": 1, "error": "string" }
taskforces
- POST /v1/query/taskforces
Queries and returns a list of taskforce objects based on the provided criteria. See FindObject, TaskforceObject.
Example request:
POST /v1/query/taskforces HTTP/1.1 Host: example.com Content-Type: application/json { "query": {}, "projection": [ "string" ], "after": "string" }
- Status Codes:
200 OK –
Matching taskforces and pagination metadata.
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "taskforces": [ { "taskforce_uuid": "string", "task_id": "string", "workflow_id": "string", "timestamp": 1.0, "priority": 1, "collector": "string", "schedd": "string", "n_workers": 1, "pilot_config": { "tag": "string", "image_source": "cvmfs", "environment": {}, "input_files": [ "string" ] }, "worker_config": { "do_transfer_worker_stdouterr": true, "max_worker_runtime": 1, "n_cores": 1, "priority": 1, "worker_disk": "string", "worker_memory": "string", "condor_requirements": "string" }, "cluster_id": 1, "submit_dict": {}, "job_event_log_fpath": "string", "phase": "pre-mq-activation", "phase_change_log": [ { "target_phase": "string", "timestamp": 1.0, "was_successful": true, "source_event_time": 1.0, "source_entity": "string", "context": "string" } ], "compound_statuses": {}, "top_task_errors": {} } ], "next_after": "string" }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
- GET /v1/taskforces/{taskforce_uuid}
Retrieves the taskforce object that matches the specified taskforce UUID. See TaskforceObject.
- Parameters:
taskforce_uuid (string) – UUID of the taskforce.
Example request:
GET /v1/taskforces/{taskforce_uuid} HTTP/1.1 Host: example.com
- Status Codes:
200 OK –
The matching taskforce object
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "taskforce_uuid": "string", "task_id": "string", "workflow_id": "string", "timestamp": 1.0, "priority": 1, "collector": "string", "schedd": "string", "n_workers": 1, "pilot_config": { "tag": "string", "image_source": "cvmfs", "environment": {}, "input_files": [ "string" ] }, "worker_config": { "do_transfer_worker_stdouterr": true, "max_worker_runtime": 1, "n_cores": 1, "priority": 1, "worker_disk": "string", "worker_memory": "string", "condor_requirements": "string" }, "cluster_id": 1, "submit_dict": {}, "job_event_log_fpath": "string", "phase": "pre-mq-activation", "phase_change_log": [ { "target_phase": "string", "timestamp": 1.0, "was_successful": true, "source_event_time": 1.0, "source_entity": "string", "context": "string" } ], "compound_statuses": {}, "top_task_errors": {} }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
Not found
Example response:
HTTP/1.1 404 Not Found Content-Type: application/json { "code": 1, "error": "string" }
workflows
- POST /v1/query/workflows
Queries and returns a list of workflow objects based on the provided criteria. See FindObject, WorkflowObject.
Example request:
POST /v1/query/workflows HTTP/1.1 Host: example.com Content-Type: application/json { "query": {}, "projection": [ "string" ], "after": "string" }
- Status Codes:
200 OK –
Matching workflows and pagination metadata.
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "workflows": [ { "workflow_id": "string", "timestamp": 1.0, "priority": 1, "deactivated": "ABORTED", "deactivated_ts": 1.0 } ], "next_after": "string" }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
- POST /v1/workflows
Creates a new workflow along with its associated task directives and taskforces. See WorkflowObject, TaskDirectiveObject, TaskforceObject.
Example request:
POST /v1/workflows HTTP/1.1 Host: example.com Content-Type: application/json { "tasks": [ { "cluster_locations": [ "string" ], "task_image": "string", "task_args": "string", "task_env": {}, "init_image": "string", "init_args": "string", "init_env": {}, "input_queue_aliases": [ "string" ], "output_queue_aliases": [ "string" ], "pilot_config": { "tag": "string", "image_source": "cvmfs", "environment": {}, "input_files": [ "string" ] }, "worker_config": { "do_transfer_worker_stdouterr": true, "max_worker_runtime": 1, "n_cores": 1, "priority": 1, "worker_disk": "string", "worker_memory": "string", "condor_requirements": "string" }, "n_workers": 1 } ], "public_queue_aliases": [ "string" ], "priority": 1 }
- Status Codes:
200 OK –
The created workflow, task directives, and taskforces.
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "workflow": { "workflow_id": "string", "timestamp": 1.0, "priority": 1, "deactivated": "ABORTED", "deactivated_ts": 1.0 }, "task_directives": [ { "task_id": "string", "workflow_id": "string", "cluster_locations": [ "string" ], "task_image": "string", "task_args": "string", "task_env": {}, "init_image": "string", "init_args": "string", "init_env": {}, "timestamp": 1.0, "input_queues": [ "string" ], "output_queues": [ "string" ] } ], "taskforces": [ { "taskforce_uuid": "string", "task_id": "string", "workflow_id": "string", "timestamp": 1.0, "priority": 1, "collector": "string", "schedd": "string", "n_workers": 1, "pilot_config": { "tag": "string", "image_source": "cvmfs", "environment": {}, "input_files": [ "string" ] }, "worker_config": { "do_transfer_worker_stdouterr": true, "max_worker_runtime": 1, "n_cores": 1, "priority": 1, "worker_disk": "string", "worker_memory": "string", "condor_requirements": "string" }, "cluster_id": 1, "submit_dict": {}, "job_event_log_fpath": "string", "phase": "pre-mq-activation", "phase_change_log": [ { "target_phase": "string", "timestamp": 1.0, "was_successful": true, "source_event_time": 1.0, "source_entity": "string", "context": "string" } ], "compound_statuses": {}, "top_task_errors": {} } ] }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
- GET /v1/workflows/{workflow_id}
Retrieves the workflow object that matches the specified workflow ID. See WorkflowObject.
- Parameters:
workflow_id (string) – The ID of the workflow object
Example request:
GET /v1/workflows/{workflow_id} HTTP/1.1 Host: example.com
- Status Codes:
200 OK –
The matching workflow object
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "workflow_id": "string", "timestamp": 1.0, "priority": 1, "deactivated": "ABORTED", "deactivated_ts": 1.0 }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
Not found
Example response:
HTTP/1.1 404 Not Found Content-Type: application/json { "code": 1, "error": "string" }
- POST /v1/workflows/{workflow_id}/actions/abort
Aborts the specified workflow, marks it as deactivated, and sends stop commands to the associated taskforces. See DeactivatedWorkflowResponseObject.
- Parameters:
workflow_id (string) – The ID of the workflow object
- Status Codes:
200 OK –
Summary of the deactivated workflow.
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "workflow_id": "string", "n_taskforces": 1 }
Not found
Example response:
HTTP/1.1 404 Not Found Content-Type: application/json { "code": 1, "error": "string" }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
- POST /v1/workflows/{workflow_id}/actions/finished
Marks the specified workflow as finished, marks it as deactivated, and sends stop commands to the associated taskforces. See DeactivatedWorkflowResponseObject.
- Parameters:
workflow_id (string) – The ID of the workflow object
- Status Codes:
200 OK –
Summary of the deactivated workflow.
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "workflow_id": "string", "n_taskforces": 1 }
Not found
Example response:
HTTP/1.1 404 Not Found Content-Type: application/json { "code": 1, "error": "string" }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
openapi
- GET /v1/schema/openapi
Returns the OpenAPI schema.
Example request:
GET /v1/schema/openapi HTTP/1.1 Host: example.com
- Status Codes:
200 OK –
The OpenAPI schema.
Example response:
HTTP/1.1 200 OK Content-Type: application/json {}
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
tms - internal
- POST /v1/tms/condor-complete/taskforces/{taskforce_uuid}
For internal use only (TMS): Updates the specified taskforce with the completion timestamp of the HTCondor cluster. See TaskforceObject.
- Parameters:
taskforce_uuid (string) – UUID of the taskforce.
Example request:
POST /v1/tms/condor-complete/taskforces/{taskforce_uuid} HTTP/1.1 Host: example.com Content-Type: application/json { "condor_complete_ts": 1 }
- Status Codes:
200 OK –
The UUID of the updated taskforce object
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "taskforce_uuid": "string" }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
Not found
Example response:
HTTP/1.1 404 Not Found Content-Type: application/json { "code": 1, "error": "string" }
- POST /v1/tms/condor-rm/taskforces/{taskforce_uuid}
For internal use only (TMS): Confirms that a taskforce has been removed on HTCondor. See TaskforceObject.
- Parameters:
taskforce_uuid (string) – UUID of the taskforce.
- Status Codes:
200 OK –
The UUID of the updated taskforce object
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "taskforce_uuid": "string" }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
Not found
Example response:
HTTP/1.1 404 Not Found Content-Type: application/json { "code": 1, "error": "string" }
- POST /v1/tms/condor-rm/taskforces/{taskforce_uuid}/failed
For internal use only (TMS): Communicates that a taskforce failed to be removed on HTCondor. See TaskforceObject.
- Parameters:
taskforce_uuid (string) – UUID of the taskforce.
Example request:
POST /v1/tms/condor-rm/taskforces/{taskforce_uuid}/failed HTTP/1.1 Host: example.com Content-Type: application/json { "error": "string" }
- Status Codes:
200 OK –
The UUID of the updated taskforce object
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "taskforce_uuid": "string" }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
Not found
Example response:
HTTP/1.1 404 Not Found Content-Type: application/json { "code": 1, "error": "string" }
- POST /v1/tms/condor-submit/taskforces/{taskforce_uuid}
For internal use only (TMS): Confirms that a taskforce has been submitted to HTCondor for execution. See TaskforceObject.
- Parameters:
taskforce_uuid (string) – UUID of the taskforce.
Example request:
POST /v1/tms/condor-submit/taskforces/{taskforce_uuid} HTTP/1.1 Host: example.com Content-Type: application/json { "taskforce_uuid": "string", "task_id": "string", "workflow_id": "string", "timestamp": 1.0, "priority": 1, "collector": "string", "schedd": "string", "n_workers": 1, "pilot_config": { "tag": "string", "image_source": "cvmfs", "environment": {}, "input_files": [ "string" ] }, "worker_config": { "do_transfer_worker_stdouterr": true, "max_worker_runtime": 1, "n_cores": 1, "priority": 1, "worker_disk": "string", "worker_memory": "string", "condor_requirements": "string" }, "cluster_id": 1, "submit_dict": {}, "job_event_log_fpath": "string", "phase": "pre-mq-activation", "phase_change_log": [ { "target_phase": "string", "timestamp": 1.0, "was_successful": true, "source_event_time": 1.0, "source_entity": "string", "context": "string" } ], "compound_statuses": {}, "top_task_errors": {} }
- Status Codes:
200 OK –
The UUID of the updated taskforce object
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "taskforce_uuid": "string" }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
Not found
Example response:
HTTP/1.1 404 Not Found Content-Type: application/json { "code": 1, "error": "string" }
- POST /v1/tms/condor-submit/taskforces/{taskforce_uuid}/failed
For internal use only (TMS): Communicates that a taskforce failed to be submitted to HTCondor for execution. See TaskforceObject.
- Parameters:
taskforce_uuid (string) – UUID of the taskforce.
Example request:
POST /v1/tms/condor-submit/taskforces/{taskforce_uuid}/failed HTTP/1.1 Host: example.com Content-Type: application/json { "error": "string" }
- Status Codes:
200 OK –
The UUID of the updated taskforce object
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "taskforce_uuid": "string" }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
Not found
Example response:
HTTP/1.1 404 Not Found Content-Type: application/json { "code": 1, "error": "string" }
- GET /v1/tms/pending-starter/taskforces
For internal use only (TMS): Retrieves the next taskforce ready to start at the specified HTCondor location. See TaskforceObject, TaskDirectiveObject, MQProfileObject.
- Query Parameters:
collector (string) – Deprecated. Name of the HTCondor collector; no longer used.
schedd (string) – Name of the HTCondor schedd. (Required)
Example request:
GET /v1/tms/pending-starter/taskforces?schedd=string HTTP/1.1 Host: example.com
- Status Codes:
200 OK –
The next taskforce to start at the HTCondor location.
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "taskforce": { "taskforce_uuid": "string", "task_id": "string", "workflow_id": "string", "timestamp": 1.0, "priority": 1, "collector": "string", "schedd": "string", "n_workers": 1, "pilot_config": { "tag": "string", "image_source": "cvmfs", "environment": {}, "input_files": [ "string" ] }, "worker_config": { "do_transfer_worker_stdouterr": true, "max_worker_runtime": 1, "n_cores": 1, "priority": 1, "worker_disk": "string", "worker_memory": "string", "condor_requirements": "string" }, "cluster_id": 1, "submit_dict": {}, "job_event_log_fpath": "string", "phase": "pre-mq-activation", "phase_change_log": [ { "target_phase": "string", "timestamp": 1.0, "was_successful": true, "source_event_time": 1.0, "source_entity": "string", "context": "string" } ], "compound_statuses": {}, "top_task_errors": {} }, "task_directive": { "task_id": "string", "workflow_id": "string", "cluster_locations": [ "string" ], "task_image": "string", "task_args": "string", "task_env": {}, "init_image": "string", "init_args": "string", "init_env": {}, "timestamp": 1.0, "input_queues": [ "string" ], "output_queues": [ "string" ] }, "mqprofiles": [ {} ] }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
- GET /v1/tms/pending-stopper/taskforces
For internal use only (TMS): Retrieves the next taskforce ready to stop at the specified HTCondor location. See TaskforceObject.
- Query Parameters:
collector (string) – Deprecated. Name of the HTCondor collector; no longer used.
schedd (string) – Name of the HTCondor schedd. (Required)
Example request:
GET /v1/tms/pending-stopper/taskforces?schedd=string HTTP/1.1 Host: example.com
- Status Codes:
200 OK –
The next taskforce to stop at the HTCondor location.
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "taskforce_uuid": "string", "task_id": "string", "workflow_id": "string", "timestamp": 1.0, "priority": 1, "collector": "string", "schedd": "string", "n_workers": 1, "pilot_config": { "tag": "string", "image_source": "cvmfs", "environment": {}, "input_files": [ "string" ] }, "worker_config": { "do_transfer_worker_stdouterr": true, "max_worker_runtime": 1, "n_cores": 1, "priority": 1, "worker_disk": "string", "worker_memory": "string", "condor_requirements": "string" }, "cluster_id": 1, "submit_dict": {}, "job_event_log_fpath": "string", "phase": "pre-mq-activation", "phase_change_log": [ { "target_phase": "string", "timestamp": 1.0, "was_successful": true, "source_event_time": 1.0, "source_entity": "string", "context": "string" } ], "compound_statuses": {}, "top_task_errors": {} }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }
- POST /v1/tms/statuses/taskforces
For internal use only (TMS): Updates and returns the statuses and errors for the specified taskforces. See TaskforceObject.
Example request:
POST /v1/tms/statuses/taskforces HTTP/1.1 Host: example.com Content-Type: application/json { "top_task_errors_by_taskforce": {}, "compound_statuses_by_taskforce": {} }
- Status Codes:
200 OK –
Individual update results for each UUID.
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "results": [ { "uuid": "string", "status": "string" } ] }
Individual update results for each UUID, including errors.
Example response:
HTTP/1.1 207 Multi-Status Content-Type: application/json { "results": [ { "uuid": "string", "status": "string", "error": "string" } ] }
Invalid request arguments
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "code": 1, "error": "string" }