project put#

Description#

プロジェクトを作成します。

Examples#

基本的な使い方#

以下のコマンドは、組織orgに「foo」という画像プロジェクトを作成します。

$ annofabcli project put --organization org --title foo --input_data_type image

デフォルトでは、作成したプロジェクトのproject_idのフォーマットはUUIDv4です。 --project_id オプションで、作成するプロジェクトのproject_idを指定することもできます。

$ annofabcli project put --organization org --title foo --input_data_type image \
 --project_id bar

プロジェクトの設定情報を指定#

--configuration オプションで、プロジェクトの設定情報を指定できます。 以下のコマンドで作成したプロジェクトは、アノテーションエディタのバージョンがプレビュー版になります。

$ annofabcli project put --organization org --title foo --input_data_type image \
 --configuration '{"editor_version":"preview"}'

JSONの構造については、 putProject APIのリクエストボディを参照してください。

3次元プロジェクトの作成#

3次元プロジェクトを作成するには、 --custom_project_type オプションも指定する必要があります。

$ annofabcli project put --organization org --title foo --input_data_type custom \
 --custom_project_type 3d

Usage Details#

プロジェクトを作成します。

usage: annofabcli project put [-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] -org ORGANIZATION
                              --title TITLE --input_data_type
                              {image,movie,custom} [-p PROJECT_ID]
                              [--overview OVERVIEW]
                              [--plugin_id PLUGIN_ID | --custom_project_type {3d}]
                              [--configuration CONFIGURATION]

Named Arguments#

-org, --organization

プロジェクトの所属先組織

--title

作成するプロジェクトのタイトル

--input_data_type

Possible choices: image, movie, custom

プロジェクトに登録する入力データの種類

  • image : 画像

  • movie : 動画

  • custom : カスタム（点群など）

-p, --project_id

作成するプロジェクトのproject_id。未指定の場合はUUIDv4になります。

--overview

作成するプロジェクトの概要

--plugin_id

アノテーションエディタプラグインのplugin_id

--custom_project_type

Possible choices: 3d

カスタムプロジェクトの種類。 --input_data_type custom を指定したときのみ有効です。指定した値に対応するエディタプラグインが適用されるため、 --plugin_id` と同時には指定できません。

  • 3d : 3次元データ

--configuration

プロジェクトの設定情報。JSON形式で指定します。JSONの構造については https://annofab.com/docs/api/#operation/putProject のリクエストボディを参照してください。 file:// を先頭に付けると、JSON形式のファイルを指定できます。

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リクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。

組織管理者、組織オーナを持つユーザで実行してください。