共用方式為

Timeneye（預覽版）

該介面允許用戶將 Timenee 的時間追蹤和管理功能與 Microsoft 生態系統中的各種應用程式和服務整合。 透過利用此介面，使用者可以自動化工作流程、同步時間追蹤數據，並透過與其他工具無縫整合來提高生產力。

此連接器適用於以下產品和區域：

服務 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）
連絡人​​
名稱 Support
URL https://support.timeneye.com/
Email info@timeneye.com
連接器中繼資料
Publisher DM 數位軟體 SRL

Timeneye API 連接器

Timeneye 是一款時間追蹤工具，旨在幫助您有效管理專案。 此連接器使您能夠透過 API 與 Timeneye 進行交互，從而允許您將時間追蹤資料與各種服務整合。

先決條件

使用此連接器之前，您需要：

  1. 一個 Timeneye 帳戶。 如果您沒有，可以 在這裡註冊。

使用者入門

設定連接器：

  • 開啟 Power Platform 並移至連接器區段。
  • 搜尋 Timeneye 連接器。
  • 出現提示時，使用 OAuth 2.0 流程進行驗證。

速率限制

為了能夠為所有用戶和客戶提供可靠的服務，我們限制每個令牌每 5 分鐘可以執行的請求數量。

每個權杖都有有限數量的請求（如下表所示），可以在給定的時間窗口內執行。 請求計數每 5 分鐘重設一次。

每 5 分鐘可以執行的請求數會根據請求時具有使用者帳戶的方案而變化。

Plan 每 5 分鐘的請求數上限
免費 500
商務（任何級別）/專業版 2000

如果達到限制，下列要求 （針對指定的權杖） 將會收到 429 錯誤。

回應將包含下列標頭： |標題 |範例值 |產品描述 | |--|--|--| |X-RateLimit-Limit |2000年 |您可以提出多少個請求 | |X-RateLimit-Remaining |0 |還剩下多少請求 | |Retry-After |177 |指出在提出後續要求之前要等待多少秒。|X-RateLimit-Reset |1691677002 |指出限制重設的時間 （UNIX 時間戳記） |

Errors

當一切按預期工作時，我們所有的 API 端點都會傳回 200 HTTP 狀態碼，但有時可能會傳回錯誤。

我們的 API 根據失敗原因傳回不同的錯誤代碼，從缺少參數到我們這邊的伺服器錯誤。

在下表中，您可以找到所有錯誤代碼的清單，其中包含原因的一般描述，以防端點未傳回特定案例的描述。

Code Meaning Description
400 錯誤的請求 一或多個必要參數遺漏或無效。
401 未經授權 授權權杖遺失、無效或已過期。
403 禁止 驗證和要求語法都正確無誤，但您嘗試編輯的資源需要授權使用者所沒有的存取層級。
403 未找到 要求的資源無法使用。
403 未找到 要求的資源無法使用。
422 Validation 傳遞的參數或承載未遵循所需的規格
429 要求太多 您已達到速率限制。
500 內部伺服器錯誤 我們這邊有問題..

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

列出使用者

取得使用者清單
列出區域

取得區域清單
列出國家

取得國家/地區清單
列出客戶

取得客戶清單
列出專案

取得專案清單
列出待辦事項

取得待辦事項清單
列出待辦事項列表

取得待辦事項清單清單
列出標籤

取得標籤清單
列出語言

取得語言清單
列出貨幣

取得貨幣清單
列出階段

列出所有階段
列出階段類別

取得階段類別清單
列出預算

取得預算清單
刪除 Group-Project 關係

已從群組中移除專案
刪除 Group-User 關係

已從群組中移除使用者
刪除 Project-Tag 清單關係

移除專案標籤清單關聯性
刪除 Project-Tag 關係

移除專案標籤關係
刪除 Project-User 關係

已從專案中移除使用者
刪除使用者

刪除使用者
刪除專案

刪除專案
刪除待辦事項

刪除待辦事項
刪除待辦事項清單

刪除待辦事項清單
刪除標籤

刪除標籤
刪除標籤清單

刪除標籤清單
刪除用戶端

刪除用戶端
刪除群組

刪除群組
刪除計時器

刪除計時器
刪除輸入建議

刪除項目建議
刪除階段

刪除階段
刪除階段類別

刪除階段類別
刪除項目

刪除項目
刪除預算

刪除預算
制定預算

制定預算
創建頭像

創建頭像
取得使用者

取得單一使用者
取得參賽作品

取得參賽作品
取得專案

取得專案
取得待辦事項

取得單一待辦事項
取得待辦事項清單

取得單一待辦事項清單
取得標籤

取得單一標籤
取得標籤清單

取得單一標籤清單
取得階段

取得相位
取得階段類別

取得階段類別
建立 Group-Project 關係

將專案附加至群組
建立 Group-User 關係

將使用者附加至群組
建立 Project-Tag 清單關聯性

建立 Project-Tag 清單關聯性
建立 Project-Tag 關係

建立 Project-Tag 清單關聯性
建立 Project-User 關係

將使用者附加至專案
建立專案

建立專案
建立專案

建立項目
建立待辦事項

建立待辦事項
建立待辦事項清單

建立待辦事項清單
建立標籤

建立標籤
建立標籤清單

建立標籤清單
建立用戶端

建立用戶端
建立群組

建立群組
建立群組

建立群組
建立計時器

建立計時器
建立階段

建立新階段
建立階段類別

建立階段類別
建立預算

建立預算
更新 Group-User 關係

更新使用者與群組之間的關係
更新 Project-Tag 清單關聯性

更新專案標籤清單關聯性
更新 Project-Tag 關係

更新專案標籤清單關聯性
更新 Project-User 關係

更新專案與使用者之間的關係
更新使用者

更新使用者
更新專案

更新專案
更新帳戶

更新帳戶
更新待辦事項

更新待辦事項
更新待辦事項清單

更新標籤清單
更新條目

更新項目
更新標籤

更新標籤
更新標籤清單

更新標籤清單
更新用戶端

更新用戶端
更新群組

更新群組
更新計時器

更新計時器
更新階段

更新階段
更新階段類別

更新階段類別
更新預算

更新預算
清單標籤清單

取得標籤清單清單
清單組

取得所有群組的清單
清單計時器

取得計時器清單
清單輸入建議

取得指定時間範圍的參賽建議清單
清單項目

取得項目清單
獲取帳戶

取得使用者帳戶的資訊
獲取計時器

取得計時器
獲得客戶

獲得客戶

列出使用者

作業識別碼：
Get-user-lists

取得使用者清單

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
頁面
 page integer

目前顯示的頁面
per_page
 per_page integer

每頁有多少項目
sort_by
 sort_by string

要排序的屬性
方向
 direction string

排序方向
收發簡訊
 text string

全文檢索
名稱
 name string

依名稱搜尋使用者
電子郵件
 email string

透過電子郵件搜尋使用者
狀態
 status string

按狀態搜索用戶
活動中
 active boolean

按活動狀態搜索用戶
group_ids[]
 group_ids[] string

要篩選的群組識別碼的逗號分隔清單
group_id
 group_id string

搜尋屬於群組的使用者
member_ids[]
 member_ids[] string

要過濾的使用者 ID 的逗點分隔清單
project_ids[]
 project_ids[] string

要篩選的專案識別碼的逗點分隔清單
client_ids[]
 client_ids[] string

要篩選的用戶端識別碼的逗號分隔清單

傳回

名稱 路徑 類型 Description
current_page
 current_page integer
資料
 data array of
first_page_url
 first_page_url string
從
 from integer
last_page
 last_page integer
last_page_url
 last_page_url string
next_page_url
 next_page_url string
路徑
 path string
per_page
 per_page integer
prev_page_url
 prev_page_url string
至
 to integer
總計
 total integer

列出區域

作業識別碼：
List-zones

取得區域清單

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json

傳回

名稱 路徑 類型 Description
array of object
country_code
 country_code string

該區域所屬國家/地區的代碼
名稱
 name string

時區名稱
zone_id
 zone_id integer

唯一識別碼

列出國家

作業識別碼：
List-countries

取得國家/地區清單

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json

傳回

名稱 路徑 類型 Description
array of object
company_tax
 company_tax string
country_code
 country_code string
名稱
 name string
private_tax
 private_tax string
vat_required
 vat_required integer

列出客戶

作業識別碼：
List-clients

取得客戶清單

參數

名稱 機碼 必要 類型 Description
頁面
 page integer

目前顯示的頁面
per_page
 per_page integer

每頁有多少項目
sort_by
 sort_by string

要排序的屬性
方向
 direction string

排序方向
收發簡訊
 text string

以客戶名稱搜尋
member_ids[]
 member_ids[] string

以逗號分隔的用戶端識別碼清單，以篩選結果
接受
 Accept string

application/json

傳回

名稱 路徑 類型 Description
資料
 data array of object
client_id (客戶識別碼)
 data.client_id integer

唯一識別碼
color
 data.color string

報表中使用的顏色
is_active
 data.is_active boolean

客戶端是否已封存
名稱
 data.name string

客戶名稱
先
 links.first string
last
 links.last string
next
 links.next string
上一頁
 links.prev string
current_page
 meta.current_page integer
從
 meta.from integer
last_page
 meta.last_page integer
links
 meta.links array of object
活動中
 meta.links.active boolean
標籤
 meta.links.label string
url
 meta.links.url string
路徑
 meta.path string
per_page
 meta.per_page integer
至
 meta.to integer
總計
 meta.total integer

列出專案

作業識別碼：
Get-projects

取得專案清單

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
公眾
 public boolean

只取得公開專案
活動中
 active boolean

只取得作用中的專案
可計費
 billable boolean

只取得可計費專案
載入[]
 load[] string

要載入的實體的逗號分隔清單。 可能的值：users、budget、phases、groups
收發簡訊
 text string

全文檢索
client_id (客戶識別碼)
 client_id integer

取得屬於此參數所識別之用戶端的專案
user_id
 user_id integer

搜尋使用者所在團隊的專案
頁面
 page integer

目前顯示的頁面
per_page
 per_page integer

每頁有多少項目
sort_by
 sort_by string

要排序的屬性
方向
 direction string

排序方向

傳回

名稱 路徑 類型 Description
current_page
 current_page integer
資料
 data array of
first_page_url
 first_page_url string
從
 from integer
last_page
 last_page integer
last_page_url
 last_page_url string
next_page_url
 next_page_url string
路徑
 path string
per_page
 per_page integer
prev_page_url
 prev_page_url string
至
 to integer
總計
 total integer

列出待辦事項

作業識別碼：
Get-todos

取得待辦事項清單

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
頁面
 page integer

目前顯示的頁面
per_page
 per_page integer

每頁有多少項目
sort_by
 sort_by string

要排序的屬性
方向
 direction string

排序方向
project_id
 project_id integer

待辦事項所屬專案的唯一識別碼
todo_list_id
 todo_list_id integer

待辦事項清單的唯一識別碼
user_ids[]
 user_ids[] string

指派給待辦事項的使用者唯一識別碼的逗點分隔清單
優先級[]
 priority[] string

以逗號分隔的優先順序清單：允許的值：低、中、高
狀態[]
 status[] string

以逗號分隔的狀態清單。 允許的值：todo、in_progress、completed

傳回

名稱 路徑 類型 Description
current_page
 current_page integer
資料
 data array of object
items
 data object
first_page_url
 first_page_url string
從
 from integer
last_page
 last_page integer
last_page_url
 last_page_url string
next_page_url
 next_page_url string
路徑
 path string
per_page
 per_page integer
prev_page_url
 prev_page_url string
至
 to integer
總計
 total integer

列出待辦事項列表

作業識別碼：
Get-todo-lists

取得待辦事項清單清單

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
頁面
 page integer

目前顯示的頁面
per_page
 per_page integer

每頁有多少項目
sort_by
 sort_by string

要排序的屬性
方向
 direction string

排序方向
project_id
 project_id integer

待辦事項清單所屬專案的唯一識別碼
載入[]
 load[] string

要載入的實體的逗號分隔清單。 “”todos“ 是唯一可接受的值”

傳回

名稱 路徑 類型 Description
current_page
 current_page integer
資料
 data array of object
items
 data object
first_page_url
 first_page_url string
從
 from integer
last_page
 last_page integer
last_page_url
 last_page_url string
next_page_url
 next_page_url string
路徑
 path string
per_page
 per_page integer
prev_page_url
 prev_page_url string
至
 to integer
總計
 total integer

列出標籤

作業識別碼：
Get-tags

取得標籤清單

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
名稱
 name string

名稱中的文字搜尋
tag_list_id
 tag_list_id integer

TagList 的 ID
頁面
 page integer

目前顯示的頁面
per_page
 per_page integer

每頁有多少項目
sort_by
 sort_by string

要排序的屬性
方向
 direction string

排序方向

傳回

名稱 路徑 類型 Description
current_page
 current_page integer
資料
 data array of object
color
 data.color string

用於報表的顏色
is_active
 data.is_active integer

標籤是否已封存
名稱
 data.name string

標籤的名稱
tag_id
 data.tag_id integer

唯一識別碼
tag_list_id
 data.tag_list_id integer

標籤所屬標籤清單的唯一識別碼
first_page_url
 first_page_url string
從
 from integer
last_page
 last_page integer
last_page_url
 last_page_url string
next_page_url
 next_page_url string
路徑
 path string
per_page
 per_page integer
prev_page_url
 prev_page_url string
至
 to integer
總計
 total integer

列出語言

作業識別碼：
List-languages

取得語言清單

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json

傳回

名稱 路徑 類型 Description
array of object
language_code
 language_code string

唯一識別碼
名稱
 name string

語言名稱

列出貨幣

作業識別碼：
List-currencies

取得貨幣清單

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json

傳回

名稱 路徑 類型 Description
array of object
currency_code
 currency_code string
名稱
 name string

列出階段

作業識別碼：
Get-phases

列出所有階段

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
收發簡訊
 text string

取得名稱中包含此文字的階段
活動中
 active boolean

僅取得作用中或非作用中階段
頁面
 page integer

目前顯示的頁面
per_page
 per_page integer

每頁有多少項目
project_id
 project_id integer

取得屬於專案的階段
sort_by
 sort_by string

要排序的屬性
方向
 direction string

排序方向

傳回

名稱 路徑 類型 Description
current_page
 current_page integer
資料
 data array of
first_page_url
 first_page_url string
從
 from integer
last_page
 last_page integer
last_page_url
 last_page_url string
next_page_url
 next_page_url string
路徑
 path string
per_page
 per_page integer
prev_page_url
 prev_page_url string
至
 to integer
總計
 total integer

列出階段類別

作業識別碼：
Get-phase-categories

取得階段類別清單

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
頁面
 page integer

目前顯示的頁面
per_page
 per_page integer

每頁有多少項目
收發簡訊
 text string

全文檢索搜尋字串

傳回

名稱 路徑 類型 Description
current_page
 current_page integer
資料
 data array of
first_page_url
 first_page_url string
從
 from integer
last_page
 last_page integer
last_page_url
 last_page_url string
next_page_url
 next_page_url string
路徑
 path string
per_page
 per_page integer
prev_page_url
 prev_page_url string
至
 to integer
總計
 total integer

列出預算

作業識別碼：
List-Budgets

取得預算清單

參數

名稱 機碼 必要 類型 Description
頁面
 page integer

目前顯示的頁面
per_page
 per_page integer

每頁有多少項目
sort_by
 sort_by string

要排序的屬性
方向
 direction string

排序方向
project_id
 project_id integer

預算所屬專案的識別碼
接受
 Accept string

application/json

傳回

名稱 路徑 類型 Description
資料
 data array of object
budget_id
 data.budget_id integer

預算的唯一識別碼
budget_minutes
 data.budget_minutes integer

預算所代表的分鐘數
間隔
 data.interval integer

預算重設日期：如果預算是每月，則為 1 至 31 天，如果預算為每週，則為 0 至 6 天
is_active
 data.is_active integer

預算是否有效
period_end
 data.period_end string

格式：YYYY-MM-DD
period_start
 data.period_start string

格式：YYYY-MM-DD
project_id
 data.project_id integer

預算所屬專案的識別碼
定期
 data.recurrence integer

預算週期：0 = 無週期，1 = 每週，2 = 每月
先
 links.first string
last
 links.last string
next
 links.next string
上一頁
 links.prev string
current_page
 meta.current_page integer
從
 meta.from integer
last_page
 meta.last_page integer
links
 meta.links array of object
活動中
 meta.links.active boolean
標籤
 meta.links.label string
url
 meta.links.url string
路徑
 meta.path string
per_page
 meta.per_page integer
至
 meta.to integer
總計
 meta.total integer

刪除 Group-Project 關係

作業識別碼：
Delete-groups-projects

已從群組中移除專案

參數

名稱 機碼 必要 類型 Description
組成群組
 group True string
專案
 project True string
接受
 Accept string

application/json

刪除 Group-User 關係

作業識別碼：
Delete-groups-users

已從群組中移除使用者

參數

名稱 機碼 必要 類型 Description
組成群組
 group True string
使用者
 user True string
接受
 Accept string

application/json

刪除 Project-Tag 清單關係

作業識別碼：
Delete-projects-project_id-tag-lists-tag_list_id

移除專案標籤清單關聯性

參數

名稱 機碼 必要 類型 Description
專案
 project True string
tag_list
 tag_list True string

刪除 Project-Tag 關係

作業識別碼：
Delete-projects-project_id-tags-tag_id

移除專案標籤關係

參數

名稱 機碼 必要 類型 Description
專案
 project True string
加標籤
 tag True string

刪除 Project-User 關係

作業識別碼：
Delete-projects-users

已從專案中移除使用者

參數

名稱 機碼 必要 類型 Description
專案
 project True string
使用者
 user True string
接受
 Accept string

application/json

刪除使用者

作業識別碼：
Delete-users-user_id

刪除使用者

參數

名稱 機碼 必要 類型 Description
使用者
 user True string
接受
 Accept string

application/json

刪除專案

作業識別碼：
Delete-projects-project_id

刪除專案

參數

名稱 機碼 必要 類型 Description
專案
 project True string
接受
 Accept string

application/json

刪除待辦事項

作業識別碼：
Delete-todos-todo_id

刪除待辦事項

參數

名稱 機碼 必要 類型 Description
待辦事項
 todo True string
接受
 Accept string

application/json

刪除待辦事項清單

作業識別碼：
Delete-todo-lists-todo_list_id

刪除待辦事項清單

參數

名稱 機碼 必要 類型 Description
todo_list
 todo_list True string
接受
 Accept string

application/json

刪除標籤

作業識別碼：
Delete-tags-tag_id

刪除標籤

參數

名稱 機碼 必要 類型 Description
加標籤
 tag True string
接受
 Accept string

application/json

刪除標籤清單

作業識別碼：
Delete-tag-lists-tag_list_id

刪除標籤清單

參數

名稱 機碼 必要 類型 Description
tag_list
 tag_list True string
接受
 Accept string

application/json

刪除用戶端

作業識別碼：
Delete-client-client_id

刪除用戶端

參數

名稱 機碼 必要 類型 Description
用戶端
 client True string
接受
 Accept string

application/json

刪除群組

作業識別碼：
Delete-groups-group_id

刪除群組

參數

名稱 機碼 必要 類型 Description
組成群組
 group True string
接受
 Accept string

application/json

刪除計時器

作業識別碼：
Delete-timers-timer_id

刪除計時器

參數

名稱 機碼 必要 類型 Description
計時器
 timer True string
接受
 Accept string

application/json

刪除輸入建議

作業識別碼：
Delete-entry-suggestions-entry_suggestion_id

刪除項目建議

參數

名稱 機碼 必要 類型 Description
entry_suggestion
 entry_suggestion True string
接受
 Accept string

application/json

刪除階段

作業識別碼：
Delete-phases-phase_id

刪除階段

參數

名稱 機碼 必要 類型 Description
階段
 phase True string
接受
 Accept string

application/json

刪除階段類別

作業識別碼：
Delete-phase-categories-phase_category_id

刪除階段類別

參數

名稱 機碼 必要 類型 Description
phase_category
 phase_category True string
接受
 Accept string

application/json

刪除項目

作業識別碼：
Delete-entries-entry_id

刪除項目

參數

名稱 機碼 必要 類型 Description
輸入
 entry True string
接受
 Accept string

application/json

刪除預算

作業識別碼：
Delete-budGet-budget_id

刪除預算

參數

名稱 機碼 必要 類型 Description
預算
 budget True string
接受
 Accept string

application/json

制定預算

作業識別碼：
Get-budGet-budget_id

制定預算

參數

名稱 機碼 必要 類型 Description
預算
 budget True string
接受
 Accept string

application/json

傳回

名稱 路徑 類型 Description
budget_id
 budget_id integer

預算的唯一識別碼
budget_minutes
 budget_minutes integer

預算所代表的分鐘數
間隔
 interval integer

預算重設日期：如果預算是每月，則為 1 至 31 天，如果預算為每週，則為 0 至 6 天
is_active
 is_active integer

預算是否有效
period_end
 period_end string

格式：YYYY-MM-DD
period_start
 period_start string

格式：YYYY-MM-DD
project_id
 project_id integer

預算所屬專案的識別碼
定期
 recurrence integer

預算週期：0 = 無週期，1 = 每週，2 = 每月

創建頭像

作業識別碼：
Post-avatar-avatar_id

創建頭像

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
圖片
 image True binary

包含影像的檔案
user_id
 user_id integer

擁有此頭像的使用者的識別碼
account_id
 account_id integer

具有此頭像的帳戶的標識符

傳回

名稱 路徑 類型 Description
account_id
 account_id integer

具有此頭像的帳戶的標識符
avatar_name
 avatar_name string

唯一檔案名稱
avatar_url
 avatar_url string

影像 URL
user_id
 user_id integer

擁有此頭像的使用者的識別碼

取得使用者

作業識別碼：
Get-users-user_id

取得單一使用者

參數

名稱 機碼 必要 類型 Description
使用者
 user True string

取得參賽作品

作業識別碼：
Get-entries-entry_id

取得參賽作品

參數

名稱 機碼 必要 類型 Description
輸入
 entry True string
接受
 Accept string

application/json

傳回

response
object

取得專案

作業識別碼：
Get-projects-project_id

取得專案

參數

名稱 機碼 必要 類型 Description
專案
 project True string
接受
 Accept string

application/json

取得待辦事項

作業識別碼：
Get-todos-todo_id

取得單一待辦事項

參數

名稱 機碼 必要 類型 Description
待辦事項
 todo True string

傳回

response
object

取得待辦事項清單

作業識別碼：
Get-todo-List-todolist_id

取得單一待辦事項清單

參數

名稱 機碼 必要 類型 Description
todo_list
 todo_list True string

取得標籤

作業識別碼：
Get-tags-tag_id

取得單一標籤

參數

名稱 機碼 必要 類型 Description
加標籤
 tag True string
接受
 Accept string

application/json

取得標籤清單

作業識別碼：
Get-tag-lists-tag_list_id

取得單一標籤清單

參數

名稱 機碼 必要 類型 Description
tag_list
 tag_list True string

取得階段

作業識別碼：
Get-phases-phase_id

取得相位

參數

名稱 機碼 必要 類型 Description
階段
 phase True string
接受
 Accept string

application/json

取得階段類別

作業識別碼：
Get-phase-categories-phase_category_id

取得階段類別

參數

名稱 機碼 必要 類型 Description
phase_category
 phase_category True string
接受
 Accept string

application/json

傳回

名稱 路徑 類型 Description
color
 color string

用於報表的顏色
名稱
 name string

階段類別的名稱
phase_category_id
 phase_category_id integer

唯一識別碼

建立 Group-Project 關係

作業識別碼：
Post-groups-projects

將專案附加至群組

參數

名稱 機碼 必要 類型 Description
組成群組
 group True string
專案
 project True string
接受
 Accept string

application/json

建立 Group-User 關係

作業識別碼：
Post-groups-users

將使用者附加至群組

參數

名稱 機碼 必要 類型 Description
組成群組
 group True string
使用者
 user True string
接受
 Accept string

application/json
is_gm
 is_gm boolean

告知使用者是否是群組的群組管理員

建立 Project-Tag 清單關聯性

作業識別碼：
Post-projects-project_id-tag-lists-tag_list_id

建立 Project-Tag 清單關聯性

參數

名稱 機碼 必要 類型 Description
專案
 project True string
tag_list
 tag_list True string
budget_amount
 budget_amount number

分配給此專案中此標籤清單的預算金額
budget_minutes
 budget_minutes integer

分配給此專案中此標籤清單的預算分鐘數
budget_amount
 budget_amount number

分配給此專案中此標籤清單的預算金額
budget_minutes
 budget_minutes integer

分配給此專案中此標籤清單的預算分鐘數
required
 required boolean

此專案的時間項目是否需要標籤

建立 Project-Tag 關係

作業識別碼：
Post-projects-project_id-tag-tag_id

建立 Project-Tag 清單關聯性

參數

名稱 機碼 必要 類型 Description
專案
 project True string
加標籤
 tag True string
budget_amount
 budget_amount number

分配給此專案中此標籤的預算金額
budget_minutes
 budget_minutes integer

分配給此專案中此標籤的預算分鐘數
budget_amount
 budget_amount number

分配給此專案中此標籤的預算金額
budget_minutes
 budget_minutes integer

分配給此專案中此標籤的預算分鐘數

建立 Project-User 關係

作業識別碼：
Post-projects-users

將使用者附加至專案

參數

名稱 機碼 必要 類型 Description
專案
 project True string
使用者
 user True string
接受
 Accept string

application/json
budget_minutes
 budget_minutes integer

在此專案中為此使用者編列預算的分鐘數
hourly_rate
 hourly_rate number

此專案中此使用者的小時費率。 優先於專案層級的小時費率和帳戶層級的小時費率
is_favorited
 is_favorited boolean

專案是否受到使用者的收藏
is_pm
 is_pm boolean

使用者是否為專案的專案經理

建立專案

作業識別碼：
Post-projects

建立專案

參數

名稱 機碼 必要 類型 Description
api_only
 api_only boolean

專案是否公開，這表示工作區中的所有使用者都可以看到它，而且每個人都可以追蹤其上的時間
client_id (客戶識別碼)
 client_id integer

專案是否公開，這表示工作區中的所有使用者都可以看到它，而且每個人都可以追蹤其上的時間
color
 color True string

用於報表的顏色
描述
 description string

專案的文字描述
hourly_rate
 hourly_rate number

用於報表的顏色
is_billable
 is_billable boolean

專案是否公開，這表示工作區中的所有使用者都可以看到它，而且每個人都可以追蹤其上的時間
is_public
 is_public boolean

專案是否公開，這表示工作區中的所有使用者都可以看到它，而且每個人都可以追蹤其上的時間
名稱
 name True string

專案名稱

傳回

名稱 路徑 類型 Description
api_only
 api_only integer

專案是否可用於僅使用 API 來追蹤時間。
client_id (客戶識別碼)
 client_id integer

專案所屬用戶端的唯一識別碼
color
 color string

用於報表的顏色
描述
 description string

專案的文字描述
hourly_rate
 hourly_rate string

專案的一般小時費率。 可以在專案-使用者關係上設定特定hourly_rate
is_active
 is_active integer

專案是否已封存
is_billable
 is_billable integer

專案是否按小時計費
is_public
 is_public integer

專案是否公開，這表示工作區中的所有使用者都可以看到它，而且每個人都可以追蹤其上的時間
名稱
 name string

專案名稱
project_id
 project_id integer

唯一識別碼

建立專案

作業識別碼：
Post-entry

建立項目

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
計費
 billed integer

0 = 可計費的條目，1 = 已計費的條目，2 = 不可計費的條目
date
 date True string

報名日期
entry_suggestion_id
 entry_suggestion_id integer

建立項目的項目建議的唯一識別碼
紀要
 minutes True integer

追蹤時間量（以分鐘為單位）
附註
 notes string

時間輸入注意事項
origin_date
 origin_date string

格式 Y-m-d 需要與repeatable_suggestion_id
phase_id
 phase_id True integer

項目所屬階段的唯一識別碼
project_id
 project_id True integer

專案的唯一識別碼
repeatable_suggestion_id
 repeatable_suggestion_id integer

建立項目的可重複項目建議的唯一識別碼
來源
 source string

必須是integration_code可用或「一致性」之一
source_text
 source_text string

描述項目來源的文字
source_url
 source_url string

描述項目來源的文字
tag_ids
 tag_ids array of integer

tag_id陣列
user_id
 user_id integer

建立項目之使用者的唯一識別碼

傳回

response
object

建立待辦事項

作業識別碼：
Post-todos

建立待辦事項

參數

名稱 機碼 必要 類型 Description
描述
 description string

待辦事項說明
due_date
 due_date string

完成待辦事項的資料
索引
 index integer

清單中待辦事項的索引（順序）
is_completed
 is_completed boolean

待辦事項是否標示為已完成
名稱
 name True string

待辦事項的標題
priority
 priority string

待辦事項是否標示為已完成
start_date
 start_date string

應負責待辦事項的日期
狀態
 status string

待辦事項的現況
tag_ids
 tag_ids array of integer

要連結至待辦事項的tag_id陣列
todo_list_id
 todo_list_id True integer

待辦事項所屬待辦事項清單的唯一識別碼
user_id
 user_id True integer

指派給待辦事項的使用者的唯一識別碼
user_ids
 user_ids array of integer

代表指派給待辦事項之使用者的user_id陣列

傳回

response
object

建立待辦事項清單

作業識別碼：
Post-todo-lists

建立待辦事項清單

參數

名稱 機碼 必要 類型 Description
color
 color True string

用於報表的顏色
索引
 index integer

用於報表的顏色
名稱
 name True string

待辦事項清單的名稱
project_id
 project_id True integer

待辦事項清單所屬專案的唯一識別碼

傳回

名稱 路徑 類型 Description
color
 color string

用於報表的顏色
建立於
 created_at string

建立日期和時間
索引
 index integer

板中待辦事項清單的索引（順序）
名稱
 name string

待辦事項清單的名稱
project_id
 project_id integer

待辦事項清單所屬專案的唯一識別碼
todo_list_id
 todo_list_id integer

唯一識別碼
updated_at
 updated_at string

更新日期和時間

建立標籤

作業識別碼：
Post-tags

建立標籤

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
名稱
 name True string

標籤的名稱
tag_list_id
 tag_list_id True integer

標籤所屬標籤清單的唯一識別碼

建立標籤清單

作業識別碼：
Post-tag-list

建立標籤清單

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
color
 color string

用於報表的顏色
名稱
 name string

標籤清單的名稱
text_color
 text_color string

用於報表的文字顏色

建立用戶端

作業識別碼：
Post-client

建立用戶端

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
color
 color True string

報表中使用的顏色
名稱
 name True string

客戶名稱

傳回

名稱 路徑 類型 Description
client_id (客戶識別碼)
 client_id integer

唯一識別碼
color
 color string

報表中使用的顏色
is_active
 is_active boolean

客戶端是否已封存
名稱
 name string

客戶名稱

建立群組

作業識別碼：
Post-groups-group_id

建立群組

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
color
 color string

用於報表的顏色
名稱
 name string

群組名稱

傳回

名稱 路徑 類型 Description
color
 color string

用於報表的顏色
group_id
 group_id integer

唯一識別碼
名稱
 name string

群組名稱

建立群組

作業識別碼：
Get-group

建立群組

參數

名稱 機碼 必要 類型 Description
組成群組
 group True string
接受
 Accept string

application/json

建立計時器

作業識別碼：
Post-timer

建立計時器

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
date
 date string

計時器日期
entry_suggestion_id
 entry_suggestion_id integer

建立計時器的項目建議的唯一識別碼
附註
 notes string

計時器注意事項
origin_date
 origin_date string

格式 Y-m-d 需要與repeatable_suggestion_id
phase_id
 phase_id True integer

計時器所屬階段的唯一識別碼
project_id
 project_id True integer

專案的唯一識別碼
repeatable_suggestion_id
 repeatable_suggestion_id integer

建立計時器的可重複項目建議的唯一識別碼
秒
 seconds integer
來源
 source string

必須是integration_code可用或「一致性」之一
source_text
 source_text string

描述計時器來源的文字
source_url
 source_url string

描述計時器來源的文字
tag_ids
 tag_ids array of integer

tag_id陣列
timer_status
 timer_status True string
user_id
 user_id integer

建立計時器的使用者的唯一識別碼

傳回

response
object

建立階段

作業識別碼：
Post-phases

建立新階段

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
budget_minutes
 budget_minutes True integer

階段的預算時間量。 階段budget_minutes的總和不得超過項目的預算時間
名稱
 name True string

階段的名稱
phase_category_id
 phase_category_id integer

階段所屬階段類別的唯一識別碼
project_id
 project_id True integer

階段的預算時間量。 階段budget_minutes的總和不得超過項目的預算時間

傳回

名稱 路徑 類型 Description
budget_minutes
 budget_minutes integer

階段的預算時間量。 階段budget_minutes的總和不得超過項目的預算時間
is_open
 is_open integer

階段是否已封存
名稱
 name string

階段的名稱
phase_category_id
 phase_category_id integer

階段所屬階段類別的唯一識別碼
phase_id
 phase_id integer

唯一識別碼
project_id
 project_id integer

階段所屬專案的唯一識別碼

建立階段類別

作業識別碼：
Post-phase-categories

建立階段類別

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
color
 color string

用於報表的顏色
名稱
 name True string

階段類別的名稱

傳回

名稱 路徑 類型 Description
color
 color string

用於報表的顏色
名稱
 name string

階段類別的名稱
phase_category_id
 phase_category_id integer

唯一識別碼

建立預算

作業識別碼：
Post-budget

建立預算

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
budget_minutes
 budget_minutes True integer

預算所代表的分鐘數
間隔
 interval integer

預算週期：0 = 無週期，1 = 每週，2 = 每月
project_id
 project_id True integer

預算所屬專案的識別碼
定期
 recurrence True integer

預算週期：0 = 無週期，1 = 每週，2 = 每月

傳回

名稱 路徑 類型 Description
budget_id
 budget_id integer

預算的唯一識別碼
budget_minutes
 budget_minutes integer

預算所代表的分鐘數
間隔
 interval integer

預算重設日期：如果預算是每月，則為 1 至 31 天，如果預算為每週，則為 0 至 6 天
is_active
 is_active integer

預算是否有效
period_end
 period_end string

格式：YYYY-MM-DD
period_start
 period_start string

格式：YYYY-MM-DD
project_id
 project_id integer

預算所屬專案的識別碼
定期
 recurrence integer

預算週期：0 = 無週期，1 = 每週，2 = 每月

更新 Group-User 關係

作業識別碼：
Put-groups-users

更新使用者與群組之間的關係

參數

名稱 機碼 必要 類型 Description
組成群組
 group True string
使用者
 user True string
接受
 Accept string

application/json
is_gm
 is_gm boolean

告知使用者是否是群組的群組管理員

更新 Project-Tag 清單關聯性

作業識別碼：
Put-projects-project_id-tag-lists-tag_list_id

更新專案標籤清單關聯性

參數

名稱 機碼 必要 類型 Description
專案
 project True string
tag_list
 tag_list True string
budget_amount
 budget_amount number

分配給此專案中此標籤清單的預算金額
budget_minutes
 budget_minutes integer

分配給此清單的預算分鐘數在此專案上標記
budget_amount
 budget_amount number

分配給此專案中此標籤清單的預算金額
budget_minutes
 budget_minutes integer

分配給此專案中此標籤清單的預算分鐘數
required
 required boolean

更新 Project-Tag 關係

作業識別碼：
Put-projects-project_id-tag-tag_id

更新專案標籤清單關聯性

參數

名稱 機碼 必要 類型 Description
專案
 project True string
加標籤
 tag True string
budget_amount
 budget_amount number

分配給此專案中此標籤的預算金額
budget_minutes
 budget_minutes integer

分配給此專案中此標籤的預算分鐘數
budget_amount
 budget_amount number

分配給此專案中此標籤的預算金額
budget_minutes
 budget_minutes integer

分配給此專案中此標籤的預算分鐘數

更新 Project-User 關係

作業識別碼：
Put-projects-users

更新專案與使用者之間的關係

參數

名稱 機碼 必要 類型 Description
專案
 project True string
使用者
 user True string
budget_minutes
 budget_minutes integer

在此專案中為此使用者編列預算的分鐘數
hourly_rate
 hourly_rate number

此專案中此使用者的小時費率。 優先於專案層級的小時費率和帳戶層級的小時費率
is_favorited
 is_favorited boolean

專案是否受到使用者的收藏
is_pm
 is_pm boolean

使用者是否為專案的專案經理

更新使用者

作業識別碼：
Put-users-user_id

更新使用者

參數

名稱 機碼 必要 類型 Description
使用者
 user True string
group_id
 group_id integer

使用者所屬群組的唯一識別碼
user_hourly_cost
 user_hourly_cost integer

使用者的每小時成本，以帳戶設定中選取的貨幣表示
user_hourly_rate
 user_hourly_rate integer

使用者的小時費率，以帳戶設定中選取的貨幣表示
working_time
 working_time integer

使用者一天通常工作多少小時
workspace_access_level
 workspace_access_level string

用戶在 Timeneye 中的角色：所有者、管理員或成員

更新專案

作業識別碼：
Put-projects-project_id

更新專案

參數

名稱 機碼 必要 類型 Description
專案
 project True string
接受
 Accept string

application/json
api_only
 api_only boolean

專案是否可用於僅使用 API 來追蹤時間。
client_id (客戶識別碼)
 client_id integer

專案所屬用戶端的唯一識別碼
color
 color string

用於報表的顏色
描述
 description string

專案的文字描述
hourly_rate
 hourly_rate number

用於報表的顏色
is_billable
 is_billable boolean

專案是否按小時計費
is_public
 is_public boolean

專案是否公開，這表示工作區中的所有使用者都可以看到它，而且每個人都可以追蹤其上的時間
名稱
 name string

專案名稱

更新帳戶

作業識別碼：
Put-account-account_id

更新帳戶

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
account_name
 account_name string

帳戶名稱，通常是公司名稱。
adminNewEntryForOthers
 adminNewEntryForOthers boolean

可以代表其他用戶添加條目
allow_password_login
 allow_password_login boolean

是否允許使用電子郵件+密碼登入
idp_cert
 idp_cert string

身分識別提供者的憑證 （與類型 = saml 搭配使用）
idp_entity_id
 idp_entity_id string

身分識別提供者的識別碼 （與類型 = saml 搭配使用）
idp_metadata_url
 idp_metadata_url string

身分識別提供者的識別碼 （與類型 = saml 搭配使用）
idp_sso_url
 idp_sso_url string

單一登入 URL （與類型 = saml 搭配使用）
型別
 type string

登入方式類型
貨幣代碼
 currencyCode string

所用貨幣的代碼
enabled
 enabled boolean

是否已啟用進入鎖定自動化
間隔
 interval string

進入鎖定的間隔
interval_target
 interval_target number

如果間隔是每月（月份中的某一天），則介於 1 到 31 之間，如果間隔是每週，則介於 0 到 6i 之間
成員平均成本
 memberAverageCost number

指出帳戶成員的平均人工成本
顯示工作時間
 showWorkingTime boolean

使用者是否可以在儀表板中查看其工作時間。 （例如，8 小時的 7 小時）

更新待辦事項

作業識別碼：
Put-todos-todo_id

更新待辦事項

參數

名稱 機碼 必要 類型 Description
待辦事項
 todo True string
描述
 description string

待辦事項說明
due_date
 due_date string

完成待辦事項的資料
索引
 index integer

清單中待辦事項的索引（順序）
is_completed
 is_completed boolean

待辦事項是否標示為已完成
名稱
 name string

待辦事項的標題
priority
 priority string

待辦事項是否標示為已完成
project_id
 project_id integer

待辦事項所屬專案的唯一識別碼
start_date
 start_date string

應負責待辦事項的日期
狀態
 status string

待辦事項的現況
tag_ids
 tag_ids array of integer

要連結至待辦事項的tag_id陣列
todo_list_id
 todo_list_id integer

待辦事項所屬待辦事項清單的唯一識別碼
user_id
 user_id integer

指派給待辦事項的使用者的唯一識別碼
user_ids
 user_ids array of integer

代表指派給待辦事項之使用者的user_id陣列

傳回

response
object

更新待辦事項清單

作業識別碼：
Put-todo-List-todolist_id

更新標籤清單

參數

名稱 機碼 必要 類型 Description
todo_list
 todo_list True string
color
 color True string

用於報表的顏色
索引
 index integer

用於報表的顏色
名稱
 name True string

待辦事項清單的名稱
project_id
 project_id True integer

待辦事項清單所屬專案的唯一識別碼

傳回

名稱 路徑 類型 Description
color
 color string

用於報表的顏色
建立於
 created_at string

建立日期和時間
索引
 index integer

板中待辦事項清單的索引（順序）
名稱
 name string

待辦事項清單的名稱
project_id
 project_id integer

待辦事項清單所屬專案的唯一識別碼
todo_list_id
 todo_list_id integer

唯一識別碼
updated_at
 updated_at string

更新日期和時間

更新條目

作業識別碼：
Put-entries-entry_id

更新項目

參數

名稱 機碼 必要 類型 Description
輸入
 entry True string
接受
 Accept string

application/json
計費
 billed integer

0 = 可計費的條目，1 = 已計費的條目，2 = 不可計費的條目
date
 date string

報名日期
entry_suggestion_id
 entry_suggestion_id integer

建立項目的項目建議的唯一識別碼
紀要
 minutes integer

追蹤時間量（以分鐘為單位）
附註
 notes string

時間輸入注意事項
origin_date
 origin_date string

格式 Y-m-d 需要與repeatable_suggestion_id
phase_id
 phase_id integer

項目所屬階段的唯一識別碼
project_id
 project_id integer

專案的唯一識別碼
repeatable_suggestion_id
 repeatable_suggestion_id integer

建立項目的可重複項目建議的唯一識別碼
來源
 source string

必須是integration_code可用或「一致性」之一
source_text
 source_text string

描述項目來源的文字
source_url
 source_url string

描述項目來源的文字
tag_ids
 tag_ids array of integer

tag_id陣列
user_id
 user_id integer

建立項目之使用者的唯一識別碼

更新標籤

作業識別碼：
Put-tags-tag_id

更新標籤

參數

名稱 機碼 必要 類型 Description
加標籤
 tag True string
接受
 Accept string

application/json
color
 color string

用於報表的顏色
名稱
 name string

標籤的名稱
tag_list_id
 tag_list_id integer

標籤所屬標籤清單的唯一識別碼

更新標籤清單

作業識別碼：
Put-tag-lists-tag_list_id

更新標籤清單

參數

名稱 機碼 必要 類型 Description
tag_list
 tag_list True string
color
 color string

用於報表的顏色
名稱
 name string

標籤清單的名稱
text_color
 text_color string

用於報表的文字顏色

更新用戶端

作業識別碼：
Put-client-client_id

更新用戶端

參數

名稱 機碼 必要 類型 Description
用戶端
 client True string
接受
 Accept string

application/json
color
 color True string

報表中使用的顏色
名稱
 name True string

報表中使用的顏色

傳回

名稱 路徑 類型 Description
client_id (客戶識別碼)
 client_id integer

唯一識別碼
color
 color string

報表中使用的顏色
is_active
 is_active boolean

客戶端是否已封存
名稱
 name string

客戶名稱

更新群組

作業識別碼：
Put-groups-group_id

更新群組

參數

名稱 機碼 必要 類型 Description
組成群組
 group True string
接受
 Accept string

application/json
color
 color string

用於報表的顏色
名稱
 name string

群組名稱

傳回

名稱 路徑 類型 Description
color
 color string

用於報表的顏色
group_id
 group_id integer

唯一識別碼
名稱
 name string

群組名稱

更新計時器

作業識別碼：
Put-timers-timer_id

更新計時器

參數

名稱 機碼 必要 類型 Description
計時器
 timer True string
接受
 Accept string

application/json
date
 date string

計時器日期
entry_suggestion_id
 entry_suggestion_id integer

建立計時器的項目建議的唯一識別碼
附註
 notes string

計時器注意事項
origin_date
 origin_date string

格式 Y-m-d 需要與repeatable_suggestion_id
phase_id
 phase_id True integer

計時器所屬階段的唯一識別碼
project_id
 project_id True integer

專案的唯一識別碼
repeatable_suggestion_id
 repeatable_suggestion_id integer

建立計時器的可重複項目建議的唯一識別碼
秒
 seconds integer
來源
 source string

必須是integration_code可用或「一致性」之一
source_text
 source_text string

描述計時器來源的文字
source_url
 source_url string

描述計時器來源的文字
tag_ids
 tag_ids array of integer

tag_id陣列
timer_status
 timer_status True string
user_id
 user_id integer

建立計時器的使用者的唯一識別碼

更新階段

作業識別碼：
Put-phases-phase_id

更新階段

參數

名稱 機碼 必要 類型 Description
階段
 phase True string
接受
 Accept string

application/json
budget_minutes
 budget_minutes integer

階段的預算時間量。 階段budget_minutes的總和不得超過項目的預算時間
is_open
 is_open integer

階段是否已封存
名稱
 name string

階段的名稱
phase_category_id
 phase_category_id integer

階段所屬階段類別的唯一識別碼
project_id
 project_id integer

階段所屬專案的唯一識別碼

更新階段類別

作業識別碼：
Put-phase-categories-phase_category_id

更新階段類別

參數

名稱 機碼 必要 類型 Description
phase_category
 phase_category True string
接受
 Accept string

application/json
color
 color string

用於報表的顏色
名稱
 name string

階段類別的名稱

傳回

名稱 路徑 類型 Description
color
 color string

用於報表的顏色
名稱
 name string

階段類別的名稱
phase_category_id
 phase_category_id integer

唯一識別碼

更新預算

作業識別碼：
Put-budGet-budget_id

更新預算

參數

名稱 機碼 必要 類型 Description
預算
 budget True string
接受
 Accept string

application/json
budget_minutes
 budget_minutes integer

預算重設日期：如果預算是每月，則為 1 至 31 天，如果預算為每週，則為 0 至 6 天
間隔
 interval integer

預算重設日期：如果預算是每月，則為 1 至 31 天，如果預算為每週，則為 0 至 6 天
定期
 recurrence integer

預算週期：0 = 無週期，1 = 每週，2 = 每月

傳回

名稱 路徑 類型 Description
budget_id
 budget_id integer

預算的唯一識別碼
budget_minutes
 budget_minutes integer

預算所代表的分鐘數
間隔
 interval integer

預算重設日期：如果預算是每月，則為 1 至 31 天，如果預算為每週，則為 0 至 6 天
is_active
 is_active integer

預算是否有效
period_end
 period_end string

格式：YYYY-MM-DD
period_start
 period_start string

格式：YYYY-MM-DD
project_id
 project_id integer

預算所屬專案的識別碼
定期
 recurrence integer

預算週期：0 = 無週期，1 = 每週，2 = 每月

清單標籤清單

作業識別碼：
List-tag-lists

取得標籤清單清單

參數

名稱 機碼 必要 類型 Description
頁面
 page integer

目前顯示的頁面
per_page
 per_page integer

每頁有多少項目
sort_by
 sort_by string

要排序的屬性
方向
 direction string

排序方向
project_id
 project_id integer

取得屬於專案的標籤清單
接受
 Accept string

application/json

傳回

名稱 路徑 類型 Description
current_page
 current_page integer
資料
 data array of
first_page_url
 first_page_url string
從
 from integer
last_page
 last_page integer
last_page_url
 last_page_url string
next_page_url
 next_page_url string
路徑
 path string
per_page
 per_page integer
prev_page_url
 prev_page_url string
至
 to integer
總計
 total integer

清單組

作業識別碼：
Get-groups

取得所有群組的清單

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json

傳回

名稱 路徑 類型 Description
current_page
 current_page integer
資料
 data array of
first_page_url
 first_page_url string
從
 from integer
last_page
 last_page integer
last_page_url
 last_page_url string
next_page_url
 next_page_url string
路徑
 path string
per_page
 per_page integer
prev_page_url
 prev_page_url string
至
 to integer
總計
 total integer

清單計時器

作業識別碼：
List-timers

取得計時器清單

參數

名稱 機碼 必要 類型 Description
頁面
 page integer

目前顯示的頁面
per_page
 per_page integer

每頁有多少項目
sort_by
 sort_by string

要排序的屬性
方向
 direction string

排序方向
date_from
 date_from string

僅獲取日期刨絲或等於此日期的計時器
date_to
 date_to string

僅獲取日期小於或等於此日期的計時器
接受
 Accept string

application/json

傳回

名稱 路徑 類型 Description
current_page
 current_page integer
資料
 data array of
first_page_url
 first_page_url string
從
 from integer
last_page
 last_page integer
last_page_url
 last_page_url string
next_page_url
 next_page_url string
路徑
 path string
per_page
 per_page integer
prev_page_url
 prev_page_url string
至
 to integer
總計
 total integer

清單輸入建議

作業識別碼：
Get-entry-suggestions

取得指定時間範圍的參賽建議清單

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json
頁面
 page integer

目前顯示的頁面
per_page
 per_page integer

每頁有多少項目
no_paginate
 no_paginate boolean

獲取完整的建議列表，無需對結果進行分頁
時間範圍
 timeframe string

僅獲取給定時間範圍內的建議
date_from
 date_from string

僅獲取日期更切碎或等於此日期的建議
date_to
 date_to string

僅獲取日期小於或等於此日期的建議

傳回

名稱 路徑 類型 Description
current_page
 current_page integer
資料
 data array of object
accepted
 data.accepted integer

無論建議是否被接受並轉換為條目
created_datetime
 data.created_datetime string

建立建議的日期和時間
entry_date
 data.entry_date string

建議的日期
entry_minutes
 data.entry_minutes integer

建議的時間量（以分鐘為單位）
entry_suggestion_id
 data.entry_suggestion_id integer

唯一識別碼
附註
 data.notes string

與建議來源相關的註釋
phase_id
 data.phase_id integer

建議階段的唯一識別碼
phase_name
 data.phase_name string

建議階段的名稱
project_id
 data.project_id integer

建議專案的唯一識別碼
project_name
 data.project_name string

建議專案的名稱
來源
 data.source string

來源識別碼
source_data
 data.source_data string

與來源相關的其他數據
source_id
 data.source_id string

來源的唯一識別碼
source_text
 data.source_text string

與來源相關的文字
source_url
 data.source_url string

建議來源的 URL
todo_id
 data.todo_id integer
user_id
 data.user_id integer

擁有建議之使用者的唯一識別碼
first_page_url
 first_page_url string
從
 from integer
last_page
 last_page integer
last_page_url
 last_page_url string
next_page_url
 next_page_url string
路徑
 path string
per_page
 per_page integer
prev_page_url
 prev_page_url string
至
 to integer
總計
 total integer

清單項目

作業識別碼：
List-entries

取得項目清單

參數

名稱 機碼 必要 類型 Description
頁面
 page integer

目前顯示的頁面
per_page
 per_page integer

每頁有多少項目
sort_by
 sort_by string

要排序的屬性
方向
 direction string

排序方向
member_ids[]
 member_ids[] string

以逗點分隔的使用者 ID 清單，以過濾結果
entry_ids[]
 entry_ids[] string

以逗號分隔的項目標識碼清單，以篩選結果
project_ids[]
 project_ids[] string

以逗號分隔的專案識別碼清單，以篩選結果
phase_ids[]
 phase_ids[] string

以逗點分隔的階段 ID 清單，以過濾結果
client_ids[]
 client_ids[] string

以逗號分隔的用戶端識別碼清單，以篩選結果
group_ids[]
 group_ids[] string

以逗號分隔的群組識別碼清單，以篩選結果
category_ids[]
 category_ids[] string

以逗號分隔的階段類別 ID 清單，以篩選結果
tag_list_ids[]
 tag_list_ids[] string

以逗號分隔的標籤清單 ID 清單，以篩選結果
tag_ids[]
 tag_ids[] string

以逗號分隔的標籤 ID 清單，以篩選結果
billed_status
 billed_status integer

僅取得具有指定計費狀態的專案：0：未計費 1：已計費 2：不可計費 3：可計費
時間範圍
 timeframe string

僅取得指定時間範圍內的項目
date_from
 date_from string

僅獲取日期更刨絲或等於此日期的條目
date_to
 date_to string

僅取得日期小於或等於此日期的項目
收發簡訊
 text string

取得附註中包含此文字的項目
接受
 Accept string

application/json

傳回

名稱 路徑 類型 Description
資料
 data array of object
計費
 data.billed integer

指出項目是否已計費
client_id (客戶識別碼)
 data.client_id integer

屬於項目專案之用戶端的唯一識別碼
成本
 data.cost string

時間項目的貨幣成本，以建立時間項目的使用者每小時成本為基礎
created_date
 data.created_date string

創建日期和時間
entry_date
 data.entry_date string

報名日期
entry_id
 data.entry_id integer

唯一識別碼
entry_minutes
 data.entry_minutes integer

追蹤時間量（以分鐘為單位）
已鎖定
 data.locked integer

項目是否已鎖定
locked_by_apionly
 data.locked_by_apionly integer

條目是否僅受第三方應用程序的限制鎖定
locked_by_date
 data.locked_by_date integer

項目是否按日期鎖定
locked_by_membership
 data.locked_by_membership integer

項目是否由成員資格鎖定
附註
 data.notes string

時間輸入注意事項
phase_category_id
 data.phase_category_id integer

項目階段所屬階段類別的唯一識別碼
phase_id
 data.phase_id integer

項目所屬階段的唯一識別碼
利
 data.profit string

收入和成本之間的差異
project_id
 data.project_id integer

專案的唯一識別碼
收入
 data.revenue string

基於一般小時費率的時間條目的貨幣收入，項目的 .
來源
 data.source string

指出條目的來源（如果有）
source_data
 data.source_data string

來源的附加資料
source_id
 data.source_id string

項目來源的唯一識別碼
source_text
 data.source_text string

描述項目來源的文字
source_url
 data.source_url string

項目來源的 URL
suggested_phase_id
 data.suggested_phase_id string

建議階段的選擇性識別碼 （如果專案是從 EntrySuggestion 建立）
suggested_project_id
 data.suggested_project_id string

建議專案的選擇性識別碼 （如果專案是從 EntrySuggestion 建立）
todo_id
 data.todo_id string

連結至時間項目的待辦事項的唯一識別碼
updated_date
 data.updated_date string

日期和時間 od 更新
user_id
 data.user_id integer

建立項目之使用者的唯一識別碼
先
 links.first string
last
 links.last string
next
 links.next string
上一頁
 links.prev string
current_page
 meta.current_page integer
從
 meta.from integer
last_page
 meta.last_page integer
links
 meta.links array of object
活動中
 meta.links.active boolean
標籤
 meta.links.label string
url
 meta.links.url string
路徑
 meta.path string
per_page
 meta.per_page integer
至
 meta.to integer
總計
 meta.total integer

獲取帳戶

作業識別碼：
Get-account

取得使用者帳戶的資訊

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

application/json

獲取計時器

作業識別碼：
Get-timers-timer_id

取得計時器

參數

名稱 機碼 必要 類型 Description
計時器
 timer True string
接受
 Accept string

application/json

傳回

名稱 路徑 類型 Description
current_page
 current_page integer
資料
 data array of
first_page_url
 first_page_url string
從
 from integer
last_page
 last_page integer
last_page_url
 last_page_url string
next_page_url
 next_page_url string
路徑
 path string
per_page
 per_page integer
prev_page_url
 prev_page_url string
至
 to integer
總計
 total integer

獲得客戶

作業識別碼：
Get-client-client_id

獲得客戶

參數

名稱 機碼 必要 類型 Description
用戶端
 client True string
接受
 Accept string

application/json

定義

物件

這是類型 'object'。