Batches API v1Alpha

Get a job group in a batch

Changed on Apr 16, 2025

Get a job group in a batch by ID.

get/api/v1alpha/batches/{batch_id}/job-groups/{job_group_id}

Request

Base URL: {{ base_url }}
URL: {{ base_url }}/api/v1alpha/batches/{batch_id}/job-groups/{job_group_id}
Auth: none declared

Path parameters

batch_idnumber required

The ID of the batch.

job_group_idnumber required

The ID of the job group.

Response

Successfully retrieved the job group in the batch.

batch_idinteger

ID of the batch this job group belongs to

job_group_idinteger

The job group ID

parent_job_group_idinteger nullable

ID of the parent job group

state'running' | 'complete' | 'cancelled'

Current state of the job group

completeboolean

Whether the job group is complete

n_jobsinteger

Total number of jobs in the group

n_completedinteger

Number of completed jobs

n_succeededinteger

Number of succeeded jobs

n_failedinteger

Number of failed jobs

n_cancelledinteger

Number of cancelled jobs

time_createdstring date-time

When the job group was created

attributesobject

Key-value pairs of attributes for the job group

Changes

Apr 16, 2025afa3b61d1d09 Revision changes
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Jan 14, 2025559a91071cc1 Revision changes
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status

Operation history