CLI For Collaboflow

A Command Line Interface for Collaboflow API.

[!NOTE] Currently, only covering all GET requests and the following three POST requests: searchDocument, outputPrint and uploadFile. More planning to be added.

• Installation
• Command Reference
  • configure
  • document
    • get_document_overview
    • get_determs
    • get_document_contents
    • search_documents
    • output_print
  • my_status
    • get_my_determs
    • get_my_requests
    • get_my_drafts
    • get_my_processes
  • file
    • upload_file
    • download_file
  • form
    • get_forms
    • get_form_parts
    • get_form_settings_print
  • user
    • get_users
    • get_user
  • group
    • get_groups
    • get_group
  • title
    • get_titles
    • get_title
  • help

Installation

From Github

cargo install --git https://github.com/0Itsuki0/collaboflow-cli

From Crate Registry

cargo install collaboflow-cli

From Release

Download the binary exeutable from the Releases page.

Command Reference

configure

Configure collaboflow connection parameters

Usage

collaboflow-cli configure [OPTIONS] --instance <INSTANCE> --username <USERNAME> --apikey <APIKEY>

Options

    --scheme <SCHEME>      URL Scheme. Default: http. [default: https] [possible values: http, https]
    --host <HOST>          URL HOST. [default: cloud.collaboflow.com]
-i, --instance <INSTANCE>  instance Name.
-u, --username <USERNAME>  Login username.
-a, --apikey <APIKEY>      API Key.
-p, --path <PATH>          Path to save the configuration file [default: ~/.collaboflow_config]
-h, --help                 Print help

Example

collaboflow-cli configure -i itsuki_test -u taro -a 0000000000

# Custom output path
collaboflow-cli configure -i itsuki_test -u taro -a 0000000000 -p /Users/itsuki/Desktop/config

document

申請書に関する操作

get_document_overview

文書の概要取得

Usage

collaboflow-cli document get_document_overview [OPTIONS] --app_cd <APP_CD>

Options

-a, --app_cd <APP_CD>                コラボフローアプリケーションのコードを指定します。
-d, --document_id <DOCUMENT_IDS>...  文書IDを指定します。
                                    Can present multiple times or declared as Comma seperated list.
                                    Ex: -d 169,170 -d 168
    --format <OUTPUT_FORMAT>         Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>           Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                          Only print final output.
-h, --help                           Print help

Example

collaboflow-cli document get_document_overview -a 1 -d 170,162 -d 169

get_determs

判定者の一覧取得

Usage

collaboflow-cli document get_determs [OPTIONS] --app_cd <APP_CD>

Options

-a, --app_cd <APP_CD>                コラボフローアプリケーションのコードを指定します。
-d, --document_id <DOCUMENT_IDS>...  文書IDを指定します。
                                    Can present multiple times or declared as Comma seperated list.
                                    Ex: -d 169,170 -d 168
-l, --limit <LIMIT>                  一度に取得するレコード数です。 [default: 10]
-o, --offset <OFFSET>                取得開始レコードのオフセットです。次ページを取得したい場合はlimitを足した値を指定します。 [default: 0]
    --current                        判定待ちの段階のみ取得するかを指定します。
    --format <OUTPUT_FORMAT>         Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>           Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                          Only print final output.
-h, --help                           Print help

Example

collaboflow-cli document get_determs -a 1 -d 170,162 -d 169

get_document_contents

申請内容の詳細を取得

Usage

collaboflow-cli document get_document_contents [OPTIONS] --app_cd <APP_CD>

Options

-a, --app_cd <APP_CD>                コラボフローアプリケーションのコードを指定します。
-d, --document_id <DOCUMENT_IDS>...  文書IDを指定します。
                                    Can present multiple times or declared as Comma seperated list.
                                    Ex: -d 169,170 -d 168
    --format <OUTPUT_FORMAT>         Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>           Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                          Only print final output.
-h, --help                           Print help

Example

collaboflow-cli document get_document_contents -d 162 -a 1

search_documents

申請書の検索

Usage

collaboflow-cli document search_documents [OPTIONS] --app_cd <APP_CD> --query <QUERY>

Options

-a, --app_cd <APP_CD>         コラボフローアプリケーションのコードを指定します。
-l, --limit <LIMIT>           一度に取得するレコード数です。 [default: 10]
-o, --offset <OFFSET>         取得開始レコードのオフセットです。次ページを取得したい場合はlimitを足した値を指定します。 [default: 0]
-q, --query <QUERY>           queryパラメータの条件式。[項目名] [演算子] [値]で記述します。
    --format <OUTPUT_FORMAT>  Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>    Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                   Only print final output.
-h, --help                    Print help

Example

collaboflow-cli document search_documents  -a 1 -q request_user=\'taro\'

output_print

帳票出力

Usage

collaboflow-cli document output_print [OPTIONS] --app_cd <APP_CD> --document_id <DOCUMENT_ID> --print_id <PRINT_ID>

Options

-a, --app_cd <APP_CD>
        コラボフローアプリケーションのコードを指定します。
-d, --document_id <DOCUMENT_ID>
        文書IDを指定します。
-p, --print_id <PRINT_ID>
        帳票IDを指定します。
-o, --output_directory <OUTPUT_DIRECTORY>
        Directory Path to save the download prints. [default: .]
    --config <CONFIG_PATH>
        Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet
        Only print final output.
-h, --help
        Print help

Example

collaboflow-cli -- document output_print -d 327 -p 1 -a 1 -o ./downloads

my_status

自分の申請書に関する操作

get_my_determs

判定待ちの一覧取得

Usage

collaboflow-cli my_status get_my_determs [OPTIONS] --app_cd <APP_CD>

Options

-a, --app_cd <APP_CD>         コラボフローアプリケーションのコードを指定します。
-l, --limit <LIMIT>           一度に取得するレコード数です。 [default: 10]
-o, --offset <OFFSET>         取得開始レコードのオフセットです。次ページを取得したい場合はlimitを足した値を指定します。 [default: 0]
    --format <OUTPUT_FORMAT>  Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>    Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                   Only print final output.
-h, --help                    Print help

Example

collaboflow-cli my_status get_my_determs -a 1

get_my_requests

申請済みの一覧取得

Usage

collaboflow-cli my_status get_my_requests [OPTIONS] --app_cd <APP_CD>

Options

-a, --app_cd <APP_CD>         コラボフローアプリケーションのコードを指定します。
-l, --limit <LIMIT>           一度に取得するレコード数です。 [default: 10]
-o, --offset <OFFSET>         取得開始レコードのオフセットです。次ページを取得したい場合はlimitを足した値を指定します。 [default: 0]
    --format <OUTPUT_FORMAT>  Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>    Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                   Only print final output.
-h, --help                    Print help

Example

collaboflow-cli my_status get_my_requests -a 1

get_my_drafts

下書きの一覧取得

Usage

collaboflow-cli my_status get_my_drafts [OPTIONS] --app_cd <APP_CD>

Options

-a, --app_cd <APP_CD>         コラボフローアプリケーションのコードを指定します。
-l, --limit <LIMIT>           一度に取得するレコード数です。 [default: 10]
-o, --offset <OFFSET>         取得開始レコードのオフセットです。次ページを取得したい場合はlimitを足した値を指定します。 [default: 0]
    --format <OUTPUT_FORMAT>  Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>    Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                   Only print final output.
-h, --help                    Pri

Example

collaboflow-cli my_status get_my_drafts -a 1

get_my_processes

申請可能な経路の一覧取得

Usage

collaboflow-cli my_status get_my_processes [OPTIONS] --app_cd <APP_CD>

Options

-a, --app_cd <APP_CD>         コラボフローアプリケーションのコードを指定します。
-l, --limit <LIMIT>           一度に取得するレコード数です。 [default: 10]
-o, --offset <OFFSET>         取得開始レコードのオフセットです。次ページを取得したい場合はlimitを足した値を指定します。 [default: 0]
    --format <OUTPUT_FORMAT>  Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>    Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                   Only print final output.
-h, --help                    Pri

Example

collaboflow-cli my_status get_my_processes -a 1

file

添付ファイルに関する操作

upload_file

添付ファイルのアップロード

Usage

collaboflow-cli file upload_file [OPTIONS]

Options

-f, --file <FILES>...         Path to the file.
    --format <OUTPUT_FORMAT>  Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>    Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                   Only print final output.
-h, --help                    Print help

Example

collaboflow-cli file upload_file -f './file1.pdf' -f './file2.pdf'

download_file

添付ファイルのダウンロード

Usage

collaboflow-cli file download_file [OPTIONS]

Options

-f, --file_id <FILE_IDS>...
        添付ファイルのファイルID（44桁）を指定します。
        Can present multiple times or declared as Comma seperated list.
        Ex: -f <id_1>,<id_2> -d <id_3>
-o, --output_directory <OUTPUT_DIRECTORY>
        Directory Path to save the download prints. [default: .]
    --config <CONFIG_PATH>
        Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet
        Only print final output.
-h, --help
        Print help

Example

collaboflow-cli file download_file -f ngbaHA8jtqSZt1kE86nez1wGiMqe9DoX_g5AclXDmqo8,_bfG_9vO7epCdHBUk9gULMG4fyUgJNjSUOASb7uCsk1F -o ./downloads

form

フォームに関する操作

get_forms

フォームの一覧取得

Usage

collaboflow-cli form get_forms [OPTIONS] --app_cd <APP_CD>

Options

-a, --app_cd <APP_CD>             コラボフローアプリケーションのコードを指定します。
-c, --category_id <CATEGORY_IDS>  フォームのカテゴリーIDです。未指定の場合は、全てのフォームが返ります。
                                Can present multiple times or declared as Comma seperated list.
                                Ex: -c 1,2 -c 3
-l, --limit <LIMIT>               一度に取得するレコード数です。 [default: 10]
-o, --offset <OFFSET>             取得開始レコードのオフセットです。次ページを取得したい場合はlimitを足した値を指定します。 [default: 0]
    --format <OUTPUT_FORMAT>      Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>        Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                       Only print final output.
-h, --help                        Print help

Example

# Get all categories
collaboflow-cli form get_forms -a 1

# Get specific categories
collaboflow-cli form get_forms -a 1 -c 8,3

get_form_parts

フォームのパーツ一覧を取得

Usage

collaboflow-cli form get_form_parts [OPTIONS] --app_cd <APP_CD>

Options

-a, --app_cd <APP_CD>         コラボフローアプリケーションのコードを指定します。
-f, --form_id <FORM_IDS>...   フォームIDを指定します。
                            Can present multiple times or declared as Comma seperated list.
                            Ex: -f 169,170 -f 168
-v, --version <VERSION>       フォームの版番号を指定します。 latestを指定した場合は最新バージョンを取得します。 [default: latest]
    --detail                  パーツ毎に設定されている情報を取得するか指定します。
                            省略した場合にはtrueが指定され、falseを指定した場合にはパーツの名前と種類のみを取得します。
    --format <OUTPUT_FORMAT>  Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>    Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                   Only print final output.
-h, --help                    Print help

Example

collaboflow-cli form get_form_parts -a 1 -f 21,20 -v latest

get_form_settings_print

フォームの帳票設定を取得

Usage

collaboflow-cli form get_form_settings_print [OPTIONS] --app_cd <APP_CD>

Options

-a, --app_cd <APP_CD>         コラボフローアプリケーションのコードを指定します。
-f, --form_id <FORM_IDS>...   フォームIDを指定します。
                            Can present multiple times or declared as Comma seperated list.
                            Ex: -f 169,170 -f 168
-v, --version <VERSION>       フォームの版番号を指定します。 latestを指定した場合は最新バージョンを取得します。 [default: latest]
    --format <OUTPUT_FORMAT>  Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>    Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                   Only print final output.
-h, --help                    Print help

Example

collaboflow-cli form get_form_settings_print -a 1 -f 21,20 -v latest

user

ユーザーに関する操作

get_users

ユーザー情報の一括取得

Usage

collaboflow-cli user get_users [OPTIONS]

Options

-l, --limit <LIMIT>           一度に取得するレコード数です。 [default: 10]
-o, --offset <OFFSET>         取得開始レコードのオフセットです。次ページを取得したい場合はlimitを足した値を指定します。 [default: 0]
-f, --fields [<FIELDS>]       受け取る情報のフィールド名を、カンマ区切りで指定します。未指定の場合は、取得可能な全ての情報が返ります。
    --format <OUTPUT_FORMAT>  Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>    Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                   Only print final output.
-h, --help                    Print help

Example

collaboflow-cli user get_users

# Only get specific fields
collaboflow-cli user get_users -f name,groups

get_user

ユーザー情報の取得

Usage

collaboflow-cli user get_user [OPTIONS]

Options

-u, --user_id <USER_IDS>...   ユーザーの内部ID、またはユーザーIDを指定します。
                            Can present multiple times or declared as Comma seperated list.
                            Ex: -u taro1,taro2 -d taro3
-k, --key <KEY>               対象ユーザーをユーザーIDで指定する場合は「userid」を指定します。 [possible values: userid]
    --format <OUTPUT_FORMAT>  Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>    Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                   Only print final output.
-h, --help                    Print help

Example

# With User Login Id
collaboflow-cli user get_user -u taro,admin -k userid

# With internal id
collaboflow-cli user get_user -u 00000000000000000000000000000000,B5453A76FF15510C6FD0311530C03BE3

group

グループに関する操作

get_groups

グループ情報の一括取得

Usage

collaboflow-cli group get_groups [OPTIONS]

Options

-l, --limit <LIMIT>           一度に取得するレコード数です。 [default: 10]
-o, --offset <OFFSET>         取得開始レコードのオフセットです。次ページを取得したい場合はlimitを足した値を指定します。 [default: 0]
-f, --fields [<FIELDS>]       受け取る情報のフィールド名を、カンマ区切りで指定します。未指定の場合は、取得可能な全ての情報が返ります。
    --format <OUTPUT_FORMAT>  Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>    Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                   Only print final output.
-h, --help                    Print help

Example

collaboflow-cli group get_groups

get_group

グループ情報の取得

Usage

collaboflow-cli group get_group [OPTIONS]

Options

-g, --group_id <GROUP_IDS>...  グループの内部ID、またはグループコードを指定します。
                                Can present multiple times or declared as Comma seperated list.
                                Ex: -g g1,g2 -g g3
-k, --key <KEY>                対象グループをグループコードで指定する場合は「code」を指定します。 [possible values: code]
    --format <OUTPUT_FORMAT>   Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>     Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                    Only print final output.
-h, --help                     Print help

Example

collaboflow-cli group get_group -g zensha,root -k code

title

役職に関する操作

get_titles

役職情報の一括取得

Usage

collaboflow-cli title get_titles [OPTIONS]

Options

-l, --limit <LIMIT>           一度に取得するレコード数です。 [default: 10]
-o, --offset <OFFSET>         取得開始レコードのオフセットです。次ページを取得したい場合はlimitを足した値を指定します。 [default: 0]
-f, --fields [<FIELDS>]       受け取る情報のフィールド名を、カンマ区切りで指定します。未指定の場合は、取得可能な全ての情報が返ります。
    --format <OUTPUT_FORMAT>  Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>    Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                   Only print final output.
-h, --help                    Print help

Example

collaboflow-cli title get_titles

get_title

役職情報の取得

Usage

collaboflow-cli title get_title [OPTIONS]

Options

-t, --title_id <TITLE_IDS>...  役職の内部ID、または役職コードを指定します。
                                Can present multiple times or declared as Comma seperated list.
                                Ex: -t t1,t2 -t t3
-k, --key <KEY>                対象役職を役職コードで指定する場合は「code」を指定します。 [possible values: code]
    --format <OUTPUT_FORMAT>   Define Output Format. [default: table] [possible values: json, table]
    --config <CONFIG_PATH>     Path to the configuration file. [default: ~/.collaboflow_config]
    --quiet                    Only print final output.
-h, --help                     Print help

Example

collaboflow-cli title get_title -t sha,b -k code

help

Print the help of the given subcommand(s)