svc-sundial 2.0.0-dev - Hudson's Bay Company

A service for scheduling and running Docker-based jobs

Version:

healthcheck

Path: /_internal_

GET /_internal_/metrics

Responses

Code	Type	Description
200	string

process

Path: /api/processes

GET /api/processes/

Retrieves a list of process runs based on search parameters.

Parameters

Name	Type	Description
process_definition_name	string	Query
start_time	date-time-iso8601	Query
end_time	date-time-iso8601	Query
max_records	integer	Query
allowed_statuses required	[process_status]	Query

Responses

Code	Type	Description
200	[process]

GET /api/processes/:process_id

Retrieves a process run

Parameters

Name	Type	Description
process_id required	uuid	Path

Responses

Code	Type	Description
200	process

POST /api/processes/:process_id/retry

Retries a failed process run by restarting failed tasks; tasks will be given a single additional attempt

Parameters

Name	Type	Description
process_id required	uuid	Path

Responses

Code	Type	Description
204	unit

POST /api/processes/:process_id/kill

Terminates an active process

Parameters

Name	Type	Description
process_id required	uuid	Path

Responses

Code	Type	Description
204	unit

process_definition

Path: /api/process_definitions

GET /api/process_definitions/

Get all currently registered process definitions

Responses

Code	Type	Description
200	[process_definition]

GET /api/process_definitions/:process_definition_name

Get a registered process definition

Parameters

Name	Type	Description
process_definition_name required	string	Path

Responses

Code	Type	Description
200	process_definition

PUT /api/process_definitions/:process_definition_name

Updates or creates a process definition

Body

process_definition

Parameters

Name	Type	Description
process_definition_name required	string	Path

Responses

Code	Type	Description
200	process_definition

DELETE /api/process_definitions/:process_definition_name

Deletes a registered process definition

Parameters

Name	Type	Description
process_definition_name required	string	Path

Responses

Code	Type	Description
204	unit

POST /api/process_definitions/:process_definition_name/trigger

Triggers a new instance of the process

Parameters

Name	Type	Description
process_definition_name required	string	Path
task_definition_name	string	Query

Responses

Code	Type	Description
204	unit

POST /api/process_definitions/:process_definition_name/pause

Pause the process schedule

Parameters

Name	Type	Description
process_definition_name required	string	Path

Responses

Code	Type	Description
204	unit

POST /api/process_definitions/:process_definition_name/resume

Resume the process schedule

Parameters

Name	Type	Description
process_definition_name required	string	Path

Responses

Code	Type	Description
204	unit

task

Path: /api/tasks

GET /api/tasks/

Retrieves the most recent tasks meeting the given criteria

Parameters

Name	Type	Description
process_definition_name required	string	Query
task_definition_name required	string	Query
allowed_statuses required	[task_status]	Query
start_time	date-time-iso8601	Query
end_time	date-time-iso8601	Query
limit	integer	Query

Responses

Code	Type	Description
200	[task]

POST /api/tasks/:task_id/log_entries

Appends log entries for a task; intended for use within the task executable

Body

[log_entry]

Parameters

Name	Type	Description
task_id required	uuid	Path

Responses

Code	Type	Description
204	unit

POST /api/tasks/:task_id/metadata

Appends metadata entries for a task; intended for use within the task executable

Body

[metadata_entry]

Parameters

Name	Type	Description
task_id required	uuid	Path

Responses

Code	Type	Description
204	unit

POST /api/tasks/:task_id/succeed

Marks the task as having succeeded

Parameters

Name	Type	Description
task_id required	uuid	Path

Responses

Code	Type	Description
204	unit

POST /api/tasks/:task_id/fail

Marks the task as having failed

Parameters

Name	Type	Description
task_id required	uuid	Path

Responses

Code	Type	Description
204	unit