Web API一覧

エリアとリソース

エリアはAPIの分類を意味し、リソースは実際の操作対象となるデータ（オブジェクト）を示します。エリアとリソースを組み合わせることで、各APIの対象データを一意に示すことができます。 TimeTracker NX Web APIに含まれるエリアは以下のとおりです。

名称	説明
auth	認証
system	システムデータ（マスターデータ）
project	プロジェクト
workitem	ワークアイテム
analytics	分析

エリア毎のWeb API

エリア毎のWeb APIの一覧を以下に示します。 API中の {} は必須のパラメーター（パスパラメーター）で、対象オブジェクト（データ）のIDを指定します。

auth

リソース	操作	API	必要な権限
token	認証用トークンを発行する	POST /auth/token	なし
	認証用トークンを無効にする	DELETE /auth/token	なし

system

リソース		操作	API	必要な権限
users		ユーザー一覧の取得	GET /system/users	コスト閲覧（コスト単価情報取得時）
		ユーザーの取得	GET /system/users/{userIds}	コスト閲覧（コスト単価情報取得時）
		ユーザーの追加	POST /system/users	システム管理
		ユーザーの更新	PUT /system/users/{userIds}	システム管理
		ユーザーの削除	DELETE /system/users/{userIds}	システム管理
	timeEntries	実績工数一覧の取得	GET /system/users/{userIds}/timeEntries	タイムシートの閲覧
		実績工数の取得	GET /system/users/{userIds}/timeEntries/{timeEntryIds}	タイムシートの閲覧
		実績工数の追加	POST /system/users/{userIds}/timeEntries/	タイムシートの編集
		実績工数の更新	PUT /system/users/{userIds}/timeEntries/{timeEntryIds}	タイムシートの編集
		実績工数の削除	DELETE /system/users/{userIds}/timeEntries/{timeEntryIds}	タイムシートの編集
	preference	設定情報の取得	GET /system/users/{userIds}/preference	アカウント設定の変更
		設定情報の更新	PUT /system/users/{userIds}/preference	アカウント設定の変更
userGroups		ユーザーグループ一覧の取得	GET /system/userGroups	なし
	subGroups	サブユーザーグループ一覧の取得	GET /system/userGroups/{userGroupId}/subGroups	なし
organizations		組織一覧の取得	GET /system/organizations	なし
	subOrganizations	サブ組織一覧の取得	GET /system/organizations/{organizationId}/subOrganizations	なし
fieldTypes		フィールドタイプ一覧の取得	GET /system/fieldTypes	なし
itemTypes		アイテムタイプ一覧の取得	GET /system/itemTypes	なし
statusTypes		ステータスタイプ一覧の取得	GET /system/statusTypes	なし
processCategories		工程分類一覧の取得	GET /system/processCategories	なし
timeEntryCategories		作業分類一覧の取得	GET /system/timeEntryCategories	なし
projectCategories		プロジェクトカテゴリー一覧の取得	GET /system/projectCategries	なし
profiles		プロファイル一覧の取得	GET /system/profiles	なし
systemRoles		システムロール一覧の取得	GET /system/systemRoles	なし

project

リソース		操作	API	必要な権限
projects		プロジェクト一覧の取得	GET /project/projects	プロジェクトの閲覧
		プロジェクトの取得	GET /project/projects/{projectIds}	プロジェクトの閲覧
		プロジェクトの追加	POST /project/projects	プロジェクトの作成
		プロジェクトの更新	PUT /project/projects/{projectIds}	プロジェクトの管理
	workCalendar	プロジェクトカレンダーの取得	GET /project/projects/{projectId}/workCalendar	プロジェクトの閲覧
		プロジェクトカレンダーの更新	PUT /project/projects/{projectId}/workCalendar	プロジェクトの管理

workitem

リソース			操作	API	必要な権限
workItems			ワークアイテムの取得	GET /workitem/workItems/{workItemIds}	プロジェクトの閲覧
			ワークアイテムの更新	PUT /workitem/workItems/{workItemIds}	プロジェクトの編集
			ワークアイテムの削除	DELETE /workitem/workItems/{workItemIds}	プロジェクトの編集
	subItems		指定ワークアイテム一覧の取得	GET /workitem/workItems/{workItemId}/subItems	プロジェクトの閲覧
			ワークアイテムの追加	POST /workitem/workItems/{workItemId}/subItems	プロジェクトの編集
		duplicate	ワークアイテムの複製	POST /workitem/workItems/{workItemId}/subItems/duplicate	プロジェクトの編集
	timeEntries	export	実績工数のエクスポート	GET /workitem/workItems/timeEntries/export	実績エクスポート

analytics

リソース	操作	API	必要な権限
timeEntities	工数分析	POST /analytics/timeEntities	なし
itemCounts	アイテム件数分析	POST /analytics/itemCounts	なし

Note

analytics APIは、Standard Editionでは利用できません。