Guides

All CLI Commands

Suggest Edits

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 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 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 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 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 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 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 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-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 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

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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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-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 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 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 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

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 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 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 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 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 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 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

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 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 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 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 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 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 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 create

Create order