fredcli batch get-status

Retrieve the status of a given batch.

Synopsis

fredcli batch get-status

Gets the current status of a batch.

fredcli batch get-status [options] BATCH_ID

Options

--output <output>

The output format for this function.

Default

text

Options

text | json | yaml

-v, --verbose

Show the detail view of the batch status.

Default

False

Arguments

BATCH_ID

Required argument

Description

Display the status for the given batch. This shows when the batch was submitted and when the current status was assigned. The --output option specifies the format for this command: one of text, json, or yaml.

If -v or --verbose is provided, then additional status information is shown.

Examples

The following command retrieves the status of an in-progress batch.

$ fredcli batch get-status 7bd3ede8a23d474b82c021a7e9cf67eb
Labels:
Submitted by:  fred
Submitted on:  2021-07-07 17:59:50.652000 GMT+0000

Status set on:  2021-07-07 17:59:50.652000 GMT+0000
Status:  Submitted

Tasks:
|   ID |    Status |                       Status set on |
|------|-----------|-------------------------------------|
|   65 | Submitted | 2021-07-07 17:59:50.652000 GMT+0000 |

As another example, the same status is shown with yaml output and verbose mode.

$ fredcli batch get-status 7bd3ede8a23d474b82c021a7e9cf67eb --verbose --output yaml
created: '2021-07-07T17:59:50.652Z'
createdBy: fred
guid: 5dfb38f9e4014490b8f9f718a58e23fc
labels: []
logEntry: ''
statusCreated: 2021-07-07 17:59:50.652000 GMT+0000
status: Submitted
statusCreated: '2021-07-07T17:59:50.652Z'
createdBy: fred
created: 2021-07-07 17:59:50.652000 GMT+0000
tasks:
- id: 65
  status: Submitted
  statusCreated: '2021-07-07T17:59:50.652Z'