annofab list_job#

Description#

ジョブとジョブに紐づくAnnofabプロジェクトの情報を一緒に出力します。

Examples#

以下のコマンドは、ジョブID job の情報と、そのジョブに紐づくAnnofabプロジェクトの情報を出力します。

$ annoworkcli annofab list_job --workspace_id org --job_id job \
 --format json --output out.json
out.json#
[
   {
      "job_id": "job",
      "job_name": "MOON",
      "job_tree": "org/parent_job/job",
      "status": "unarchived",
      "target_hours": null,
      "workspace_id": "org",
      "note": "",
      "external_linkage_info": {
         "url": "https://annofab.com/projects/af_project_id"
      },
      "created_datetime": "2021-10-27T14:51:20.196Z",
      "updated_datetime": "2021-10-27T14:51:20.196Z",
      "parent_job_id": "5a144b2a-3db0-4086-aa4e-1620109c72e3",
      "parent_job_name": "PLANET",
      "annofab": {
         "project_id": "af_project_id",
         "project_title": "af_MOON",
         "project_status": "suspended",
         "input_data_type": "image"
      }
   }
]

Usage Details#

ジョブとジョブに紐づくAnnofabプロジェクトの情報を一緒に出力します。

usage: annoworkcli annofab list_job [-h] [--debug]
                                    [--annowork_user_id ANNOWORK_USER_ID]
                                    [--annowork_password ANNOWORK_PASSWORD]
                                    [--endpoint_url ENDPOINT_URL]
                                    [-w WORKSPACE_ID] [-j JOB_ID [JOB_ID ...]
                                    | -pj PARENT_JOB_ID [PARENT_JOB_ID ...]]
                                    [-af_p ANNOFAB_PROJECT_ID [ANNOFAB_PROJECT_ID ...]]
                                    [-o OUTPUT] [-f {csv,json}]
                                    [--parallelism PARALLELISM]
                                    [--annofab_user_id ANNOFAB_USER_ID]
                                    [--annofab_password ANNOFAB_PASSWORD]
                                    [--annofab_pat ANNOFAB_PAT]

Named Arguments#

-w, --workspace_id

対象のワークスペースID。未指定の場合は環境変数`ANNOWORK_WORKSPACE_ID`を使用します。

-j, --job_id

絞り込み対象であるジョブのjob_idを指定してください。

-pj, --parent_job_id

絞り込み対象である親のジョブのjob_idを指定してください。

-af_p, --annofab_project_id

絞り込み対象であるAnnofabプロジェクトのproject_idを指定してください。

-o, --output

出力先

-f, --format

Possible choices: csv, json

出力先

Default: 'csv'

--parallelism

並列度。指定しない場合は、逐次的に処理します。

--annofab_user_id

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

--annofab_password

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

--annofab_pat

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

global optional arguments#

--debug

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

--annowork_user_id

Annoworkにログインする際のユーザーIDを指定します。

--annowork_password

Annoworkにログインする際のパスワードを指定します。

--endpoint_url

Annowork WebAPIのエンドポイントを指定します。指定しない場合は https://annowork.com です。