CLI: Job Categories



On This Page

 


The CLI references “skysync.” This is expected.

Job Categories

In the following examples, the authentication parameters are provided within the configuration file.  See the authentication section for more information.

List Job Categories

parameter

description

required

default

parameter

description

required

default

search, q

Search text

optional

 

offset

Search offset

optional

0

limit

Search page size

optional

20

 

Example

Command

skysync-cli job-categories list

Example results

ID Name -1 Default 1 Maintenance

Example results (JSON)

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

 

Show a Job Category

parameter

description

required

parameter

description

required

id

ID of the job category to be shown

required

Example

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command with variables

Command with example values

Example results

Example results (JSON)

 

Create a Job Category

parameter

description

type

option 1

option 2

parameter

description

type

option 1

option 2

name

Job category name

string

required

 

Example with parameters

command with variables

Command with example values

Expected result

Expected result (JSON)

 

Delete a Job Category

parameter

description

required

parameter

description

required

id

ID of the job category to be deleted

required

Example

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.

Command with variables

Command with example values

Expected result

Error result

 

 

DryvIQ Migrate Version: 5.6.1.4136
Release Date: February 9, 2024