Overview

The CLI allows you to manage migration job categories. This includes retrieving a list of existing job categories, creating new categories, and deleting categories. The authentication parameters are provided within the configuration file in all examples. See CLI: Authentication for more information.

List Job Categories

Command

skysync-cli job-categories list

Example Results

ID Name
-1 Default
1  Maintenance

Example JSON Results

[
  {
    "id": -1,
    "name": "Default"
  },
  {
    "id": 1,
    "name": "Maintenance"
  }
]

Show a Job Category

Command With Variables

skysync-cli job-categories show {{id}}

Command With Example Variables

skysync-cli job-categories show 1

Example Results

ID   1
Name Maintenance

Example JSON Results

[
  {
    "id": 1,
    "name": "Maintenance"
  }
]

Create a Job Category

Command With Variables

skysync-cli job-categories add {{name}}

Command With Example Variables

skysync-cli job-categories add 'HR Department'

Expected Result

ID   2
Name HR Deparment

Expected JSON Result 

[
  {
    "id": 2,
    "name": "HR Department"
  }
]

Delete a Job Category

Command With Variables

skysync-cli job-categories delete {{id}}

Command With Example Variables

skysync-cli job-categories delete 2

Expected Result

The job category was deleted successfully.

Expected JSON Result 

The job category could not be deleted.