GuidesAPI ReferenceRelease NotesTutorials
Guides

Tasks

Suggest Edits

Overview

Use the following commands to manage tasks via the Seven Bridges Command Line Interface.

tasks create

Create a new task.

The project_id takes the form of {project_owner}/{project}, where {project_owner} is the username of the user who created the project and {project} is not the project's full given name, but its short name.

The app_id is formatted as: {project_owner}/{project}/{app_short_name}/{revision_number}.

You can set the value for inputs_file if you want to describe the inputs in a JSON file. If you do not set the value, the command expects inputs description from stdin.

Similarly, if you are performing a batch task, you can set the value for batch_criteria_file if you want to describe batch criteria in a JSON file. If you do not set the value, the command expects a batch criteria description from stdin.

Usage:
  sb tasks create [--name <name_value>] [--description <description_value>] --project_id <project_id_value> --app_id <app_id_value> --inputs_file <inputs_file_value> [--batch_by <batch_by_value>] [--batch_input <batch_input_value>] [--run_now] [flags]

Flags:
      --name string          The name of the task.
      --description string   Human-readable description of the task.
      --project_id string    The project in which you want to create the task.
      --app_id string        The id of the app you want to run.
      --inputs_file string   The file describing the input object. If omitted, input from stdin is expected.
      --batch_by string      Filename for file that contains a specification of batch criteria.
      --batch_input string   The ID of the input on which you wish to batch.
      --run_now              Set to true to run a task immediately upon creation.
  -h, --help                 help for create

tasks list

Get a list of tasks that you can access.

Usage:
  sb tasks list [--status <status_value>] [--project <project_value>] [--parent <parent_value>] [flags]

Flags:
      --status string    List only tasks that have the specified status.
      --project string   List only tasks from the specified project.
      --parent string    List only child tasks from the specified task.
  -h, --help             help for list

tasks get

Get the details of the specified task.

Usage:
  sb tasks get <task_id> [--inputs_only] [flags]

Arguments:
      task_id   ID of the task.

Flags:
      --inputs_only   Get only inputs for the task (JSON output only).
  -h, --help          help for get

tasks update

Update task details.

You can set the value for inputs_file if you want to describe the inputs in a JSON file. If you do not set the value, the command expects an inputs description from stdin.

Similarly, if you are performing a batch task, you can set the value for batch_criteria_file if you want to describe batch criteria in a JSON file. If you do not set the value, the command expects a batch criteria description from stdin.

Usage:
  sb tasks update <task_id> [--name <name_value>] [--description <description_value>] [--inputs_file <inputs_file_value>] [--batch_by <batch_by_value>] [--batch_input <batch_input_value>] [flags]

Arguments:
      task_id   ID of the task.

Flags:
      --name string          The updated name for the task.
      --description string   Updated description of the task.
      --inputs_file string   Filename for file that contains a dictionary of input objects.
      --batch_by string      Filename for file that contains a specification of batch criteria.
      --batch_input string   The ID of the input on which you wish to batch.
  -h, --help                 help for update

tasks run

Run a specified task.

Usage:
  sb tasks run <task_id> [flags]

Arguments:
      task_id   ID of the task.

Flags:
  -h, --help   help for run

tasks abort

Abort the specified task. Only a task whose status is either "RUNNING" or "QUEUED" may be aborted.

Usage:
  sb tasks abort <task_id> [flags]

Arguments:
      task_id   ID of the task.

Flags:
  -h, --help   help for abort

Updated about 2 years ago