project update#

Description#

プロジェクトのタイトルまたは概要を更新します。

Examples#

CSVファイルを指定する場合#

--csv に、更新対象のプロジェクト情報が記載されたCSVファイルのパスを指定してください。

CSVのフォーマットは以下の通りです。

  • カンマ区切り

  • ヘッダ行あり

列名

必須

備考

project_id

Yes

更新対象のプロジェクトID

title

No

変更後のプロジェクトタイトル。更新しない場合は空欄

overview

No

変更後のプロジェクト概要。更新しない場合は空欄

以下はCSVファイルのサンプルです。

project.csv#
project_id,title,overview
prj1,新しいタイトル1,新しい概要1
prj2,,変更された概要のみ
prj3,タイトルのみ変更,

$ annofabcli project update --csv project.csv

JSON文字列を指定する場合#

--json に、更新対象のプロジェクト情報をJSON文字列で指定してください。

以下は、JSONのサンプルです。

project.json#
[
    {
        "project_id": "prj1",
        "title": "新しいタイトル1",
        "overview": "新しい概要1"
    },
    {
        "project_id": "prj2",
        "overview": "変更された概要のみ"
    },
    {
        "project_id": "prj3",
        "title": "タイトルのみ変更"
    }
]

JSONのキーは、 --csv に指定するCSVファイルの列に対応します。 更新しないプロパティは、キーを記載しないか値をnullにしてください。

--json にJSON形式の文字列、またはJSONファイルのパスを指定できます。

$ annofabcli project update --json file://project.json

Usage Details#

プロジェクトのタイトルまたは概要を更新します。

usage: annofabcli project update [-h] [--yes] [--endpoint_url ENDPOINT_URL]
                                 [--annofab_user_id ANNOFAB_USER_ID]
                                 [--annofab_password ANNOFAB_PASSWORD]
                                 [--annofab_pat ANNOFAB_PAT] [--logdir LOGDIR]
                                 [--disable_log] [--debug]
                                 (--csv CSV | --json JSON)
                                 [--parallelism {2,3,4}]

Named Arguments#

--csv

更新対象のプロジェクトと更新後の値が記載されたCSVファイルのパスを指定します。 CSVのフォーマットは以下の通りです。

  • ヘッダ行あり, カンマ区切り

  • project_id (required)

  • title (optional)

  • overview (optional)

更新しないプロパティは、セルの値を空欄にしてください。

--json

更新対象のプロジェクトと更新後の値をJSON形式で指定します。 JSONの各キーは --csv に渡すCSVの各列に対応しています。 file:// を先頭に付けるとjsonファイルを指定できます。 (ex) [{"project_id":"prj1","title":"new_title1"},{"project_id":"prj2","overview":"new_overview2"}] 更新しないプロパティは、キーを記載しないか値をnullにしてください。

--parallelism

Possible choices: 2, 3, 4

使用するプロセス数（並列度）。指定しない場合は、逐次的に処理します。指定する場合は --yes も一緒に指定する必要があります。

global optional arguments#

--yes

処理中に現れる問い合わせに対して、常に yes と回答します。

--endpoint_url

Annofab WebAPIのエンドポイントを指定します。

Default: 'https://annofab.com'

--annofab_user_id

Annofabにログインする際のユーザーID

--annofab_password

Annofabにログインする際のパスワード

--annofab_pat

Annofabにログインする際のパーソナルアクセストークン

--logdir

ログファイルを保存するディレクトリを指定します。

Default: .log

--disable_log

ログを無効にします。

--debug

HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。

プロジェクトオーナロールを持つユーザで実行してください。