Get batch information

GET

Retrieve information about a batch.

Path parameters

batch_idintegerRequired

The batch ID.

Headers

IB-ContextstringOptional

Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. See Authorization and context identification for details.

Response

This endpoint returns an object.
idinteger

The batch ID.

namestring

The batch name.

workspacestringOptional

The name of the workspace in which the batch exists.

mount_pointstringOptional

The name of the connected drive in which the batch is stored.

repo_ownerstringOptional

The owner of the workspace (also known as the repo) in which the batch exists.

batch_ownerstringOptional

Username of the user that created the batch.

created_at_mslongOptional

When the batch was created, in Unix time.

updated_at_mslongOptional

When the batch was last updated, in Unix time.

path_suffixstringOptional

Batch path suffix from the mount point.