annoworkapi.api module#

annoworkapi.AnnoworkApi class#

class annoworkapi.AnnoworkApi(login_user_id: str, login_password: str, *, endpoint_url: str = 'https://annowork.com')[ソース]#

Web APIに対応したメソッドが存在するクラス。

パラメータ:

  • login_user_id -- AnnoworkにログインするときのユーザID

  • login_password -- Annoworkにログインするときのパスワード

  • endpoint_url -- WebAPI URLのbase部分

change_password(request_body: Any | None = None, **kwargs) → Any#

パスワード変更

パスワード変更

パラメータ:

request_body (Any) -- Request Body change_password_request (ChangePasswordRequest): (required)

戻り値:

InlineResponse200

confirm_reset_password(request_body: Any | None = None, **kwargs) → Any#

パスワードリセットstep2（新しいパスワードに変更）

新しいパスワードに変更します。 本人確認のため、[パスワードリセットを要求](#operation/resetPassword)で受信したメールに記載された検証コードを使用します。 パスワードリセットプロセスの最終ステップです。

パラメータ:

request_body (Any) -- Request Body confirm_reset_password_request (ConfirmResetPasswordRequest): (required)

戻り値:

InlineResponse200

confirm_sign_up(request_body: Any | None = None, **kwargs) → Any#

サインアップstep2（本登録）

アカウントのサインアップの最後のステップとして、アカウントを本登録します。

パラメータ:

request_body (Any) -- Request Body confirm_sign_up_request (ConfirmSignUpRequest): (required)

戻り値:

InlineResponse200

delete_actual_working_time_by_workspace_member(workspace_id: str, workspace_member_id: str, actual_working_time_id: str, **kwargs) → Any#

実績時間の削除

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • workspace_member_id (str) -- ワークスペースメンバーID (required)

  • actual_working_time_id (str) -- 実績稼働時間ID (required)

戻り値:

ActualWorkingTime

delete_expected_working_time_by_workspace_member(workspace_id: str, workspace_member_id: str, date: str, **kwargs) → Any#

予定稼働時間の日付指定削除

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • workspace_member_id (str) -- ワークスペースメンバーID (required)

  • date (str) -- 予定の対象日 (required)

戻り値:

ExpectedWorkingTime

delete_job(workspace_id: str, job_id: str, **kwargs) → Any#

ジョブの削除

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • job_id (str) -- ジョブID (required)

戻り値:

Job

delete_schedule(workspace_id: str, schedule_id: str, **kwargs) → Any#

作業計画の削除

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • schedule_id (str) -- スケジュールID (required)

戻り値:

Schedule

delete_workspace_member(workspace_id: str, workspace_member_id: str, **kwargs) → Any#

ワークスペースメンバーの削除

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • workspace_member_id (str) -- ワークスペースメンバーID (required)

戻り値:

WorkspaceMember

get_account_external_linkage_info(user_id: str, **kwargs) → Any#

アカウント外部連携情報取得

パラメータ:

user_id (str) -- ユーザーID (required)

戻り値:

InlineResponse2001

get_actual_working_times(workspace_id: str, query_params: dict[str, Any] | None = None, **kwargs) → Any#

ワークスペース全体の実績時間の一括取得

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • query_params (dict[str, Any]) -- Query Parameters job_id (str): ジョブID term_start (str): 日付での範囲検索で使用 term_end (str): 日付での範囲検索で使用

戻り値:

[ActualWorkingTime]

get_actual_working_times_by_workspace_member(workspace_id: str, workspace_member_id: str, query_params: dict[str, Any] | None = None, **kwargs) → Any#

ワークスペースメンバーに対する実績時間の一括取得

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • workspace_member_id (str) -- ワークスペースメンバーID (required)

  • query_params (dict[str, Any]) -- Query Parameters term_start (str): 取得する範囲の開始日時。日付での範囲検索で使用 term_end (str): 取得する範囲の終了日時。日付での範囲検索で使用

戻り値:

[ActualWorkingTime]

get_expected_working_times(workspace_id: str, query_params: dict[str, Any] | None = None, **kwargs) → Any#

予定稼働時間の一括取得

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • query_params (dict[str, Any]) -- Query Parameters term_start (str): 日付での範囲検索で使用 term_end (str): 日付での範囲検索で使用

戻り値:

[ExpectedWorkingTime]

get_expected_working_times_by_workspace_member(workspace_id: str, workspace_member_id: str, query_params: dict[str, Any] | None = None, **kwargs) → Any#

予定稼働時間の一覧取得

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • workspace_member_id (str) -- ワークスペースメンバーID (required)

  • query_params (dict[str, Any]) -- Query Parameters term_start (str): 取得する範囲の開始日。日付での範囲検索で使用 term_end (str): 取得する範囲の終了日。日付での範囲検索で使用

戻り値:

[ExpectedWorkingTime]

get_job(workspace_id: str, job_id: str, **kwargs) → Any#

ジョブの取得

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • job_id (str) -- ジョブID (required)

戻り値:

Job

get_job_children(workspace_id: str, job_id: str, **kwargs) → Any#

子ジョブの一覧取得

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • job_id (str) -- ジョブID (required)

戻り値:

JobChildren

get_jobs(workspace_id: str, query_params: dict[str, Any] | None = None, **kwargs) → Any#

ジョブの一覧取得

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • query_params (dict[str, Any]) -- Query Parameters sort (str): sort key(複数項目を利用したソートの場合は,(カンマ)区切りで指定してください。key(id or name)、降順にしたい場合は先頭に-(ハイフン)を付ける)

戻り値:

[Job]

get_my_account(**kwargs) → Any#

ログイン中のアカウント情報を取得する

Args:

戻り値:

Account

get_my_schedules(query_params: dict[str, Any] | None = None, **kwargs) → Any#

自身がアサインされているスケジュール一覧を取得する

パラメータ:

query_params (dict[str, Any]) -- Query Parameters workspace_id (str): ワークスペースIDを指定することで対象のワークスペースでアサインされているスケジュールのみを取得できる term_start (str): 日付での範囲検索で使用 term_end (str): 日付での範囲検索で使用

戻り値:

[Schedule]

get_my_workspace_members(query_params: dict[str, Any] | None = None, **kwargs) → Any#

自身のワークスペースメンバー情報一覧を取得する

パラメータ:

query_params (dict[str, Any]) -- Query Parameters workspace_id (str): ワークスペースIDを指定することで対象のワークスペースに所属しているワークスペースメンバー情報のみを取得できる

戻り値:

[WorkspaceMember]

get_my_workspaces(**kwargs) → Any#

自身の所属するワークスペース情報一覧を取得する

Args:

戻り値:

[Workspace]

get_schedule(workspace_id: str, schedule_id: str, **kwargs) → Any#

作業計画の取得

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • schedule_id (str) -- スケジュールID (required)

戻り値:

Schedule

get_schedules(workspace_id: str, query_params: dict[str, Any] | None = None, **kwargs) → Any#

作業計画の一覧取得

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • query_params (dict[str, Any]) -- Query Parameters term_start (str): 日付での範囲検索で使用 term_end (str): 日付での範囲検索で使用 job_id (str): ジョブID

戻り値:

[Schedule]

get_sum_of_actual_working_times(workspace_id: str, query_params: dict[str, Any] | None = None, **kwargs) → Any#

ワークスペース全体の実績時間の合計取得

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • query_params (dict[str, Any]) -- Query Parameters job_id (str): ジョブID includes_archived_job (bool): アーカイブ化したジョブの合計も含めるかどうか

戻り値:

SumOfTimes

get_sum_of_schedules(workspace_id: str, query_params: dict[str, Any] | None = None, **kwargs) → Any#

ワークスペース全体のスケジュール時間の合計取得

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • query_params (dict[str, Any]) -- Query Parameters job_id (str): ジョブID includes_archived_job (bool): アーカイブ化したジョブの合計も含めるかどうか

戻り値:

SumOfTimes

get_workspace(workspace_id: str, **kwargs) → Any#

ワークスペースの取得

パラメータ:

workspace_id (str) -- ワークスペースID (required)

戻り値:

Workspace

get_workspace_member(workspace_id: str, workspace_member_id: str, **kwargs) → Any#

ワークスペースメンバーの取得

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • workspace_member_id (str) -- ワークスペースメンバーID (required)

戻り値:

WorkspaceMember

get_workspace_member_tags(workspace_id: str, workspace_member_id: str, **kwargs) → Any#

ワークスペースメンバーのタグ一覧取得

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • workspace_member_id (str) -- ワークスペースメンバーID (required)

戻り値:

WorkspaceMemberTags

get_workspace_members(workspace_id: str, query_params: dict[str, Any] | None = None, **kwargs) → Any#

ワークスペースメンバー一覧の取得

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • query_params (dict[str, Any]) -- Query Parameters sort (str): sort key(降順にしたい場合は先頭に-(ハイフン)を付ける) includes_inactive_members (bool): 無効化したワークスペースメンバーも含めるかどうか

戻り値:

[WorkspaceMember]

get_workspace_tag(workspace_id: str, workspace_tag_id: str, **kwargs) → Any#

ワークスペースタグの取得

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • workspace_tag_id (str) -- ワークスペースタグID (required)

戻り値:

WorkspaceTag

get_workspace_tag_members(workspace_id: str, workspace_tag_id: str, **kwargs) → Any#

ワークスペースタグに紐付いているワークスペースメンバーの一覧取得

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • workspace_tag_id (str) -- ワークスペースタグID (required)

戻り値:

WorkspaceTagMembers

get_workspace_tags(workspace_id: str, **kwargs) → Any#

ワークスペースタグ一覧の取得

パラメータ:

workspace_id (str) -- ワークスペースID (required)

戻り値:

[WorkspaceTag]

login() → dict[str, Any][ソース]#

ログイン

戻り値:

Token情報

post_login(request_body: Any | None = None, **kwargs) → Any#

ログイン

パラメータ:

request_body (Any) -- Request Body login_request (LoginRequest): (required)

戻り値:

LoginToken

put_account_external_linkage_info(user_id: str, request_body: Any | None = None, **kwargs) → Any#

アカウント外部連携情報更新

パラメータ:

  • user_id (str) -- ユーザーID (required)

  • request_body (Any) -- Request Body put_account_external_linkage_info_request (PutAccountExternalLinkageInfoRequest): (required)

戻り値:

InlineResponse2001

put_actual_working_time_by_workspace_member(workspace_id: str, workspace_member_id: str, actual_working_time_id: str, request_body: Any | None = None, **kwargs) → Any#

実績時間の更新

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • workspace_member_id (str) -- ワークスペースメンバーID (required)

  • actual_working_time_id (str) -- 実績稼働時間ID (required)

  • request_body (Any) -- Request Body put_actual_working_time_request (PutActualWorkingTimeRequest): (required)

戻り値:

ActualWorkingTime

put_expected_working_time_by_workspace_member(workspace_id: str, workspace_member_id: str, date: str, request_body: Any | None = None, **kwargs) → Any#

予定稼働時間の日付指定更新

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • workspace_member_id (str) -- ワークスペースメンバーID (required)

  • date (str) -- 予定の対象日 (required)

  • request_body (Any) -- Request Body put_expected_working_time_request (PutExpectedWorkingTimeRequest): (required)

戻り値:

ExpectedWorkingTime

put_job(workspace_id: str, job_id: str, request_body: Any | None = None, **kwargs) → Any#

ジョブの更新

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • job_id (str) -- ジョブID (required)

  • request_body (Any) -- Request Body put_job_request (PutJobRequest): (required)

戻り値:

Job

put_my_account(request_body: Any | None = None, **kwargs) → Any#

アカウント情報更新

パラメータ:

request_body (Any) -- Request Body put_my_account_request (PutMyAccountRequest): (required)

戻り値:

Account

put_schedule(workspace_id: str, schedule_id: str, request_body: Any | None = None, **kwargs) → Any#

作業計画の更新

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • schedule_id (str) -- スケジュールID (required)

  • request_body (Any) -- Request Body put_schedule_request (PutScheduleRequest): (required)

戻り値:

Schedule

put_workspace(workspace_id: str, request_body: Any | None = None, **kwargs) → Any#

ワークスペースの更新

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • request_body (Any) -- Request Body put_workspace_request (PutWorkspaceRequest): (required)

戻り値:

Workspace

put_workspace_member(workspace_id: str, workspace_member_id: str, request_body: Any | None = None, **kwargs) → Any#

ワークスペースメンバーの変更

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • workspace_member_id (str) -- ワークスペースメンバーID (required)

  • request_body (Any) -- Request Body put_workspace_member_request (PutWorkspaceMemberRequest): (required)

戻り値:

WorkspaceMember

put_workspace_tag(workspace_id: str, workspace_tag_id: str, request_body: Any | None = None, **kwargs) → Any#

ワークスペースタグの更新

パラメータ:

  • workspace_id (str) -- ワークスペースID (required)

  • workspace_tag_id (str) -- ワークスペースタグID (required)

  • request_body (Any) -- Request Body put_workspace_tag_request (PutWorkspaceTagRequest): (required)

戻り値:

WorkspaceTag

reset_password(request_body: Any | None = None, **kwargs) → Any#

パスワードリセットstep1（開始）

パスワードリセットに必要な確認コードをメールで送付します。 後続の[新しいパスワードに変更](#operation/confirmResetPassword)を実行することで、新しいパスワードに変更できます。

パラメータ:

request_body (Any) -- Request Body reset_password_request (ResetPasswordRequest): (required)

戻り値:

InlineResponse200

sign_up(request_body: Any | None = None, **kwargs) → Any#

サインアップstep1（仮登録）

アカウントのサインアップの最初のステップとして、アカウントを仮登録します。 Annoworkに未登録のメールアドレスであれば、新規アカウントが仮登録状態で作成され、本登録フローのためのメールが送信されます。 このメールには仮パスワードなどが記載されています。 指定したメールアドレスを使うユーザーが仮登録であれば、本登録フローのメールが再送信されます。 指定したメールアドレスを使うユーザーが本登録であれば、不正なリクエストとしてエラーを返します（本登録が仮登録に戻ることはありません）。

パラメータ:

request_body (Any) -- Request Body sign_up_request (SignUpRequest): (required)

戻り値:

InlineResponse200