CLI: Job Categories
- Lindsey Byers (Deactivated)
- Andrea Harvey
On This Page
- 1 Job Categories
- 1.1 List Job Categories
- 1.1.1 Example
- 1.2 Show a Job Category
- 1.2.1 Example
- 1.3 Create a Job Category
- 1.3.1 Example with parameters
- 1.4 Delete a Job Category
- 1.4.1 Example
- 1.1 List Job Categories
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 |
|---|---|---|---|
search, q | Search text | optional |
|
offset | Search offset | optional | 0 |
limit | Search page size | optional | 20 |
Example
Command
skysync-cli job-categories listExample results
ID Name
-1 Default
1 MaintenanceExample results (JSON)
[
{
"id": -1,
"name": "Default"
},
{
"id": 1,
"name": "Maintenance"
}
]
Show a Job Category
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 |
|---|---|---|---|---|
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 |
|---|---|---|
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