All CLI Commands
This is a full list of available commands in cio.
cio classifier-entry
Interact with classifier entries
Options
-h, --help help for classifier-entry
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio classifier-entry archive -
Archive classifier entry - cio classifier-entry create - Create
classifier entry - cio classifier-entry delete - Delete
classifier entry - cio classifier-entry ls - List external
classifier entries - cio classifier-entry refresh -
Refresh classifier entry graph - cio classifier-entry unarchive -
Unarchive classifier entry - cio classifier-entry update - Update
classifier entry
cio classifier-entry archive
Archive classifier entry
cio classifier-entry archive [flags]
Options
--classifier-entry-id int Archive classifier entry which belong to the specified classifier entry ID
-h, --help help for archive
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio classifier-entry - Interact with
classifier entries
cio classifier-entry create
Create classifier entry
Synopsis
Create a classifier entry by providing its data with flags or on stdin
as json.
cio classifier-entry create [flags]
Examples
Simple classifier entry with only one property:
cio classifier-entry create --classifier-id=1 --data='{"Documenttype": "Special Document"}'
Classifier entry with an ID and name property:
cio classifier-entry create --classifier-id=3 --data='{"id": "1AC3", "name": "Factory plant"}'
On some versions of PowerShell you might need to escape double quotes:
cio classifier-entry create --classifier-id=24 --data='{\"customerName\": \"Test\"}'
More information about that here: https://ciople.nu/pwsh_args
Options
--classifier-id int Create a classifier entry which belongs to the classifier specified with this ID
--data string Data of the classifier entry. Flat JSON object where each property corresponds to a property of the classifier.
-h, --help help for create
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio classifier-entry - Interact with
classifier entries
cio classifier-entry delete
Delete classifier entry
cio classifier-entry delete [classifier-entry-id] [flags]
Options
--classifier-entry-id int The ID of the classifier entry to delete
-h, --help help for delete
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio classifier-entry - Interact with
classifier entries
cio classifier-entry ls
List external classifier entries
Synopsis
This command lists external classifier entries. To include archived
external classifier entries use --archived=include. To see external
classifiers use "cio classifier ls".
cio classifier-entry ls [flags]
Options
--archived string Filters the external classifier entries by 'archived' property. Allowed values are: (include | exclude | only) (default "exclude")
--classifier-id int Only list classifier entries which belong to the classifier specified with this ID
-h, --help help for ls
--key string Filters the external classifiers entries by key. Can only be used in combination with the --value flag.
--page-index int The page index used for pagination, starts with 0.
--page-size string Limit the maximum of returned entities. Can be between 20 and 200.
--value string Filters the external classifiers entries by value. Can only be used in combination with the --key flag.
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio classifier-entry - Interact with
classifier entries
cio classifier-entry refresh
Refresh classifier entry graph
cio classifier-entry refresh [flags]
Options
-h, --help help for refresh
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio classifier-entry - Interact with
classifier entries
cio classifier-entry unarchive
Unarchive classifier entry
cio classifier-entry unarchive [flags]
Options
--classifier-entry-id int Unarchive classifier entry which belong to the specified classifier entry ID
-h, --help help for unarchive
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio classifier-entry - Interact with
classifier entries
cio classifier-entry update
Update classifier entry
Synopsis
Update a classifier entry by providing its data with flags or on stdin
as json.
cio classifier-entry update [classifier-entry-id] [flags]
Examples
Simple classifier entry with only one property:
cio classifier-entry update --classifier-entry-id=32 --data='{"Documenttype": "Other Special Document"}'
Classifier entry with an ID and name property:
cio classifier-entry update --classifier-entry-id=42 --data='{"id": "1AC3", "name": "Manufacturing plant"}'
On some versions of PowerShell you might need to escape double quotes:
cio classifier-entry update --classifier-entry-id=66 --data='{\"customerName\": \"Example\"}'
More information about that here: https://ciople.nu/pwsh_args
Options
--classifier-entry-id int ID of the classifier entry to update
--data string Data of the classifier entry. Flat JSON object where each property corresponds to a property of the classifier.
-h, --help help for update
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio classifier-entry - Interact with
classifier entries
cio classifier-filter
Interact with classifier filters
Options
-h, --help help for classifier-filter
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio classifier-filter ls - List all
classifier filters
cio classifier-filter ls
List all classifier filters
cio classifier-filter ls [flags]
Options
-a, --all Include archived filters
-h, --help help for ls
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio classifier-filter - Interact with
classifier filters
cio classifier
Interact with classifiers
Options
-h, --help help for classifier
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio classifier archive - Archive
classifier - cio classifier get - Get single classifier
with ID - cio classifier ls - List external classifiers
- cio classifier unarchive - Unarchive
classifier
cio classifier archive
Archive classifier
cio classifier archive [flags]
Options
--classifier-id int Archive classifier which belong to the specified classifier ID
-h, --help help for archive
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio classifier - Interact with classifiers
cio classifier get
Get single classifier with ID
cio classifier get [classifier-id] [flags]
Options
--classifier-id int The ID of the classifier
-h, --help help for get
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio classifier - Interact with classifiers
cio classifier ls
List external classifiers
Synopsis
This command lists external classifiers. To include archived external
classifiers use --archived=include. To see external classifier entries
use "cio classifier-entry ls."
cio classifier ls [flags]
Options
--archived string Filters the external classifiers by 'archived' property. Allowed values are: (include | exclude | only) (default "exclude")
-h, --help help for ls
--include-pivot Include pivot classifiers
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio classifier - Interact with classifiers
cio classifier unarchive
Unarchive classifier
cio classifier unarchive [flags]
Options
--classifier-id int Unarchive classifier which belong to the specified classifier ID
-h, --help help for unarchive
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio classifier - Interact with classifiers
cio gimage
Interact with global images
Options
-h, --help help for gimage
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio gimage add - Attach entities to global image
- cio gimage create - Create global image
- cio gimage get - Get global image
- cio gimage ls - List global images
- cio gimage remove - Remove entities from
global image - cio gimage replace - Replace global image
file
cio gimage add
Attach entities to global image
Options
-h, --help help for add
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gimage - Interact with global images
- cio gimage add
classifier-entry - Add classifier
entry
cio gimage add classifier-entry
Add classifier entry
Synopsis
Add classifier entry to global image. In case any of the global image or
external classifier entry ids doesn't exist, the command will
automatically ignore it not resulting in an error
cio gimage add classifier-entry [flags]
Options
--classifier-entry-ids ints The IDs of the classifier entry (required)
--gimage-id int The ID of the global image (required)
-h, --help help for classifier-entry
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gimage add - Attach entities to global image
cio gimage create
Create global image
Synopsis
Create a global image by uploading an image file. Returns the metadata
of the new global image. If a language is provided with --lang, the
filename will be used as the name of the image in this language
otherwise the default language is used.
cio gimage create [flags]
Options
-f, --file string File to upload (required)
-h, --help help for create
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gimage - Interact with global images
cio gimage get
Get global image
Synopsis
Get command allows to fetch data for a global image.
Options
-h, --help help for get
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gimage - Interact with global images
- cio gimage get
classifier-entry - Get classifier
entry
cio gimage get classifier-entry
Get classifier entry
Synopsis
The classifier-entry command allows to retrieve classifier entries
attached to the global image.
cio gimage get classifier-entry [flags]
Options
--gimage-id int The ID of the global image (required)
-h, --help help for classifier-entry
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gimage get - Get global image
cio gimage ls
List global images
cio gimage ls [flags]
Options
-h, --help help for ls
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gimage - Interact with global images
cio gimage remove
Remove entities from global image
Options
-h, --help help for remove
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gimage - Interact with global images
- cio gimage remove
classifier-entry - Remove
classifier entry
cio gimage remove classifier-entry
Remove classifier entry
Synopsis
Remove classifier entry from global image. In case any of the global
image or external classifier entry ids doesn't exist, the command will
automatically ignore it not resulting in an error
cio gimage remove classifier-entry [flags]
Options
--classifier-entry-ids ints The IDs of the classifier entry (required)
--gimage-id int The ID of the global image (required)
-h, --help help for classifier-entry
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gimage remove - Remove entities from
global image
cio gimage replace
Replace global image file
Synopsis
Replace the file of a global image by uploading a new one. Returns the
updated global image object. The image to update is identified by its
[gimage-id]. The name is not changed. Setting a --lang does not have
any effect.
cio gimage replace [gimage-id] [flags]
Options
-f, --file string File to upload (required)
-h, --help help for replace
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gimage - Interact with global images
cio gpart
Interact with global parts
Options
-h, --help help for gpart
-l, --lang string Language to use. If not set the servers
default is used.
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio gpart add - Attach entities to global part
- cio gpart create - Create a global part by
providing its data with flags or on stdin as json. An image file can
be provided with the --file flag. - cio gpart delete - Delete the global part
specified by [gpart-id]. - cio gpart get - Get command allows to fetch data
for a global parts. - cio gpart ls - List all global part objects with
metadata. - cio gpart remove - Remove entities from global
part - cio gpart replace-image - Replace image
file of global part - cio gpart update - Update the key or the
partcategory of a global part.
cio gpart add
Attach entities to global part
Options
-h, --help help for add
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used.
SEE ALSO
- cio gpart - Interact with global parts
- cio gpart add classifier-entry -
classifier-entry command allows to add classifier entries to global
part.
cio gpart add classifier-entry
classifier-entry command allows to add classifier entries to global
part.
Synopsis
Add classifier entry to global part. In case any of the global part or
external classifier entry ids doesn't exist, the command will
automatically ignore it not resulting in an error
cio gpart add classifier-entry [flags]
Options
--classifier-entry-ids ints The IDs of the classifier entry (required)
--gpart-id int The ID of the global part (required)
-h, --help help for classifier-entry
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used.
SEE ALSO
- cio gpart add - Attach entities to global part
cio gpart create
Create a global part by providing its data with flags or on stdin as
json. An image file can be provided with the --file flag.
cio gpart create [flags]
Options
-c, --category-id int Id of the category the part should be assigned. If none is provided no category is assigned, set this to 0 to remove existing category. (default -1)
--custom-id string Customer selected id
-f, --file string Image file. Not required.
-h, --help help for create
-k, --key string Name of the part
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used.
SEE ALSO
- cio gpart - Interact with global parts
cio gpart delete
Delete the global part specified by [gpart-id].
cio gpart delete [gpart-id] [flags]
Options
-h, --help help for delete
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used.
SEE ALSO
- cio gpart - Interact with global parts
cio gpart get
Get command allows to fetch data for a global parts.
Options
-h, --help help for get
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used.
SEE ALSO
- cio gpart - Interact with global parts
- cio gpart get classifier-entry -
The classifier-entry command allows to retrieve classifier entries
attached to the global part.
cio gpart get classifier-entry
The classifier-entry command allows to retrieve classifier entries
attached to the global part.
cio gpart get classifier-entry [flags]
Options
--gpart-id int The ID of the global part (required)
-h, --help help for classifier-entry
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used.
SEE ALSO
- cio gpart get - Get command allows to fetch data
for a global parts.
cio gpart ls
List all global part objects with metadata.
cio gpart ls [flags]
Options
-h, --help help for ls
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used.
SEE ALSO
- cio gpart - Interact with global parts
cio gpart remove
Remove entities from global part
Options
-h, --help help for remove
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used.
SEE ALSO
- cio gpart - Interact with global parts
- cio gpart remove
classifier-entry - The
classifier-entry command allows to remove classifier entries from
global part.
cio gpart remove classifier-entry
The classifier-entry command allows to remove classifier entries from
global part.
Synopsis
Remove classifier entry from global part. In case any of the global part
or external classifier entry ids doesn't exist, the command will
automatically ignore it not resulting in an error
cio gpart remove classifier-entry [flags]
Options
--classifier-entry-ids ints The IDs of the classifier entry (required)
--gpart-id int The ID of the global part
-h, --help help for classifier-entry
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used.
SEE ALSO
- cio gpart remove - Remove entities from global
part
cio gpart replace-image
Replace image file of global part
cio gpart replace-image [flags]
Options
--file string File name or path of the file
--gpart-id int The ID of the global part (required)
-h, --help help for replace-image
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used.
SEE ALSO
- cio gpart - Interact with global parts
cio gpart update
Update the key or the partcategory of a global part.
cio gpart update [gpart-id] [flags]
Options
-c, --category-id int Id of the category the part should be assigned. If none is provided no category is assigned, set this to 0 to remove existing category. (default -1)
--custom-id string Customer selected id
-h, --help help for update
-k, --key string Name of the part
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used.
SEE ALSO
- cio gpart - Interact with global parts
cio gpdf
Interact with global pdfs
Options
-h, --help help for gpdf
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio gpdf add - Attach entities to global pdf
- cio gpdf create - Create global pdf
- cio gpdf get - Get command allows to fetch data for
a global pdf. - cio gpdf ls - List all global pdf objects with
metadata. - cio gpdf remove - Remove entities from global
pdf - cio gpdf replace - Replace global pdf file
- cio gpdf update - Update the name of global pdf.
Returns the updated global pdf.
cio gpdf add
Attach entities to global pdf
Options
-h, --help help for add
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gpdf - Interact with global pdfs
- cio gpdf add classifier-entry -
The classifier-entry command allows to add classifier entries to
global pdf.
cio gpdf add classifier-entry
The classifier-entry command allows to add classifier entries to global
pdf.
Synopsis
Add classifier entry to global pdf. In case any of the global pdf or
external classifier entry ids doesn't exist, the command will
automatically ignore it not resulting in an error
cio gpdf add classifier-entry [flags]
Options
--classifier-entry-ids ints The IDs of the classifier entry (required)
--gpdf-id int The ID of the global pdf (required)
-h, --help help for classifier-entry
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gpdf add - Attach entities to global pdf
cio gpdf create
Create global pdf
Synopsis
Create a global pdf by uploading a pdf file. Returns the metadata of the
new global pdf. If a language is provided with --lang, the filename will
be used as the name of the pdf in this language otherwise the default
language is used.
cio gpdf create [flags]
Options
-f, --file string File to upload (required)
-h, --help help for create
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gpdf - Interact with global pdfs
cio gpdf get
Get command allows to fetch data for a global pdf.
Options
-h, --help help for get
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gpdf - Interact with global pdfs
- cio gpdf get classifier-entry -
The classifier-entry command allows to retrieve classifier entries
attached to global pdf.
cio gpdf get classifier-entry
The classifier-entry command allows to retrieve classifier entries
attached to global pdf.
cio gpdf get classifier-entry [flags]
Options
--gpdf-id int The ID of the global pdf (required)
-h, --help help for classifier-entry
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gpdf get - Get command allows to fetch data for
a global pdf.
cio gpdf ls
List all global pdf objects with metadata.
cio gpdf ls [flags]
Options
-h, --help help for ls
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gpdf - Interact with global pdfs
cio gpdf remove
Remove entities from global pdf
Options
-h, --help help for remove
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gpdf - Interact with global pdfs
- cio gpdf remove
classifier-entry - The
classifier-entry command allows to remove classifier entries from
global pdf.
cio gpdf remove classifier-entry
The classifier-entry command allows to remove classifier entries from
global pdf.
Synopsis
Remove classifier entry from global pdf. In case any of the global pdf
or external classifier entry ids doesn't exist, the command will
automatically ignore it not resulting in an error
cio gpdf remove classifier-entry [flags]
Options
--classifier-entry-ids ints The IDs of the classifier entry (required)
--gpdf-id int The ID of the global pdf (required)
-h, --help help for classifier-entry
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gpdf remove - Remove entities from global
pdf
cio gpdf replace
Replace global pdf file
Synopsis
Replace the file of a global pdf by uploading a new one. Returns the
updated global pdf object. The pdf to update is identified by its
[gpdf-id]. The name is not changed. Setting a --lang does not have any
effect.
cio gpdf replace [gpdf-id] [flags]
Options
-f, --file string File to upload (required)
-h, --help help for replace
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gpdf - Interact with global pdfs
cio gpdf update
Update the name of global pdf. Returns the updated global pdf.
cio gpdf update [gpdf-id] [flags]
Options
-h, --help help for update
-n, --name string Name of the global pdf (required)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gpdf - Interact with global pdfs
cio group
Interact with groups
Options
-h, --help help for group
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio group add - Add users to group
- cio group archive - Archive groups
- cio group delete - Delete groups
- cio group get - Get group by ID
- cio group ls - List all groups
- cio group remove - Remove users from group
- cio group unarchive - Unarchive groups
- cio group update - Updates the name or
description of a group. Returns the updated group.
cio group add
Add users to group
cio group add [flags]
Options
--group-id int The ID of the group (required)
-h, --help help for add
--user-ids ints Add users to group that belong to the specified user IDs
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio group - Interact with groups
cio group archive
Archive groups
cio group archive [flags]
Options
--group-ids ints Archive groups which belong to the specified group IDs
-h, --help help for archive
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio group - Interact with groups
cio group delete
Delete groups
cio group delete [flags]
Options
--group-ids ints Delete groups with the specified group IDs
-h, --help help for delete
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio group - Interact with groups
cio group get
Get group by ID
cio group get [group-id] [flags]
Options
--group-id int The ID of the group
-h, --help help for get
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio group - Interact with groups
cio group ls
List all groups
cio group ls [flags]
Options
-h, --help help for ls
--page-index int The page index used for pagination, starts with 0. (default: "0")
--page-size string Limit the maximum of returned entities. Can be between 20 and 200. If you want to fetch all entries you can use "all". (default "100")
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio group - Interact with groups
cio group remove
Remove users from group
cio group remove [flags]
Options
--group-id int The ID of the group (required)
-h, --help help for remove
--user-ids ints Remove users from group which belong to the specified user IDs
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio group - Interact with groups
cio group unarchive
Unarchive groups
cio group unarchive [flags]
Options
--group-ids ints Unarchive groups which belong to the specified group IDs
-h, --help help for unarchive
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio group - Interact with groups
cio group update
Updates the name or description of a group. Returns the updated group.
cio group update [group-id] [flags]
Options
--description string Description of the group
--group-id int The ID of the group
-h, --help help for update
--name string Name of the group
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio group - Interact with groups
cio gvideo
Interact with global videos
Options
-h, --help help for gvideo
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio gvideo add - Attach entities to global video
- cio gvideo create - Create global video
- cio gvideo get - Get command allows to fetch data
for a global video. - cio gvideo ls - List global videos
- cio gvideo remove - Remove entities from
global video - cio gvideo replace - Replace global video
file
cio gvideo add
Attach entities to global video
Options
-h, --help help for add
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gvideo - Interact with global videos
- cio gvideo add
classifier-entry - The
classifier-entry command allows to add classifier entries to global
video.
cio gvideo add classifier-entry
The classifier-entry command allows to add classifier entries to global
video.
Synopsis
Add classifier entry to global video. In case any of the global video or
external classifier entry ids doesn't exist, the command will
automatically ignore it not resulting in an error
cio gvideo add classifier-entry [flags]
Options
--classifier-entry-ids ints The IDs of the classifier entry (required)
--gvideo-id int The ID of the global video (required)
-h, --help help for classifier-entry
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gvideo add - Attach entities to global video
cio gvideo create
Create global video
Synopsis
Create a global video by uploading an video file. Returns the metadata
of the new global video. If a language is provided with --lang, the
filename will be used as the name of the video in this language
otherwise the default language is used.
cio gvideo create [flags]
Options
-f, --file string File to upload (required)
-h, --help help for create
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gvideo - Interact with global videos
cio gvideo get
Get command allows to fetch data for a global video.
Options
-h, --help help for get
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gvideo - Interact with global videos
- cio gvideo get
classifier-entry - The
classifier-entry command allows to retrieve classifier entries
attached to global video.
cio gvideo get classifier-entry
The classifier-entry command allows to retrieve classifier entries
attached to global video.
cio gvideo get classifier-entry [flags]
Options
--gvideo-id int The ID of the global video (required)
-h, --help help for classifier-entry
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gvideo get - Get command allows to fetch data
for a global video.
cio gvideo ls
List global videos
cio gvideo ls [flags]
Options
-h, --help help for ls
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gvideo - Interact with global videos
cio gvideo remove
Remove entities from global video
Options
-h, --help help for remove
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gvideo - Interact with global videos
- cio gvideo remove
classifier-entry - The
classifier-entry command allows to remove classifier entries from
global video.
cio gvideo remove classifier-entry
The classifier-entry command allows to remove classifier entries from
global video.
Synopsis
Remove classifier entry from global video. In case any of the global
video or external classifier entry ids doesn't exist, the command will
automatically ignore it not resulting in an error
cio gvideo remove classifier-entry [flags]
Options
--classifier-entry-ids ints The IDs of the classifier entry (required)
--gvideo-id int The ID of the global video (required)
-h, --help help for classifier-entry
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gvideo remove - Remove entities from
global video
cio gvideo replace
Replace global video file
Synopsis
Replace the file of a global video by uploading a new one. Returns the
updated global video object. The video to update is identified by its
[gvideo-id]. The name is not changed. Setting a --lang does not have
any effect.
cio gvideo replace [gvideo-id] [flags]
Options
-f, --file string File to upload (required)
-h, --help help for replace
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio gvideo - Interact with global videos
cio image-feedback
The image-feedback command allows to interact with image feedbacks
Options
-h, --help help for image-feedback
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio image-feedback download -
Download an existing image-feedback given by the image_feedback_id.
If no filepath is specified the file will be saved as .jpg in the
current directory.
cio image-feedback download
Download an existing image-feedback given by the image_feedback_id. If
no filepath is specified the file will be saved as .jpg in the current
directory.
cio image-feedback download [id] [flags]
Options
--filepath string Download filepath
-h, --help help for download
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio image-feedback - The image-feedback
command allows to interact with image feedbacks
cio instruction
Interact with instructions
Options
-h, --help help for instruction
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio instruction add - Add other objects to
instruction - cio instruction archive - Archive and
instruction - cio instruction create - Creates an
instruction. Name and language are required. - cio instruction duplicate - Duplicate
instruction - cio instruction get - Get instruction
- cio instruction ls - List instructions
- cio instruction publish - Publish an
instruction - cio instruction remove - Remove other
object from instructions - cio instruction update - Update
instruction - cio instruction visible - Set visibility
of an instruction
cio instruction add
Add other objects to instruction
Options
-h, --help help for add
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio instruction - Interact with instructions
- cio instruction add
classifier-entry - Add
classifier entry to instruction - cio instruction add
instruction - Add nested
instructions either with child instructions IDs or base instructions
IDs - cio instruction add language - Add
language to instruction
cio instruction add classifier-entry
Add classifier entry to instruction
Synopsis
Attach an external classifier entry to an instruction. The instruction
must be in the state "in-edit" or "new". In case any of the instruction
or external classifier entry ids doesn't exist, the command will
automatically ignore it not resulting in an error
cio instruction add classifier-entry [flags]
Options
--classifier-entry-ids ints The IDs of the classifier entry (required)
-h, --help help for classifier-entry
--instruction-id int The ID of the instruction (required)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio instruction add - Add other objects to
instruction
cio instruction add instruction
Add nested instructions either with child instructions IDs or base
instructions IDs
cio instruction add instruction [flags]
Options
--child-base-instruction-ids ints Base IDs of the nested instruction Usage: --child-base-instruction-ids=1,2,3
--child-instruction-ids ints The IDs of the nested instruction Usage: --child-instruction-ids=1,2,3
-h, --help help for instruction
--instruction-id int The ID of the instruction (required)
--position int Position of the nested instruction (required). Position 0 means the nested instruction is added at the start of the instruction
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio instruction add - Add other objects to
instruction
cio instruction add language
Add language to instruction
cio instruction add language [flags]
Options
-h, --help help for language
--instruction-id int The ID of the instruction (required)
--locale-code string The locale of the instruction (required)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio instruction add - Add other objects to
instruction
cio instruction archive
Archive and instruction
Synopsis
Archive an instruction and its history. This operation can not be
reversed. The instruction must be in the state "active" or "trash".
cio instruction archive [instruction-id] [flags]
Options
-h, --help help for archive
--instruction-id int The ID of the instruction
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio instruction - Interact with instructions
cio instruction create
Creates an instruction. Name and language are required.
cio instruction create [flags]
Options
--has-variables Specify if you want to have an instruction that contain variables
-h, --help help for create
--lang string The language of the instruction (required)
--name string The name of the instruction (required)
--progress-hidden Specify if progress for this instruction should be hidden by default
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio instruction - Interact with instructions
cio instruction duplicate
Duplicate instruction
Synopsis
Create an exact duplicate of an instruction. Returns the new
instruction.
cio instruction duplicate [instruction-id] [flags]
Options
-h, --help help for duplicate
--instruction-id int The ID of the instruction
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio instruction - Interact with instructions
cio instruction get
Get instruction
cio instruction get [instruction-id] [flags]
Options
-h, --help help for get
--include-steps Include steps, rows and interactions relevant information
--instruction-id int The ID of the instruction
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio instruction - Interact with instructions
- cio instruction get
classifier-entry - Retrieve
the list of external classifier entries attached to an instruction.
cio instruction get classifier-entry
Retrieve the list of external classifier entries attached to an
instruction.
cio instruction get classifier-entry [instruction-id] [flags]
Options
-h, --help help for classifier-entry
--instruction-id int The ID of the instruction
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio instruction get - Get instruction
cio instruction ls
List instructions
Synopsis
This command lists the latest version of each instruction. These can be
in the state: "new", "review-new", "active", "in-edit" and
"review-edit". To see all versions of all instructions use --all. This
will include older versions of the instructions. These instructions can
also be in state: "archived" and "trash".
cio instruction ls [flags]
Options
-a, --all Show all instructions
--classifier-entry-ids ints Filter list by classifier entry id. Usage: --classifier-entry-ids=1,2,3
-h, --help help for ls
--page-index int The page index used for pagination, starts with 0.
--page-size string Limit the maximum of returned entities. Can be between 20 and 200.
--search string Filter instructions by search term in instructions titel
--states strings Filter instructions by states. Is overwritten by --all flag. Usage: --states=in-edit,active
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio instruction - Interact with instructions
cio instruction publish
Publish an instruction
Synopsis
Publish an instruction. If the instruction is in the "new" or
"review-new" state, the command will skip the review and publish the
instruction in version 1.0. If the instruction is in the state
"in-edit", the instruction will be published with minor version bump
(e.g. X.3 to X.4). The published instruction will be returned to
standard out. If the instruction is in another state this command will
fail.
cio instruction publish [instruction-id] [flags]
Options
--change-notes string Customized change notes, if non provided automatic change notes will be set, does not work for state = "review-new"
-h, --help help for publish
--instruction-id int The ID of the instruction
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio instruction - Interact with instructions
cio instruction remove
Remove other object from instructions
Options
-h, --help help for remove
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio instruction - Interact with instructions
- cio instruction remove
classifier-entry - Remove
classifier entry from instruction - cio instruction remove
language - Remove language from
instruction
cio instruction remove classifier-entry
Remove classifier entry from instruction
Synopsis
Remove an external classifier entry from an instruction. The instruction
must be in the state "in-edit" or "new". In case any of the instruction
or external classifier entry ids doesn't exist, the command will
automatically ignore it not resulting in an error
cio instruction remove classifier-entry [flags]
Options
--classifier-entry-ids ints The IDs of the classifier entry (required)
-h, --help help for classifier-entry
--instruction-id int The ID of the instruction (required)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio instruction remove - Remove other
object from instructions
cio instruction remove language
Remove language from instruction
cio instruction remove language [flags]
Options
-h, --help help for language
--instruction-id int The ID of the instruction (required)
--locale-code string The locale of the instruction (required)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio instruction remove - Remove other
object from instructions
cio instruction update
Update instruction
Synopsis
Update the name and notes of an instruction. Returns the updated
instruction. If the instruction is not in an editable state, the
instruction version will be bumped. This command can read a JSON object
from standard in which will will be used for updating the instruction.
cio instruction update [instruction-id] [flags]
Options
--change-notes string Customized change notes, if non provided automatic change notes will be set
--confidentiality string Possible confidentialities are "public", "internal", "confidential" or "strictly-confidential", to remove confidentiality submit "null"
--has-variables Specify if you want to have an instruction that contain variables
-h, --help help for update
--instruction-id int The ID of the instruction
--name string New name of the instruction
--notes string New notes of the instruction
--progress-hidden Specify if progress for this instruction should be hidden by default
-p, --publish Try to publish instruction after change
--validity-date string Set a validity date for the instruction. It must be an ISO 8601 formated string (e.g: 2018-10-04T10:35:52.984Z) or "null"
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio instruction - Interact with instructions
cio instruction visible
Set visibility of an instruction
Synopsis
Set the visibility of an instruction. If the visibility is not specified
with --visible it will be set to true. The command will use the first
argument as the instruction id.
cio instruction visible [instruction-id] [flags]
Options
-h, --help help for visible
--instruction-id int The ID of the instruction
-v, --visible The visibility of the instruction (default true)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers
default is used. Does not always have an effect.
SEE ALSO
- cio instruction - Interact with instructions
cio interaction-tag
Interact with interaction tags
Options
-h, --help help for interaction-tag
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio interaction-tag ls - List interaction
tags
cio interaction-tag ls
List interaction tags
cio interaction-tag ls [flags]
Options
-h, --help help for ls
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio interaction-tag - Interact with
interaction tags
cio interaction-value
Interact with interaction values
Options
-h, --help help for interaction-value
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio interaction-value get - Fetch
related objects
cio interaction-value get
Fetch related objects
Options
-h, --help help for get
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio interaction-value - Interact with
interaction values - cio interaction-value get
by-persistent-interaction -
Retrieve the interaction values marked by the persistent interaction
ID. - cio interaction-value get
history - Get history
cio interaction-value get by-persistent-interaction
Retrieve the interaction values marked by the persistent interaction ID.
cio interaction-value get by-persistent-interaction [flags]
Options
-h, --help help for by-persistent-interaction
--persistent-interaction-id int The ID of the persistent interaction
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio interaction-value get - Fetch
related objects
cio interaction-value get history
Get history
cio interaction-value get history [interaction-value-id] [flags]
Options
-h, --help help for history
--interaction-value-id int The ID of the interaction value
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio interaction-value get - Fetch
related objects
cio interaction
Interact with interactions
Options
-h, --help help for interaction
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio interaction create - Creates an
interaction - cio interaction get - Get interaction
cio interaction create
Creates an interaction
cio interaction create [flags]
Options
--allow-additional-feedback Explanation option of the interaction
--can-be-not-applicable N/A option of the interaction
-h, --help help for create
--key string The key of the interaction (required)
--lang string The language of the interaction (required)
--mandatory Mandatory option of the interaction
--nominal-value string Nominal value of number feedback interaction
--row-id int The ID of the row
--show-nominal-value Visibility of the nominal value for the number interaction (default true)
--type string The type of the interaction (required).The type currently supported are "confirm" and "number"
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio interaction - Interact with interactions
cio interaction get
Get interaction
cio interaction get [flags]
Options
-h, --help help for get
--interaction-id int The ID of the interaction
-l, --lang string Language of the interaction
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio interaction - Interact with interactions
cio login
Log into a Operations1 instance. The provided information will be stored
in a config file.
cio login [flags]
Options
-h, --help help for login
--host string Operations1 instance hostname
-i, --insecure Connect to the server without validating the certificate
-t, --token string OAuth access token
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
cio lpdf
Interact with local pdfs
Options
-h, --help help for lpdf
-l, --lang string Language to use. If not set the servers default is used. Does not always have an effect.
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio lpdf create - Create local pdf
cio lpdf create
Create local pdf
Synopsis
Create a local pdf by uploading a pdf file. Returns the metadata of the
new local pdf. If a language is provided with --lang, the filename will
be used as the name of the pdf in this language otherwise the default
language is used.
cio lpdf create [flags]
Options
-f, --file string File to upload
--from-global int The global PDF ID from where to create the local PDF (required if no file is provided)
-h, --help help for create
--instruction-id int The ID of the related instruction
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers default is used. Does not always have an effect.
SEE ALSO
- cio lpdf - Interact with local pdfs
cio order-instruction-assignment
Interact with order instruction assignments
Options
-h, --help help for order-instruction-assignment
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio order-instruction-assignment
delete - Delete order
instruction assignment
cio order-instruction-assignment delete
Delete order instruction assignment
Synopsis
Remove instruction from order by deleting related order instruction
assignment. This can only happen when the related order is not yet
started.
cio order-instruction-assignment delete [order-instruction-assignment-id] [flags]
Options
-h, --help help for delete
--order-instruction-assignment-id int The ID of the order instruction assignment
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio
order-instruction-assignment -
Interact with order instruction assignments
cio order
Interact with orders
Options
-h, --help help for order
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio order add - Add other objects to orders
- cio order archive - Archive order
- cio order copy - Copy an order
- cio order create - Create order
- cio order delete - Delete a single order by ID.
- cio order get - Retrieve a single order by ID.
- cio order ls - List orders
- cio order publish - Publish order
- cio order remove - Remove other object from
orders - cio order scheduled - Interact with
scheduled orders - cio order unarchive - Unarchive order
- cio order update - Update order
cio order add
Add other objects to orders
Options
-h, --help help for add
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order - Interact with orders
- cio order add classifier-entry -
Attach a classifier entry to an order. The order must be in the
state 'in-edit'. - cio order add instruction - Add
instruction to order - cio order add variables - Add variables
to order
cio order add classifier-entry
Attach a classifier entry to an order. The order must be in the state
'in-edit'.
Synopsis
Add classifier entry to an order. In case any of the order or external
classifier entry ids doesn't exist, the command will automatically
ignore it not resulting in an error
cio order add classifier-entry [flags]
Options
--classifier-entry-ids ints The IDs of the classifier entry (required)
-h, --help help for classifier-entry
--order-id int The ID of the order (required)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order add - Add other objects to orders
cio order add instruction
Add instruction to order
Synopsis
Add an instruction to an order. The order must be in the state
"in-edit".
cio order add instruction [flags]
Options
-h, --help help for instruction
--instruction-id int The ID of the instruction (required)
--order-id int The ID of the order (required)
--position int On which position should instruction be added, if unspecified use last position (default -1)
--quantity int How often should the instruction be repeated (default 1)
--sub-assignee-id int User ID to whom the instruction should be assigned to
--use-latest-instruction Specify if the latest instruction should be used (default true)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order add - Add other objects to orders
cio order add variables
Add variables to order
Synopsis
Add a set of variables with order-specific information to an order. The
order must be in the state "in-edit". Data must be provided as JSON
Object via stdin.
cio order add variables [flags]
Options
-h, --help help for variables
--order-id int The ID of the order (required)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order add - Add other objects to orders
cio order archive
Archive order
cio order archive [flags]
Options
-h, --help help for archive
--order-id int The ID of the order
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order - Interact with orders
cio order copy
Copy an order
Synopsis
Duplicate an order into the "in-edit" or "not-started" state. The order
must not be in the "template" state. A startdate has to be set.
cio order copy [flags]
Options
--end-date string Set an end-date for the copied order, must be according to ISO 8601 (UTC), and seconds have to be given, e.g. 2019-07-23T13:10:11+02:00
-h, --help help for copy
--order-id int The ID of the order
--start-date string Set a start-date for the copied order, must be according to ISO 8601 (UTC), and seconds have to be given, e.g. 2019-07-23T13:10:11+02:00
--state string The state of the copied order. Possible values: "in-edit", "not-started" (default "not-started")
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order - Interact with orders
cio order create
Create order
Synopsis
Create an order with using the first argument for the name of the order.
The name can also be explicitly set using --name. Returns the created
order object. If a language is provided with --lang, the name of the
order will be set in this language otherwise the default language is
used.
Additional settings can be provided using flags.
cio order create [flags]
Options
--assignee-id int The user id to whom the order should be assigned to
--automatic-completion Set true for completing an order automatically or false to require manual completion (default true)
--can-be-taken-over Filter for orders that can (not) be taken over
-c, --comments string Comments (additional data) of the order
--custom-order-id string A custom order id for this order - it must be unique within all custom order ids
-d, --description string Description of the order
--due-date string The due date for this order, must be a ISO 8601 formatted string (e.g: 2018-10-04T10:35:52.984Z)
-h, --help help for create
-n, --name string Name of the order
-p, --priority int The priority of the order, must be a number between 1 and 10
--start-date string The start date for this order, must be a ISO 8601 formatted string (e.g: 2018-10-04T10:35:52.984Z)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order - Interact with orders
cio order delete
Delete a single order by ID.
cio order delete [order-id] [flags]
Options
-h, --help help for delete
--order-id int The ID of the order
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order - Interact with orders
cio order get
Retrieve a single order by ID.
cio order get [order-id] [flags]
Options
-h, --help help for get
--order-id int The ID of the order
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order - Interact with orders
- cio order get classifier-entry -
Retrieve the list of external classifier entries attached to an
order.
cio order get classifier-entry
Retrieve the list of external classifier entries attached to an order.
cio order get classifier-entry [flags]
Options
-h, --help help for classifier-entry
--order-id int The ID of the order
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order get - Retrieve a single order by ID.
cio order ls
List orders
Synopsis
This command lists orders. If no flag is provided only orders which are
not finished will be shown. This means their state is one of: "in-edit",
"not-started", "in-progress", "paused" or "problem". Use --all to show
all orders.
cio order ls [flags]
Options
-a, --all Show all orders and cannot be used with the combination of --states flag
--archived string Filters the order by 'archived' property. Allowed values are: (include | exclude | only) (default "exclude")
--assignee-id ints Filter for orders that are assigned to one of the given assignees
--can-be-taken-over Filter for orders that can (not) be taken over
--classifier-combination string Set on "union" or "intersection" for applying that combination operation on the results of the classifier entries (default "intersection")
--classifier-entry-ids ints Filter list by classifier entry id. Usage: --classifier-entry-ids=1,2,3
--classifier-ids ints Filter list by classifier entry id. Usage: --classifier-ids=1,2,3
--created-at string Time range filter which is applied on the created-at attribute; timestamps must be according to ISO 8601 (UTC), e.g. 2019-07-23T13:10:11+02:00..2019-08-23T13:10:11+02:00 (for from..to) or ..2019-08-23T13:10:11+02:00 (for the half open interval)
--custom-order-ids strings Filter list by custom order ids. Usage: --custom-order-ids=ord-1,12,t3
--due-date string Time range filter which is applied on the due-date attribute; timestamps must be according to ISO 8601 (UTC), e.g. 2019-07-23T13:10:11+02:00..2019-08-23T13:10:11+02:00 (for from..to) or ..2019-08-23T13:10:11+02:00 (for the half open interval)
-h, --help help for ls
--include-classifier-children Set for including results from child classifier entries
--include-classifier-parents Set for including results from parent classifier entries
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
--order-ids ints Filter list by order ids. Usage: --order-ids=1,2,3
--page-index int The page index used for pagination, starts with 0.
--page-size string Limit the maximum of returned entities. Can be between 20 and 200.
--priority ints Filter for orders of the given priorities
--search string Search for order name
--start-date string Time range filter which is applied on the start-date attribute; timestamps must be according to ISO 8601 (UTC), e.g. 2019-07-23T13:10:11+02:00..2019-08-23T13:10:11+02:00 (for from..to) or ..2019-08-23T13:10:11+02:00 (for the half open interval)
--states strings Filter order list by states.Usage: --states="in-progress","paused"
--sub-assignee-id ints Filter for orders that have instructions sub assigned to one of the given sub assignees
--updated-at string Time range filter which is applied on the updated-at attribute; timestamps must be according to ISO 8601 (UTC), e.g. 2019-07-23T13:10:11+02:00..2019-08-23T13:10:11+02:00 (for from..to) or ..2019-08-23T13:10:11+02:00 (for the half open interval)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio order - Interact with orders
cio order publish
Publish order
Synopsis
Publish an order. The first argument will be used as the order ID. The
Order must be either in the "in-edit" state or in the "template" state.
If the order is in the "template" state, you have to give the exact
"start-date" associated to the scheduled order.
cio order publish [order-id] [flags]
Options
-h, --help help for publish
--order-id int The ID of the order
--start-date string The exact start date of the order, must be according to ISO 8601 (UTC), e.g. 2019-07-23T13:10:11+02:00
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order - Interact with orders
cio order remove
Remove other object from orders
Options
-h, --help help for remove
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order - Interact with orders
- cio order remove
classifier-entry - Detach a
classifier entry from an order. The order must be in the state
'in-edit'. - cio order remove progress - Remove
progress from an order.
cio order remove classifier-entry
Detach a classifier entry from an order. The order must be in the state
'in-edit'.
Synopsis
Detach a classifier entry from an order. In case any of the order or
external classifier entry ids doesn't exist, the command will
automatically ignore it not resulting in an error
cio order remove classifier-entry [flags]
Options
--classifier-entry-ids ints The ID of the classifier entry (required)
-h, --help help for classifier-entry
--order-id int The ID of the order (required)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order remove - Remove other object from
orders
cio order remove progress
Remove progress from an order.
cio order remove progress [flags]
Options
--archived If you only want to remove the report from the order without archiving it use --archived=false (default true)
-h, --help help for progress
--order-id int The ID of the order (required)
--progress-ids ints The ID of the classifier entry (required)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order remove - Remove other object from
orders
cio order scheduled
Interact with scheduled orders
Options
-h, --help help for scheduled
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order - Interact with orders
- cio order scheduled ls - List all
scheduled orders
cio order scheduled ls
List all scheduled orders
Synopsis
List all scheduled orders. You have to specify at least the start-date
or due-date time filter as a half open interval [..to]. These time
range filters must be according to ISO 8601 (UTC),
e.g. 2019-07-23T13:10:11.000+02:00..2019-08-23T13:10:11.000+02:00 (for
the range from..to) or ..2017-05-12T11:04:02.000Z (for the half open
interval ..to).
cio order scheduled ls [flags]
Options
--assignee-id ints Filter for orders that are assigned to one of the given assignees
--can-be-taken-over Filter for orders that can (not) be taken over
--classifier-combination string Set on "union" or "intersection" for applying that combination operation on the results of the classifier entries (default "intersection")
--classifier-entry-ids ints Filter list by classifier entry id. Usage: --classifier-entry-ids=1,2,3
--classifier-ids ints Filter list by classifier entry id. Usage: --classifier-ids=1,2,3
--created-at string Time range filter which is applied on the created-at attribute; timestamps must be according to ISO 8601 (UTC), e.g. 2019-07-23T13:10:11+02:00..2019-08-23T13:10:11+02:00 (for from..to) or ..2019-08-23T13:10:11+02:00 (for the half open interval)
--custom-order-ids strings Filter list by custom order ids. Usage: --custom-order-ids=ord-1,12,t3
--due-date string Time range filter which is applied on the due-date attribute; timestamps must be according to ISO 8601 (UTC), e.g. 2019-07-23T13:10:11+02:00..2019-08-23T13:10:11+02:00 (for from..to) or ..2019-08-23T13:10:11+02:00 (for the half open interval)
-h, --help help for ls
--include-classifier-children Set for including results from child classifier entries
--include-classifier-parents Set for including results from parent classifier entries
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
--priority ints Filter for orders of the given priorities
--search string Search for order name
--start-date string Time range filter which is applied on the start-date attribute; timestamps must be according to ISO 8601 (UTC), e.g. 2019-07-23T13:10:11+02:00..2019-08-23T13:10:11+02:00 (for from..to) or ..2019-08-23T13:10:11+02:00 (for the half open interval)
--sub-assignee-id ints Filter for orders that have instructions sub assigned to one of the given sub assignees
--updated-at string Time range filter which is applied on the updated-at attribute; timestamps must be according to ISO 8601 (UTC), e.g. 2019-07-23T13:10:11+02:00..2019-08-23T13:10:11+02:00 (for from..to) or ..2019-08-23T13:10:11+02:00 (for the half open interval)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio order scheduled - Interact with
scheduled orders
cio order unarchive
Unarchive order
cio order unarchive [flags]
Options
-h, --help help for unarchive
--order-id int The ID of the order
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order - Interact with orders
cio order update
Update order
Synopsis
Update the metadata of an order by ID. If no order ID is specified via
--order-id the first argument will be used as the order ID.
cio order update [order-id] [flags]
Options
--assignee-id int The user id to whom the order should be assigned to
--automatic-completion Set true for completing an order automatically or false to require manual completion (default true)
--can-be-taken-over Filter for orders that can (not) be taken over
-c, --comments string Comments (additional data) of the order
--custom-order-id string A custom order id for the order - it must be unique within all custom order ids. Submitting
an empty string resets a custom order id. Overwriting an existing custom order id requires
the permission UPDATE_EXISTING_CUSTOM_ORDER_ID.
-d, --description string Description of the order
--due-date string The due date for this order, must be a ISO 8601 formatted string (e.g: 2018-10-04T10:35:52.984Z)
-h, --help help for update
-n, --name string Name of the order
--order-id int The ID of the order
-p, --priority int The priority of the order, must be a number between 1 and 10
--start-date string The start date for this order, must be a ISO 8601 formatted string (e.g: 2018-10-04T10:35:52.984Z)
--state string The future state of the order.
Orders in state <in-edit> can be changed to <not-started>, <in-progress>, <paused>, <problem>, <done> and <cancelled>.
Orders in state <not-started> can be changed to <in-progress>, <paused>, <problem>, <done>, <cancelled>.
Orders in state <in-progress> can be changed to <paused>, <problem>, <done>, and <cancelled>.
Orders in state <paused> can be changed to <in-progress>, <problem>, <done>, and <cancelled>.
Orders in state <problem> can be changed to <in-progress>, <paused>, <done> and <cancelled>.
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio order - Interact with orders
cio pdf-feedback
Interact with PDF feedbacks
Options
-h, --help help for pdf-feedback
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio pdf-feedback download - Download
an PDF feedback
cio pdf-feedback download
Download an PDF feedback
Synopsis
Download an existing PDF feedback given by the pdf_feedback_id. If no
filepath is specified the file will be saved in the current directory.
cio pdf-feedback download [id] [flags]
Options
--filepath string Download filepath
-h, --help help for download
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio pdf-feedback - Interact with PDF feedbacks
cio ping
Test connection and authentication
Synopsis
Test the connection to the Operations1 server and verify that your
authentication token is still valid. If successful the command will
return some basic information like the version of the server.
cio ping [flags]
Options
-h, --help help for ping
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
cio progress
Interact with progresses
Options
-h, --help help for progress
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio progress add - Attach entities to progress
- cio progress download-csv - Download a
progress as csv - cio progress
generate-report-pdf - Generate
and download a report-pdf for a progress - cio progress get - Retrieve a single progress
by ID. - cio progress history - Get progress history
- cio progress lock - Lock and Unlock progress
by ID - cio progress ls - List all progresses
- cio progress remove - Remove entities from
progress - cio progress reopen - Reopen progress by ID
- cio progress update - Update the metadata of
a progress by ID.
cio progress add
Attach entities to progress
Options
-h, --help help for add
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio progress - Interact with progresses
- cio progress add
classifier-entry - Add
classifier entry
cio progress add classifier-entry
Add classifier entry
Synopsis
Add classifier entry in progress. In case any of the progress or
external classifier entry ids doesn't exist, the command will
automatically ignore it not resulting in an error
cio progress add classifier-entry [flags]
Options
--classifier-entry-ids ints The IDs of the classifier entries (required)
-h, --help help for classifier-entry
--progress-id int The ID of the progress (required)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio progress add - Attach entities to progress
cio progress download-csv
Download a progress as csv
Synopsis
Download a progress given by its id as a csv file. If no filepath is
specified the file will be downloaded to the current directory.
cio progress download-csv [progress-id] [flags]
Options
--custom Get custom csv report
--filepath string Download filepath
-h, --help help for download-csv
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio progress - Interact with progresses
cio progress generate-report-pdf
Generate and download a report-pdf for a progress
Synopsis
Generate and download a report-pdf for a progress, the language of the
pdf must be specified.
cio progress generate-report-pdf [progress-id] [flags]
Options
--filepath string Download filepath
-h, --help help for generate-report-pdf
--include-attached-media-section Set if the attached media section should be included (default true)
--include-comments-section Set if the report comments field should be included (default true)
--include-completed-by Set if the 'completed by' information should be included (default true)
--include-customer-address Set if customer address should be included
--include-instruction-classifiers Set if the instruction classifiers should be included
--include-instruction-metadata-section Set if instruction metadata section should be included (default true)
--include-list-of-participants Set if a list of participants should be included
--include-material-section Set if material section should be included (default true)
--include-order-header Set if the order header should be included
--include-order-section Set if order section should be included (default true)
--include-passed-status Set if passed status of steps should be included
--include-status-section Set if status section should be included (default true)
--include-step-log-section Set if the detailed overview of steps should be included (default true)
--include-step-overview-section Set if the step overview section should be included (default true)
--include-timestamps Set if timestamps should be in pdf (default true)
-l, --lang string Language of output pdf (required)
--only-custom-rows Include only custom rows in pdf
--show-mandatory-markup Set if mandatory interactions should be highlighted (default true)
--use-datetime Set if time precision should be date and time, else only the date will be displayed (default true)
--use-full-username Set if instead of login username, the first and last name of a users will be displayed
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio progress - Interact with progresses
cio progress get
Retrieve a single progress by ID.
cio progress get [progress-id] [flags]
Options
-h, --help help for get
--progress-id int The ID of the progress
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio progress - Interact with progresses
- cio progress get
classifier-entry - Retrieve the
list of external classifier entries attached to the progress. - cio progress get
interaction-value - Retrieve
the list of interaction values attached to a progress. - cio progress get
media-feedback - Retrieve the
list of media feedback attached to the progress. - cio progress get step-log - Get step
logs
cio progress get classifier-entry
Retrieve the list of external classifier entries attached to the
progress.
cio progress get classifier-entry [progress-id] [flags]
Options
-h, --help help for classifier-entry
--progress-id int The ID of the progress
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio progress get - Retrieve a single progress
by ID.
cio progress get interaction-value
Retrieve the list of interaction values attached to a progress.
cio progress get interaction-value [flags]
Options
-h, --help help for interaction-value
--interaction-tag-ids ints Interaction tag ids to filter down values to only values of interactions with those tags attached. Multiple values can be separated by comma
--progress-id int The ID of the progress
--updated-at string Time range filters apply for the updated-at attribute, and timestamps must be according to ISO 8601 (UTC), e.g. 2019-07-23T13:10:11+02:00..2019-08-23T13:10:11+02:00
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio progress get - Retrieve a single progress
by ID.
cio progress get media-feedback
Retrieve the list of media feedback attached to the progress.
cio progress get media-feedback [progress-id] [flags]
Options
--archived string Filters the media feedback by 'archived' property. Allowed values are: (include | exclude | only) (default "exclude")
-h, --help help for media-feedback
--progress-id int The ID of the progress
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio progress get - Retrieve a single progress
by ID.
cio progress get step-log
Get step logs
Synopsis
Get step logs for progress which contains information when steps in
progress where last opened
cio progress get step-log [progress-id] [flags]
Options
-h, --help help for step-log
--progress-id int The ID of the progress
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio progress get - Retrieve a single progress
by ID.
cio progress history
Get progress history
Synopsis
Get history of progress state changes and changes in the passed property
cio progress history [progress-id] [flags]
Options
-h, --help help for history
--progress-id int The ID of the progress
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio progress - Interact with progresses
cio progress lock
Lock and Unlock progress by ID
cio progress lock [progress-id] [flags]
Options
-h, --help help for lock
--locked The progress should be lock or unlock (default true)
--progress-id int The ID of the progress
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio progress - Interact with progresses
cio progress ls
List all progresses
Synopsis
List all finished progresses, to retrieve all unfinished progresses set
the --state=in-progress flag.
cio progress ls [flags]
Options
--classifier-combination string Set on "union" or "intersection" for applying that combination operation on the results from the classifier entries (default "intersection")
--classifier-entry-ids ints Filter list by classifier entry id. Usage: --classifier-entry-ids=1,2,3
--classifier-ids ints Filter list by classifier entry id. Usage: --classifier-ids=1,2,3
--created-at string Time range filters apply for the created-at attribute, and timestamps must be according to ISO 8601 (UTC), e.g. 2019-07-23T13:10:11+02:00..2019-08-23T13:10:11+02:00
--created-by int Filter list by the creator of the progress given by the user-id
-h, --help help for ls
--include-classifier-children Set for including results from child classifier entries
--include-classifier-parents Set for including results from parent classifier entries
--offline Filter progress by offline property if not explicitly set the results will not be filtered
--order-ids ints Filter list by order ids. Usage: --order-ids=1,2,3
--page-index int The page index used for pagination, starts with 0.
--page-size string Limit the maximum of returned entities. Can be between 20 and 200.
--state string Filter progress by state, possible values are: all, in-progress, problem, paused, done (default "done")
--updated-at string Time range filters apply for the updated-at attribute, and timestamps must be according to ISO 8601 (UTC), e.g. 2019-07-23T13:10:11+02:00..2019-08-23T13:10:11+02:00
--updated-by int Filter list by the last user that updated the progress given by the user-id
--value-search string Search for progress where submitted string was entered in an interaction; Search string must be at least three characters
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio progress - Interact with progresses
cio progress remove
Remove entities from progress
Options
-h, --help help for remove
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio progress - Interact with progresses
- cio progress remove
classifier-entry - Remove
classifier entry
cio progress remove classifier-entry
Remove classifier entry
Synopsis
Remove classifier entry from progress. In case any of the progress or
external classifier entry ids doesn't exist, the command will
automatically ignore it not resulting in an error
cio progress remove classifier-entry [flags]
Options
--classifier-entry-ids ints The IDs of the classifier entries (required)
-h, --help help for classifier-entry
--progress-id int The ID of the progress (required)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio progress remove - Remove entities from
progress
cio progress reopen
Reopen progress by ID
cio progress reopen [progress-id] [flags]
Options
-h, --help help for reopen
--note string Reason of reopening progress
--progress-id int The ID of the progress
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio progress - Interact with progresses
cio progress update
Update the metadata of a progress by ID.
cio progress update [progress-id] [flags]
Options
-h, --help help for update
--name string New name of the progress
--progress-id int The ID of the progress
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use; if not set the servers default is used; does not always have an effect
SEE ALSO
- cio progress - Interact with progresses
cio report-pdf
Interact with report-pdfs
Options
-h, --help help for report-pdf
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio report-pdf download - Download a
report-pdf - cio report-pdf ls - List all report-pdfs
cio report-pdf download
Download a report-pdf
Synopsis
Download an existing report-pdf given by the report pdf id. If no
filepath is specified the file will be downloaded to the current
directory.
cio report-pdf download [id] [flags]
Options
--filepath string Download filepath
-h, --help help for download
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio report-pdf - Interact with report-pdfs
cio report-pdf ls
List all report-pdfs
Synopsis
List all report-pdfs. This can be filtered by submitting a progress-id.
cio report-pdf ls [flags]
Options
-h, --help help for ls
--progress-id int The id of a progress
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio report-pdf - Interact with report-pdfs
cio role
Interact with roles
Options
-h, --help help for role
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio role ls - List all roles
cio role ls
List all roles
cio role ls [flags]
Options
-h, --help help for ls
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio role - Interact with roles
cio row
The row command allows to interact with rows.
Options
-h, --help help for row
-l, --lang string Language to use. If not set the servers default is used. Does not always have an effect.
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio row add - Add other objects to row
- cio row create - Creates a row for a step with a
header and optional language. - cio row get - Retrieve a single row by ID
cio row add
Add other objects to row
Synopsis
The add commands allows to attach different objects to a row. (Only
local PDF supported for now).
Options
-h, --help help for add
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers default is used. Does not always have an effect.
SEE ALSO
- cio row - The row command allows to interact with rows.
- cio row add lpdf - Add a local PDF entry to
row. A previous 'cio step add lpdf' is required.
cio row add lpdf
Add a local PDF entry to row. A previous 'cio step add lpdf' is
required.
cio row add lpdf [flags]
Options
-h, --help help for lpdf
--lpdf-id int The ID of the local PDF (required)
--position int The position of the local PDF (required)
--row-id int The ID of the row (required)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers default is used. Does not always have an effect.
SEE ALSO
- cio row add - Add other objects to row
cio row create
Creates a row for a step with a header and optional language.
cio row create [flags]
Options
--header string The header of the row (required)
-h, --help help for create
--lang string The language of the row (required)
--step-id int The ID of the related step
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio row - The row command allows to interact with rows.
cio row get
Retrieve a single row by ID
cio row get [flags]
Options
-h, --help help for get
--row-id int The ID of the row
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
-l, --lang string Language to use. If not set the servers default is used. Does not always have an effect.
SEE ALSO
- cio row - The row command allows to interact with rows.
cio share-link
Interact with internal share links
Options
-h, --help help for share-link
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio share-link instruction - Create a
share link
cio share-link instruction
Create a share link
Synopsis
Create a share Link for an instruction. You have to give an
instruction-id, other flags are optional.
cio share-link instruction [flags]
Options
--display-target string Select the instruction processing entry point: "cardView" launches process in card view, "firstStep" launches process in first instruction step
-h, --help help for instruction
--instruction-id int The ID of the instruction
-l, --lang string Language which is used to open the instruction (example --lang=de)
--use-latest-version Set if the most recent version of the instruction should be used. If --use-latest-version=false is set the version as specified in instruction-id will be used. (default true)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio share-link - Interact with internal share
links
cio step
The step command allows to interact with steps
Options
-h, --help help for step
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio step create - Creates a step
- cio step get - Retrieve a single step by ID
cio step create
Creates a step
Synopsis
Creates a step for an instruction with a name, type and language. The
supported types are "tutorial" and "default".
cio step create [flags]
Options
-h, --help help for create
--instruction-id int The ID of the related instruction
--lang string The language of the step (required)
--name string The name of the step (required)
--type string The type of the step (required, 'tutorial' and 'default' supported)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio step - The step command allows to interact with
steps
cio step get
Retrieve a single step by ID
cio step get [flags]
Options
-h, --help help for get
--lang string The language of the step
--step-id int The ID of the step
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio step - The step command allows to interact with
steps
cio task
Interact with tasks
Options
-h, --help help for task
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio task get - Get single task with ID
- cio task ls - List the task
cio task get
Get single task with ID
cio task get [task-id] [flags]
Options
-h, --help help for get
--task-id int The ID of the task
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio task - Interact with tasks
- cio task get classifier-entry -
Retrieve the list of external classifier entries attached to a task.
cio task get classifier-entry
Retrieve the list of external classifier entries attached to a task.
cio task get classifier-entry [task-id] [flags]
Options
-h, --help help for classifier-entry
--task-id int The ID of the task
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio task get - Get single task with ID
cio task ls
List the task
cio task ls [flags]
Options
--created-at string Time range filters apply for the created-at attribute, and timestamps must be according to ISO 8601 (UTC), e.g. 2019-07-23T13:10:11+02:00..2019-08-23T13:10:11+02:00
--due-date string Time range filters apply for the due-date attribute, and timestamps must be according to ISO 8601 (UTC), e.g. 2019-07-23T13:10:11+02:00..2019-08-23T13:10:11+02:00
-h, --help help for ls
--page-index int The page index used for pagination, starts with 0. (default: "0")
--page-size string Limit the maximum of returned entities. Can be between 20 and 200. (default "100")
--states strings Filter the task list by states.Usage: --states="not-started","in-progress"
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio task - Interact with tasks
cio translation
Useful methods for integrating external translations
Options
-h, --help help for translation
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio translation upload - Upload
translation
cio translation upload
Upload translation
Synopsis
Upload translated documents expecting a json file with the following
structure: [ { versionPersistentId: number, type: (instruction | step
| row | interaction | interactionChoice ), name: { de: "neuer
deutscher name", en: "new englisch name", .... } }, .... ]
cio translation upload [flags]
Options
--filepath string Path of the file containing the translations
--format string Format of the file. Currently, only json-array is supported (default "json-array")
-h, --help help for upload
--stop-on-error Stop updating translation after first error
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio translation - Useful methods for integrating
external translations
cio unit
The unit command allows to interact with units
Options
-h, --help help for unit
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio unit create - Create unit with a unique name
(mandatory) - cio unit delete - Delete unit
- cio unit get - Retrieve a single unit by ID
- cio unit ls - Lists all units
cio unit create
Create unit with a unique name (mandatory)
cio unit create [flags]
Options
-h, --help help for create
--name string The name of the unit
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio unit - The unit command allows to interact with
units
cio unit delete
Delete unit
Synopsis
Delete a single unit by ID. Only possible, if the unit is unused (no
interactions refer to it) and a custom unit.
cio unit delete [flags]
Options
-h, --help help for delete
--unit-id int The ID of the unit
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio unit - The unit command allows to interact with
units
cio unit get
Retrieve a single unit by ID
cio unit get [flags]
Options
-h, --help help for get
--unit-id int The ID of the unit
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio unit - The unit command allows to interact with
units
cio unit ls
Lists all units
cio unit ls [flags]
Options
-h, --help help for ls
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio unit - The unit command allows to interact with
units
cio user
Interact with users
Options
-h, --help help for user
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio user add - Add objects to user
- cio user create - Create a user. A unique
username must be set. - cio user delete - Delete a user by ID
- cio user get - Get user by ID
- cio user ls - List all users
- cio user push-instruction - Push
instruction to user - cio user remove - Remove object from user
- cio user update - Update a user. Specified by
the user id
cio user add
Add objects to user
Options
-h, --help help for add
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio user - Interact with users
- cio user add role - Add specified role to
specified user
cio user add role
Add specified role to specified user
cio user add role [flags]
Options
-h, --help help for role
--role-id int The id of the role
--user-id int The id of the user
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio user add - Add objects to user
cio user create
Create a user. A unique username must be set.
cio user create [flags]
Options
--classifier-filter-assistant-id int The id of the classifier filter used in the assistant (0 for no filter) (default -1)
--classifier-filter-editor-id int The id of the classifier filter used in the editor (0 for no filter) (default -1)
--default-locale string The default locale for the user
--email string Email address of the user
--first-name string First name of the user
-h, --help help for create
--is-app Setting this flag means the user object is an app which can't login to the interface
--job string The job title
--last-name string Last name of the user
-p, --password string The password of the user
-u, --username string The user name which will be used for login
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio user - Interact with users
cio user delete
Delete a user by ID
cio user delete [user-id] [flags]
Options
-h, --help help for delete
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio user - Interact with users
cio user get
Get user by ID
cio user get [user-id] [flags]
Options
-h, --help help for get
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio user - Interact with users
cio user ls
List all users
cio user ls [flags]
Options
-a, --all Include archived users
--group-ids ints Filter the users by group IDs
-h, --help help for ls
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio user - Interact with users
cio user push-instruction
Push instruction to user
Synopsis
To push an instruction to a user the instruction must be in the state
active or archived. If the user is logged into the assistant this
command will open the instruction directly. The pushed instruction id
will be returned.
cio user push-instruction [flags]
Options
-h, --help help for push-instruction
--instruction-id int Instruction ID which should be pushed (required)
-l, --lang string Set the language of the instruction opened in assistant
--latest Set for pushing the latest version of this instruction
--step-version-persistent-id int The version persistent ID of the step which should initially be opened
--user-id int User ID to push instruction to (required)
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio user - Interact with users
cio user remove
Remove object from user
Options
-h, --help help for remove
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio user - Interact with users
- cio user remove role - Remove specified
role from specified user
cio user remove role
Remove specified role from specified user
cio user remove role [flags]
Options
-h, --help help for role
--role-id int The id of the role
--user-id int The id of the user
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio user remove - Remove object from user
cio user update
Update a user. Specified by the user id
cio user update [user-id] [flags]
Options
--classifier-filter-assistant-id int The id of the classifier filter used in the assistant (0 for no filter) (default -1)
--classifier-filter-editor-id int The id of the classifier filter used in the editor (0 for no filter) (default -1)
--default-locale string The default locale for the user
--email string Email address of the user
--first-name string First name of the user
-h, --help help for update
--is-app Setting this flag means the user object is an app which can't login to the interface
--job string The job title
--last-name string Last name of the user
-p, --password string The password of the user
-u, --username string The user name which will be used for login
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio user - Interact with users
cio video-feedback
Interact with video feedbacks
Options
-h, --help help for video-feedback
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio - Command Line Interface for Operations1
- cio video-feedback download -
Download a video feedback
cio video-feedback download
Download a video feedback
Synopsis
Download an existing video-feedback given by the video_feedback_id. If
no filepath is specified the file will be saved as .mp4 in the current
directory.
cio video-feedback download [id] [flags]
Options
--filepath string Download filepath
-h, --help help for download
Options inherited from parent commands
--config string Config file (default is ./.cio.yaml)
SEE ALSO
- cio video-feedback - Interact with video
feedbacks
Updated 7 months ago