Toggl Track (獨立發行者) (預覽版)
唯一一款時間追蹤軟體,可根據團隊的時間資料建立自訂報告,以最大限度地提高生產力和收入。 我們的時間跟踪解決方案記錄您全天所有工作活動的日曆時間表。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | 特洛伊·泰勒 |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 特洛伊斯泰勒 |
| 網站 | https://toggl.com/track/automated-time-tracker/ |
| 隱私策略 | https://toggl.com/legal/track/privacy/ |
| 類別 | 生產力 |
切換軌道
唯一一款時間追蹤軟體,可根據團隊的時間資料建立自訂報告,以最大限度地提高生產力和收入。 我們的時間跟踪解決方案記錄您全天所有工作活動的日曆時間表。
發行商:Troy Taylor,Hitachi Solutions
先決條件
您必須在 Toggl 註冊一個帳戶。
取得憑證
此連接器會使用您的電子郵件地址和密碼進行基本驗證。
支援的作業
取得目前的使用者
傳回目前使用者的詳細資料。
更新目前使用者
更新目前使用者的詳細資料。
取得使用者用戶端
取得目前使用者的用戶端。
取得使用者功能
取得目前使用者可用的功能。
取得使用者位置
傳回用戶端的 IP 型位置。 如果沒有資料存在,則會產生空回應。
檢查驗證
用於檢查身份驗證是否有效。
取得使用者組織
取得指定使用者所屬的所有組織。
取得使用者專案
取得目前使用者的專案。
將使用者專案分頁
取得目前使用者的分頁專案。
取得使用者標籤
傳回目前使用者的標籤。
取得使用者工作
從使用者參與的專案傳回任務。
取得曲目提醒
傳回曲目提醒清單。
取得網頁計時器
取得 Web 計時器設定。
取得使用者工作區
列出指定使用者的工作區。
取得時間項目
列出最新的時間項目。
取得目前時間條目
載入使用者 ID 的執行時間項目。
通過 ID 獲取時間條目
依目前使用者可存取的 ID 載入時間項目。
取得工作區使用者 (組織層級)
直接或透過至少一個群組傳回屬於工作區的任何使用者。
取得工作區使用者
列出指定工作區的所有使用者。
取得工作區專案使用者
列出指定工作區的所有專案使用者。
取得使用者用戶端
取得目前使用者的用戶端。
取得使用者組織
取得指定使用者所屬的所有組織。
取得工作區使用者 (組織層級)
直接或透過至少一個群組傳回屬於工作區的任何使用者。
取得使用者專案
取得目前使用者的專案。
將使用者專案分頁
取得目前使用者的分頁專案。
取得工作區專案使用者
列出指定工作區的所有專案使用者。
取得工作區專案
取得指定工作區的專案。
取得工作區專案
取得指定工作區的專案。
取得使用者標籤
傳回目前使用者的標籤。
取得使用者工作
從使用者參與的專案傳回任務。
取得使用者工作區
列出指定使用者的工作區。
建立時間項目
建立新的工作區時間項目。
刪除時間項目
刪除工作區時間項目。
更新時間項目
更新工作區時間項目。
大量編輯時間項目
大量編輯時間項目。 當某些記錄出現錯誤時,補丁將部分執行。 沒有交易,就沒有回滾。
停止時間輸入
停止工作區時間項目。
取得工作區使用者 (組織層級)
直接或透過至少一個群組傳回屬於工作區的任何使用者。
取得單一工作區
取得單一工作區的資訊。
取得費率清單
按級別(工作區|項目|任務|用戶)獲取費率。
取得工作區統計資料
傳回工作區管理員清單、成員計數和群組計數。
取得工作區時間項目限制
取得指定工作區的時間項目限制。
取得工作區追蹤提醒
傳回曲目提醒清單。
取得工作區使用者
列出指定工作區的所有使用者。
取得工作區專案使用者
列出指定工作區的所有專案使用者。
取得工作區專案
取得指定工作區的專案。
取得工作區專案
取得指定工作區的專案。
取得時間項目
列出最新的時間項目。
取得目前時間條目
載入使用者 ID 的執行時間項目。
通過 ID 獲取時間條目
依目前使用者可存取的 ID 載入時間項目。
建立時間項目時
在工作區中建立新的時間項目時觸發。
更新時間項目時
在工作區中修改現有時間項目時觸發。
刪除時間項目時
從工作區中刪除時間項目時觸發。
啟動時間項目時
在工作區中啟動時間項目 (計時器開始) 時觸發。
當時間項目停止時
當工作區中的執行時間項目停止時觸發。
已知問題和限制
目前沒有已知問題。
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 用戶名稱 | securestring | 此API的使用者名稱 | 對 |
| 密碼 | securestring | 此 API 的密碼 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 停止時間輸入 |
停止工作區時間項目。 |
| 刪除時間項目 |
刪除工作區時間項目。 |
| 取得使用者位置 |
傳回用戶端的 IP 型位置。 如果沒有資料存在,則會產生空回應。 |
| 取得使用者功能 |
取得目前使用者可用的功能。 |
| 取得使用者專案 |
取得目前使用者的專案。 |
| 取得使用者工作 |
從使用者參與的專案傳回任務。 |
| 取得使用者工作區 |
列出指定使用者的工作區。 |
| 取得使用者標籤 |
傳回目前使用者的標籤。 |
| 取得使用者用戶端 |
取得目前使用者的用戶端。 |
| 取得使用者組織 |
取得指定使用者所屬的所有組織。 |
| 取得單一工作區 |
取得單一工作區的資訊。 |
| 取得工作區使用者 |
列出指定工作區的所有使用者。 |
| 取得工作區使用者 (組織層級) |
直接或透過至少一個群組傳回屬於工作區的任何使用者。 |
| 取得工作區專案 |
取得指定工作區的專案。 |
| 取得工作區專案 |
取得指定工作區的專案。 |
| 取得工作區專案使用者 |
列出指定工作區的所有專案使用者。 |
| 取得工作區時間項目限制 |
取得指定工作區的時間項目限制。 |
| 取得工作區統計資料 |
傳回工作區管理員清單、成員計數和群組計數。 |
| 取得工作區追蹤提醒 |
傳回曲目提醒清單。 |
| 取得時間項目 |
列出最新的時間項目。 |
| 取得曲目提醒 |
傳回曲目提醒清單。 |
| 取得目前時間條目 |
載入使用者 ID 的執行時間項目。 |
| 取得目前的使用者 |
傳回目前使用者的詳細資料。 |
| 取得網頁計時器 |
取得 Web 計時器設定。 |
| 取得費率清單 |
按級別(工作區|項目|任務|用戶)獲取費率。 |
| 大量編輯時間項目 |
大量編輯時間項目。 當某些記錄出現錯誤時,補丁將部分執行。 沒有交易,就沒有回滾。 |
| 將使用者專案分頁 |
取得目前使用者的分頁專案。 |
| 建立時間項目 |
建立新的工作區 TimeEntry。 |
| 更新時間項目 |
更新工作區時間項目。 |
| 更新目前使用者 |
更新目前使用者的詳細資料。 |
| 檢查驗證 |
用於檢查身份驗證是否有效。 |
| 通過 ID 獲取時間條目 |
依目前使用者可存取的 ID 載入時間項目。 |
停止時間輸入
停止工作區時間項目。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
|
時間項目 ID
|
time_entry_id | True | integer |
TimeEntry 識別碼。 |
傳回
- 身體
- TimeEntry
刪除時間項目
刪除工作區時間項目。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
|
時間項目 ID
|
time_entry_id | True | integer |
TimeEntry 識別碼。 |
取得使用者位置
取得使用者功能
取得使用者專案
取得目前使用者的專案。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
包括已存檔
|
include_archived | string |
包括封存的專案。 |
|
|
自日期以來
|
since | integer |
使用 UNIX 時間戳記擷取自此日期以來建立/修改/刪除的項目。 |
傳回
- response
- array of Project
取得使用者工作
從使用者參與的專案傳回任務。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
包含中繼資料
|
meta | boolean |
回應是否應該包含中繼實體的資料。 |
|
|
自日期以來
|
since | integer |
使用 UNIX 時間戳記擷取自此日期以來建立/修改/刪除的項目。 |
|
|
包括非作用中任務
|
include_not_active | string |
包括標示為完成的任務。 |
|
|
分頁偏移
|
offset | integer |
Offset 以從中恢復下一個分頁。 |
|
|
每頁項目數
|
per_page | integer |
每頁的項目數,預設為 201。 |
傳回
- response
- array of Task
取得使用者工作區
列出指定使用者的工作區。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
自日期以來
|
since | integer |
使用 UNIX 時間戳記擷取自此日期以來建立/修改/刪除的項目。 |
傳回
- response
- array of Workspace
取得使用者標籤
傳回目前使用者的標籤。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
自日期以來
|
since | integer |
使用 UNIX 時間戳記擷取自此日期以來建立/修改/刪除的項目。 |
傳回
- response
- array of Tag
取得使用者用戶端
取得目前使用者的用戶端。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
自日期以來
|
since | integer |
使用 UNIX 時間戳記擷取自此日期以來建立/修改/刪除的項目。 |
傳回
- response
- array of Client
取得使用者組織
取得單一工作區
取得工作區使用者
列出指定工作區的所有使用者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
|
排除已刪除
|
exclude_deleted | boolean |
在回應中排除已刪除的記錄。 |
傳回
- response
- array of WorkspaceUserSimple
取得工作區使用者 (組織層級)
直接或透過至少一個群組傳回屬於工作區的任何使用者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織識別碼
|
organization_id | True | integer |
組織的數字 ID。 |
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
|
頁碼
|
page | integer |
頁碼。 |
|
|
每頁項目數
|
per_page | integer |
每頁的項目數,預設為 201。 |
|
|
自訂費率篩選器
|
custom_rates | boolean |
僅傳回具有或沒有自訂小時費率的使用者。 |
|
|
僅限活躍用戶
|
active | boolean |
僅傳回作用中使用者。 |
|
|
名稱篩選器
|
name | string |
要篩選依據的工作區使用者名稱。 |
|
|
搜尋篩選器
|
search | string |
依名稱或電子郵件篩選工作區。 |
傳回
- response
- array of WorkspaceUser
取得工作區專案
取得指定工作區的專案。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
|
專案識別碼
|
project_id | True | integer |
專案的數字 ID。 |
傳回
- 身體
- Project
取得工作區專案
取得指定工作區的專案。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
|
已釘選排序
|
sort_pinned | True | boolean |
將釘選的專案放在回應的頂端。 |
|
僅限活躍用戶
|
active | boolean |
僅傳回作用中使用者。 |
|
|
自日期以來
|
since | integer |
使用 UNIX 時間戳記擷取自此日期以來建立/修改/刪除的項目。 |
|
|
可計費
|
billable | boolean |
按可計費狀態過濾。 |
|
|
使用者 ID
|
user_ids | array |
要篩選的使用者 ID。 |
|
|
用戶端 ID
|
client_ids | array |
要篩選的用戶端識別碼。 |
|
|
群組標識碼
|
group_ids | array |
要篩選的群組 ID。 |
|
|
專案 ID
|
project_ids | string |
專案的數字 ID,以逗號分隔。 |
|
|
狀態
|
statuses | array |
要篩選的專案狀態。 |
|
|
名稱篩選器
|
name | string |
要篩選依據的工作區使用者名稱。 |
|
|
頁碼
|
page | integer |
頁碼。 |
|
|
排序欄位
|
sort_field | True | string |
要排序的欄位。 |
|
排序順序
|
sort_order | True | string |
排序順序 (asc/desc)。 |
|
僅限範本
|
only_templates | True | boolean |
僅傳回專案範本。 |
|
僅限我的專案
|
only_me | boolean |
僅獲取分配給當前用戶的項目。 |
|
|
每頁項目數
|
per_page | integer |
每頁的項目數,預設為 201。 |
傳回
- response
- array of Project
取得工作區專案使用者
列出指定工作區的所有專案使用者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
|
專案 ID
|
project_ids | string |
專案的數字 ID,以逗號分隔。 |
|
|
使用者識別碼
|
user_id | string |
使用者的數值 ID,如果傳遞,則只會傳回此使用者專案的專案使用者。 |
|
|
包括群組成員
|
with_group_members | boolean |
包括群組成員。 |
傳回
- response
- array of ProjectUser
取得工作區時間項目限制
取得指定工作區的時間項目限制。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
傳回
取得工作區統計資料
傳回工作區管理員清單、成員計數和群組計數。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
傳回
取得工作區追蹤提醒
傳回曲目提醒清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
傳回
取得時間項目
列出最新的時間項目。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
包含中繼資料
|
meta | boolean |
回應是否應該包含中繼實體的資料。 |
|
|
包含共用
|
include_sharing | boolean |
在回覆中包含分享詳細資訊。 |
|
|
自日期以來
|
since | integer |
使用 UNIX 時間戳記擷取自此日期以來建立/修改/刪除的項目。 |
|
|
之前日期
|
before | string |
獲取帶有開始時間、給定日期之前 (YYYY-MM-DD) 或RFC3339格式的條目。 |
|
|
開始日期
|
start_date | string |
獲取帶有開始時間的條目,從 YYYY-MM-DD start_date或RFC3339格式的時間。 與end_date一起使用。 |
|
|
結束日期
|
end_date | string |
取得帶有開始時間的條目,直到 end_date YYYY-MM-DD 或以RFC3339格式取得時間。 與start_date一起使用。 |
傳回
- response
- array of TimeEntry
取得曲目提醒
取得目前時間條目
取得目前的使用者
傳回目前使用者的詳細資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
包含相關資料
|
with_related_data | boolean |
檢索用戶相關數據(客戶、項目、任務、標籤、工作區、時間條目等)。 |
傳回
- 身體
- UserResponse
取得網頁計時器
取得 Web 計時器設定。
取得費率清單
按級別(工作區|項目|任務|用戶)獲取費率。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
|
Level
|
level | True | string |
費率層級:工作區、專案、任務或使用者。 |
|
層級 ID
|
level_id | True | integer |
實體層級的數值識別碼。 |
|
費率類型
|
type | string |
要傳回的費率值類型:billable_rates 或 labor_costs。 預設值為billable_rates。 |
傳回
- response
- array of Rate
大量編輯時間項目
大量編輯時間項目。 當某些記錄出現錯誤時,補丁將部分執行。 沒有交易,就沒有回滾。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
|
時間項目 ID
|
time_entry_ids | True | string |
time_entries的數字 ID,以逗號分隔。 例如:204301830,202700150,202687559。 每個請求的限制為 100 個 ID。 |
|
包含中繼資料
|
meta | boolean |
回應是否應該包含中繼實體的資料。 |
|
|
行動
|
op | True | string |
操作(添加/刪除/替換)。 |
|
路徑
|
path | True | string |
要修補的實體路徑(例如 /description)。 |
|
價值觀
|
value | object |
路徑中實體的新值。 |
傳回
將使用者專案分頁
取得目前使用者的分頁專案。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
啟動專案 ID
|
start_project_id | integer |
專案 ID,以從中繼續下一個分頁。 |
|
|
自日期以來
|
since | integer |
使用 UNIX 時間戳記擷取自此日期以來建立/修改/刪除的項目。 |
|
|
每頁項目數
|
per_page | integer |
每頁的項目數,預設為 201。 |
傳回
- response
- array of Project
建立時間項目
建立新的工作區 TimeEntry。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
|
包含中繼資料
|
meta | boolean |
回應是否應該包含中繼實體的資料。 |
|
|
可計費
|
billable | boolean |
時間項目是否標示為可計費、選擇性、預設 false。 |
|
|
創建方式
|
created_with | string |
建立時間項目時必須提供,並應識別用來建立時間項目的服務/應用程式。 |
|
|
Description
|
description | string |
時間項目描述,選用。 |
|
|
持續時間
|
duration | integer |
時間輸入持續時間。 對於運行條目,應為負數,最好為 -1。 |
|
|
僅持續時間
|
duronly | boolean |
已棄用:用於建立具有持續時間但沒有停止時間的時間項目。 可以忽略此參數。 |
|
|
原點功能
|
origin_feature | string |
原點特徵名稱。 |
|
|
可見目標數
|
visible_goals_count | integer |
可見目標的數量。 |
|
|
費用 ID
|
expense_ids | array of integer |
與時間項目相關聯的工作費用。 |
|
|
專案 ID (舊版)
|
pid | integer |
專案 ID,舊版欄位。 |
|
|
專案識別碼
|
project_id | integer |
專案 ID,選用。 |
|
|
與使用者 ID 共用
|
shared_with_user_ids | array of integer |
要與之共用此時間項目的使用者 ID 清單。 |
|
|
開始時間
|
start | string |
開始時間以 UTC 為單位,建立時需要。 格式:2006-01-02T15:04:05Z。 |
|
|
開始日期
|
start_date | string |
如果在建立期間提供,則日期部分將優先於「開始」的日期部分。 格式:2006-11-07。 |
|
|
停止時間
|
stop | string |
UTC 中的停止時間,如果它仍在運行或使用“duration”創建,則可以省略。 如果提供 'stop' 和 'duration',則值必須一致 (start + duration == stop)。 |
|
|
標籤動作
|
tag_action | string |
可以是「新增」或「刪除」。 更新現有時間項目時使用。 |
|
|
標籤 ID
|
tag_ids | array of integer |
要新增/移除的標籤 ID。 |
|
|
Tags
|
tags | array of string |
要新增/移除的標籤名稱。 如果名稱作為標籤不存在,則會自動建立一個。 |
|
|
工作識別碼
|
task_id | integer |
工作 ID,選用。 |
|
|
工作識別碼 (舊版)
|
tid | integer |
任務 ID,舊版欄位。 |
|
|
使用者 ID (舊版)
|
uid | integer |
時間項目建立者識別碼,舊版欄位。 |
|
|
使用者識別碼
|
user_id | integer |
時間項目建立者識別碼 (如果省略) 將使用要求者使用者識別碼。 |
|
|
工作區 ID (舊版)
|
wid | integer |
工作區ID,舊版欄位。 |
|
|
工作區識別碼
|
workspace_id | integer |
工作區 ID,必要。 |
傳回
- 身體
- TimeEntry
更新時間項目
更新工作區時間項目。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
|
時間項目 ID
|
time_entry_id | True | integer |
TimeEntry 識別碼。 |
|
包含中繼資料
|
meta | boolean |
回應是否應該包含中繼實體的資料。 |
|
|
包含共用
|
include_sharing | boolean |
在回覆中包含分享詳細資訊。 |
|
|
可計費
|
billable | boolean |
時間項目是否標示為可計費、選擇性、預設 false。 |
|
|
創建方式
|
created_with | string |
建立時間項目時必須提供,並應識別用來建立時間項目的服務/應用程式。 |
|
|
Description
|
description | string |
時間項目描述,選用。 |
|
|
持續時間
|
duration | integer |
時間輸入持續時間。 對於運行條目,應為負數,最好為 -1。 |
|
|
僅持續時間
|
duronly | boolean |
已棄用:用於建立具有持續時間但沒有停止時間的時間項目。 可以忽略此參數。 |
|
|
原點功能
|
origin_feature | string |
原點特徵名稱。 |
|
|
可見目標數
|
visible_goals_count | integer |
可見目標的數量。 |
|
|
費用 ID
|
expense_ids | array of integer |
與時間項目相關聯的工作費用。 |
|
|
專案 ID (舊版)
|
pid | integer |
專案 ID,舊版欄位。 |
|
|
專案識別碼
|
project_id | integer |
專案 ID,選用。 |
|
|
與使用者 ID 共用
|
shared_with_user_ids | array of integer |
要與之共用此時間項目的使用者 ID 清單。 |
|
|
開始時間
|
start | string |
開始時間以 UTC 為單位,建立時需要。 格式:2006-01-02T15:04:05Z。 |
|
|
開始日期
|
start_date | string |
如果在建立期間提供,則日期部分將優先於「開始」的日期部分。 格式:2006-11-07。 |
|
|
停止時間
|
stop | string |
UTC 中的停止時間,如果它仍在運行或使用“duration”創建,則可以省略。 如果提供 'stop' 和 'duration',則值必須一致 (start + duration == stop)。 |
|
|
標籤動作
|
tag_action | string |
可以是「新增」或「刪除」。 更新現有時間項目時使用。 |
|
|
標籤 ID
|
tag_ids | array of integer |
要新增/移除的標籤 ID。 |
|
|
Tags
|
tags | array of string |
要新增/移除的標籤名稱。 如果名稱作為標籤不存在,則會自動建立一個。 |
|
|
工作識別碼
|
task_id | integer |
工作 ID,選用。 |
|
|
工作識別碼 (舊版)
|
tid | integer |
任務 ID,舊版欄位。 |
|
|
使用者 ID (舊版)
|
uid | integer |
時間項目建立者識別碼,舊版欄位。 |
|
|
使用者識別碼
|
user_id | integer |
時間項目建立者識別碼 (如果省略) 將使用要求者使用者識別碼。 |
|
|
工作區 ID (舊版)
|
wid | integer |
工作區ID,舊版欄位。 |
|
|
工作區識別碼
|
workspace_id | integer |
工作區 ID,必要。 |
傳回
- 身體
- TimeEntry
更新目前使用者
更新目前使用者的詳細資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
週初
|
beginning_of_week | integer |
使用者一週的第一天。 週日:0,週一:1,依此類推。 |
|
|
國家/地區 ID
|
country_id | integer |
使用者的國家/地區 ID。 |
|
|
目前密碼
|
current_password | string |
使用者目前的密碼(用於變更目前密碼)。 |
|
|
預設工作區識別碼
|
default_workspace_id | integer |
使用者的預設工作區識別碼。 |
|
|
Email
|
string |
用戶的電子郵件位址。 |
||
|
全名
|
fullname | string |
使用者的全名。 |
|
|
新密碼
|
password | string |
使用者的新密碼(也必須提供目前的密碼)。 |
|
|
Timezone
|
timezone | string |
使用者的時區。 |
傳回
檢查驗證
用於檢查身份驗證是否有效。
通過 ID 獲取時間條目
依目前使用者可存取的 ID 載入時間項目。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
時間項目 ID
|
time_entry_id | True | integer |
TimeEntry 識別碼。 |
|
包含中繼資料
|
meta | boolean |
回應是否應該包含中繼實體的資料。 |
|
|
包含共用
|
include_sharing | boolean |
在回覆中包含分享詳細資訊。 |
傳回
- 身體
- TimeEntry
觸發程序
| 刪除時間項目時 |
從工作區中刪除時間項目時觸發。 |
| 啟動時間項目時 |
在工作區中啟動時間項目 (計時器開始) 時觸發。 |
| 建立時間項目時 |
在工作區中建立新的時間項目時觸發。 |
| 更新時間項目時 |
在工作區中修改現有時間項目時觸發。 |
| 當時間項目停止時 |
當工作區中的執行時間項目停止時觸發。 |
刪除時間項目時
從工作區中刪除時間項目時觸發。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
|
實體
|
entity | string |
切換 追蹤要篩選的業務實體。 |
|
|
行動
|
action | string |
套用至實體的修改類型。 |
傳回
啟動時間項目時
在工作區中啟動時間項目 (計時器開始) 時觸發。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
|
實體
|
entity | string |
切換 追蹤要篩選的業務實體。 |
|
|
行動
|
action | string |
套用至實體的修改類型。 |
傳回
建立時間項目時
在工作區中建立新的時間項目時觸發。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
|
實體
|
entity | string |
切換 追蹤要篩選的業務實體。 |
|
|
行動
|
action | string |
套用至實體的修改類型。 |
傳回
更新時間項目時
在工作區中修改現有時間項目時觸發。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
|
實體
|
entity | string |
切換 追蹤要篩選的業務實體。 |
|
|
行動
|
action | string |
套用至實體的修改類型。 |
傳回
當時間項目停止時
當工作區中的執行時間項目停止時觸發。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作區識別碼
|
workspace_id | True | integer |
工作區的數字識別碼。 |
|
實體
|
entity | string |
切換 追蹤要篩選的業務實體。 |
|
|
行動
|
action | string |
套用至實體的修改類型。 |
傳回
定義
使用者回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
啟用 2FA
|
2fa_enabled | boolean |
已啟用雙因素身份驗證狀態。 |
|
API 令牌
|
api_token | string |
API 權杖,如果為空,則會省略。 |
|
上次更新
|
at | string |
上次更新時間戳記。 |
|
授權更新
|
authorization_updated_at | string |
授權使用者工作階段物件上次更新的時間戳記。 |
|
週初
|
beginning_of_week | integer |
使用者一週的第一天(0=星期日,1=星期一等)。 |
|
客戶
|
clients | array of Client |
用戶端,如果with_related_data未設定為 true,則為 null。 |
|
國家/地區 ID
|
country_id | integer |
使用者的國家/地區 ID。 |
|
創建於
|
created_at | string |
使用者建立時間戳記。 |
|
預設工作區識別碼
|
default_workspace_id | integer |
使用者的預設工作區識別碼。 |
|
Email
|
string |
用戶的電子郵件位址。 |
|
|
全名
|
fullname | string |
使用者的全名。 |
|
有密碼
|
has_password | boolean |
使用者是否已設定密碼。 |
|
使用者識別碼
|
id | integer |
使用者識別碼。 |
|
圖像網址
|
image_url | string |
使用者的設定檔影像URL。 |
|
對講雜湊
|
intercom_hash | string |
對講機雜湊,如果為空,則會省略。 |
|
OAuth提供者
|
oauth_providers | array of string |
可供使用者使用的 OAuth 提供者。 |
|
OpenID 電子郵件
|
openid_email | string |
OpenID 電子郵件地址。 |
|
已啟用 OpenID
|
openid_enabled | boolean |
OpenID 驗證已啟用狀態。 |
|
選項
|
options | object |
使用者選項,如果為空,則會省略。 |
|
專案
|
projects | array of Project |
專案,如果 with_related_data 未設定為 true,則為 null。 |
|
Tags
|
tags | array of Tag |
標籤,如果with_related_data未設定為 true,則為 null。 |
|
任務
|
tasks | array of Task |
Tasks,如果 with_related_data 未設定為 true,則為 null。 |
|
時間項目
|
time_entries | array of TimeEntry |
時間項目,如果with_related_data未設定為 true,則為 null。 |
|
Timezone
|
timezone | string |
使用者的時區。 |
|
更新於
|
updated_at | string |
使用者上次更新時間戳記。 |
|
工作區
|
workspaces | array of Workspace |
工作區,如果with_related_data未設定為 true,則為 null。 |
UserBasic回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
啟用 2FA
|
2fa_enabled | boolean |
已啟用雙因素身份驗證狀態。 |
|
API 令牌
|
api_token | string |
API 權杖,如果為空,則會省略。 |
|
上次更新
|
at | string |
上次更新時間戳記。 |
|
週初
|
beginning_of_week | integer |
使用者一週的第一天。 |
|
國家/地區 ID
|
country_id | integer |
使用者的國家/地區 ID。 |
|
創建於
|
created_at | string |
使用者建立時間戳記。 |
|
預設工作區識別碼
|
default_workspace_id | integer |
使用者的預設工作區識別碼。 |
|
Email
|
string |
用戶的電子郵件位址。 |
|
|
全名
|
fullname | string |
使用者的全名。 |
|
有密碼
|
has_password | boolean |
使用者是否已設定密碼。 |
|
使用者識別碼
|
id | integer |
使用者識別碼。 |
|
圖像網址
|
image_url | string |
使用者的設定檔影像URL。 |
|
OpenID 電子郵件
|
openid_email | string |
OpenID 電子郵件地址。 |
|
已啟用 OpenID
|
openid_enabled | boolean |
OpenID 驗證已啟用狀態。 |
|
選項
|
options | object |
使用者選項,如果為空,則會省略。 |
|
Timezone
|
timezone | string |
使用者的時區。 |
|
更新於
|
updated_at | string |
使用者上次更新時間戳記。 |
客戶
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Archived
|
archived | boolean |
如果用戶端已封存,則為 true。 |
|
上次更新
|
at | string |
最後一次更新是什麼時候。 |
|
創作者 ID
|
creator_id | integer |
建立用戶端的使用者識別碼。 |
|
外部參考
|
external_reference | string |
追蹤用戶端實體的外部參考。 |
|
用戶端識別碼
|
id | integer |
用戶端識別碼。 |
|
整合外部ID
|
integration_ext_id | string |
外部系統中連結實體的外部 ID。 |
|
整合外部類型
|
integration_ext_type | string |
外部系統中連結實體的外部類型。 |
|
整合提供者
|
integration_provider | object |
具有連結至此 Toggl Track 實體的實體的提供者。 |
|
客戶名稱
|
name | string |
用戶端的名稱。 |
|
註釋
|
notes | string |
客戶筆記。 |
|
權限
|
permissions | array of string |
此用戶端的授權權限清單。 |
|
總計數
|
total_count | integer |
Total 欄位來儲存總計數。 |
|
工作區識別碼
|
wid | integer |
工作區 ID。 |
專案
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Active
|
active | boolean |
專案是作用中還是已封存。 |
|
實際時數
|
actual_hours | integer |
專案實際花費的小時數。 |
|
實際秒數
|
actual_seconds | integer |
專案實際花費的秒數。 |
|
上次更新
|
at | string |
最後更新日期。 |
|
自動估算
|
auto_estimates | boolean |
啟用自動估計。 |
|
可計費
|
billable | boolean |
專案是否可計費。 |
|
可以追蹤時間
|
can_track_time | boolean |
是否可以追蹤到這個專案的時間。 |
|
用戶端 ID (舊版)
|
cid | integer |
Client ID legacy 欄位。 |
|
用戶端識別碼
|
client_id | integer |
用戶端識別碼。 |
|
客戶名稱
|
client_name | string |
用戶端名稱。 |
|
顏色
|
color | string |
專案顏色。 |
|
創建於
|
created_at | string |
創建日期。 |
|
貨幣
|
currency | string |
專案貨幣。 |
|
當前期間
|
current_period | object |
當前項目期間,高級功能。 |
|
結束日期
|
end_date | string |
專案結束日期。 |
|
預計時數
|
estimated_hours | integer |
專案的預估時數。 |
|
預估秒數
|
estimated_seconds | integer |
專案的預估秒數。 |
|
外部參考
|
external_reference | string |
追蹤專案實體的外部參考。 |
|
固定費用
|
fixed_fee | double |
固定費用,高級功能。 |
|
專案識別碼
|
id | integer |
專案 ID。 |
|
整合外部ID
|
integration_ext_id | string |
外部系統中連結實體的外部 ID。 |
|
整合外部類型
|
integration_ext_type | string |
外部系統中連結實體的外部類型。 |
|
整合提供者
|
integration_provider | object |
具有連結至此 Toggl Track 實體的實體的提供者。 |
|
是私人
|
is_private | boolean |
專案是否為私人專案。 |
|
專案名稱
|
name | string |
專案名稱。 |
|
權限
|
permissions | array of string |
專案權限。 |
|
已釘選
|
pinned | boolean |
專案是否釘選。 |
|
時薪
|
rate | double |
專案的小時費率。 |
|
費率 最後更新
|
rate_last_updated | string |
上次更新費率的時間。 |
|
定期
|
recurring | boolean |
項目是否是重複的高級功能。 |
|
週期性參數
|
recurring_parameters | array of RecurringParameter |
項目重複參數,高級功能。 |
|
開始日期
|
start_date | string |
專案開始日期。 |
|
地位
|
status | string |
專案的狀態(即將進行、作用中、已結束、已封存、已刪除)。 |
|
Template
|
template | boolean |
專案是否為範本。 |
|
範本識別碼
|
template_id | integer |
如果專案是以範本為基礎,則範本 ID。 |
|
總計數
|
total_count | integer |
找到的專案總數。 |
|
工作區 ID (舊版)
|
wid | integer |
Workspace ID 舊版欄位。 |
|
工作區識別碼
|
workspace_id | integer |
工作區 ID。 |
Recurring參數
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
自訂期間
|
custom_period | integer |
自訂期間,當期間欄位為「自訂」時使用。 |
|
預估秒數
|
estimated_seconds | integer |
估計秒數。 |
|
參數結束日期
|
parameter_end_date | string |
參數結束日期。 |
|
參數開始日期
|
parameter_start_date | string |
週期性開始日期。 |
|
期間
|
period | string |
週期性。 |
|
專案開始日期
|
project_start_date | string |
專案開始日期。 |
標記
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
上次修改時間
|
at | string |
建立/上次修改的時間。 |
|
創作者 ID
|
creator_id | integer |
建立標籤的使用者 ID。 |
|
刪除時間
|
deleted_at | string |
何時被刪除。 |
|
標籤 ID
|
id | integer |
標籤 ID。 |
|
整合外部ID
|
integration_ext_id | string |
外部系統中連結實體的外部 ID。 |
|
整合外部類型
|
integration_ext_type | string |
外部系統中連結實體的外部類型。 |
|
整合提供者
|
integration_provider | object |
具有連結至此 Toggl Track 實體的實體的提供者。 |
|
標記名稱
|
name | string |
標記名稱。 |
|
權限
|
permissions | array of string |
標籤權限。 |
|
工作區識別碼
|
workspace_id | integer |
工作區 ID。 |
任務
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Active
|
active | boolean |
False 當任務完成時。 |
|
上次修改時間
|
at | string |
任務的建立/上次修改時間。 |
|
頭像網址
|
avatar_url | string |
頭像網址。 |
|
客戶名稱
|
client_name | string |
用戶端名稱。 |
|
預估秒數
|
estimated_seconds | integer |
任務的預估秒數。 |
|
工作識別碼
|
id | integer |
工作 ID。 |
|
整合外部ID
|
integration_ext_id | string |
外部系統中連結實體的外部 ID。 |
|
整合外部類型
|
integration_ext_type | string |
外部系統中連結實體的外部類型。 |
|
整合提供者
|
integration_provider | object |
具有連結至此 Toggl Track 實體的實體的提供者。 |
|
任務名稱
|
name | string |
任務名稱。 |
|
權限
|
permissions | array of string |
任務權限。 |
|
項目計費
|
project_billable | boolean |
專案是否可計費。 |
|
專案顏色
|
project_color | string |
專案色彩中繼資料。 |
|
專案識別碼
|
project_id | integer |
專案 ID。 |
|
專案是私人的
|
project_is_private | boolean |
專案是否為私人專案。 |
|
專案名稱
|
project_name | string |
專案名稱。 |
|
費率
|
rate | double |
此任務的費率。 |
|
費率 最後更新
|
rate_last_updated | string |
上次更新費率的時間。 |
|
定期
|
recurring | boolean |
這是否是一項重複性任務。 |
|
切換帳戶 ID
|
toggl_accounts_id | string |
切換帳戶 ID。 |
|
追蹤秒數
|
tracked_seconds | integer |
tracked_seconds值以毫秒為單位,而不是以秒為單位。 |
|
使用者識別碼
|
user_id | integer |
使用者識別碼。 |
|
使用者名
|
user_name | string |
使用者名稱。 |
|
工作區識別碼
|
workspace_id | integer |
工作區 ID。 |
時間輸入
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
上次更新
|
at | string |
上次更新時間,遵循 ISO 8601 格式。 |
|
可計費
|
billable | boolean |
時間項目是否標示為可計費。 |
|
客戶名稱
|
client_name | string |
相關實體中繼欄位。 |
|
Description
|
description | string |
時間項目描述。 |
|
持續時間
|
duration | integer |
時間輸入持續時間。 對於運行條目,應為負數,最好為 -1。 |
|
僅持續時間
|
duronly | boolean |
用於建立具有持續時間但沒有停止時間的 TE。 |
|
費用 ID
|
expense_ids | array of integer |
工作費用。 |
|
時間項目 ID
|
id | integer |
時間項目 ID。 |
|
權限
|
permissions | array of string |
權限清單。 |
|
專案 ID (舊版)
|
pid | integer |
專案 ID,舊版欄位。 |
|
項目活躍
|
project_active | boolean |
專案是否處於作用中狀態。 |
|
項目計費
|
project_billable | boolean |
專案是否可計費。 |
|
專案顏色
|
project_color | string |
專案顏色。 |
|
專案識別碼
|
project_id | integer |
專案 ID。 |
|
專案名稱
|
project_name | string |
專案名稱。 |
|
共用對象
|
shared_with | array of SharedWith |
指出時間項目已與誰共用。 |
|
開始時間
|
start | string |
開始時間為 UTC。 |
|
停止時間
|
stop | string |
UTC 中的停止時間,如果仍在執行,則可以為 null。 |
|
標籤 ID
|
tag_ids | array of integer |
標籤 ID,如果未提供標籤或稍後刪除,則為 null。 |
|
Tags
|
tags | array of string |
標籤名稱,如果未提供標籤或稍後刪除標籤,則為 null。 |
|
工作識別碼
|
task_id | integer |
工作 ID。 |
|
任務名稱
|
task_name | string |
任務名稱。 |
|
工作識別碼 (舊版)
|
tid | integer |
任務 ID,舊版欄位。 |
|
使用者 ID (舊版)
|
uid | integer |
時間項目建立者識別碼,舊版欄位。 |
|
使用者頭像網址
|
user_avatar_url | string |
使用者頭像 URL。 |
|
使用者識別碼
|
user_id | integer |
時間項目建立者 ID。 |
|
使用者名
|
user_name | string |
使用者名稱。 |
|
工作區 ID (舊版)
|
wid | integer |
工作區ID,舊版欄位。 |
|
工作區識別碼
|
workspace_id | integer |
工作區 ID。 |
共用
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
已接受
|
accepted | boolean |
是否接受該份額。 |
|
使用者識別碼
|
user_id | integer |
共用人員的使用者 ID。 |
|
使用者名
|
user_name | string |
共用人員的使用者名稱。 |
工作空間
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
作用中專案計數
|
active_project_count | integer |
作用中專案數目。 |
|
管理員
|
admin | boolean |
目前使用者是工作區管理員 (已淘汰)。 |
|
API 令牌
|
api_token | string |
API 權杖 (已淘汰)。 |
|
上次變更
|
at | string |
上次工作區變更的時間戳記。 |
|
商務工作空間
|
business_ws | boolean |
Workspace on Premium 訂閱。 |
|
CSV 上傳
|
csv_upload | object |
CSV 上傳資料。 |
|
預設貨幣
|
default_currency | string |
默認貨幣,高級功能。 |
|
預設小時費率
|
default_hourly_rate | double |
預設小時費率,進階功能。 |
|
停用核准
|
disable_approvals | boolean |
停用工作區中的核准。 |
|
停用時程表檢視
|
disable_timesheet_view | boolean |
停用工作區中的時程表檢視。 |
|
隱藏開始結束時間
|
hide_start_end_times | boolean |
隱藏開始和結束時間。 |
|
啟用 iCal
|
ical_enabled | boolean |
已啟用日曆整合。 |
|
iCal 網址
|
ical_url | string |
行事曆的 URL。 |
|
工作區識別碼
|
id | integer |
工作區的識別碼。 |
|
上次修改時間
|
last_modified | string |
工作區中資料的最後修改。 |
|
限制公用專案資料
|
limit_public_project_data | boolean |
將報表中的公用專案資料限制為管理員。 |
|
標誌網址
|
logo_url | string |
工作區標誌的 URL。 |
|
資料保留天數上限
|
max_data_retention_days | object |
免費工作區可以存取資料的距離。 |
|
工作區名稱
|
name | string |
工作區的名稱。 |
|
只有管理員可以建立專案
|
only_admins_may_create_projects | boolean |
只有管理員才能建立專案。 |
|
只有管理員可以建立標籤
|
only_admins_may_create_tags | boolean |
只有管理員才能建立標籤。 |
|
只有管理員才能看到團隊儀表板
|
only_admins_see_team_dashboard | boolean |
只有管理員才能看到團隊儀表板。 |
|
組織識別碼
|
organization_id | integer |
組織的識別碼。 |
|
權限
|
permissions | array of string |
權限清單。 |
|
進階
|
premium | boolean |
Starter 訂閱的 Workspace 版。 |
|
預設可計費的專案
|
projects_billable_by_default | boolean |
新專案預設可計費。 |
|
專案強制計費
|
projects_enforce_billable | boolean |
追蹤專案時間是否會強制執行要遵守的計費設定。 |
|
預設為私人專案
|
projects_private_by_default | boolean |
預設專案可見性的工作區設定。 |
|
費率 最後更新
|
rate_last_updated | string |
上次工作區費率更新的時間戳記。 |
|
報告摺疊
|
reports_collapse | boolean |
是否應該預設收合報表。 |
|
Role
|
role | string |
目前使用者在工作區中的角色。 |
|
四捨五入
|
rounding | integer |
默認舍入,高級功能。 0 - 最接近,1 - 向上舍入,-1 - 向下舍入。 |
|
四捨五入分鐘
|
rounding_minutes | integer |
預設四捨五入(以分鐘為單位),高級功能。 |
|
Subscription
|
subscription | object |
訂閱詳細資料 (已淘汰)。 |
|
停賽於
|
suspended_at | string |
暫停的時間戳記。 |
|
時間輸入限制
|
te_constraints | object |
時間輸入限制設定。 |
|
工作時間(分鐘)
|
working_hours_in_minutes | integer |
工作時間(以分鐘為單位)。 |
特徵 / 功能
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
已啟用
|
enabled | boolean |
此功能是否已啟用。 |
|
功能識別碼
|
feature_id | integer |
功能 ID。 |
|
功能名稱
|
name | string |
功能名稱。 |
工作區功能
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Features
|
features | array of Feature |
功能列表。 |
|
工作區識別碼
|
workspace_id | integer |
工作區 ID。 |
位置回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
城市
|
city | string |
城市名稱。 |
|
城市坐標
|
city_lat_long | string |
城市經緯度。 |
|
國碼 (地區碼)
|
country_code | string |
國家代碼。 |
|
國家名稱
|
country_name | string |
國家/地區名稱。 |
|
State
|
state | string |
州或地區。 |
組織
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
管理員
|
admin | boolean |
要求者是否為組織的系統管理員。 |
|
上次修改時間
|
at | string |
組織的最後修改日期。 |
|
創建於
|
created_at | string |
組織的建立日期。 |
|
組織識別碼
|
id | integer |
組織 ID。 |
|
啟用多工作區
|
is_multi_workspace_enabled | boolean |
當設定組織選項is_multi_workspace_enabled時為 true。 |
|
是統一的
|
is_unified | boolean |
是統一的組織。 |
|
資料保留天數上限
|
max_data_retention_days | object |
此組織中的免費工作區可以存取資料的距離。 |
|
最大工作區
|
max_workspaces | integer |
組織允許的工作區數目上限。 |
|
組織名稱
|
name | string |
組織名稱。 |
|
所有者
|
owner | boolean |
要求者是否為組織的擁有者。 |
|
權限
|
permissions | array of string |
組織權限。 |
|
定價計劃 企業
|
pricing_plan_enterprise | boolean |
訂閱方案是企業方案。 |
|
定價方案標識碼
|
pricing_plan_id | integer |
組織計劃 ID。 |
|
定價計劃名稱
|
pricing_plan_name | string |
組織目前所在的訂閱計劃名稱。 |
|
停賽於
|
suspended_at | string |
組織目前是否已暫停。 |
|
trial_info
|
trial_info | TrialInfo | |
|
用戶數
|
user_count | integer |
組織使用者數目。 |
審判資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
可以進行試用
|
can_have_trial | boolean |
如果組織和所有者以前都沒有試用過,則為真。 |
|
最後定價方案標識碼
|
last_pricing_plan_id | integer |
最後一個定價方案識別碼。 |
|
下一個付款日期
|
next_payment_date | string |
下一個付款日期。 |
|
Trial
|
trial | boolean |
組織的訂閱目前是否處於試用階段。 |
|
試用可用
|
trial_available | boolean |
此組織何時可以使用試用版 (已淘汰)。 |
|
試用結束日期
|
trial_end_date | string |
試用結束日期。 |
|
試用方案 ID
|
trial_plan_id | integer |
試用方案 ID。 |
追蹤提醒
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
創建於
|
created_at | string |
提醒創建時間。 |
|
頻率
|
frequency | integer |
提醒頻率(以天為單位)應為 1 或 7。 |
|
群組標識碼
|
group_ids | array of integer |
要傳送提醒的群組 ID。 |
|
提醒 ID
|
reminder_id | integer |
提醒 ID。 |
|
閾值
|
threshold | integer |
閾值是發送提醒的小時數。 |
|
使用者 ID
|
user_ids | array of integer |
要傳送提醒的使用者 ID。 |
|
工作區識別碼
|
workspace_id | integer |
工作區 ID。 |
追蹤提醒回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
追蹤提醒
|
items | array of TrackReminder |
傳回曲目提醒清單。 |
BulkEdit回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
失敗
|
failure | array of BulkEditFailure |
失敗作業清單。 |
|
成功ID
|
success | array of integer |
修補程式成功的識別碼。 |
BulkEditFailure
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
失敗的標識符
|
id | integer |
修補程式作業失敗的 ID。 |
|
錯誤訊息
|
message | string |
操作失敗原因。 |
工作區使用者
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
啟用 2FA
|
2fa_enabled | boolean |
指示使用是否啟用了 2FA 的標誌。 |
|
Active
|
active | boolean |
指示使用者是否接受邀請的旗標。 |
|
管理員
|
admin | boolean |
指示使用者是否為管理員的旗標。 |
|
上次更新
|
at | string |
上次更新的時間戳記。 |
|
頭像網址
|
avatar_file_name | string |
頭像的網址。 |
|
Email
|
string |
使用者的電子郵件。 |
|
|
群組標識碼
|
group_ids | array of integer |
使用者所屬的群組清單。 |
|
使用者工作區識別碼
|
id | integer |
使用者工作區的識別碼。 |
|
停用
|
inactive | boolean |
指出工作區管理員是否停用使用者的旗標。 |
|
邀請碼
|
invitation_code | string |
內部邀請碼。 |
|
邀請網址
|
invite_url | string |
內部邀請URL。 |
|
是直接會員
|
is_direct | boolean |
指示使用者是否為工作區的直接成員 (未使用群組指派給工作區) 的旗標。 |
|
人工成本
|
labor_cost | double |
指派給使用者的人工成本。 |
|
人工成本最後更新
|
labor_cost_last_updated | string |
上次人力成本更新的時間戳記。 |
|
名稱
|
name | string |
使用者的名稱。 |
|
組織管理員
|
organization_admin | boolean |
指示使用者是否為組織內部管理員的旗標。 |
|
費率
|
rate | double |
指派給使用者的費率。 |
|
費率 最後更新
|
rate_last_updated | string |
上次費率更新的時間戳記。 |
|
Role
|
role | string |
使用者的角色。 |
|
角色 ID
|
role_id | integer |
角色 ID。 |
|
Timezone
|
timezone | string |
使用者的時區。 |
|
全域使用者 ID
|
uid | integer |
全域使用者識別碼。 |
|
使用者識別碼
|
user_id | integer |
UserID 替代 JSON 欄位,僅供 get-organization-workspaces-workspaceusers 使用。 |
|
檢視編輯計費費率
|
view_edit_billable_rates | boolean |
精細速率許可權旗標。 僅對具有條件式速率權限的角色生效。 |
|
檢視編輯人工成本
|
view_edit_labor_costs | boolean |
檢視編輯人工成本權限。 |
|
工作區識別碼
|
wid | integer |
工作區識別碼。 |
|
工作時間(分鐘)
|
working_hours_in_minutes | integer |
工作時間值(以分鐘為單位)。 |
|
工作區管理員
|
workspace_admin | boolean |
指示使用者是否是工作區內的管理員的旗標。 |
|
工作區識別碼
|
workspace_id | integer |
UserID 替代 JSON 欄位,僅供 get-organization-workspaces-workspaceusers 使用。 |
費率
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
總數
|
amount | double |
費率的金額。 |
|
創建於
|
created_at | string |
費率的建立日期。 |
|
創作者 ID
|
creator_id | integer |
創作者 ID。 |
|
刪除時間
|
deleted_at | string |
費率的刪除日期,如果為空,則表示費率處於活動狀態。 |
|
結束日期
|
end | string |
費率的結束日期時間。 |
|
費率 ID
|
id | integer |
費率的識別碼。 |
|
計劃任務 ID
|
planned_task_id | integer |
套用費率的計劃任務ID。 |
|
專案識別碼
|
project_id | integer |
套用費率的專案 ID。 |
|
專案使用者 ID
|
project_user_id | integer |
套用費率的專案使用者 ID。 |
|
費率變更模式
|
rate_change_mode | string |
速率變更模式。 |
|
開始日期
|
start | string |
費率的開始日期時間。 |
|
類型
|
type | string |
費率類型。 |
|
更新於
|
updated_at | string |
費率的最後更新日期。 |
|
工作區識別碼
|
workspace_id | integer |
套用費率的工作區 ID。 |
|
工作區使用者 ID
|
workspace_user_id | integer |
套用費率的工作區使用者 ID。 |
工作區統計資料
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
管理員
|
admins | array of WorkspaceAdmin |
工作區系統管理員清單。 |
|
群組計數
|
groups_count | integer |
工作區中的群組數目。 |
|
會員人數
|
members_count | integer |
工作區中的成員數目。 |
工作區管理員
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
管理員名稱。 |
|
使用者識別碼
|
user_id | integer |
管理員使用者 ID。 |
時間輸入條件約束
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
必填說明
|
description_present | boolean |
時間項目需要說明。 |
|
所需項目
|
project_present | boolean |
時間項目需要項目。 |
|
需要標籤
|
tag_present | boolean |
時間項目需要標籤。 |
|
所需任務
|
task_present | boolean |
時間項目需要任務。 |
|
已啟用的約束
|
time_entry_constraints_enabled | boolean |
已啟用時間項目限制。 |
工作區UserSimple
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Email
|
string |
使用者的電子郵件。 |
|
|
全名
|
fullname | string |
使用者的名稱。 |
|
使用者識別碼
|
id | integer |
全域使用者識別碼。 |
|
停用
|
inactive | boolean |
非作用中指出使用者是否已停用在工作區中。 |
|
處於活動狀態
|
is_active | boolean |
IsActive 指出使用者是否已加入工作區。 |
|
是管理員 (已棄用)
|
is_admin | boolean |
指示使用者是否為管理員的旗標(已棄用)。 |
|
Role
|
role | string |
使用者的角色。 |
專案使用者
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
上次修改時間
|
at | string |
上次修改的時間。 |
|
群組 ID (舊版)
|
gid | integer |
群組 ID,舊版欄位。 |
|
群組識別碼
|
group_id | integer |
群組 ID。 |
|
專案使用者 ID
|
id | integer |
專案使用者 ID。 |
|
人工成本
|
labor_cost | double |
此專案使用者的人工成本。 |
|
人工成本最後更新
|
labor_cost_last_updated | string |
人工成本的上次更新日期。 |
|
經理
|
manager | boolean |
使用者是否是專案的管理員。 |
|
專案識別碼
|
project_id | integer |
專案 ID。 |
|
費率
|
rate | double |
此專案使用者的費率。 |
|
費率 最後更新
|
rate_last_updated | string |
費率的最後更新日期。 |
|
使用者識別碼
|
user_id | integer |
使用者識別碼。 |
|
工作區識別碼
|
workspace_id | integer |
工作區 ID。 |
TimeEntryWebhookEvent
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
事件識別碼
|
event_id | integer |
Webhook 事件的唯一識別碼。 |
|
訂用帳戶識別碼
|
subscription_id | integer |
觸發此事件之 Webhook 訂用帳戶的識別碼。 |
|
事件建立於
|
created_at | string |
事件建立的時間。 |
|
事件時間戳
|
timestamp | string |
事件發送時間。 |
|
創作者 ID
|
creator_id | integer |
觸發事件的使用者識別碼。 |
|
回呼 URL
|
url_callback | string |
此事件的回呼 URL。 |
|
請求類型
|
metadata.request_type | string |
觸發事件的要求類型。 |
|
事件使用者 ID
|
metadata.event_user_id | integer |
與事件相關聯的使用者識別碼。 |
|
行動
|
metadata.action | string |
已執行的動作 (建立、更新、刪除、啟動、停止)。 |
|
承載
|
payload | TimeEntry |