openapi: 3.1.0
info:
title: torc
description: Rust-owned OpenAPI surface for Torc.
contact:
name: Daniel Thom
license:
name: BSD-3-Clause
identifier: BSD-3-Clause
version: 0.12.0
servers:
- url: /torc-service/v1
description: Versioned Torc API base path
paths:
/access_check/{workflow_id}/{user_name}:
get:
tags:
- access_control
operationId: check_workflow_access
parameters:
- name: workflow_id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: user_name
in: path
description: Username
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AccessCheckResponse'
/access_groups:
get:
tags:
- access_control
operationId: list_access_groups
parameters:
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListAccessGroupsResponse'
post:
tags:
- access_control
operationId: create_access_group
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccessGroupModel'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AccessGroupModel'
/access_groups/{id}:
get:
tags:
- access_control
operationId: get_access_group
parameters:
- name: id
in: path
description: Access group ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AccessGroupModel'
delete:
tags:
- access_control
operationId: delete_access_group
parameters:
- name: id
in: path
description: Access group ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AccessGroupModel'
/access_groups/{id}/members:
get:
tags:
- access_control
operationId: list_group_members
parameters:
- name: id
in: path
description: Access group ID
required: true
schema:
type: integer
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListUserGroupMembershipsResponse'
post:
tags:
- access_control
operationId: add_user_to_group
parameters:
- name: id
in: path
description: Access group ID
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserGroupMembershipModel'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UserGroupMembershipModel'
/access_groups/{id}/members/{user_name}:
delete:
tags:
- access_control
operationId: remove_user_from_group
parameters:
- name: id
in: path
description: Access group ID
required: true
schema:
type: integer
format: int64
- name: user_name
in: path
description: Username
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UserGroupMembershipModel'
/admin/reload-auth:
post:
tags:
- access_control
operationId: reload_auth
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ReloadAuthResponse'
/bulk_jobs:
post:
tags:
- jobs
operationId: create_jobs
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JobsModel'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateJobsResponse'
/compute_nodes:
get:
tags:
- compute_nodes
operationId: list_compute_nodes
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: sort_by
in: query
required: false
schema:
type:
- string
- 'null'
- name: reverse_sort
in: query
required: false
schema:
type:
- boolean
- 'null'
- name: hostname
in: query
required: false
schema:
type:
- string
- 'null'
- name: is_active
in: query
required: false
schema:
type:
- boolean
- 'null'
- name: scheduled_compute_node_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListComputeNodesResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- compute_nodes
operationId: create_compute_node
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeNodeModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeNodeModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- compute_nodes
operationId: delete_compute_nodes
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteCountResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/compute_nodes/{id}:
get:
tags:
- compute_nodes
operationId: get_compute_node
parameters:
- name: id
in: path
description: ID of the compute node record
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeNodeModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- compute_nodes
operationId: update_compute_node
parameters:
- name: id
in: path
description: ID of the compute node.
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeNodeModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeNodeModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- compute_nodes
operationId: delete_compute_node
parameters:
- name: id
in: path
description: Compute node ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeNodeModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/events:
get:
tags:
- events
operationId: list_events
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: sort_by
in: query
required: false
schema:
type:
- string
- 'null'
- name: reverse_sort
in: query
required: false
schema:
type:
- boolean
- 'null'
- name: category
in: query
required: false
schema:
type:
- string
- 'null'
- name: after_timestamp
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListEventsResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- events
operationId: create_event
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EventModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/EventModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- events
operationId: delete_events
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema: {}
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/events/{id}:
get:
tags:
- events
operationId: get_event
parameters:
- name: id
in: path
description: ID of the event record.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/EventModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- events
operationId: update_event
parameters:
- name: id
in: path
description: ID of the event.
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema: {}
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/EventModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- events
operationId: delete_event
parameters:
- name: id
in: path
description: ID of the event record.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/EventModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/failure_handlers:
post:
tags:
- failure_handlers
operationId: create_failure_handler
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FailureHandlerModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/FailureHandlerModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/failure_handlers/{id}:
get:
tags:
- failure_handlers
operationId: get_failure_handler
parameters:
- name: id
in: path
description: Failure handler ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/FailureHandlerModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- failure_handlers
operationId: delete_failure_handler
parameters:
- name: id
in: path
description: Failure handler ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/FailureHandlerModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/files:
get:
tags:
- files
operationId: list_files
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
- name: produced_by_job_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: sort_by
in: query
required: false
schema:
type:
- string
- 'null'
- name: reverse_sort
in: query
required: false
schema:
type:
- boolean
- 'null'
- name: name
in: query
required: false
schema:
type:
- string
- 'null'
- name: path
in: query
required: false
schema:
type:
- string
- 'null'
- name: is_output
in: query
required: false
schema:
type:
- boolean
- 'null'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListFilesResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- files
operationId: create_file
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FileModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/FileModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- files
operationId: delete_files
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteCountResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/files/{id}:
get:
tags:
- files
operationId: get_file
parameters:
- name: id
in: path
description: ID of the file record
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/FileModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- files
operationId: update_file
parameters:
- name: id
in: path
description: ID of the file.
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FileModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/FileModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- files
operationId: delete_file
parameters:
- name: id
in: path
description: File ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/FileModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/jobs:
get:
tags:
- jobs
operationId: list_jobs
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
- name: status
in: query
required: false
schema:
oneOf:
- type: 'null'
- $ref: '#/components/schemas/JobStatus'
- name: needs_file_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: upstream_job_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: sort_by
in: query
required: false
schema:
type:
- string
- 'null'
- name: reverse_sort
in: query
required: false
schema:
type:
- boolean
- 'null'
- name: include_relationships
in: query
required: false
schema:
type:
- boolean
- 'null'
- name: active_compute_node_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListJobsResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- jobs
operationId: create_job
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JobModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/JobModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Unprocessable content (e.g., invalid priority)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- jobs
operationId: delete_jobs
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteCountResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/jobs/{id}:
get:
tags:
- jobs
operationId: get_job
parameters:
- name: id
in: path
description: ID of the job record
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/JobModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- jobs
operationId: update_job
parameters:
- name: id
in: path
description: ID of the job.
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JobModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/JobModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- jobs
operationId: delete_job
parameters:
- name: id
in: path
description: Job ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/JobModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/jobs/{id}/complete_job/{status}/{run_id}:
post:
tags:
- jobs
operationId: complete_job
parameters:
- name: id
in: path
description: Job ID
required: true
schema:
type: integer
format: int64
- name: status
in: path
description: New job status.
required: true
schema:
$ref: '#/components/schemas/JobStatus'
- name: run_id
in: path
description: Current job run ID
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResultModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/JobModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/jobs/{id}/manage_status_change/{status}/{run_id}:
put:
tags:
- jobs
operationId: manage_status_change
parameters:
- name: id
in: path
description: Job ID
required: true
schema:
type: integer
format: int64
- name: status
in: path
description: New job status
required: true
schema:
$ref: '#/components/schemas/JobStatus'
- name: run_id
in: path
description: Current job run ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/JobModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/jobs/{id}/retry/{run_id}:
post:
tags:
- jobs
operationId: retry_job
parameters:
- name: id
in: path
description: Job ID
required: true
schema:
type: integer
format: int64
- name: run_id
in: path
description: Current workflow run ID
required: true
schema:
type: integer
format: int64
- name: max_retries
in: query
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/JobModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Unprocessable content
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/jobs/{id}/start_job/{run_id}/{compute_node_id}:
put:
tags:
- jobs
operationId: start_job
parameters:
- name: id
in: path
description: Job ID
required: true
schema:
type: integer
format: int64
- name: run_id
in: path
description: Current job run ID
required: true
schema:
type: integer
format: int64
- name: compute_node_id
in: path
description: Compute node ID that started the job
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/JobModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/local_schedulers:
get:
tags:
- local_schedulers
operationId: list_local_schedulers
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: sort_by
in: query
required: false
schema:
type:
- string
- 'null'
- name: reverse_sort
in: query
required: false
schema:
type:
- boolean
- 'null'
- name: memory
in: query
required: false
schema:
type:
- string
- 'null'
- name: num_cpus
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListLocalSchedulersResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- local_schedulers
operationId: create_local_scheduler
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LocalSchedulerModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/LocalSchedulerModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- local_schedulers
operationId: delete_local_schedulers
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteCountResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/local_schedulers/{id}:
get:
tags:
- local_schedulers
operationId: get_local_scheduler
parameters:
- name: id
in: path
description: ID of the local scheduler record
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/LocalSchedulerModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- local_schedulers
operationId: update_local_scheduler
parameters:
- name: id
in: path
description: ID of the local scheduler.
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LocalSchedulerModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/LocalSchedulerModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- local_schedulers
operationId: delete_local_scheduler
parameters:
- name: id
in: path
description: Local scheduler ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/LocalSchedulerModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/ping:
get:
tags:
- system
operationId: ping
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PingResponse'
/resource_requirements:
get:
tags:
- resource_requirements
operationId: list_resource_requirements
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
- name: job_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: name
in: query
required: false
schema:
type:
- string
- 'null'
- name: memory
in: query
required: false
schema:
type:
- string
- 'null'
- name: num_cpus
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: num_gpus
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: num_nodes
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: runtime
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: sort_by
in: query
required: false
schema:
type:
- string
- 'null'
- name: reverse_sort
in: query
required: false
schema:
type:
- boolean
- 'null'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourceRequirementsResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- resource_requirements
operationId: create_resource_requirements
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceRequirementsModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceRequirementsModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Unprocessable content
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- resource_requirements
operationId: delete_resource_requirements
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema: {}
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/resource_requirements/{id}:
get:
tags:
- resource_requirements
operationId: get_resource_requirements
parameters:
- name: id
in: path
description: Resource requirements ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceRequirementsModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- resource_requirements
operationId: update_resource_requirements
parameters:
- name: id
in: path
description: Resource requirements ID
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceRequirementsModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceRequirementsModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Unprocessable content
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- resource_requirements
operationId: delete_resource_requirement
parameters:
- name: id
in: path
description: Resource requirements ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceRequirementsModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/results:
get:
tags:
- results
operationId: list_results
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
- name: job_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: run_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: return_code
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: status
in: query
required: false
schema:
oneOf:
- type: 'null'
- $ref: '#/components/schemas/JobStatus'
- name: compute_node_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: sort_by
in: query
required: false
schema:
type:
- string
- 'null'
- name: reverse_sort
in: query
required: false
schema:
type:
- boolean
- 'null'
- name: all_runs
in: query
required: false
schema:
type:
- boolean
- 'null'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListResultsResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- results
operationId: create_result
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResultModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ResultModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- results
operationId: delete_results
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema: {}
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/results/{id}:
get:
tags:
- results
operationId: get_result
parameters:
- name: id
in: path
description: Results ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ResultModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- results
operationId: update_result
parameters:
- name: id
in: path
description: Result ID
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResultModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ResultModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- results
operationId: delete_result
parameters:
- name: id
in: path
description: Results ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ResultModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/ro_crate_entities:
post:
tags:
- ro_crate_entities
operationId: create_ro_crate_entity
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoCrateEntityModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/RoCrateEntityModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Unprocessable content
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/ro_crate_entities/{id}:
get:
tags:
- ro_crate_entities
operationId: get_ro_crate_entity
parameters:
- name: id
in: path
description: Entity ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/RoCrateEntityModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- ro_crate_entities
operationId: update_ro_crate_entity
parameters:
- name: id
in: path
description: Entity ID
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoCrateEntityModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/RoCrateEntityModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Unprocessable content
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- ro_crate_entities
operationId: delete_ro_crate_entity
parameters:
- name: id
in: path
description: Entity ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/scheduled_compute_nodes:
get:
tags:
- scheduled_compute_nodes
operationId: list_scheduled_compute_nodes
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: sort_by
in: query
required: false
schema:
type:
- string
- 'null'
- name: reverse_sort
in: query
required: false
schema:
type:
- boolean
- 'null'
- name: scheduler_id
in: query
required: false
schema:
type:
- string
- 'null'
- name: scheduler_config_id
in: query
required: false
schema:
type:
- string
- 'null'
- name: status
in: query
required: false
schema:
type:
- string
- 'null'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListScheduledComputeNodesResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- scheduled_compute_nodes
operationId: create_scheduled_compute_node
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledComputeNodesModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledComputeNodesModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- scheduled_compute_nodes
operationId: delete_scheduled_compute_nodes
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteCountResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/scheduled_compute_nodes/{id}:
get:
tags:
- scheduled_compute_nodes
operationId: get_scheduled_compute_node
parameters:
- name: id
in: path
description: ID of the scheduled_compute_nodes record
required: true
schema:
type: integer
format: int64
responses:
'200':
description: HTTP 200 OK.
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledComputeNodesModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- scheduled_compute_nodes
operationId: update_scheduled_compute_node
parameters:
- name: id
in: path
description: Scheduled compute node ID
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledComputeNodesModel'
required: true
responses:
'200':
description: scheduled compute node updated in the table.
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledComputeNodesModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- scheduled_compute_nodes
operationId: delete_scheduled_compute_node
parameters:
- name: id
in: path
description: Scheduled compute node ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledComputeNodesModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/slurm_schedulers:
get:
tags:
- slurm_schedulers
operationId: list_slurm_schedulers
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: sort_by
in: query
required: false
schema:
type:
- string
- 'null'
- name: reverse_sort
in: query
required: false
schema:
type:
- boolean
- 'null'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListSlurmSchedulersResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- slurm_schedulers
operationId: create_slurm_scheduler
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SlurmSchedulerModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/SlurmSchedulerModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- slurm_schedulers
operationId: delete_slurm_schedulers
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteCountResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/slurm_schedulers/{id}:
get:
tags:
- slurm_schedulers
operationId: get_slurm_scheduler
parameters:
- name: id
in: path
description: Slurm compute node configuration ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/SlurmSchedulerModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- slurm_schedulers
operationId: update_slurm_scheduler
parameters:
- name: id
in: path
description: Slurm compute node configuration ID
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SlurmSchedulerModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/SlurmSchedulerModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- slurm_schedulers
operationId: delete_slurm_scheduler
parameters:
- name: id
in: path
description: Slurm compute node configuration ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/SlurmSchedulerModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/slurm_stats:
get:
tags:
- slurm_stats
operationId: list_slurm_stats
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
- name: job_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: run_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: attempt_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListSlurmStatsResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- slurm_stats
operationId: create_slurm_stats
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SlurmStatsModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/SlurmStatsModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/user_data:
get:
tags:
- user_data
operationId: list_user_data
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
- name: consumer_job_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: producer_job_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: sort_by
in: query
required: false
schema:
type:
- string
- 'null'
- name: reverse_sort
in: query
required: false
schema:
type:
- boolean
- 'null'
- name: name
in: query
required: false
schema:
type:
- string
- 'null'
- name: is_ephemeral
in: query
required: false
schema:
type:
- boolean
- 'null'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListUserDataResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- user_data
operationId: create_user_data
parameters:
- name: consumer_job_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: producer_job_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserDataModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/UserDataModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- user_data
operationId: delete_all_user_data
parameters:
- name: workflow_id
in: query
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema: {}
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/user_data/{id}:
get:
tags:
- user_data
operationId: get_user_data
parameters:
- name: id
in: path
description: User data record ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/UserDataModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- user_data
operationId: update_user_data
parameters:
- name: id
in: path
description: User data record ID
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserDataModel'
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/UserDataModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- user_data
operationId: delete_user_data
parameters:
- name: id
in: path
description: User data record ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/UserDataModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/users/{user_name}/groups:
get:
tags:
- access_control
operationId: list_user_groups
parameters:
- name: user_name
in: path
description: Username
required: true
schema:
type: string
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListAccessGroupsResponse'
/version:
get:
tags:
- system
operationId: get_version
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/VersionResponse'
/workflows:
get:
tags:
- workflows
operationId: list_workflows
parameters:
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: sort_by
in: query
required: false
schema:
type:
- string
- 'null'
- name: reverse_sort
in: query
required: false
schema:
type:
- boolean
- 'null'
- name: name
in: query
required: false
schema:
type:
- string
- 'null'
- name: user
in: query
required: false
schema:
type:
- string
- 'null'
- name: description
in: query
required: false
schema:
type:
- string
- 'null'
- name: is_archived
in: query
required: false
schema:
type:
- boolean
- 'null'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListWorkflowsResponse'
post:
tags:
- workflows
operationId: create_workflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowModel'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowModel'
/workflows/{id}:
get:
tags:
- workflows
operationId: get_workflow
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowModel'
put:
tags:
- workflows
operationId: update_workflow
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowModel'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowModel'
delete:
tags:
- workflows
operationId: delete_workflow
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowModel'
/workflows/{id}/access_groups:
get:
tags:
- access_control
operationId: list_workflow_groups
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListAccessGroupsResponse'
/workflows/{id}/access_groups/{group_id}:
post:
tags:
- access_control
operationId: add_workflow_to_group
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: group_id
in: path
description: Access group ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowAccessGroupModel'
delete:
tags:
- access_control
operationId: remove_workflow_from_group
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: group_id
in: path
description: Access group ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowAccessGroupModel'
/workflows/{id}/actions:
get:
tags:
- workflow_actions
operationId: get_workflow_actions
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WorkflowActionModel'
post:
tags:
- workflow_actions
operationId: create_workflow_action
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowActionModel'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowActionModel'
/workflows/{id}/actions/pending:
get:
tags:
- workflow_actions
operationId: get_pending_actions
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: trigger_type
in: query
required: false
schema:
type:
- array
- 'null'
items:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WorkflowActionModel'
/workflows/{id}/actions/{action_id}/claim:
post:
tags:
- workflow_actions
operationId: claim_action
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: action_id
in: path
description: Action ID
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClaimActionRequest'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ClaimActionResponse'
/workflows/{id}/cancel:
put:
tags:
- workflows
operationId: cancel_workflow
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: ''
content:
application/json:
schema: {}
/workflows/{id}/claim_jobs_based_on_resources/{limit}:
post:
tags:
- workflows
operationId: claim_jobs_based_on_resources
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: strict_scheduler_match
in: query
required: false
schema:
type:
- boolean
- 'null'
- name: limit
in: path
description: Maximum number of jobs to claim
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeNodesResources'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ClaimJobsBasedOnResources'
/workflows/{id}/claim_next_jobs:
post:
tags:
- workflows
operationId: claim_next_jobs
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ClaimNextJobsResponse'
/workflows/{id}/failure_handlers:
get:
tags:
- failure_handlers
operationId: list_failure_handlers
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListFailureHandlersResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/workflows/{id}/initialize_jobs:
post:
tags:
- workflows
operationId: initialize_jobs
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: only_uninitialized
in: query
required: false
schema:
type:
- boolean
- 'null'
- name: clear_ephemeral_user_data
in: query
required: false
schema:
type:
- boolean
- 'null'
responses:
'200':
description: ''
content:
application/json:
schema: {}
/workflows/{id}/is_complete:
get:
tags:
- workflows
operationId: is_workflow_complete
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/IsCompleteResponse'
/workflows/{id}/is_uninitialized:
get:
tags:
- workflows
operationId: is_workflow_uninitialized
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/IsUninitializedResponse'
/workflows/{id}/job_dependencies:
get:
tags:
- workflows
operationId: list_job_dependencies
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: sort_by
in: query
required: false
schema:
type:
- string
- 'null'
- name: reverse_sort
in: query
required: false
schema:
type:
- boolean
- 'null'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListJobDependenciesResponse'
/workflows/{id}/job_file_relationships:
get:
tags:
- workflows
operationId: list_job_file_relationships
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: sort_by
in: query
required: false
schema:
type:
- string
- 'null'
- name: reverse_sort
in: query
required: false
schema:
type:
- boolean
- 'null'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListJobFileRelationshipsResponse'
/workflows/{id}/job_ids:
get:
tags:
- workflows
operationId: list_job_ids
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListJobIdsResponse'
/workflows/{id}/job_user_data_relationships:
get:
tags:
- workflows
operationId: list_job_user_data_relationships
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: sort_by
in: query
required: false
schema:
type:
- string
- 'null'
- name: reverse_sort
in: query
required: false
schema:
type:
- boolean
- 'null'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListJobUserDataRelationshipsResponse'
/workflows/{id}/missing_user_data:
get:
tags:
- workflows
operationId: list_missing_user_data
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListMissingUserDataResponse'
/workflows/{id}/process_changed_job_inputs:
post:
tags:
- workflows
operationId: process_changed_job_inputs
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: dry_run
in: query
required: false
schema:
type:
- boolean
- 'null'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessChangedJobInputsResponse'
/workflows/{id}/ready_job_requirements:
get:
tags:
- workflows
operationId: get_ready_job_requirements
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: scheduler_config_id
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GetReadyJobRequirementsResponse'
/workflows/{id}/remote_workers:
get:
tags:
- remote_workers
operationId: list_remote_workers
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RemoteWorkerModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- remote_workers
operationId: create_remote_workers
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RemoteWorkerModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Unprocessable content
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/workflows/{id}/remote_workers/{worker}:
delete:
tags:
- remote_workers
operationId: delete_remote_worker
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: worker
in: path
description: Worker address
required: true
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteWorkerModel'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/workflows/{id}/required_existing_files:
get:
tags:
- workflows
operationId: list_required_existing_files
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListRequiredExistingFilesResponse'
/workflows/{id}/reset_job_status:
post:
tags:
- workflows
operationId: reset_job_status
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: failed_only
in: query
required: false
schema:
type:
- boolean
- 'null'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ResetJobStatusResponse'
/workflows/{id}/reset_status:
post:
tags:
- workflows
operationId: reset_workflow_status
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: force
in: query
required: false
schema:
type:
- boolean
- 'null'
responses:
'200':
description: ''
content:
application/json:
schema: {}
/workflows/{id}/ro_crate_entities:
get:
tags:
- ro_crate_entities
operationId: list_ro_crate_entities
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
- name: offset
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: limit
in: query
required: false
schema:
type:
- integer
- 'null'
format: int64
- name: sort_by
in: query
required: false
schema:
type:
- string
- 'null'
- name: reverse_sort
in: query
required: false
schema:
type:
- boolean
- 'null'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListRoCrateEntitiesResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- ro_crate_entities
operationId: delete_ro_crate_entities
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteRoCrateEntitiesResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/workflows/{id}/status:
get:
tags:
- workflows
operationId: get_workflow_status
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowStatusModel'
put:
tags:
- workflows
operationId: update_workflow_status
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowStatusModel'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowStatusModel'
components:
schemas:
AccessCheckResponse:
type: object
required:
- has_access
- user_name
- workflow_id
properties:
has_access:
type: boolean
reason:
type:
- string
- 'null'
user_name:
type: string
workflow_id:
type: integer
format: int64
AccessGroupModel:
type: object
required:
- name
properties:
created_at:
type:
- string
- 'null'
description:
type:
- string
- 'null'
id:
type:
- integer
- 'null'
format: int64
name:
type: string
ClaimActionRequest:
type: object
properties:
compute_node_id:
type:
- integer
- 'null'
format: int64
ClaimActionResponse:
type: object
required:
- action_id
properties:
action_id:
type: integer
format: int64
success:
type: boolean
default: false
ClaimJobsBasedOnResources:
type: object
properties:
jobs:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/JobModel'
reason:
type:
- string
- 'null'
ClaimNextJobsResponse:
type: object
properties:
jobs:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/JobModel'
ComputeNodeModel:
type: object
required:
- workflow_id
- hostname
- pid
- start_time
- num_cpus
- memory_gb
- num_gpus
- num_nodes
- compute_node_type
properties:
compute_node_type:
type: string
duration_seconds:
type:
- number
- 'null'
format: double
hostname:
type: string
id:
type:
- integer
- 'null'
format: int64
is_active:
type:
- boolean
- 'null'
memory_gb:
type: number
format: double
num_cpus:
type: integer
format: int64
num_gpus:
type: integer
format: int64
num_nodes:
type: integer
format: int64
pid:
type: integer
format: int64
scheduler: {}
scheduler_config_id:
type:
- integer
- 'null'
format: int64
start_time:
type: string
time_limit:
type:
- string
- 'null'
workflow_id:
type: integer
format: int64
ComputeNodeSchedule:
type: object
required:
- num_jobs
- scheduler_id
properties:
max_parallel_jobs:
type:
- integer
- 'null'
format: int64
num_jobs:
type: integer
format: int64
scheduler_id:
type: integer
format: int64
start_one_worker_per_node:
type:
- boolean
- 'null'
ComputeNodesResources:
type: object
required:
- num_cpus
- memory_gb
- num_gpus
- num_nodes
properties:
id:
type:
- integer
- 'null'
format: int64
memory_gb:
type: number
format: double
num_cpus:
type: integer
format: int64
num_gpus:
type: integer
format: int64
num_nodes:
type: integer
format: int64
scheduler_config_id:
type:
- integer
- 'null'
format: int64
time_limit:
type:
- string
- 'null'
CreateJobsResponse:
type: object
properties:
jobs:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/JobModel'
DeleteCountResponse:
type: object
required:
- count
properties:
count:
type: integer
format: int64
DeleteRoCrateEntitiesResponse:
type: object
required:
- message
- deleted_count
properties:
deleted_count:
type: integer
format: int64
message:
type: string
ErrorResponse:
type: object
required:
- error
properties:
code:
type:
- integer
- 'null'
format: int64
error: {}
errorMessage:
type:
- string
- 'null'
errorNum:
type:
- integer
- 'null'
format: int64
EventModel:
type: object
required:
- workflow_id
- timestamp
- data
properties:
data: {}
id:
type:
- integer
- 'null'
format: int64
timestamp:
type: integer
format: int64
workflow_id:
type: integer
format: int64
FailureHandlerModel:
type: object
required:
- workflow_id
- name
- rules
properties:
id:
type:
- integer
- 'null'
format: int64
name:
type: string
rules:
type: string
workflow_id:
type: integer
format: int64
FileModel:
type: object
required:
- workflow_id
- name
- path
properties:
id:
type:
- integer
- 'null'
format: int64
name:
type: string
path:
type: string
st_mtime:
type:
- number
- 'null'
format: double
workflow_id:
type: integer
format: int64
GetReadyJobRequirementsResponse:
type: object
required:
- num_jobs
- num_cpus
- num_gpus
- memory_gb
- max_num_nodes
- max_runtime
properties:
max_num_nodes:
type: integer
format: int64
max_runtime:
type: string
memory_gb:
type: number
format: double
num_cpus:
type: integer
format: int64
num_gpus:
type: integer
format: int64
num_jobs:
type: integer
format: int64
IsCompleteResponse:
type: object
required:
- is_canceled
- is_complete
- needs_to_run_completion_script
properties:
is_canceled:
type: boolean
is_complete:
type: boolean
needs_to_run_completion_script:
type: boolean
IsUninitializedResponse:
type: object
required:
- is_uninitialized
properties:
is_uninitialized:
type: boolean
JobDependencyModel:
type: object
required:
- job_id
- job_name
- depends_on_job_id
- depends_on_job_name
- workflow_id
properties:
depends_on_job_id:
type: integer
format: int64
depends_on_job_name:
type: string
job_id:
type: integer
format: int64
job_name:
type: string
workflow_id:
type: integer
format: int64
JobFileRelationshipModel:
type: object
required:
- file_id
- file_name
- file_path
- workflow_id
properties:
consumer_job_id:
type:
- integer
- 'null'
format: int64
consumer_job_name:
type:
- string
- 'null'
file_id:
type: integer
format: int64
file_name:
type: string
file_path:
type: string
producer_job_id:
type:
- integer
- 'null'
format: int64
producer_job_name:
type:
- string
- 'null'
workflow_id:
type: integer
format: int64
JobModel:
type: object
required:
- workflow_id
- name
- command
properties:
attempt_id:
type:
- integer
- 'null'
format: int64
cancel_on_blocking_job_failure:
type:
- boolean
- 'null'
command:
type: string
depends_on_job_ids:
type:
- array
- 'null'
items:
type: integer
format: int64
failure_handler_id:
type:
- integer
- 'null'
format: int64
id:
type:
- integer
- 'null'
format: int64
input_file_ids:
type:
- array
- 'null'
items:
type: integer
format: int64
input_user_data_ids:
type:
- array
- 'null'
items:
type: integer
format: int64
invocation_script:
type:
- string
- 'null'
name:
type: string
output_file_ids:
type:
- array
- 'null'
items:
type: integer
format: int64
output_user_data_ids:
type:
- array
- 'null'
items:
type: integer
format: int64
priority:
type:
- integer
- 'null'
format: int64
description: Scheduling priority; higher values are submitted first. Minimum 0, default 0.
default: 0
minimum: 0
resource_requirements_id:
type:
- integer
- 'null'
format: int64
schedule_compute_nodes:
oneOf:
- type: 'null'
- $ref: '#/components/schemas/ComputeNodeSchedule'
scheduler_id:
type:
- integer
- 'null'
format: int64
status:
oneOf:
- type: 'null'
- $ref: '#/components/schemas/JobStatus'
supports_termination:
type:
- boolean
- 'null'
workflow_id:
type: integer
format: int64
JobStatus:
type: string
enum:
- uninitialized
- blocked
- ready
- pending
- running
- completed
- failed
- canceled
- terminated
- disabled
- pending_failed
JobUserDataRelationshipModel:
type: object
required:
- user_data_id
- user_data_name
- workflow_id
properties:
consumer_job_id:
type:
- integer
- 'null'
format: int64
consumer_job_name:
type:
- string
- 'null'
producer_job_id:
type:
- integer
- 'null'
format: int64
producer_job_name:
type:
- string
- 'null'
user_data_id:
type: integer
format: int64
user_data_name:
type: string
workflow_id:
type: integer
format: int64
JobsModel:
type: object
required:
- jobs
properties:
jobs:
type: array
items:
$ref: '#/components/schemas/JobModel'
ListAccessGroupsResponse:
type: object
required:
- items
- offset
- limit
- total_count
- has_more
properties:
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/AccessGroupModel'
limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListComputeNodesResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/ComputeNodeModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListEventsResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/EventModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListFailureHandlersResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/FailureHandlerModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListFilesResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/FileModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListJobDependenciesResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/JobDependencyModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListJobFileRelationshipsResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/JobFileRelationshipModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListJobIdsResponse:
type: object
required:
- job_ids
- count
properties:
count:
type: integer
format: int64
job_ids:
type: array
items:
type: integer
format: int64
ListJobUserDataRelationshipsResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/JobUserDataRelationshipModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListJobsResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/JobModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListLocalSchedulersResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/LocalSchedulerModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListMissingUserDataResponse:
type: object
required:
- user_data
properties:
user_data:
type: array
items:
type: integer
format: int64
ListRequiredExistingFilesResponse:
type: object
required:
- files
properties:
files:
type: array
items:
type: integer
format: int64
ListResourceRequirementsResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/ResourceRequirementsModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListResultsResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/ResultModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListRoCrateEntitiesResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/RoCrateEntityModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListScheduledComputeNodesResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/ScheduledComputeNodesModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListSlurmSchedulersResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/SlurmSchedulerModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListSlurmStatsResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/SlurmStatsModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListUserDataResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/UserDataModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListUserGroupMembershipsResponse:
type: object
required:
- items
- offset
- limit
- total_count
- has_more
properties:
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/UserGroupMembershipModel'
limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
ListWorkflowsResponse:
type: object
required:
- items
- offset
- max_limit
- count
- total_count
- has_more
properties:
count:
type: integer
format: int64
has_more:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/WorkflowModel'
max_limit:
type: integer
format: int64
offset:
type: integer
format: int64
total_count:
type: integer
format: int64
LocalSchedulerModel:
type: object
required:
- workflow_id
properties:
id:
type:
- integer
- 'null'
format: int64
memory:
type:
- string
- 'null'
name:
type:
- string
- 'null'
num_cpus:
type:
- integer
- 'null'
format: int64
workflow_id:
type: integer
format: int64
MessageResponse:
type: object
required:
- message
properties:
message:
type: string
PingResponse:
type: object
required:
- status
properties:
status:
type: string
ProcessChangedJobInputsResponse:
type: object
required:
- reinitialized_jobs
properties:
reinitialized_jobs:
type: array
items:
type: string
ReloadAuthResponse:
type: object
required:
- message
- user_count
properties:
message:
type: string
user_count:
type: integer
format: int64
RemoteWorkerModel:
type: object
required:
- worker
- workflow_id
properties:
worker:
type: string
workflow_id:
type: integer
format: int64
ResetJobStatusResponse:
type: object
required:
- workflow_id
- updated_count
- status
properties:
reset_type:
type:
- string
- 'null'
status:
type: string
updated_count:
type: integer
format: int64
workflow_id:
type: integer
format: int64
ResourceRequirementsModel:
type: object
required:
- workflow_id
- name
properties:
id:
type:
- integer
- 'null'
format: int64
memory:
type: string
default: 1m
name:
type: string
num_cpus:
type: integer
format: int64
default: 1
num_gpus:
type: integer
format: int64
default: 0
num_nodes:
type: integer
format: int64
default: 1
runtime:
type: string
default: PT1M
workflow_id:
type: integer
format: int64
ResultModel:
type: object
required:
- job_id
- workflow_id
- run_id
- compute_node_id
- return_code
- exec_time_minutes
- completion_time
- status
properties:
attempt_id:
type:
- integer
- 'null'
format: int64
avg_cpu_percent:
type:
- number
- 'null'
format: double
avg_memory_bytes:
type:
- integer
- 'null'
format: int64
completion_time:
type: string
compute_node_id:
type: integer
format: int64
exec_time_minutes:
type: number
format: double
id:
type:
- integer
- 'null'
format: int64
job_id:
type: integer
format: int64
peak_cpu_percent:
type:
- number
- 'null'
format: double
peak_memory_bytes:
type:
- integer
- 'null'
format: int64
return_code:
type: integer
format: int64
run_id:
type: integer
format: int64
status:
$ref: '#/components/schemas/JobStatus'
workflow_id:
type: integer
format: int64
RoCrateEntityModel:
type: object
required:
- workflow_id
- entity_id
- entity_type
- metadata
properties:
entity_id:
type: string
entity_type:
type: string
file_id:
type:
- integer
- 'null'
format: int64
id:
type:
- integer
- 'null'
format: int64
metadata:
type: string
workflow_id:
type: integer
format: int64
ScheduledComputeNodesModel:
type: object
required:
- workflow_id
- scheduler_id
- scheduler_config_id
- scheduler_type
- status
properties:
id:
type:
- integer
- 'null'
format: int64
scheduler_config_id:
type: integer
format: int64
scheduler_id:
type: integer
format: int64
scheduler_type:
type: string
status:
type: string
workflow_id:
type: integer
format: int64
SlurmSchedulerModel:
type: object
required:
- workflow_id
- account
- nodes
- walltime
properties:
account:
type: string
extra:
type:
- string
- 'null'
gres:
type:
- string
- 'null'
id:
type:
- integer
- 'null'
format: int64
mem:
type:
- string
- 'null'
name:
type:
- string
- 'null'
nodes:
type: integer
format: int64
ntasks_per_node:
type:
- integer
- 'null'
format: int64
partition:
type:
- string
- 'null'
qos:
type:
- string
- 'null'
tmp:
type:
- string
- 'null'
walltime:
type: string
workflow_id:
type: integer
format: int64
SlurmStatsModel:
type: object
required:
- workflow_id
- job_id
- run_id
- attempt_id
properties:
attempt_id:
type: integer
format: int64
ave_cpu_seconds:
type:
- number
- 'null'
format: double
id:
type:
- integer
- 'null'
format: int64
job_id:
type: integer
format: int64
max_disk_read_bytes:
type:
- integer
- 'null'
format: int64
max_disk_write_bytes:
type:
- integer
- 'null'
format: int64
max_rss_bytes:
type:
- integer
- 'null'
format: int64
max_vm_size_bytes:
type:
- integer
- 'null'
format: int64
node_list:
type:
- string
- 'null'
run_id:
type: integer
format: int64
slurm_job_id:
type:
- string
- 'null'
workflow_id:
type: integer
format: int64
UserDataModel:
type: object
required:
- workflow_id
- name
properties:
data: {}
id:
type:
- integer
- 'null'
format: int64
is_ephemeral:
type:
- boolean
- 'null'
name:
type: string
workflow_id:
type: integer
format: int64
UserGroupMembershipModel:
type: object
required:
- user_name
- group_id
- role
properties:
created_at:
type:
- string
- 'null'
group_id:
type: integer
format: int64
id:
type:
- integer
- 'null'
format: int64
role:
type: string
user_name:
type: string
VersionResponse:
type: object
required:
- version
- api_version
properties:
api_version:
type: string
git_hash:
type:
- string
- 'null'
version:
type: string
WorkflowAccessGroupModel:
type: object
required:
- workflow_id
- group_id
properties:
created_at:
type:
- string
- 'null'
group_id:
type: integer
format: int64
workflow_id:
type: integer
format: int64
WorkflowActionModel:
type: object
required:
- workflow_id
- trigger_type
- action_type
- action_config
properties:
action_config: {}
action_type:
type: string
executed:
type: boolean
default: false
executed_at:
type:
- string
- 'null'
executed_by:
type:
- integer
- 'null'
format: int64
id:
type:
- integer
- 'null'
format: int64
is_recovery:
type: boolean
default: false
job_ids:
type:
- array
- 'null'
items:
type: integer
format: int64
persistent:
type: boolean
default: false
required_triggers:
type: integer
format: int64
default: 1
trigger_count:
type: integer
format: int64
default: 0
trigger_type:
type: string
workflow_id:
type: integer
format: int64
WorkflowModel:
type: object
required:
- name
- user
properties:
compute_node_expiration_buffer_seconds:
type:
- integer
- 'null'
format: int64
compute_node_ignore_workflow_completion:
type:
- boolean
- 'null'
compute_node_min_time_for_new_jobs_seconds:
type:
- integer
- 'null'
format: int64
compute_node_wait_for_healthy_database_minutes:
type:
- integer
- 'null'
format: int64
compute_node_wait_for_new_jobs_seconds:
type:
- integer
- 'null'
format: int64
description:
type:
- string
- 'null'
enable_ro_crate:
type:
- boolean
- 'null'
execution_config:
type:
- string
- 'null'
id:
type:
- integer
- 'null'
format: int64
metadata:
type:
- string
- 'null'
name:
type: string
project:
type:
- string
- 'null'
resource_monitor_config:
type:
- string
- 'null'
slurm_config:
type:
- string
- 'null'
slurm_defaults:
type:
- string
- 'null'
status_id:
type:
- integer
- 'null'
format: int64
timestamp:
type:
- string
- 'null'
use_pending_failed:
type:
- boolean
- 'null'
user:
type: string
WorkflowStatusModel:
type: object
required:
- is_canceled
- run_id
properties:
has_detected_need_to_run_completion_script:
type:
- boolean
- 'null'
id:
type:
- integer
- 'null'
format: int64
is_archived:
type:
- boolean
- 'null'
is_canceled:
type: boolean
run_id:
type: integer
format: int64