Complete Batch

PATCH

/api/v2/batches/{batch__id}/complete

Parameters

Path Parameters

batch__id

required

Batch Id

string format: uuid

Responses

200

Successful Response

NonPaginatedResponse[ProducedBatchWithPartialJobsResponse]

Represents a response with either a list of items or a single item in a single page.

Generic Parameters: - A (TypeVar): The type bound to this class, which can be a single BaseModel, a list of BaseModels, or None.

Usage: - To respond with an unpaginated list of FooResponse items from an API endpoint, ensure that your function returns NonPaginatedResponse[List[FooResponse]].

- To respond with a single `FooResponse` item from an API endpoint,
  make sure that your function returns `NonPaginatedResponse[FooResponse]`
  and that Python recognizes it.

object

data

ProducedBatchWithPartialJobsResponse

Response for a batch request which includes its jobs data but without the results.

This schema defines all the fields that can be publicly shared by the API.

object

id

required

Id

string format: uuid

parent_id

Parent Id

string format: uuid

status

required

BatchStatus

An enumeration.

string

Allowed values: PENDING RUNNING DONE CANCELED TIMED_OUT ERROR PAUSED

complete

required

Complete

boolean

open

required

Open

boolean

priority

required

Priority

integer

device_type

required

Device Type

string

user_id

required

User Id

string

project_id

required

Project Id

string format: uuid

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

sequence_builder

required

Sequence Builder

string

jobs_count

required

Jobs Count

integer

jobs_count_per_status

required

Jobs Count Per Status

object

tags

required

Tags

Array<string>

configuration

Configuration

object

webhook

Webhook

string

start_datetime

Start Datetime

string format: date-time

end_datetime

End Datetime

string format: date-time

jobs

Jobs

Array<object>

ProducedPartialJobResponse

Response to a request for a job.

This schema defines all the fields that can be publicly shared by the API and do not require significant computational resources. For example, ‘logs_links’ or ‘results link’.

object

id

required

Id

string format: uuid

parent_id

Parent Id

string format: uuid

status

required

JobStatus

An enumeration.

string

Allowed values: PENDING RUNNING DONE ERROR CANCELED

runs

required

Runs

integer

batch_id

required

Batch Id

string format: uuid

project_id

required

Project Id

string format: uuid

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

start_timestamp

Start Timestamp

string format: date-time

end_timestamp

End Timestamp

string format: date-time

variables

Variables

object

errors

Errors

Array<string>

progress

Progress

integer

<= 100

sequence

Sequence

string

creation_order

required

Creation Order

integer

slurm_job_id

Slurm Job Id

string

queue_priority

required

QueuePriority

Values represent the queue a value will be written to, each priority represents the order of preference batches will be executed. Queue priority is processed in a descending order: CRITICAL, HIGH, MEDIUM, LOW, FREE

string

Allowed values: CRITICAL HIGH MEDIUM LOW FREE

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string