job list#

Description#

ジョブの一覧を出力します。

Examples#

以下のコマンドは、ジョブの一覧を出力します。

$ annoworkcli job list --workspace_id org \
 --format json --output out.json
out.json#
[
   {
      "job_id": "00c1133d-791d-4bf5-8412-b4e2aca3f53e",
      "job_name": "MOON",
      "job_tree": "org/d2fb9245-5fcb-432f-9c40-a8ecfc5f3d7c/00c1133d-791d-4bf5-8412-b4e2aca3f53e",
      "status": "unarchived",
      "target_hours": null,
      "workspace_id": "org",
      "note": "",
      "external_linkage_info": {
         "url": "https://annofab.com/projects/00c1133d-791d-4bf5-8412-b4e2aca3f53e"
      },
      "created_datetime": "2021-10-27T14:51:20.196Z",
      "updated_datetime": "2021-10-27T14:51:20.196Z",
      "parent_job_id": "d2fb9245-5fcb-432f-9c40-a8ecfc5f3d7c",
      "parent_job_name": "PLANET"
   }
]

Usage Details#

ジョブ一覧を出力します。

usage: annoworkcli job list [-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 ...]]
                            [--external_linkage_info_url EXTERNAL_LINKAGE_INFO_URL [EXTERNAL_LINKAGE_INFO_URL ...]]
                            [-o OUTPUT] [-f {csv,json}]

Named Arguments#

-w, --workspace_id

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

-j, --job_id

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

-pj, --parent_job_id

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

--external_linkage_info_url

外部連携情報のURLで絞り込みます。URL末尾のスラッシュの有無に影響されないように、前方一致で絞り込みます。

-o, --output

出力先

-f, --format

Possible choices: csv, json

出力先のフォーマット

Default: 'csv'

global optional arguments#

--debug

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

--annowork_user_id

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

--annowork_password

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

--endpoint_url

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