Time Desinger API とは
プロジェクトやタスク,作業履歴などの追加や取得を始めとした、ブラウザ上の Time Designer からできる操作を API 経由で行うことができます。
Time Designer API を活用し、より快適なタスク管理を始めましょう。
Time Desinger API を利用できる契約プラン
Time Desinger には、Time Desinger API を利用できるプランとできないプランがございます。
詳しくはプラン・ご利用料金をご覧ください。
エンドポイント
API エンドポイント
https://api.timedesigner.com/v1
エンドポイントのベース URI は、 https://api.timedesigner.com/v1 となります。
※エンドポイントへは https でアクセスする必要があります。
API の変更
API に対して互換性を保つことができないような変更が入る場合には、エンドポイントの /v1 のバージョン部分が変更され、旧バージョンの API は一定の移行期間の間維持されます。
レスポンスのフィールド追加や新規 API の追加など、互換性を保ったまま変更ができる場合にはバージョンを上げずに変更を行うことがあります。
いずれの場合でも、API に変更が入る際にはブログや Time Desinger のお知らせ機能を通じて事前に変更内容のお知らせが行われます。
認証
API トークンを確認する
Time Desinger API を利用する際には、認証を行う必要があります。
認証には各ユーザーに一意な値として発行された API トークンを利用します。
API トークンは、自分の各種設定 → その他の設定の画面から確認をすることができます。
API トークンの使用
例
curl --basic -u api_token:${APIトークン} \
https://api.timedesigner.com/v1/...
APIはBasic認証で認証します。
Basic認証のユーザー名にapi_tokenを指定し、パスワードに上記APIトークンを指定してください。
API フォーマット
コンテンツタイプ
例
curl --basic -u api_token:${APIトークン} \
-X POST 'https://api.timedesigner.com/v1/tasks' \
-H 'Content-Type: application/json' \
--data '{
"project_id": "3AKnP92l",
"title": "新規タスク",
"priority": "Low"
}'
# レスポンス
{
"id": "6VwWeVm3",
"title": "新規タスク",
"task_status": {
"id": "5vmq3wYR",
"name": "未着手"
},
"assignee": null,
"priority": "Low",
"complete_date_time": null,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"schedule": {
"start_date_time": null,
"end_date_time": null,
"total_working_schedule_time_sec": 0,
"estimate_time_sec": null
},
"actual": {
"progress_rate": 0,
"working_time_sec": 0,
"remaining_working_time_sec": null
},
"predict": {
"progress_rate": null,
"working_time_sec": null
},
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
},
"tags": []
}
API へのリクエストに Body を指定する場合には、JSON 形式を指定してください。
Content-Type：application/json のリクエストヘッダーを設定していることを確認してください。
また、各エンドポイントは JSON でエンコードされたレスポンスボディを返します。
日時フォーマット
API のリクエストパラメータや、レスポンス内容に日時を指定する場合には、ISO 8601 形式を使用します。
YYYY-MM-DDTHH:MM:SSZ
例えば、UTC のタイムゾーンで日付を指定する場合には、
「2018-01-01T01:02:30Z」となります。
Asia/Tokyo(+09:00)のタイムゾーンで日付を指定する場合には、
「2018-01-01T11:02:30+09:00」となります。
レスポンス
エラーレスポンスの例
{
"message": "リクエストパラメーターに不正な値が指定されています。",
"errors": [
{
"field": "title",
"code": "LENGTH",
"data": {
"min": 0,
"max": 100
}
}
]
}
API を呼び出した結果の成否は、レスポンスの HTTP ステータスコードを以て判定してください。
下記の表が、返却されるステータスコードの一覧となります。
結果がエラーの場合には、右記のように message というキーに、エラーの概要が記載されます。
また、エラーの詳細情報が errors に配列で記載されます。
errors の中には、以下の情報が記載されます。
field・・・エラーの原因項目code・・・エラーの詳細を示すコードdata・・・エラーの補足情報
| エラーコード | 内容 |
|---|---|
| 200 - OK | リクエストは正常に処理された。 |
| 201 - Created | リクエストは正常に処理され、新たにリソースが作成された。 |
| 204 - No Content | リクエストは正常に処理され、返却するべき値はない。 |
| 400 - Bad Request | リクエストの送信内容に不備がある。 |
| 401 - Unauthorized | 認証を行うことが出来なかった。 |
| 403 - Forbidden | 許可されていない操作を行った。 |
| 404 - Not Found | 指定したリソースが存在しない。 |
| 409 - Conflict | リソースの更新に競合が発生した。 |
| 429 - Too Many Requests | リクエスト数が多すぎる。 |
| 500, 502, 503, 504 - Server Errors | Time Designer の API サーバーでエラーが発生している。 |
メンバー
自分自身や、組織、チームに所属するメンバーの情報を参照する API について、以下に記載します。
自分の情報の取得
例
curl 'https://api.timedesigner.com/v1/members/me' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "pkm5OwGA",
"name": "山口 博一",
"mail_address": "test01@timedesigner.com",
"profile_image_url": "https://timedesigner-public-file-storage-demo-data.s3.ap-northeast-1.amazonaws.com/profile-image/65bcccc8-6ee1-4e5c-82b3-702a130c8fe6.png",
"roles": {
"admin": true,
"labor_cost_management": true,
"member_management": true,
"client_management": true,
"organization_report": true,
"team_report": true,
"organization_member_view": true,
"team_member_view": true
},
"permissions": {
"can_delete_project": true,
"can_delete_task": true
},
"status": "Active",
"teams": [
{
"id": "pkm5OwGA",
"name": "宇宙ビジネスロケット部"
},
{
"id": "Vlwz59Ra",
"name": "宇宙トラベル事業部"
}
],
"registered_date_time": "2022-07-17T23:06:05Z"
}
自分自身のメンバー情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/members/me
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーの ID |
| name | 名前 | |
| mail_address | ○ | メールアドレス |
| profile_image_url | プロフィール画像の URL | |
| roles | ○ | メンバーのロール。詳細は下記を参照してください。 |
| permissions | ○ | メンバーの権限。詳細は下記を参照してください。 |
| status | ○ | メンバーのステータス。 詳細は下記を参照してください。 |
| teams | ○ | 所属しているチームの情報。 詳細は下記を参照してください。 |
| registered_date_time | ○ | 会員登録日時 |
roles
| レスポンス | 必須 | 内容 |
|---|---|---|
| admin | ○ | 管理者かどうかのフラグ。管理者の場合は true、そうでない場合は false。 |
| labor_cost_management | ○ | 人件費管理権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| member_management | ○ | メンバー管理権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| client_management | ○ | 取引先権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| organization_report | ○ | 組織レポート閲覧権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| team_report | ○ | チームレポート閲覧権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| organization_member_view | ○ | 組織メンバーの情報を閲覧する権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| team_member_view | ○ | チームメンバーの情報を閲覧する権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
permissions
| レスポンス | 必須 | 内容 |
|---|---|---|
| can_delete_project | ○ | プロジェクトを削除することができるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| can_delete_task | ○ | タスクを削除することができるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
status
| Active | 有効なメンバーであることを示します。 |
| Inactive | 無効になったメンバーであることを示します。 |
| Inviting | 招待中のメンバーであることを示します。 |
teams
| レスポンス | 必須 | |
|---|---|---|
| id | ○ | チームのID。 |
| name | ○ | チームの名称。 |
メンバー情報の取得
例
curl 'https://api.timedesigner.com/v1/members/pkm5OwGA' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "pkm5OwGA",
"name": "山口 博一",
"mail_address": "test01@timedesigner.com",
"profile_image_url": "https://timedesigner-public-file-storage-demo-data.s3.ap-northeast-1.amazonaws.com/profile-image/65bcccc8-6ee1-4e5c-82b3-702a130c8fe6.png",
"roles": {
"admin": true,
"labor_cost_management": true,
"member_management": true,
"client_management": true,
"organization_report": true,
"team_report": true,
"organization_member_view": true,
"team_member_view": true
},
"permissions": {
"can_delete_project": true,
"can_delete_task": true
},
"status": "Active",
"teams": [
{
"id": "pkm5OwGA",
"name": "宇宙ビジネスロケット部"
},
{
"id": "Vlwz59Ra",
"name": "宇宙トラベル事業部"
}
],
"registered_date_time": "2022-07-17T23:06:05Z"
}
メンバー情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/members/{メンバーID}
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーの ID |
| name | 名前 | |
| mail_address | ○ | メールアドレス |
| profile_image_url | プロフィール画像の URL | |
| roles | ○ | メンバーのロール。詳細は下記を参照してください。 |
| permissions | ○ | メンバーの権限。詳細は下記を参照してください。 |
| status | ○ | メンバーのステータス。 詳細は下記を参照してください。 |
| teams | ○ | 所属しているチームの情報。 詳細は下記を参照してください。 |
| registered_date_time | ○ | 会員登録日時 |
roles
| レスポンス | 必須 | 内容 |
|---|---|---|
| admin | ○ | 管理者かどうかのフラグ。管理者の場合は true、そうでない場合は false。 |
| labor_cost_management | ○ | 人件費管理権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| member_management | ○ | メンバー管理権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| client_management | ○ | 取引先権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| organization_report | ○ | 組織レポート閲覧権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| team_report | ○ | チームレポート閲覧権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| organization_member_view | ○ | 組織メンバーの情報を閲覧する権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| team_member_view | ○ | チームメンバーの情報を閲覧する権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
permissions
| レスポンス | 必須 | 内容 |
|---|---|---|
| can_delete_project | ○ | プロジェクトを削除することができるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| can_delete_task | ○ | タスクを削除することができるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
status
| Active | 有効なメンバーであることを示します。 |
| Inactive | 無効になったメンバーであることを示します。 |
| Inviting | 招待中のメンバーであることを示します。 |
teams
| レスポンス | 必須 | |
|---|---|---|
| id | ○ | チームのID。 |
| name | ○ | チームの名称。 |
組織に所属するメンバー一覧の取得
例
curl 'https://api.timedesigner.com/v1/members?page=1&page_size=50&status=Active' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 50,
"page": 1,
"total_count": 12,
"total_page_count": 1,
"has_next_page": false,
"has_previous_page": false,
"items": [
{
"id": "pkm5OwGA",
"name": "山口 博一",
"mail_address": "test01@timedesigner.com",
"profile_image_url": "https://timedesigner-public-file-storage-demo-data.s3.ap-northeast-1.amazonaws.com/profile-image/65bcccc8-6ee1-4e5c-82b3-702a130c8fe6.png",
"roles": {
"admin": true,
"labor_cost_management": true,
"member_management": true,
"client_management": true,
"organization_report": true,
"team_report": true,
"organization_member_view": true,
"team_member_view": true
},
"permissions": {
"can_delete_project": true,
"can_delete_task": true
},
"status": "Active",
"teams": [
{
"id": "pkm5OwGA",
"name": "宇宙ビジネスロケット部"
},
{
"id": "Vlwz59Ra",
"name": "宇宙トラベル事業部"
}
],
"registered_date_time": "2022-07-17T23:06:05Z"
},
...
]
組織に所属するメンバーの一覧情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/members
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | min:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
| page_size | default:50 | min:1, max:100 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
| status | メンバーのステータス。ステータスで絞り込みしたい場合に指定します。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1ページあたりのデータ件数。 |
| page | ○ | 現在のページ番号。 |
| total_count | ○ | 合計データ数。 |
| total_page_count | ○ | 合計ページ数。 |
| has_next_page | ○ | 次のページがあるかどうか。 |
| has_previous_page | ○ | 前のページがあるかどうか。 |
| items | ○ | 取得したデータ。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーの ID |
| name | 名前 | |
| mail_address | ○ | メールアドレス |
| profile_image_url | プロフィール画像の URL | |
| roles | ○ | メンバーのロール。詳細は下記を参照してください。 |
| permissions | ○ | メンバーの権限。詳細は下記を参照してください。 |
| status | ○ | メンバーのステータス。 詳細は下記を参照してください。 |
| teams | ○ | 所属しているチームの情報。 詳細は下記を参照してください。 |
| registered_date_time | ○ | 会員登録日時 |
items.roles
| レスポンス | 必須 | 内容 |
|---|---|---|
| admin | ○ | 管理者かどうかのフラグ。管理者の場合は true、そうでない場合は false。 |
| labor_cost_management | ○ | 人件費管理権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| member_management | ○ | メンバー管理権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| client_management | ○ | 取引先権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| organization_report | ○ | 組織レポート閲覧権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| team_report | ○ | チームレポート閲覧権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| organization_member_view | ○ | 組織メンバーの情報を閲覧する権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| team_member_view | ○ | チームメンバーの情報を閲覧する権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
items.permissions
| レスポンス | 必須 | 内容 |
|---|---|---|
| can_delete_project | ○ | プロジェクトを削除することができるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| can_delete_task | ○ | タスクを削除することができるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
items.status
| Active | 有効なメンバーであることを示します。 |
| Inactive | 無効になったメンバーであることを示します。 |
| Inviting | 招待中のメンバーであることを示します。 |
items.teams
| レスポンス | 必須 | |
|---|---|---|
| id | ○ | チームのID。 |
| name | ○ | チームの名称。 |
チームに所属するメンバー一覧の取得
例
curl 'https://api.timedesigner.com/v1/teams/pkm5OwGA/members?page=1&page_size=50?status=Active' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 50,
"page": 1,
"total_count": 12,
"total_page_count": 1,
"has_next_page": false,
"has_previous_page": false,
"items": [
{
"id": "pkm5OwGA",
"name": "山口 博一",
"mail_address": "test01@timedesigner.com",
"profile_image_url": "https://timedesigner-public-file-storage-demo-data.s3.ap-northeast-1.amazonaws.com/profile-image/65bcccc8-6ee1-4e5c-82b3-702a130c8fe6.png",
"roles": {
"admin": true,
"labor_cost_management": true,
"member_management": true,
"client_management": true,
"organization_report": true,
"team_report": true,
"organization_member_view": true,
"team_member_view": true
},
"permissions": {
"can_delete_project": true,
"can_delete_task": true
},
"status": "Active",
"teams": [
{
"id": "pkm5OwGA",
"name": "宇宙ビジネスロケット部"
},
{
"id": "Vlwz59Ra",
"name": "宇宙トラベル事業部"
}
],
"registered_date_time": "2022-07-17T23:06:05Z"
},
...
]
チームに所属するメンバーの一覧情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/teams/{チームID}/members
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | min:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
| page_size | default:50 | min:1, max:100 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
| status | メンバーのステータス。ステータスで絞り込みしたい場合に指定します。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1ページあたりのデータ件数。 |
| page | ○ | 現在のページ番号。 |
| total_count | ○ | 合計データ数。 |
| total_page_count | ○ | 合計ページ数。 |
| has_next_page | ○ | 次のページがあるかどうか。 |
| has_previous_page | ○ | 前のページがあるかどうか。 |
| items | ○ | 取得したデータ。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーの ID |
| name | 名前 | |
| mail_address | ○ | メールアドレス |
| profile_image_url | プロフィール画像の URL | |
| roles | ○ | メンバーのロール。詳細は下記を参照してください。 |
| permissions | ○ | メンバーの権限。詳細は下記を参照してください。 |
| status | ○ | メンバーのステータス。 詳細は下記を参照してください。 |
| teams | ○ | 所属しているチームの情報。 詳細は下記を参照してください。 |
| registered_date_time | ○ | 会員登録日時 |
items.roles
| レスポンス | 必須 | 内容 |
|---|---|---|
| admin | ○ | 管理者かどうかのフラグ。管理者の場合は true、そうでない場合は false。 |
| labor_cost_management | ○ | 人件費管理権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| member_management | ○ | メンバー管理権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| client_management | ○ | 取引先権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| organization_report | ○ | 組織レポート閲覧権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| team_report | ○ | チームレポート閲覧権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| organization_member_view | ○ | 組織メンバーの情報を閲覧する権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| team_member_view | ○ | チームメンバーの情報を閲覧する権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
items.permissions
| レスポンス | 必須 | 内容 |
|---|---|---|
| can_delete_project | ○ | プロジェクトを削除することができるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| can_delete_task | ○ | タスクを削除することができるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
items.status
| Active | 有効なメンバーであることを示します。 |
| Inactive | 無効になったメンバーであることを示します。 |
| Inviting | 招待中のメンバーであることを示します。 |
items.teams
| レスポンス | 必須 | |
|---|---|---|
| id | ○ | チームのID。 |
| name | ○ | チームの名称。 |
組織
組織の情報を参照する API について、以下に記載します。
所属する組織の情報の取得
例
curl 'https://api.timedesigner.com/v1/organization' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "Vlwz59Ra",
"name": "サンプル組織",
"plan_code": "Business",
"contract_preriod": "Monthly",
"billing_mail_address": "sample@timdesigner.com",
"image_url": "https://file.timedesigner.com/profile-image/xxxx-yyyy-zzzz.png"
}
所属する組織の情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/organization
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 組織の ID |
| name | ○ | 組織名 |
| plan_code | ○ | 契約しているプランコード。詳細は下記を参照してください。 |
| contract_preriod | ○ | 契約期間。詳細は下記を参照してください。 |
| billing_mail_address | ○ | 請求先メールアドレス |
| image_url | 組織の画像の URL |
plan_code
| Basic | ベーシックプラン |
| Professional | プロプラン |
| Business | ビジネスプラン |
contract_preriod
| Monthly | 月間契約 |
| Yearly | 年間契約 |
所属する組織の情報の更新
例
curl -X PUT 'https://api.timedesigner.com/v1/organization' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"name": "サンプル組織",
"billing_mail_address": "sample@timedesigner.com"
}'
# レスポンス
{
"id": "pkm5OwGA",
"name": "サンプル組織",
"plan_code": "Business",
"contract_preriod": "Monthly",
"billing_mail_address": "sample@timedesigner.com",
"image_url": "https://timedesigner-public-file-storage-demo-data.s3.ap-northeast-1.amazonaws.com/organization-image/fa17f6db-5f4c-4ccd-9756-68b41bcbdb3e.png"
}
所属する組織の情報を更新します。
エンドポイント:
PUT https://api.timedesigner.com/v1/organization
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| name | ○ | max-length:100 | 組織名 |
| billing_mail_address | ○ | valid mail address | 請求先メールアドレス |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 組織の ID |
| name | ○ | 組織名 |
| plan_code | ○ | 契約しているプランコード。詳細は下記を参照してください。 |
| contract_preriod | ○ | 契約期間。詳細は下記を参照してください。 |
| billing_mail_address | ○ | 請求先メールアドレス |
| image_url | 組織の画像の URL |
plan_code
| Basic | ベーシックプラン |
| Professional | プロプラン |
| Business | ビジネスプラン |
contract_preriod
| Monthly | 月間契約 |
| Yearly | 年間契約 |
取引先
取引先の情報を参照する API について、以下に記載します。
取引先一覧の取得
例
curl 'https://api.timedesigner.com/v1/clients?page=1&page_size=50' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 50,
"page": 1,
"total_count": 5,
"total_page_count": 1,
"has_next_page": false,
"has_previous_page": false,
"items": [
{
"id": "pkm5OwGA",
"name": "Galaxyカンパニー"
},
...
]
}
取引先一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/clients
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | min:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
| page_size | default:50 | min:1, max:100 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1ページあたりのデータ件数。 |
| page | ○ | 現在のページ番号。 |
| total_count | ○ | 合計データ数。 |
| total_page_count | ○ | 合計ページ数。 |
| has_next_page | ○ | 次のページがあるかどうか。 |
| has_previous_page | ○ | 前のページがあるかどうか。 |
| items | ○ | 取得したデータ。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先の ID |
| name | ○ | 取引先名 |
取引先情報の取得
例
curl 'https://api.timedesigner.com/v1/clients/2p9pbKQM' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "2p9pbKQM",
"name": "サンプル取引先"
}
取引先情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/clients/{取引先ID}
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先の ID |
| name | ○ | 取引先名 |
取引先情報の作成
例
curl -X POST 'https://api.timedesigner.com/v1/clients' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"name": "サンプル取引先"
}'
# レスポンス
{
"id": "2p9pbKQM",
"name": "サンプル取引先"
}
取引先情報を作成します。
エンドポイント:
POST https://api.timedesigner.com/v1/clients
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| name | ○ | max-length:100 | 取引先名 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先の ID |
| name | ○ | 取引先名 |
取引先情報の更新
例
curl -X PUT 'https://api.timedesigner.com/v1/clients/2p9pbKQM' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"name": "サンプル取引先"
}'
# レスポンス
{
"id": "2p9pbKQM",
"name": "サンプル取引先"
}
取引先情報を更新します。
エンドポイント:
PUT https://api.timedesigner.com/v1/clients/{取引先ID}
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| name | ○ | max-length:100 | 取引先名 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先の ID |
| name | ○ | 取引先名 |
取引先情報の削除
例
curl -X DELETE 'https://api.timedesigner.com/v1/clients/2p9pbKQM' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json'
# レスポンス
なし (204 No Content)
取引先情報を削除します。
エンドポイント:
DELETE https://api.timedesigner.com/v1/clients/{取引先ID}
リクエスト・パラメータ
なし
レスポンス・データ
なし
チーム
チームの情報を参照する API について、以下に記載します。
チーム一覧の取得
例
curl 'https://api.timedesigner.com/v1/teams?page=1&page_size=50&status=Active' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 50,
"page": 1,
"total_count": 2,
"total_page_count": 1,
"has_next_page": false,
"has_previous_page": false,
"items": [
{
"id": "pkm5OwGA",
"name": "宇宙ビジネスロケット部",
"status": "Active"
},
{
"id": "Vlwz59Ra",
"name": "宇宙トラベル事業部",
"status": "Active"
}
]
}
チーム一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/teams
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | min:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
| page_size | default:50 | min:1, max:100 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
| status | チームのステータス。ステータスで絞り込みしたい場合に指定します。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1ページあたりのデータ件数。 |
| page | ○ | 現在のページ番号。 |
| total_count | ○ | 合計データ数。 |
| total_page_count | ○ | 合計ページ数。 |
| has_next_page | ○ | 次のページがあるかどうか。 |
| has_previous_page | ○ | 前のページがあるかどうか。 |
| items | ○ | 取得したデータ。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | チームの ID |
| name | ○ | チーム名 |
| status | ○ | チームの状態。詳細は下記を参照してください。 |
items.status
| Active | 有効 |
| Archived | アーカイブ済 |
チーム情報の取得
例
curl 'https://api.timedesigner.com/v1/teams/Vlwz59Ra' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "Vlwz59Ra",
"name": "サンプルチーム１",
"status": "Active"
}
チーム情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/teams/{チームID}
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | チームの ID |
| name | ○ | チーム名 |
| status | ○ | チームの状態。詳細は下記を参照してください。 |
status
| Active | 有効 |
| Archived | アーカイブ済 |
チーム情報の作成
例
curl -X POST 'https://api.timedesigner.com/v1/teams' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"name": "サンプルチーム１",
"mail_addresses": ["member1@timedesigner.com","member2@timedesigner.com"],
"member_ids": ["pkm5OwGA"]
}'
# レスポンス
{
"id": "Vlwz59Ra",
"name": "サンプルチーム１",
"status": "Active"
}
チーム情報を作成します。
エンドポイント:
POST https://api.timedesigner.com/v1/teams
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| name | ○ | max-length:100 | チーム名 |
| member_ids | 任意の項目です。チームに参加させたいメンバーのIDを配列で指定してください。指定されたIDのメンバーが存在しない場合は、そのメンバーは無視されます。 | ||
| mail_addresses | 任意の項目です。チームに参加させたいメンバーのメールアドレスを配列で指定してください。指定されたメールアドレスのメンバーが存在しない場合は、そのメンバーは無視されます。 |
member_ids, mail_addressesが指定されていない場合には、チームを作成した人は自動的に参加メンバーに登録されます。 member_ids, mail_addressesが指定されていない場合には、指定したメンバーのみ参加メンバーに登録されます。
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | チームの ID |
| name | ○ | チーム名 |
| status | ○ | チームの状態。詳細は下記を参照してください。 |
status
| Active | 有効 |
| Archived | アーカイブ済 |
チーム情報の更新
例
curl -X PUT 'https://api.timedesigner.com/v1/teams/Vlwz59Ra' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"name": "サンプルチーム１"
}'
# レスポンス
{
"id": "Vlwz59Ra",
"name": "サンプルチーム１",
"status": "Active"
}
チーム情報を更新します。
エンドポイント:
POST https://api.timedesigner.com/v1/teams/{チームID}
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| name | ○ | max-length:100 | チーム名 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | チームの ID |
| name | ○ | チーム名 |
| status | ○ | チームの状態。詳細は下記を参照してください。 |
status
| Active | 有効 |
| Archived | アーカイブ済 |
チームをアーカイブする
例
curl -X PUT 'https://api.timedesigner.com/v1/teams/Vlwz59Ra/archive' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "Vlwz59Ra",
"name": "サンプルチーム１",
"status": "Archived"
}
チームをアーカイブします。
エンドポイント:
PUT https://api.timedesigner.com/v1/teams/{チームID}/archive
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | チームの ID |
| name | ○ | チーム名 |
| status | ○ | チームの状態。詳細は下記を参照してください。 |
status
| Active | 有効 |
| Archived | アーカイブ済 |
チームのアーカイブを解除する
例
curl -X PUT 'https://api.timedesigner.com/v1/teams/Vlwz59Ra/unarchive' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "Vlwz59Ra",
"name": "サンプルチーム１",
"status": "ArchActiveived"
}
チームのアーカイブを解除します。
エンドポイント:
PUT https://api.timedesigner.com/v1/teams/{チームID}/unarchive
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | チームの ID |
| name | ○ | チーム名 |
| status | ○ | チームの状態。詳細は下記を参照してください。 |
status
| Active | 有効 |
| Archived | アーカイブ済 |
チームへの参加メンバーの追加
例
curl -X POST 'https://api.timedesigner.com/v1/teams/Vlwz59Ra/add-members' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"mail_addresses": ["member1@timedesigner.com","member2@timedesigner.com"],
"member_ids": ["pkm5OwGA"]
}'
# レスポンス
[
{
"id": "pkm5OwGA",
"name": "山口 博一",
"mail_address": "test01@timedesigner.com",
"profile_image_url": "https://timedesigner-public-file-storage-demo-data.s3.ap-northeast-1.amazonaws.com/profile-image/65bcccc8-6ee1-4e5c-82b3-702a130c8fe6.png",
"roles": {
"admin": true,
"labor_cost_management": true,
"member_management": true,
"client_management": true,
"organization_report": true,
"team_report": true,
"organization_member_view": true,
"team_member_view": true
},
"permissions": {
"can_delete_project": true,
"can_delete_task": true
},
"status": "Active",
"teams": [
{
"id": "pkm5OwGA",
"name": "宇宙ビジネスロケット部"
},
{
"id": "Vlwz59Ra",
"name": "宇宙トラベル事業部"
}
],
"registered_date_time": "2022-07-17T23:06:05Z"
},
...
]
チームに参加するメンバーを追加します。 メンバーIDかメールアドレスを指定して、参加メンバーを追加することが出来ます。
エンドポイント:
POST https://api.timedesigner.com/v1/teams/{チームID}/add-members
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| member_ids | 任意の項目です。チームに参加させたいメンバーのIDを配列で指定してください。指定されたIDのメンバーが存在しない場合は、そのメンバーは無視されます。 | ||
| mail_addresses | 任意の項目です。チームに参加させたいメンバーのメールアドレスを配列で指定してください。指定されたメールアドレスのメンバーが存在しない場合は、そのメンバーは無視されます。 |
レスポンス・データ
今回チームに参加成功したメンバーの一覧を返します。
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーの ID |
| name | 名前 | |
| mail_address | ○ | メールアドレス |
| profile_image_url | プロフィール画像の URL | |
| roles | ○ | メンバーのロール。詳細は下記を参照してください。 |
| permissions | ○ | メンバーの権限。詳細は下記を参照してください。 |
| status | ○ | メンバーのステータス。 詳細は下記を参照してください。 |
| teams | ○ | 所属しているチームの情報。 詳細は下記を参照してください。 |
| registered_date_time | ○ | 会員登録日時 |
roles
| レスポンス | 必須 | 内容 |
|---|---|---|
| admin | ○ | 管理者かどうかのフラグ。管理者の場合は true、そうでない場合は false。 |
| labor_cost_management | ○ | 人件費管理権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| member_management | ○ | メンバー管理権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| client_management | ○ | 取引先権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| organization_report | ○ | 組織レポート閲覧権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| team_report | ○ | チームレポート閲覧権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| organization_member_view | ○ | 組織メンバーの情報を閲覧する権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| team_member_view | ○ | チームメンバーの情報を閲覧する権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
permissions
| レスポンス | 必須 | 内容 |
|---|---|---|
| can_delete_project | ○ | プロジェクトを削除することができるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| can_delete_task | ○ | タスクを削除することができるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
status
| Active | 有効なメンバーであることを示します。 |
| Inactive | 無効になったメンバーであることを示します。 |
| Inviting | 招待中のメンバーであることを示します。 |
チームからのメンバーの削除
例
curl -X POST 'https://api.timedesigner.com/v1/teams/Vlwz59Ra/remove-members' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"mail_addresses": ["member1@timedesigner.com","member2@timedesigner.com"],
"member_ids": ["pkm5OwGA"]
}'
# レスポンス
[
{
"id": "pkm5OwGA",
"name": "山口 博一",
"mail_address": "test01@timedesigner.com",
"profile_image_url": "https://timedesigner-public-file-storage-demo-data.s3.ap-northeast-1.amazonaws.com/profile-image/65bcccc8-6ee1-4e5c-82b3-702a130c8fe6.png",
"roles": {
"admin": true,
"labor_cost_management": true,
"member_management": true,
"client_management": true,
"organization_report": true,
"team_report": true,
"organization_member_view": true,
"team_member_view": true
},
"permissions": {
"can_delete_project": true,
"can_delete_task": true
},
"status": "Active",
"teams": [
{
"id": "pkm5OwGA",
"name": "宇宙ビジネスロケット部"
},
{
"id": "Vlwz59Ra",
"name": "宇宙トラベル事業部"
}
],
"registered_date_time": "2022-07-17T23:06:05Z"
},
...
]
チームから指定したメンバーを削除します。 メンバーIDかメールアドレスを指定して、メンバーを削除することが出来ます。
エンドポイント:
POST https://api.timedesigner.com/v1/teams/{チームID}/remove-members
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| member_ids | 任意の項目です。チームから削除したいメンバーのIDを配列で指定してください。指定されたIDのメンバーが存在しない場合は、そのメンバーは無視されます。 | ||
| mail_addresses | 任意の項目です。チームから削除したいメンバーのメールアドレスを配列で指定してください。指定されたメールアドレスのメンバーが存在しない場合は、そのメンバーは無視されます。 |
レスポンス・データ
今回チームから削除成功したメンバーの一覧を返します。
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーの ID |
| name | 名前 | |
| mail_address | ○ | メールアドレス |
| profile_image_url | プロフィール画像の URL | |
| roles | ○ | メンバーのロール。詳細は下記を参照してください。 |
| permissions | ○ | メンバーの権限。詳細は下記を参照してください。 |
| status | ○ | メンバーのステータス。 詳細は下記を参照してください。 |
| teams | ○ | 所属しているチームの情報。 詳細は下記を参照してください。 |
| registered_date_time | ○ | 会員登録日時 |
roles
| レスポンス | 必須 | 内容 |
|---|---|---|
| admin | ○ | 管理者かどうかのフラグ。管理者の場合は true、そうでない場合は false。 |
| labor_cost_management | ○ | 人件費管理権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| member_management | ○ | メンバー管理権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| client_management | ○ | 取引先権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| organization_report | ○ | 組織レポート閲覧権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| team_report | ○ | チームレポート閲覧権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| organization_member_view | ○ | 組織メンバーの情報を閲覧する権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| team_member_view | ○ | チームメンバーの情報を閲覧する権限があるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
permissions
| レスポンス | 必須 | 内容 |
|---|---|---|
| can_delete_project | ○ | プロジェクトを削除することができるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
| can_delete_task | ○ | タスクを削除することができるかどうかのフラグ。権限がある場合は true、そうでない場合は false。 |
status
| Active | 有効なメンバーであることを示します。 |
| Inactive | 無効になったメンバーであることを示します。 |
| Inviting | 招待中のメンバーであることを示します。 |
プロジェクト
プロジェクトの情報を参照する API について、以下に記載します。
プロジェクト一覧の取得
例
curl 'https://api.timedesigner.com/v1/projects?page=1&page_size=50&complete=false' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 3,
"page": 1,
"total_count": 8,
"total_page_count": 3,
"has_next_page": true,
"has_previous_page": false,
"items": [
{
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査",
"complete": false,
"color": "#FF0000",
"key": null,
"complete_date_time": null,
"team": {
"id": "pkm5OwGA",
"name": "宇宙ビジネスロケット部"
},
"client": {
"id": "pkm5OwGA",
"name": "Galaxyカンパニー"
}
},
...
]
}
プロジェクト一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/projects
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
|
| complete | 完了したプロジェクトに絞り込みしたい場合は true、未完了のプロジェクトに絞り込みしたい場合は false を指定します。 |
||
| team_id | チームで絞り込みしたい場合に、チームIDを指定します。 | ||
| client_id | 取引先で絞り込みしたい場合に、取引先IDを指定します。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトの ID |
| name | ○ | プロジェクト名 |
| complete | ○ | プロジェクトの完了ステータス。完了している場合は True、そうでない場合は False。 |
| color | プロジェクトの色。#FF1122といようにシャープと数字6桁のフォーマットです。 |
|
| key | プロジェクト管理番号 | |
| complete_date_time | プロジェクトが完了ステータスとなった日時 | |
| team | ○ | チームの情報 |
| client | 取引先の情報 |
items.team
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | チームのID |
| name | ○ | チームの名称 |
items.client
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先のID |
| name | ○ | 取引先の名称 |
チームに紐づくプロジェクト一覧の取得
例
curl 'https://api.timedesigner.com/v1/teams/Vlwz59Ra/projects?page=1&page_size=50&complete=false' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 50,
"page": 1,
"total_count": 1,
"total_page_count": 1,
"has_next_page": false,
"has_previous_page": false,
"items": [
{
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査",
"complete": false,
"color": "#FF0000",
"key": null,
"complete_date_time": null,
"team": {
"id": "pkm5OwGA",
"name": "宇宙ビジネスロケット部"
},
"client": {
"id": "pkm5OwGA",
"name": "Galaxyカンパニー"
}
}
]
}
取引先に紐づくプロジェクト一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/teams/{チームID}/projects
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
|
| complete | 完了したプロジェクトに絞り込みしたい場合は true、未完了のプロジェクトに絞り込みしたい場合は false を指定します。 |
||
| client_id | 取引先で絞り込みしたい場合に、取引先IDを指定します。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトの ID |
| name | ○ | プロジェクト名 |
| complete | ○ | プロジェクトの完了ステータス。完了している場合は True、そうでない場合は False。 |
| color | プロジェクトの色。#FF1122といようにシャープと数字6桁のフォーマットです。 |
|
| key | プロジェクト管理番号 | |
| complete_date_time | プロジェクトが完了ステータスとなった日時 | |
| team | ○ | チームの情報 |
| client | 取引先の情報 |
items.team
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | チームのID |
| name | ○ | チームの名称 |
items.client
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先のID |
| name | ○ | 取引先の名称 |
取引先に紐づくプロジェクト一覧の取得
例
curl 'https://api.timedesigner.com/v1/clients/Vlwz59Ra/projects?page=1&page_size=50&complete=false' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 50,
"page": 1,
"total_count": 1,
"total_page_count": 1,
"has_next_page": false,
"has_previous_page": false,
"items": [
{
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査",
"complete": false,
"color": "#FF0000",
"key": null,
"complete_date_time": null,
"team": {
"id": "pkm5OwGA",
"name": "宇宙ビジネスロケット部"
},
"client": {
"id": "pkm5OwGA",
"name": "Galaxyカンパニー"
}
}
]
}
取引先に紐づくプロジェクト一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/clients/{取引先ID}/projects
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
|
| complete | 完了したプロジェクトに絞り込みしたい場合は true、未完了のプロジェクトに絞り込みしたい場合は false を指定します。 |
||
| team_id | チームで絞り込みしたい場合に、チームIDを指定します。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトの ID |
| name | ○ | プロジェクト名 |
| complete | ○ | プロジェクトの完了ステータス。完了している場合は True、そうでない場合は False。 |
| color | プロジェクトの色。#FF1122といようにシャープと数字6桁のフォーマットです。 |
|
| key | プロジェクト管理番号 | |
| complete_date_time | プロジェクトが完了ステータスとなった日時 | |
| team | ○ | チームの情報 |
| client | 取引先の情報 |
items.team
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | チームのID |
| name | ○ | チームの名称 |
items.client
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先のID |
| name | ○ | 取引先の名称 |
プロジェクト情報の取得
例
curl 'https://api.timedesigner.com/v1/projects/3AKnP92l' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査",
"complete": false,
"color": "#FF0000",
"key": null,
"complete_date_time": null,
"team": {
"id": "pkm5OwGA",
"name": "宇宙ビジネスロケット部"
},
"client": {
"id": "pkm5OwGA",
"name": "Galaxyカンパニー"
}
}
プロジェクト情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/projects/{プロジェクトID}
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトの ID |
| name | ○ | プロジェクト名 |
| complete | ○ | プロジェクトの完了ステータス。完了している場合は True、そうでない場合は False。 |
| color | プロジェクトの色。#FF1122といようにシャープと数字6桁のフォーマットです。 |
|
| key | プロジェクト管理番号 | |
| complete_date_time | プロジェクトが完了ステータスとなった日時 | |
| team | ○ | チームの情報 |
| client | 取引先の情報 |
team
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | チームのID |
| name | ○ | チームの名称 |
client
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先のID |
| name | ○ | 取引先の名称 |
プロジェクト情報の作成
例
curl -X POST 'https://api.timedesigner.com/v1/projects' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"team_id": "pkm5OwGA",
"name": "サンプルプロジェクト",
"key": "SAMPLE",
"color": "#FF0000",
"client_id": "2p9pbKQM"
}'
# レスポンス
{
"id": "pkm5OwGA",
"name": "サンプルプロジェクト",
"complete": false,
"color": "#FF0000",
"key": "SAMPLE",
"complete_date_time": null,
"team": {
"id": "pkm5OwGA",
"name": "宇宙ビジネスロケット部"
},
"client": {
"id": "2p9pbKQM",
"name": "Galaxyカンパニー"
}
}
プロジェクト情報を作成します。
エンドポイント:
POST https://api.timedesigner.com/v1/projects
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| team_id | ○ | チーム ID | |
| name | ○ | max-length:100 | プロジェクト名 |
| key | max-length:30 | プロジェクト管理番号 | |
| client_id | 紐付ける取引先 ID | ||
| project_template_id | 元にするプロジェクトテンプレート ID |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトの ID |
| name | ○ | プロジェクト名 |
| complete | ○ | プロジェクトの完了ステータス。完了している場合は True、そうでない場合は False。 |
| color | プロジェクトの色。#FF1122といようにシャープと数字6桁のフォーマットです。 |
|
| key | プロジェクト管理番号 | |
| complete_date_time | プロジェクトが完了ステータスとなった日時 | |
| team | ○ | チームの情報 |
| client | 取引先の情報 |
team
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | チームのID |
| name | ○ | チームの名称 |
client
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先のID |
| name | ○ | 取引先の名称 |
プロジェクト情報の更新
例
curl -X PUT 'https://api.timedesigner.com/v1/projects/2p9pbKQM' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"name": "サンプルプロジェクト2",
"key": "SAMPLE-2",
"client_id": "2p9pbKQM",
"color": "#FF0000"
}'
# レスポンス
{
"id": "pkm5OwGA",
"name": "サンプルプロジェクト2",
"complete": false,
"color": "#FF0000",
"key": "SAMPLE-2",
"complete_date_time": null,
"team": {
"id": "pkm5OwGA",
"name": "宇宙ビジネスロケット部"
},
"client": {
"id": "2p9pbKQM",
"name": "Galaxyカンパニー"
}
}
プロジェクト情報を更新します。
エンドポイント:
PUT https://api.timedesigner.com/v1/projects/{プロジェクトID}
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| name | ○ | max-length:100 | プロジェクト名 |
| key | max-length:30 | プロジェクト管理番号 | |
| client_id | 紐付ける取引先 ID |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトの ID |
| name | ○ | プロジェクト名 |
| complete | ○ | プロジェクトの完了ステータス。完了している場合は True、そうでない場合は False。 |
| color | プロジェクトの色。#FF1122といようにシャープと数字6桁のフォーマットです。 |
|
| key | プロジェクト管理番号 | |
| complete_date_time | プロジェクトが完了ステータスとなった日時 | |
| team | ○ | チームの情報 |
| client | 取引先の情報 |
team
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | チームのID |
| name | ○ | チームの名称 |
client
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先のID |
| name | ○ | 取引先の名称 |
プロジェクトを複製して作成する
例
curl -X POST 'https://api.timedesigner.com/v1/projects/2p9pbKQM/duplicate' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "pkm5OwGA",
"name": "サンプルプロジェクトのコピー",
"complete": false,
"color": "#FF0000",
"key": "SAMPLE-2",
"complete_date_time": null,
"team": {
"id": "pkm5OwGA",
"name": "宇宙ビジネスロケット部"
},
"client": {
"id": "2p9pbKQM",
"name": "Galaxyカンパニー"
}
}
プロジェクト情報を複製して新しいプロジェクトを作成します。
エンドポイント:
POST https://api.timedesigner.com/v1/projects/{プロジェクトID}/duplicate
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトの ID |
| name | ○ | プロジェクト名 |
| complete | ○ | プロジェクトの完了ステータス。完了している場合は True、そうでない場合は False。 |
| color | プロジェクトの色。#FF1122といようにシャープと数字6桁のフォーマットです。 |
|
| key | プロジェクト管理番号 | |
| complete_date_time | プロジェクトが完了ステータスとなった日時 | |
| team | ○ | チームの情報 |
| client | 取引先の情報 |
team
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | チームのID |
| name | ○ | チームの名称 |
client
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先のID |
| name | ○ | 取引先の名称 |
プロジェクトを完了に更新する
例
curl -X PUT 'https://api.timedesigner.com/v1/projects/2p9pbKQM/complete' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "pkm5OwGA",
"name": "サンプルプロジェクトのコピー",
"complete": true,
"color": "#FF0000",
"key": "SAMPLE-2",
"complete_date_time": "2022-05-15T14:26:25Z"
"team": {
"id": "pkm5OwGA",
"name": "宇宙ビジネスロケット部"
},
"client": {
"id": "2p9pbKQM",
"name": "Galaxyカンパニー"
}
}
プロジェクトを完了に更新します。
エンドポイント:
PUT https://api.timedesigner.com/v1/projects/{プロジェクトID}/complete
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトの ID |
| name | ○ | プロジェクト名 |
| complete | ○ | プロジェクトの完了ステータス。完了している場合は True、そうでない場合は False。 |
| color | プロジェクトの色。#FF1122といようにシャープと数字6桁のフォーマットです。 |
|
| key | プロジェクト管理番号 | |
| complete_date_time | プロジェクトが完了ステータスとなった日時 | |
| team | ○ | チームの情報 |
| client | 取引先の情報 |
team
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | チームのID |
| name | ○ | チームの名称 |
client
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先のID |
| name | ○ | 取引先の名称 |
プロジェクトを未完了に更新する
例
curl -X PUT 'https://api.timedesigner.com/v1/projects/2p9pbKQM/incomplete' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "pkm5OwGA",
"name": "サンプルプロジェクト",
"complete": false,
"color": "#FF0000",
"key": "SAMPLE",
"complete_date_time": null,
"team": {
"id": "pkm5OwGA",
"name": "宇宙ビジネスロケット部"
},
"client": {
"id": "2p9pbKQM",
"name": "Galaxyカンパニー"
}
}
プロジェクトを未完了に更新します。
エンドポイント:
PUT https://api.timedesigner.com/v1/projects/{プロジェクトID}/incomplete
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトの ID |
| name | ○ | プロジェクト名 |
| complete | ○ | プロジェクトの完了ステータス。完了している場合は True、そうでない場合は False。 |
| color | プロジェクトの色。#FF1122といようにシャープと数字6桁のフォーマットです。 |
|
| key | プロジェクト管理番号 | |
| complete_date_time | プロジェクトが完了ステータスとなった日時 | |
| team | ○ | チームの情報 |
| client | 取引先の情報 |
team
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | チームのID |
| name | ○ | チームの名称 |
client
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先のID |
| name | ○ | 取引先の名称 |
プロジェクト情報の削除
例
curl -X DELETE 'https://api.timedesigner.com/v1/projects/2p9pbKQM' \
--basic -u api_token:${APIトークン}
# レスポンス
なし (204 No Content)
プロジェクト情報を削除します。
エンドポイント:
DELETE https://api.timedesigner.com/v1/projects/{プロジェクトID}
リクエスト・パラメータ
なし
レスポンス・データ
なし
タスク
タスクの情報を参照する API について、以下に記載します。
タスク一覧の取得
例
curl 'https://api.timedesigner.com/v1/tasks?page=1&page_size=50' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 1,
"page": 1,
"total_count": 56,
"total_page_count": 56,
"has_next_page": true,
"has_previous_page": false,
"items": [
{
"id": "pWwv7EKP",
"title": "たすく",
"task_status": {
"id": "5vmq3wYR",
"name": "未着手"
},
"assignee": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"priority": "Low",
"complete_date_time": null,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"schedule": {
"start_date_time": "2022-07-18T14:42:41Z",
"end_date_time": "2022-07-23T14:42:44Z",
"total_working_schedule_time_sec": 0,
"estimate_time_sec": 3600
},
"actual": {
"progress_rate": 35,
"working_time_sec": 0,
"remaining_working_time_sec": 3600
},
"predict": {
"progress_rate": 0,
"working_time_sec": 0
},
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
},
"tags": [
{
"id": "j1mA3wYZ",
"name": "会議"
}
]
}
...
]
}
タスク一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/tasks
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
|
| complete | 完了したタスクに絞り込みしたい場合は true、未完了のタスクに絞り込みしたい場合は false を指定します。 |
||
| assignee_id | 担当者のメンバーID。担当者で絞り込みしたい場合に指定します。 | ||
| priority | 優先度。優先度で絞り込みしたい場合に指定します。 | ||
| complete_date_time_since | 完了日時が、指定した日時よりも後のタスクに絞り込みたい場合に指定します。 | ||
| complete_date_time_until | 完了日時が、指定した日時よりも前のタスクに絞り込みたい場合に指定します。 | ||
| schedule_start_date_time_since | 予定作業開始日時が、指定した日時よりも後のタスクに絞り込みたい場合に指定します。 | ||
| schedule_start_date_time_until | 予定作業開始日時が、指定した日時よりも前のタスクに絞り込みたい場合に指定します。 | ||
| schedule_end_date_time_since | 締切日時が、指定した日時よりも後のタスクに絞り込みたい場合に指定します。 | ||
| schedule_end_date_time_until | 締切日時が、指定した日時よりも前のタスクに絞り込みたい場合に指定します。 | ||
| project_id | プロジェクトID。プロジェクトで絞り込みしたい場合に指定します。 | ||
| task_status_id | タスクステータスID。タスクステータスで絞り込みしたい場合に指定します。 | ||
| tag_id | タグID。タグで絞り込みしたい場合に指定します。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスク ID |
| title | ○ | タスクのタイトル |
| task_status | ○ | タスクステータスの情報 |
| assignee | 担当メンバーの情報 | |
| priority | 優先度。詳細は下記を参照してください。 | |
| complete_date_time | 完了日時。 | |
| created_member | ○ | タスクを作成したメンバーの情報 |
| schedule | ○ | タスクの作業予定情報。詳細については下記を参照してください。 |
| actual | ○ | タスクの実作業情報。詳細については下記を参照してください。 |
| predict | ○ | タスクの予測情報。詳細については下記を参照してください。 |
| project | ○ | プロジェクトの情報。 |
| tags | ○ | タグの情報。 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
items.task_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
items.created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
items.assignee
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
items.schedule
| レスポンス | 必須 | 内容 |
|---|---|---|
| start_date_time | 開始予定日時 | |
| end_date_time | 終了予定日時 | |
| total_working_schedule_time_sec | カレンダーに登録されている合計作業予定時間（単位: 秒） | |
| estimate_time_sec | 見積もり時間（単位: 秒） |
items.actual
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
items.predict
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | 予測進捗率（単位: ％） | |
| working_time_sec | 予測総作業時間（単位: 秒） |
items.project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
items.tags
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグID |
| name | ○ | タグ名称 |
プロジェクトに紐づくタスク一覧の取得
例
curl 'https://api.timedesigner.com/v1/projects/3AKnP92l/tasks?page=1&page_size=50' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 1,
"page": 1,
"total_count": 56,
"total_page_count": 56,
"has_next_page": true,
"has_previous_page": false,
"items": [
{
"id": "pWwv7EKP",
"title": "たすく",
"task_status": {
"id": "5vmq3wYR",
"name": "未着手"
},
"assignee": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"priority": "Low",
"complete_date_time": null,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"schedule": {
"start_date_time": "2022-07-18T14:42:41Z",
"end_date_time": "2022-07-23T14:42:44Z",
"total_working_schedule_time_sec": 0,
"estimate_time_sec": 3600
},
"actual": {
"progress_rate": 35,
"working_time_sec": 0,
"remaining_working_time_sec": 3600
},
"predict": {
"progress_rate": 0,
"working_time_sec": 0
},
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
},
"tags": [
{
"id": "j1mA3wYZ",
"name": "会議"
}
]
}
...
]
}
プロジェクトに紐づくタスク一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/projects/{プロジェクトID}/tasks
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
|
| complete | 完了したタスクに絞り込みしたい場合は true、未完了のタスクに絞り込みしたい場合は false を指定します。 |
||
| assignee_id | 担当者のメンバーID。担当者で絞り込みしたい場合に指定します。 | ||
| priority | 優先度。優先度で絞り込みしたい場合に指定します。 | ||
| complete_date_time_since | 完了日時が、指定した日時よりも後のタスクに絞り込みたい場合に指定します。 | ||
| complete_date_time_until | 完了日時が、指定した日時よりも前のタスクに絞り込みたい場合に指定します。 | ||
| schedule_start_date_time_since | 予定作業開始日時が、指定した日時よりも後のタスクに絞り込みたい場合に指定します。 | ||
| schedule_start_date_time_until | 予定作業開始日時が、指定した日時よりも前のタスクに絞り込みたい場合に指定します。 | ||
| schedule_end_date_time_since | 締切日時が、指定した日時よりも後のタスクに絞り込みたい場合に指定します。 | ||
| schedule_end_date_time_until | 締切日時が、指定した日時よりも前のタスクに絞り込みたい場合に指定します。 | ||
| task_status_id | タスクステータスID。タスクステータスで絞り込みしたい場合に指定します。 | ||
| tag_id | タグID。タグで絞り込みしたい場合に指定します。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスク ID |
| title | ○ | タスクのタイトル |
| task_status | ○ | タスクステータスの情報 |
| assignee | 担当メンバーの情報 | |
| priority | 優先度。詳細は下記を参照してください。 | |
| complete_date_time | 完了日時。 | |
| created_member | ○ | タスクを作成したメンバーの情報 |
| schedule | ○ | タスクの作業予定情報。詳細については下記を参照してください。 |
| actual | ○ | タスクの実作業情報。詳細については下記を参照してください。 |
| predict | ○ | タスクの予測情報。詳細については下記を参照してください。 |
| project | ○ | プロジェクトの情報。 |
| tags | ○ | タグの情報。 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
items.task_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
items.created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
items.assignee
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
items.schedule
| レスポンス | 必須 | 内容 |
|---|---|---|
| start_date_time | 開始予定日時 | |
| end_date_time | 終了予定日時 | |
| total_working_schedule_time_sec | カレンダーに登録されている合計作業予定時間（単位: 秒） | |
| estimate_time_sec | 見積もり時間（単位: 秒） |
items.actual
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
items.predict
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | 予測進捗率（単位: ％） | |
| working_time_sec | 予測総作業時間（単位: 秒） |
items.project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
items.tags
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグID |
| name | ○ | タグ名称 |
タスクステータスに紐づくタスク一覧の取得
例
curl 'https://api.timedesigner.com/v1/task-statuses/5vmq3wYR/tasks?page=1&page_size=50' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 1,
"page": 1,
"total_count": 56,
"total_page_count": 56,
"has_next_page": true,
"has_previous_page": false,
"items": [
{
"id": "pWwv7EKP",
"title": "たすく",
"task_status": {
"id": "5vmq3wYR",
"name": "未着手"
},
"assignee": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"priority": "Low",
"complete_date_time": null,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"schedule": {
"start_date_time": "2022-07-18T14:42:41Z",
"end_date_time": "2022-07-23T14:42:44Z",
"total_working_schedule_time_sec": 0,
"estimate_time_sec": 3600
},
"actual": {
"progress_rate": 35,
"working_time_sec": 0,
"remaining_working_time_sec": 3600
},
"predict": {
"progress_rate": 0,
"working_time_sec": 0
},
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
},
"tags": [
{
"id": "j1mA3wYZ",
"name": "会議"
}
]
}
...
]
}
タスクステータスに紐づくタスク一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/task-statuses/{タスクステータスID}/tasks
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
|
| complete | 完了したタスクに絞り込みしたい場合は true、未完了のタスクに絞り込みしたい場合は false を指定します。 |
||
| assignee_id | 担当者のメンバーID。担当者で絞り込みしたい場合に指定します。 | ||
| priority | 優先度。優先度で絞り込みしたい場合に指定します。 | ||
| complete_date_time_since | 完了日時が、指定した日時よりも後のタスクに絞り込みたい場合に指定します。 | ||
| complete_date_time_until | 完了日時が、指定した日時よりも前のタスクに絞り込みたい場合に指定します。 | ||
| schedule_start_date_time_since | 予定作業開始日時が、指定した日時よりも後のタスクに絞り込みたい場合に指定します。 | ||
| schedule_start_date_time_until | 予定作業開始日時が、指定した日時よりも前のタスクに絞り込みたい場合に指定します。 | ||
| schedule_end_date_time_since | 締切日時が、指定した日時よりも後のタスクに絞り込みたい場合に指定します。 | ||
| schedule_end_date_time_until | 締切日時が、指定した日時よりも前のタスクに絞り込みたい場合に指定します。 | ||
| project_id | プロジェクトID。プロジェクトで絞り込みしたい場合に指定します。 | ||
| tag_id | タグID。タグで絞り込みしたい場合に指定します。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスク ID |
| title | ○ | タスクのタイトル |
| task_status | ○ | タスクステータスの情報 |
| assignee | 担当メンバーの情報 | |
| priority | 優先度。詳細は下記を参照してください。 | |
| complete_date_time | 完了日時。 | |
| created_member | ○ | タスクを作成したメンバーの情報 |
| schedule | ○ | タスクの作業予定情報。詳細については下記を参照してください。 |
| actual | ○ | タスクの実作業情報。詳細については下記を参照してください。 |
| predict | ○ | タスクの予測情報。詳細については下記を参照してください。 |
| project | ○ | プロジェクトの情報。 |
| tags | ○ | タグの情報。 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
items.task_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
items.created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
items.assignee
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
items.schedule
| レスポンス | 必須 | 内容 |
|---|---|---|
| start_date_time | 開始予定日時 | |
| end_date_time | 終了予定日時 | |
| total_working_schedule_time_sec | カレンダーに登録されている合計作業予定時間（単位: 秒） | |
| estimate_time_sec | 見積もり時間（単位: 秒） |
items.actual
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
items.predict
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | 予測進捗率（単位: ％） | |
| working_time_sec | 予測総作業時間（単位: 秒） |
items.project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
items.tags
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグID |
| name | ○ | タグ名称 |
タグに紐づくタスク一覧の取得
例
curl 'https://api.timedesigner.com/v1/tags/j1mA3wYZ/tasks?page=1&page_size=50' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 1,
"page": 1,
"total_count": 56,
"total_page_count": 56,
"has_next_page": true,
"has_previous_page": false,
"items": [
{
"id": "pWwv7EKP",
"title": "たすく",
"task_status": {
"id": "5vmq3wYR",
"name": "未着手"
},
"assignee": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"priority": "Low",
"complete_date_time": null,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"schedule": {
"start_date_time": "2022-07-18T14:42:41Z",
"end_date_time": "2022-07-23T14:42:44Z",
"total_working_schedule_time_sec": 0,
"estimate_time_sec": 3600
},
"actual": {
"progress_rate": 35,
"working_time_sec": 0,
"remaining_working_time_sec": 3600
},
"predict": {
"progress_rate": 0,
"working_time_sec": 0
},
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
},
"tags": [
{
"id": "j1mA3wYZ",
"name": "会議"
}
]
}
...
]
}
タグに紐づくタスク一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/tags/{タグID}/tasks
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
|
| complete | 完了したタスクに絞り込みしたい場合は true、未完了のタスクに絞り込みしたい場合は false を指定します。 |
||
| assignee_id | 担当者のメンバーID。担当者で絞り込みしたい場合に指定します。 | ||
| priority | 優先度。優先度で絞り込みしたい場合に指定します。 | ||
| complete_date_time_since | 完了日時が、指定した日時よりも後のタスクに絞り込みたい場合に指定します。 | ||
| complete_date_time_until | 完了日時が、指定した日時よりも前のタスクに絞り込みたい場合に指定します。 | ||
| schedule_start_date_time_since | 予定作業開始日時が、指定した日時よりも後のタスクに絞り込みたい場合に指定します。 | ||
| schedule_start_date_time_until | 予定作業開始日時が、指定した日時よりも前のタスクに絞り込みたい場合に指定します。 | ||
| schedule_end_date_time_since | 締切日時が、指定した日時よりも後のタスクに絞り込みたい場合に指定します。 | ||
| schedule_end_date_time_until | 締切日時が、指定した日時よりも前のタスクに絞り込みたい場合に指定します。 | ||
| project_id | プロジェクトID。プロジェクトで絞り込みしたい場合に指定します。 | ||
| task_status_id | タスクステータスID。タスクステータスで絞り込みしたい場合に指定します。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスク ID |
| title | ○ | タスクのタイトル |
| task_status | ○ | タスクステータスの情報 |
| assignee | 担当メンバーの情報 | |
| priority | 優先度。詳細は下記を参照してください。 | |
| complete_date_time | 完了日時。 | |
| created_member | ○ | タスクを作成したメンバーの情報 |
| schedule | ○ | タスクの作業予定情報。詳細については下記を参照してください。 |
| actual | ○ | タスクの実作業情報。詳細については下記を参照してください。 |
| predict | ○ | タスクの予測情報。詳細については下記を参照してください。 |
| project | ○ | プロジェクトの情報。 |
| tags | ○ | タグの情報。 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
items.task_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
items.created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
items.assignee
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
items.schedule
| レスポンス | 必須 | 内容 |
|---|---|---|
| start_date_time | 開始予定日時 | |
| end_date_time | 終了予定日時 | |
| total_working_schedule_time_sec | カレンダーに登録されている合計作業予定時間（単位: 秒） | |
| estimate_time_sec | 見積もり時間（単位: 秒） |
items.actual
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
items.predict
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | 予測進捗率（単位: ％） | |
| working_time_sec | 予測総作業時間（単位: 秒） |
items.project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
items.tags
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグID |
| name | ○ | タグ名称 |
タスク情報の取得
例
curl 'https://api.timedesigner.com/v1/tasks/pWwv7EKP' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "pWwv7EKP",
"title": "たすく",
"task_status": {
"id": "5vmq3wYR",
"name": "未着手"
},
"assignee": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"priority": "Low",
"complete_date_time": null,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"schedule": {
"start_date_time": "2022-07-18T14:42:41Z",
"end_date_time": "2022-07-23T14:42:44Z",
"total_working_schedule_time_sec": 0,
"estimate_time_sec": 3600
},
"actual": {
"progress_rate": 35,
"working_time_sec": 0,
"remaining_working_time_sec": 3600
},
"predict": {
"progress_rate": 0,
"working_time_sec": 0
},
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
},
"tags": [
{
"id": "j1mA3wYZ",
"name": "会議"
}
]
}
タスク情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/tasks/{タスクID}
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスク ID |
| title | ○ | タスクのタイトル |
| task_status | ○ | タスクステータスの情報 |
| assignee | 担当メンバーの情報 | |
| priority | 優先度。詳細は下記を参照してください。 | |
| complete_date_time | 完了日時。 | |
| created_member | ○ | タスクを作成したメンバーの情報 |
| schedule | ○ | タスクの作業予定情報。詳細については下記を参照してください。 |
| actual | ○ | タスクの実作業情報。詳細については下記を参照してください。 |
| predict | ○ | タスクの予測情報。詳細については下記を参照してください。 |
| project | ○ | プロジェクトの情報。 |
| tags | ○ | タグの情報。 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
task_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
assignee
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
schedule
| レスポンス | 必須 | 内容 |
|---|---|---|
| start_date_time | 開始予定日時 | |
| end_date_time | 終了予定日時 | |
| total_working_schedule_time_sec | カレンダーに登録されている合計作業予定時間（単位: 秒） | |
| estimate_time_sec | 見積もり時間（単位: 秒） |
actual
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
predict
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | 予測進捗率（単位: ％） | |
| working_time_sec | 予測総作業時間（単位: 秒） |
project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
tags
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグID |
| name | ○ | タグ名称 |
タスク情報の作成
例
curl -X POST 'https://api.timedesigner.com/v1/tasks' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"title": "新しいタスク",
"project_id": "2p9pbKQM",
"task_status_id": "6GmQ8Ka1",
"priority": "High",
"schedule": {
"start_date_time": "2022-05-17T01:00:00Z",
"end_date_time": "2022-05-18T10:00:00Z",
"estimate_time_sec": 36000
}
}'
# レスポンス
{
"id": "W3wYqVwj",
"title": "新しいタスク",
"task_status": {
"id": "G49lgmlL",
"name": "未着手"
},
"assignee": null,
"priority": "High",
"complete_date_time": null,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"schedule": {
"start_date_time": "2022-05-17T01:00:00Z",
"end_date_time": "2022-05-18T10:00:00Z",
"total_working_schedule_time_sec": 0,
"estimate_time_sec": 36000
},
"actual": {
"progress_rate": 0,
"working_time_sec": 0,
"remaining_working_time_sec": 36000
},
"predict": {
"progress_rate": 0,
"working_time_sec": null
},
"project": {
"id": "j1mA3wYZ",
"name": "ロケット打ち上げテスト"
},
"tags": []
}
タスク情報を作成します。
エンドポイント:
POST https://api.timedesigner.com/v1/tasks
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| title | ○ | max-length:100 | タスクのタイトル |
| project_id | ○ | プロジェクト ID | |
| assignee_member_id | 担当メンバー ID | ||
| priority | 優先度。詳細は下記を参照してください。 | ||
| schedule | タスクの作業予定情報。詳細については下記を参照してください。 |
schedule
| start_date_time | 開始予定日時 |
| end_date_time | 終了予定日時 |
| estimate_time_sec | 見積もり時間（単位: 秒） |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスク ID |
| title | ○ | タスクのタイトル |
| task_status | ○ | タスクステータスの情報 |
| assignee | 担当メンバーの情報 | |
| priority | 優先度。詳細は下記を参照してください。 | |
| complete_date_time | 完了日時。 | |
| created_member | ○ | タスクを作成したメンバーの情報 |
| schedule | ○ | タスクの作業予定情報。詳細については下記を参照してください。 |
| actual | ○ | タスクの実作業情報。詳細については下記を参照してください。 |
| predict | ○ | タスクの予測情報。詳細については下記を参照してください。 |
| project | ○ | プロジェクトの情報。 |
| tags | ○ | タグの情報。 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
task_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
assignee
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
schedule
| レスポンス | 必須 | 内容 |
|---|---|---|
| start_date_time | 開始予定日時 | |
| end_date_time | 終了予定日時 | |
| total_working_schedule_time_sec | カレンダーに登録されている合計作業予定時間（単位: 秒） | |
| estimate_time_sec | 見積もり時間（単位: 秒） |
actual
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
predict
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | 予測進捗率（単位: ％） | |
| working_time_sec | 予測総作業時間（単位: 秒） |
project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
tags
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグID |
| name | ○ | タグ名称 |
タスク情報の更新
例
curl -X PUT 'https://api.timedesigner.com/v1/tasks/W3wYqVwj' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"title": "新しいタスク2",
"assignee_member_id": "3AKnP92l",
"progress_rate": 20,
"priority": "High",
"schedule": {
"start_date_time": "2022-05-17T01:00:00Z",
"end_date_time": "2022-05-18T10:00:00Z",
"estimate_time_sec": 36000
}
}'
# レスポンス
{
"id": "W3wYqVwj",
"title": "新しいタスク2",
"task_status": {
"id": "G49lgmlL",
"name": "未着手"
},
"assignee": null,
"priority": "High",
"complete_date_time": null,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"schedule": {
"start_date_time": "2022-05-17T01:00:00Z",
"end_date_time": "2022-05-18T10:00:00Z",
"total_working_schedule_time_sec": 0,
"estimate_time_sec": 36000
},
"actual": {
"progress_rate": 20,
"working_time_sec": 0,
"remaining_working_time_sec": 36000
},
"predict": {
"progress_rate": 0,
"working_time_sec": 0
},
"project": {
"id": "j1mA3wYZ",
"name": "ロケット打ち上げテスト"
},
"tags": []
}
タスク情報を更新します。
エンドポイント:
PUT https://api.timedesigner.com/v1/tasks/{タスクID}
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| title | ○ | max-length:100 | タスクのタイトル |
| assignee_member_id | 担当メンバー ID | ||
| progress_rate | ○ | min:0, max:100 | 進捗率（単位: ％） |
| priority | 優先度。詳細は下記を参照してください。 | ||
| schedule | タスクの作業予定情報。詳細については下記を参照してください。 |
schedule
| start_date_time | 開始予定日時 |
| end_date_time | 終了予定日時 |
| estimate_time_sec | 見積もり時間（単位: 秒） |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスク ID |
| title | ○ | タスクのタイトル |
| task_status | ○ | タスクステータスの情報 |
| assignee | 担当メンバーの情報 | |
| priority | 優先度。詳細は下記を参照してください。 | |
| complete_date_time | 完了日時。 | |
| created_member | ○ | タスクを作成したメンバーの情報 |
| schedule | ○ | タスクの作業予定情報。詳細については下記を参照してください。 |
| actual | ○ | タスクの実作業情報。詳細については下記を参照してください。 |
| predict | ○ | タスクの予測情報。詳細については下記を参照してください。 |
| project | ○ | プロジェクトの情報。 |
| tags | ○ | タグの情報。 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
task_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
assignee
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
schedule
| レスポンス | 必須 | 内容 |
|---|---|---|
| start_date_time | 開始予定日時 | |
| end_date_time | 終了予定日時 | |
| total_working_schedule_time_sec | カレンダーに登録されている合計作業予定時間（単位: 秒） | |
| estimate_time_sec | 見積もり時間（単位: 秒） |
actual
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
predict
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | 予測進捗率（単位: ％） | |
| working_time_sec | 予測総作業時間（単位: 秒） |
project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
tags
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグID |
| name | ○ | タグ名称 |
タスク情報を複製して作成する
例
curl -X POST 'https://api.timedesigner.com/v1/tasks/W3wYqVwj/duplicate' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "8VwoeEm5",
"title": "たすくのコピー",
"task_status": {
"id": "5vmq3wYR",
"name": "未着手"
},
"assignee": null,
"priority": "Low",
"complete_date_time": null,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"schedule": {
"start_date_time": "2022-07-18T14:42:41Z",
"end_date_time": "2022-07-23T14:42:44Z",
"total_working_schedule_time_sec": 0,
"estimate_time_sec": 3600
},
"actual": {
"progress_rate": 0,
"working_time_sec": 0,
"remaining_working_time_sec": 3600
},
"predict": {
"progress_rate": 0,
"working_time_sec": null
},
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
},
"tags": [
{
"id": "j1mA3wYZ",
"name": "会議"
}
]
}
タスク情報を複製して新しいタスクを作成します。
エンドポイント:
POST https://api.timedesigner.com/v1/tasks/{タスクID}/duplicate
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスク ID |
| title | ○ | タスクのタイトル |
| task_status | ○ | タスクステータスの情報 |
| assignee | 担当メンバーの情報 | |
| priority | 優先度。詳細は下記を参照してください。 | |
| complete_date_time | 完了日時。 | |
| created_member | ○ | タスクを作成したメンバーの情報 |
| schedule | ○ | タスクの作業予定情報。詳細については下記を参照してください。 |
| actual | ○ | タスクの実作業情報。詳細については下記を参照してください。 |
| predict | ○ | タスクの予測情報。詳細については下記を参照してください。 |
| project | ○ | プロジェクトの情報。 |
| tags | ○ | タグの情報。 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
task_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
assignee
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
schedule
| レスポンス | 必須 | 内容 |
|---|---|---|
| start_date_time | 開始予定日時 | |
| end_date_time | 終了予定日時 | |
| total_working_schedule_time_sec | カレンダーに登録されている合計作業予定時間（単位: 秒） | |
| estimate_time_sec | 見積もり時間（単位: 秒） |
actual
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
predict
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | 予測進捗率（単位: ％） | |
| working_time_sec | 予測総作業時間（単位: 秒） |
project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
tags
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグID |
| name | ○ | タグ名称 |
タスクを作業開始する
例
curl -X PUT 'https://api.timedesigner.com/v1/tasks/pWwv7EKP/start' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"start": {
"task": {
"id": "pWwv7EKP",
"title": "たすく",
"task_status": {
"id": "y29EJwRJ",
"name": "進行中"
},
"assignee": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"priority": "Low",
"complete_date_time": null,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"schedule": {
"start_date_time": "2022-07-18T14:42:41Z",
"end_date_time": "2022-07-23T14:42:44Z",
"total_working_schedule_time_sec": 0,
"estimate_time_sec": 3600
},
"actual": {
"progress_rate": 35,
"working_time_sec": 38,
"remaining_working_time_sec": 3562
},
"predict": {
"progress_rate": 1,
"working_time_sec": 109
},
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
},
"tags": [
{
"id": "j1mA3wYZ",
"name": "会議"
}
]
},
"time_entry": {
"id": "rjmBeNK2",
"start_date_time": "2022-07-18T15:30:35Z",
"end_date_time": null,
"working_time_sec": null,
"working_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"task": {
"id": "pWwv7EKP",
"title": "たすく"
},
"calendar_event": null
}
},
"stop": {
"task": {
"id": "8VwoeEm5",
"title": "たすくのコピー",
"task_status": {
"id": "y29EJwRJ",
"name": "進行中"
},
"assignee": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"priority": "Low",
"complete_date_time": null,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"schedule": {
"start_date_time": "2022-07-18T14:42:41Z",
"end_date_time": "2022-07-23T14:42:44Z",
"total_working_schedule_time_sec": 0,
"estimate_time_sec": 3600
},
"actual": {
"progress_rate": 0,
"working_time_sec": 2,
"remaining_working_time_sec": 3598
},
"predict": {
"progress_rate": 0,
"working_time_sec": null
},
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
},
"tags": [
{
"id": "j1mA3wYZ",
"name": "会議"
}
]
},
"time_entry": {
"id": "g3KNEMwG",
"start_date_time": "2022-07-18T15:30:32Z",
"end_date_time": "2022-07-18T15:30:35Z",
"working_time_sec": 2,
"working_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"task": {
"id": "8VwoeEm5",
"title": "たすく2"
},
"calendar_event": null
}
}
}
タスクの作業記録を開始します。
エンドポイント:
PUT https://api.timedesigner.com/v1/tasks/{タスクID}/start
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| start | ○ | 作業開始したタスクと、作業記録データの情報。詳細は下記を参照してください。 |
| stop | すでに他に作業中のタスクが存在していた場合には、自動的にそちらのタスクは停止されます。停止されたタスクがあった場合に、そのタスクと作業記録データの情報が入ります。詳細は下記を参照してください。 |
start
| レスポンス | 必須 | 内容 |
|---|---|---|
| task | ○ | 開始したタスクの情報 詳細は下記を参照してください。 |
| time_entry | ○ | 開始した業履歴データの情報 詳細は下記を参照してください。 |
stop
| レスポンス | 必須 | 内容 |
|---|---|---|
| task | ○ | 停止されたタスクの情報 詳細は下記を参照してください。 |
| time_entry | 停止された作業履歴データの情報 詳細は下記を参照してください。 |
start.task / stop.task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスク ID |
| title | ○ | タスクのタイトル |
| task_status | ○ | タスクステータスの情報 |
| assignee | 担当メンバーの情報 | |
| priority | 優先度。詳細は下記を参照してください。 | |
| complete_date_time | 完了日時。 | |
| created_member | ○ | タスクを作成したメンバーの情報 |
| schedule | ○ | タスクの作業予定情報。詳細については下記を参照してください。 |
| actual | ○ | タスクの実作業情報。詳細については下記を参照してください。 |
| predict | ○ | タスクの予測情報。詳細については下記を参照してください。 |
| project | ○ | プロジェクトの情報。 |
| tags | ○ | タグの情報。 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
[start.task / stop.task].task_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
[start.task / stop.task].created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
[start.task / stop.task].assignee
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
[start.task / stop.task].schedule
| レスポンス | 必須 | 内容 |
|---|---|---|
| start_date_time | 開始予定日時 | |
| end_date_time | 終了予定日時 | |
| total_working_schedule_time_sec | カレンダーに登録されている合計作業予定時間（単位: 秒） | |
| estimate_time_sec | 見積もり時間（単位: 秒） |
[start.task / stop.task].actual
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
[start.task / stop.task].predict
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | 予測進捗率（単位: ％） | |
| working_time_sec | 予測総作業時間（単位: 秒） |
[start.task / stop.task].project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
[start.task / stop.task].tags
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグID |
| name | ○ | タグ名称 |
start.time_entry / stop.time_entry
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 作業履歴 ID |
| start_date_time | ○ | 開始日時 |
| end_date_time | 終了日時 | |
| working_time_sec | 作業時間（単位: 秒） | |
| working_member | ○ | 作業メンバーの情報 |
| task | タスクの情報 | |
| calendar_event | カレンダー予定の情報 |
[start.time_entry / stop.time_entry].working_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| name | ○ | 名前 |
[start.time_entry / stop.time_entry].task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| title | ○ | タスクのタイトル |
[start.time_entry / stop.time_entry].calendar_event
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | カレンダー予定 ID |
| calendar_type | ○ | カレンダー種別 |
| event_name | ○ | 予定名称 |
タスクを作業停止する
例
curl -X PUT 'https://api.timedesigner.com/v1/tasks/pWwv7EKP/stop' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"task": {
"id": "pWwv7EKP",
"title": "たすく",
"task_status": {
"id": "y29EJwRJ",
"name": "進行中"
},
"assignee": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"priority": "Low",
"complete_date_time": null,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"schedule": {
"start_date_time": "2022-07-18T14:42:41Z",
"end_date_time": "2022-07-23T14:42:44Z",
"total_working_schedule_time_sec": 0,
"estimate_time_sec": 3600
},
"actual": {
"progress_rate": 35,
"working_time_sec": 590,
"remaining_working_time_sec": 3010
},
"predict": {
"progress_rate": 16,
"working_time_sec": 1686
},
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
},
"tags": [
{
"id": "j1mA3wYZ",
"name": "会議"
}
]
},
"time_entry": {
"id": "rjmBeNK2",
"start_date_time": "2022-07-18T15:30:35Z",
"end_date_time": "2022-07-18T15:39:48Z",
"working_time_sec": 552,
"working_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"task": {
"id": "pWwv7EKP",
"title": "たすく"
},
"calendar_event": null
}
}
タスクの作業記録を停止します。
エンドポイント:
PUT https://api.timedesigner.com/v1/tasks/{タスクID}/stop
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| task | ○ | 停止したタスクの情報 詳細は下記を参照してください。 |
| time_entry | 停止した作業履歴データの情報 詳細は下記を参照してください。 |
task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスク ID |
| title | ○ | タスクのタイトル |
| task_status | ○ | タスクステータスの情報 |
| assignee | 担当メンバーの情報 | |
| priority | 優先度。詳細は下記を参照してください。 | |
| complete_date_time | 完了日時。 | |
| created_member | ○ | タスクを作成したメンバーの情報 |
| schedule | ○ | タスクの作業予定情報。詳細については下記を参照してください。 |
| actual | ○ | タスクの実作業情報。詳細については下記を参照してください。 |
| predict | ○ | タスクの予測情報。詳細については下記を参照してください。 |
| project | ○ | プロジェクトの情報。 |
| tags | ○ | タグの情報。 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
task.task_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
task.created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
task.assignee
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
task.schedule
| レスポンス | 必須 | 内容 |
|---|---|---|
| start_date_time | 開始予定日時 | |
| end_date_time | 終了予定日時 | |
| total_working_schedule_time_sec | カレンダーに登録されている合計作業予定時間（単位: 秒） | |
| estimate_time_sec | 見積もり時間（単位: 秒） |
task.actual
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
task.predict
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | 予測進捗率（単位: ％） | |
| working_time_sec | 予測総作業時間（単位: 秒） |
task.project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
task.tags
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグID |
| name | ○ | タグ名称 |
time_entry
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 作業履歴 ID |
| start_date_time | ○ | 開始日時 |
| end_date_time | 終了日時 | |
| working_time_sec | 作業時間（単位: 秒） | |
| working_member | ○ | 作業メンバーの情報 |
| task | タスクの情報 | |
| calendar_event | カレンダー予定の情報 |
time_entry.working_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| name | ○ | 名前 |
time_entry.task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| title | ○ | タスクのタイトル |
time_entry.calendar_event
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | カレンダー予定 ID |
| calendar_type | ○ | カレンダー種別 |
| event_name | ○ | 予定名称 |
タスクを完了に更新する
例
curl -X PUT 'https://api.timedesigner.com/v1/tasks/pWwv7EKP/complete' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"task": {
"id": "pWwv7EKP",
"title": "たすく",
"task_status": {
"id": "R1mg5wvg",
"name": "完了"
},
"assignee": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"priority": "Low",
"complete_date_time": "2022-07-18T15:44:17Z",
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"schedule": {
"start_date_time": "2022-07-18T14:42:41Z",
"end_date_time": "2022-07-23T14:42:44Z",
"total_working_schedule_time_sec": 0,
"estimate_time_sec": 3600
},
"actual": {
"progress_rate": 100,
"working_time_sec": 602,
"remaining_working_time_sec": 0
},
"predict": {
"progress_rate": 17,
"working_time_sec": 602
},
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
},
"tags": [
{
"id": "j1mA3wYZ",
"name": "会議"
}
]
},
"working_histories": [
{
"id": "pkKdpeKJ",
"start_date_time": "2022-07-18T15:44:04Z",
"end_date_time": "2022-07-18T15:44:17Z",
"working_time_sec": 12,
"working_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"task": {
"id": "pWwv7EKP",
"title": "たすく"
},
"calendar_event": null
}
]
}
タスクを完了に更新します。
エンドポイント:
PUT https://api.timedesigner.com/v1/tasks/{タスクID}/complete
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| task | ○ | 完了したタスクの情報 詳細は下記を参照してください。 |
| time_entry | 完了により停止された作業履歴データの情報 詳細は下記を参照してください。 |
task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスク ID |
| title | ○ | タスクのタイトル |
| task_status | ○ | タスクステータスの情報 |
| assignee | 担当メンバーの情報 | |
| priority | 優先度。詳細は下記を参照してください。 | |
| complete_date_time | 完了日時。 | |
| created_member | ○ | タスクを作成したメンバーの情報 |
| schedule | ○ | タスクの作業予定情報。詳細については下記を参照してください。 |
| actual | ○ | タスクの実作業情報。詳細については下記を参照してください。 |
| predict | ○ | タスクの予測情報。詳細については下記を参照してください。 |
| project | ○ | プロジェクトの情報。 |
| tags | ○ | タグの情報。 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
task.task_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
task.created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
task.assignee
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
task.schedule
| レスポンス | 必須 | 内容 |
|---|---|---|
| start_date_time | 開始予定日時 | |
| end_date_time | 終了予定日時 | |
| total_working_schedule_time_sec | カレンダーに登録されている合計作業予定時間（単位: 秒） | |
| estimate_time_sec | 見積もり時間（単位: 秒） |
task.actual
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
task.predict
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | 予測進捗率（単位: ％） | |
| working_time_sec | 予測総作業時間（単位: 秒） |
task.project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
task.tags
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグID |
| name | ○ | タグ名称 |
time_entry
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 作業履歴 ID |
| start_date_time | ○ | 開始日時 |
| end_date_time | 終了日時 | |
| working_time_sec | 作業時間（単位: 秒） | |
| working_member | ○ | 作業メンバーの情報 |
| task | タスクの情報 | |
| calendar_event | カレンダー予定の情報 |
time_entry.working_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| name | ○ | 名前 |
time_entry.task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| title | ○ | タスクのタイトル |
time_entry.calendar_event
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | カレンダー予定 ID |
| calendar_type | ○ | カレンダー種別 |
| event_name | ○ | 予定名称 |
タスクを未完了に更新する
例
curl -X PUT 'https://api.timedesigner.com/v1/tasks/g3KNZKGD/incomplete' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "pWwv7EKP",
"title": "たすく",
"task_status": {
"id": "5vmq3wYR",
"name": "未着手"
},
"assignee": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"priority": "Low",
"complete_date_time": null,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"schedule": {
"start_date_time": "2022-07-18T14:42:41Z",
"end_date_time": "2022-07-23T14:42:44Z",
"total_working_schedule_time_sec": 0,
"estimate_time_sec": 3600
},
"actual": {
"progress_rate": 100,
"working_time_sec": 602,
"remaining_working_time_sec": 2998
},
"predict": {
"progress_rate": 17,
"working_time_sec": 602
},
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
},
"tags": [
{
"id": "j1mA3wYZ",
"name": "会議"
}
]
}
タスク未完了に更新します。
エンドポイント:
PUT https://api.timedesigner.com/v1/tasks/{タスクID}/incomplete
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスク ID |
| title | ○ | タスクのタイトル |
| task_status | ○ | タスクステータスの情報 |
| assignee | 担当メンバーの情報 | |
| priority | 優先度。詳細は下記を参照してください。 | |
| complete_date_time | 完了日時。 | |
| created_member | ○ | タスクを作成したメンバーの情報 |
| schedule | ○ | タスクの作業予定情報。詳細については下記を参照してください。 |
| actual | ○ | タスクの実作業情報。詳細については下記を参照してください。 |
| predict | ○ | タスクの予測情報。詳細については下記を参照してください。 |
| project | ○ | プロジェクトの情報。 |
| tags | ○ | タグの情報。 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
task_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
assignee
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
schedule
| レスポンス | 必須 | 内容 |
|---|---|---|
| start_date_time | 開始予定日時 | |
| end_date_time | 終了予定日時 | |
| total_working_schedule_time_sec | カレンダーに登録されている合計作業予定時間（単位: 秒） | |
| estimate_time_sec | 見積もり時間（単位: 秒） |
actual
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | ○ | 進捗率（単位: ％） |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| remaining_working_time_sec | 残作業時間（単位: 秒） |
predict
| レスポンス | 必須 | 内容 |
|---|---|---|
| progress_rate | 予測進捗率（単位: ％） | |
| working_time_sec | 予測総作業時間（単位: 秒） |
project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
tags
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグID |
| name | ○ | タグ名称 |
タスク情報の削除
例
curl -X DELETE 'https://api.timedesigner.com/v1/tasks/g3KNZKGD' \
--basic -u api_token:${APIトークン}
# レスポンス
なし (204 No Content)
タスク情報を削除します。
エンドポイント:
DELETE https://api.timedesigner.com/v1/tasks/{タスクID}
リクエスト・パラメータ
なし
レスポンス・データ
なし
タグ
タグの情報を参照する API について、以下に記載します。
タグ一覧の取得
例
curl 'https://api.timedesigner.com/v1/tags?page=1&page_size=50' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 50,
"page": 1,
"total_count": 5,
"total_page_count": 1,
"has_next_page": false,
"has_previous_page": false,
"items": [
{
"id": "pkm5OwGA",
"name": "トラベル事業"
},
{
"id": "Vlwz59Ra",
"name": "調査"
},
{
"id": "2p9pbKQM",
"name": "開発事業"
},
{
"id": "2VwxaKX8",
"name": "会計管理"
},
{
"id": "j1mA3wYZ",
"name": "会議"
}
]
}
タグ一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/tags
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグのID |
| name | ○ | タグ名 |
タスクに紐づくタグ一覧の取得
例
curl 'https://api.timedesigner.com/v1/task/Vlwz59Ra/tags?page=1&page_size=50' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 50,
"page": 1,
"total_count": 1,
"total_page_count": 1,
"has_next_page": false,
"has_previous_page": false,
"items": [
{
"id": "j1mA3wYZ",
"name": "会議"
},
...
]
}
タスクに紐づくタグ一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/tasks/{タスクID}/tags
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグのID |
| name | ○ | タグ名 |
タグ情報の取得
例
curl 'https://api.timedesigner.com/v1/tags/j1mA3wYZ' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "j1mA3wYZ",
"name": "会議"
}
タグ情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/tags/{タグID}
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグのID |
| name | ○ | タグ名 |
タグの作成
例
curl -X POST 'https://api.timedesigner.com/v1/tags' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"name": "新しいタグ"
}'
# レスポンス
{
"id":"MLwJkKYN",
"name":"新しいタグ"
}
タグを作成します。
エンドポイント:
POST https://api.timedesigner.com/v1/tags
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| name | ○ | max-length:100 | タグ名 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグのID |
| name | ○ | タグ名 |
タグ情報の更新
例
curl -X PUT 'https://api.timedesigner.com/v1/tags/MLwJkKYN' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"name": "新しいタグ2"
}'
# レスポンス
{
"id": "MLwJkKYN",
"name": "新しいタグ2"
}
タグ情報を更新します。
エンドポイント:
PUT https://api.timedesigner.com/v1/tags/{タグID}
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| name | ○ | max-length:100 | タグ名 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タグのID |
| name | ○ | タグ名 |
タグ情報の削除
例
curl -X DELETE 'https://api.timedesigner.com/v1/tags/MLwJkKYN' \
--basic -u api_token:${APIトークン}
# レスポンス
なし (204 No Content)
タグ情報を削除します。
エンドポイント:
DELETE https://api.timedesigner.com/v1/tags/{タグID}
リクエスト・パラメータ
なし
レスポンス・データ
なし
作業履歴
作業履歴の情報を参照する API について、以下に記載します。
作業履歴一覧の取得
例
curl 'https://api.timedesigner.com/v1/time-entries??page=1&page_size=50&since=2022-04-24T01:00:00Z&until=2022-04-24T05:00:00Z' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 50,
"page": 1,
"total_count": 2,
"total_page_count": 1,
"has_next_page": false,
"has_previous_page": false,
"items": [
{
"id": "dYmGxx9A",
"start_date_time": "2022-04-24T03:00:00Z",
"end_date_time": "2022-04-24T04:30:00Z",
"working_time_sec": 5400,
"working_member": {
"id": "3AKnP92l",
"name": "松永 達也"
},
"task": {
"id": "1rwXvOmD",
"title": "テスト結果の調査と分析"
},
"calendar_event": null
},
...
]
}
作業履歴一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/time-entries
なお、 「組織全員の作業履歴の閲覧」権限がある場合には、全てのメンバーの作業履歴を取得できます。 「チームメンバーの作業履歴の閲覧」権限のみある場合には、所属しているチームメンバーの作業履歴のみを取得できます。 どちらの権限も無い場合には、自分自身の作業履歴のみを取得できます。
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
|
| working_member_id | 作業したメンバーのID。作業者で絞り込みしたい場合に指定します。 | ||
| task_id | タスクのID。タスクで絞り込みしたい場合に指定します。 | ||
| calendar_event_id | カレンダー予定のID。カレンダー予定で絞り込みしたい場合に指定します。 | ||
| since | 指定した日時以降に絞り込みした場合に指定します。ISO8601形式(YYYY-MM-DDTHH:MM:SSZ)で指定してください。左記の例ではタイムゾーンはUTC+0になりますのでご注意ください。 | ||
| until | 指定した日時までに絞り込みした場合に指定します。ISO8601形式(YYYY-MM-DDTHH:MM:SSZ)で指定してください。左記の例ではタイムゾーンはUTC+0になりますのでご注意ください。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 作業履歴 ID |
| start_date_time | ○ | 開始日時 |
| end_date_time | 終了日時 | |
| working_time_sec | 作業時間（単位: 秒） ※ 作業停止していない場合は NULL |
|
| working_member | ○ | 作業メンバーの情報 |
| task | タスクの情報 | |
| calendar_event | カレンダー予定の情報 |
working_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| name | ○ | 名前 |
task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| title | ○ | タスクのタイトル |
calendar_event
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | カレンダー予定 ID |
| calendar_type | ○ | カレンダー種別 |
| event_name | ○ | 予定名称 |
タスクに紐づく作業履歴一覧の取得
例
curl 'https://api.timedesigner.com/v1/tasks/A79OG9ld/time-entries?page=1&page_size=50&since=2022-04-24T01:00:00Z&until=2022-04-24T05:00:00Z' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 50,
"page": 1,
"total_count": 1081,
"total_page_count": 200,
"has_next_page": true,
"has_previous_page": false,
"items": [
{
"id": "pkKdpeKJ",
"start_date_time": "2022-07-18T15:44:04Z",
"end_date_time": "2022-07-18T15:44:17Z",
"working_time_sec": 12,
"working_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"task": {
"id": "pWwv7EKP",
"title": "資料作成"
},
"calendar_event": null
}
...
]
}
タスクに紐づく作業履歴一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/tasks/{タスクID}/time-entries
なお、 「組織全員の作業履歴の閲覧」権限がある場合には、全てのメンバーの作業履歴を取得できます。 「チームメンバーの作業履歴の閲覧」権限のみある場合には、所属しているチームメンバーの作業履歴のみを取得できます。 どちらの権限も無い場合には、自分自身の作業履歴のみを取得できます。
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
|
| working_member_id | 作業したメンバーのID。作業者で絞り込みしたい場合に指定します。 | ||
| calendar_event_id | カレンダー予定のID。カレンダー予定で絞り込みしたい場合に指定します。 | ||
| since | 指定した日時以降に絞り込みした場合に指定します。ISO8601形式(YYYY-MM-DDTHH:MM:SSZ)で指定してください。左記の例ではタイムゾーンはUTC+0になりますのでご注意ください。 | ||
| until | 指定した日時までに絞り込みした場合に指定します。ISO8601形式(YYYY-MM-DDTHH:MM:SSZ)で指定してください。左記の例ではタイムゾーンはUTC+0になりますのでご注意ください。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 作業履歴 ID |
| start_date_time | ○ | 開始日時 |
| end_date_time | 終了日時 | |
| working_time_sec | 作業時間（単位: 秒） ※ 作業停止していない場合は NULL |
|
| working_member | ○ | 作業メンバーの情報 |
| task | ○ | タスクの情報 |
| calendar_event | カレンダー予定の情報 |
working_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| name | ○ | 名前 |
task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| title | ○ | タスクのタイトル |
calendar_event
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | カレンダー予定 ID |
| calendar_type | ○ | カレンダー種別 |
| event_name | ○ | 予定名称 |
カレンダー予定に紐づく作業履歴一覧の取得
例
curl 'https://api.timedesigner.com/v1/calendar-events/A79OG9ld/time-entries?page=1&page_size=50&since=2022-04-24T01:00:00Z&until=2022-04-24T05:00:00Z' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 50,
"page": 1,
"total_count": 1081,
"total_page_count": 200,
"has_next_page": true,
"has_previous_page": false,
"items": [
{
"id": "pkKdpeKJ",
"start_date_time": "2022-07-18T15:44:04Z",
"end_date_time": "2022-07-18T15:44:17Z",
"working_time_sec": 12,
"working_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"task": null,
"calendar_event": {
"id": "pWwv7EKP",
"calendar_type": "pWwv7EKP",
"event_name": "会議"
}
}
...
]
}
カレンダー予定に紐づく作業履歴一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/calendar-events/{カレンダーイベントID}/time-entries
なお、 「組織全員の作業履歴の閲覧」権限がある場合には、全てのメンバーの作業履歴を取得できます。 「チームメンバーの作業履歴の閲覧」権限のみある場合には、所属しているチームメンバーの作業履歴のみを取得できます。 どちらの権限も無い場合には、自分自身の作業履歴のみを取得できます。
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
|
| working_member_id | 作業したメンバーのID。作業者で絞り込みしたい場合に指定します。 | ||
| task_id | タスクのID。タスクで絞り込みしたい場合に指定します。 | ||
| since | 指定した日時以降に絞り込みした場合に指定します。ISO8601形式(YYYY-MM-DDTHH:MM:SSZ)で指定してください。左記の例ではタイムゾーンはUTC+0になりますのでご注意ください。 | ||
| until | 指定した日時までに絞り込みした場合に指定します。ISO8601形式(YYYY-MM-DDTHH:MM:SSZ)で指定してください。左記の例ではタイムゾーンはUTC+0になりますのでご注意ください。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 作業履歴 ID |
| start_date_time | ○ | 開始日時 |
| end_date_time | 終了日時 | |
| working_time_sec | 作業時間（単位: 秒） ※ 作業停止していない場合は NULL |
|
| working_member | ○ | 作業メンバーの情報 |
| task | タスクの情報 | |
| calendar_event | ○ | カレンダー予定の情報 |
working_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| name | ○ | 名前 |
task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| title | ○ | タスクのタイトル |
calendar_event
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | カレンダー予定 ID |
| calendar_type | ○ | カレンダー種別 |
| event_name | ○ | 予定名称 |
作業履歴情報の取得
例
curl 'https://api.timedesigner.com/v1/time-entries/g3KNZKGD' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "pkKdpeKJ",
"start_date_time": "2022-07-18T15:44:04Z",
"end_date_time": "2022-07-18T15:44:17Z",
"working_time_sec": 12,
"working_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"task": {
"id": "pWwv7EKP",
"title": "たすく"
},
"calendar_event": null
}
作業履歴情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/time-entries/{作業履歴ID}
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 作業履歴 ID |
| start_date_time | ○ | 開始日時 |
| end_date_time | 終了日時 | |
| working_time_sec | 作業時間（単位: 秒） ※ 作業停止していない場合は NULL |
|
| working_member | ○ | 作業メンバーの情報 |
| task | タスクの情報 | |
| calendar_event | カレンダー予定の情報 |
working_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| name | ○ | 名前 |
task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| title | ○ | タスクのタイトル |
calendar_event
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | カレンダー予定 ID |
| calendar_type | ○ | カレンダー種別 |
| event_name | ○ | 予定名称 |
作業履歴情報の作成
例
curl -X POST 'https://api.timedesigner.com/v1/time-entries' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"task_id": "pWwv7EKP",
"start_date_time": "2022-05-17T01:00:00Z",
"end_date_time": "2022-05-18T10:00:00Z"
}'
# レスポンス
{
"id": "vVmLXDmA",
"start_date_time": "2022-05-17T01:00:00Z",
"end_date_time": "2022-05-18T10:00:00Z",
"working_time_sec": 118800,
"working_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"task": {
"id": "pWwv7EKP",
"title": "たすく"
},
"calendar_event": null
}
作業履歴情報を作成します。
エンドポイント:
POST https://api.timedesigner.com/v1/time-entries
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| task_id | ○ | タスク ID | |
| start_date_time | ○ | 終了日時よりも前の日時であること | 開始日時 |
| end_date_time | ○ | 開始日時よりも後の日時であること | 終了日時 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 作業履歴 ID |
| start_date_time | ○ | 開始日時 |
| end_date_time | 終了日時 | |
| working_time_sec | 作業時間（単位: 秒） ※ 作業停止していない場合は NULL |
|
| working_member | ○ | 作業メンバーの情報 |
| task | タスクの情報 | |
| calendar_event | カレンダー予定の情報 |
working_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| name | ○ | 名前 |
task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| title | ○ | タスクのタイトル |
calendar_event
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | カレンダー予定 ID |
| calendar_type | ○ | カレンダー種別 |
| event_name | ○ | 予定名称 |
作業履歴情報の更新
例
curl -X PUT 'https://api.timedesigner.com/v1/time-entries/g3KNZKGD' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"start_date_time": "2022-05-17T01:00:00Z",
"end_date_time": "2022-05-18T10:00:00Z"
}'
# レスポンス
{
"id": "vVmLXDmA",
"start_date_time": "2022-05-17T01:00:00Z",
"end_date_time": "2022-05-18T10:00:00Z",
"working_time_sec": 118800,
"working_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"task": {
"id": "pWwv7EKP",
"title": "たすく"
},
"calendar_event": null
}
作業履歴情報を更新します。
エンドポイント:
PUT https://api.timedesigner.com/v1/time-entries/{作業履歴ID}
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| start_date_time | ○ | 終了日時よりも前の日時であること | 開始日時 |
| end_date_time | ・開始日時よりも後の日時であること ・すでに終了日時が設定されている場合、Null には更新できない ・作業中の場合には、一度タスクから作業終了をしてからでなければ更新できない |
終了日時 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 作業履歴 ID |
| start_date_time | ○ | 開始日時 |
| end_date_time | 終了日時 | |
| working_time_sec | 作業時間（単位: 秒） ※ 作業停止していない場合は NULL |
|
| working_member | ○ | 作業メンバーの情報 |
| task | タスクの情報 | |
| calendar_event | カレンダー予定の情報 |
working_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| name | ○ | 名前 |
task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| title | ○ | タスクのタイトル |
calendar_event
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | カレンダー予定 ID |
| calendar_type | ○ | カレンダー種別 |
| event_name | ○ | 予定名称 |
作業履歴情報の削除
例
curl -X DELETE 'https://api.timedesigner.com/v1/time-entries/g3KNZKGD' \
--basic -u api_token:${APIトークン}
# レスポンス
なし (204 No Content)
作業履歴情報を削除します。
エンドポイント:
DELETE https://api.timedesigner.com/v1/time-entries/{作業履歴ID}
リクエスト・パラメータ
なし
レスポンス・データ
なし
作業予定
作業予定の情報を参照する API について、以下に記載します。
作業予定一覧の取得
例
curl 'https://api.timedesigner.com/v1/work-schedules?page=1&page_size=50' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 1,
"page": 50,
"total_count": 250,
"total_page_count": 50,
"has_next_page": true,
"has_previous_page": false,
"items": [
{
"id": "dYmGO4mA",
"start_date_time": "2022-04-24T07:00:00Z",
"end_date_time": "2022-04-24T08:00:00Z",
"working_time_sec": 3600,
"working_member": {
"id": "3AKnP92l",
"name": "松永 達也"
},
"task": {
"id": "ByK1394X",
"title": "進捗報告会"
}
},
...
]
}
作業予定一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/work-schedules
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
|
| task_id | タスクID。タスクで絞り込みしたい場合に指定します。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 作業予定 ID |
| start_date_time | ○ | 開始日時 |
| end_date_time | ○ | 終了日時 |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| working_member | ○ | 作業メンバーの情報 |
| task | ○ | タスクの情報 |
items.working_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
items.task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| title | ○ | タスクのタイトル |
タスクに紐づく作業予定一覧の取得
例
curl 'https://api.timedesigner.com/v1/tasks/ByK1394X/work-schedules?page=1&page_size=50' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 1,
"page": 50,
"total_count": 250,
"total_page_count": 50,
"has_next_page": true,
"has_previous_page": false,
"items": [
{
"id": "dYmGO4mA",
"start_date_time": "2022-04-24T07:00:00Z",
"end_date_time": "2022-04-24T08:00:00Z",
"working_time_sec": 3600,
"working_member": {
"id": "3AKnP92l",
"name": "松永 達也"
},
"task": {
"id": "ByK1394X",
"title": "進捗報告会"
}
},
...
]
}
タスクに紐づく作業予定一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/tasks/{タスクID}/work-schedules
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 作業予定 ID |
| start_date_time | ○ | 開始日時 |
| end_date_time | ○ | 終了日時 |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| working_member | ○ | 作業メンバーの情報 |
| task | ○ | タスクの情報 |
items.working_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
items.task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| title | ○ | タスクのタイトル |
作業予定情報の取得
例
curl 'https://api.timedesigner.com/v1/work-schedules/dYmGO4mA' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "dYmGO4mA",
"start_date_time": "2022-04-24T07:00:00Z",
"end_date_time": "2022-04-24T08:00:00Z",
"working_time_sec": 3600,
"working_member": {
"id": "3AKnP92l",
"name": "松永 達也"
},
"task": {
"id": "ByK1394X",
"title": "進捗報告会"
}
}
作業予定情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/work-schedules/{作業予定ID}
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 作業予定 ID |
| start_date_time | ○ | 開始日時 |
| end_date_time | ○ | 終了日時 |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| working_member | ○ | 作業メンバーの情報 |
| task | ○ | タスクの情報 |
working_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| title | ○ | タスクのタイトル |
作業予定情報の作成
例
curl -X POST 'https://api.timedesigner.com/v1/work-schedules' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"task_id": "ByK1394X",
"start_date_time": "2022-05-17T01:00:00Z",
"end_date_time": "2022-05-18T10:00:00Z"
}'
# レスポンス
{
"id": "JN9eWnK0",
"start_date_time": "2022-05-17T01:00:00Z",
"end_date_time": "2022-05-18T10:00:00Z",
"working_time_sec": 118800,
"working_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"task": {
"id": "ByK1394X",
"title": "進捗報告会"
}
}
作業予定情報を作成します。
エンドポイント:
POST https://api.timedesigner.com/v1/work-schedules
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| task_id | ○ | タスク ID | |
| start_date_time | ○ | 開始日時 | |
| end_date_time | ○ | 終了日時 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 作業予定 ID |
| start_date_time | ○ | 開始日時 |
| end_date_time | ○ | 終了日時 |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| working_member | ○ | 作業メンバーの情報 |
| task | ○ | タスクの情報 |
working_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| title | ○ | タスクのタイトル |
作業予定情報の更新
例
curl -X PUT 'https://api.timedesigner.com/v1/work-schedules/JN9eWnK0' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"start_date_time": "2022-05-17T01:00:00Z",
"end_date_time": "2022-05-18T10:00:00Z"
}'
# レスポンス
{
"id": "JN9eWnK0",
"start_date_time": "2022-05-17T01:00:00Z",
"end_date_time": "2022-05-18T10:00:00Z",
"working_time_sec": 118800,
"working_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
},
"task": {
"id": "ByK1394X",
"title": "進捗報告会"
}
}
作業予定情報を更新します。
エンドポイント:
PUT https://api.timedesigner.com/v1/work-schedules/{作業予定ID}
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| start_date_time | ○ | 開始日時 | |
| end_date_time | 終了日時 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 作業予定 ID |
| start_date_time | ○ | 開始日時 |
| end_date_time | ○ | 終了日時 |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| working_member | ○ | 作業メンバーの情報 |
| task | ○ | タスクの情報 |
working_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバー ID |
| title | ○ | タスクのタイトル |
作業予定情報の削除
例
curl -X DELETE 'https://api.timedesigner.com/v1/work-schedules/g3KNZKGD' \
--basic -u api_token:${APIトークン}
# レスポンス
なし (204 No Content)
作業予定情報を削除します。
エンドポイント:
DELETE https://api.timedesigner.com/v1/work-schedules/{作業予定ID}
リクエスト・パラメータ
なし
レスポンス・データ
なし
タスクステータス
タスクステータスの情報を参照する API について、以下に記載します。
タスクステータス一覧の取得
例
curl 'https://api.timedesigner.com/v1/projects/3AKnP92l/task-statuses' \
--basic -u api_token:${APIトークン}
# レスポンス
[
{
"id": "5vmq3wYR",
"name": "未着手",
"end_status": false,
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
}
},
{
"id": "y29EJwRJ",
"name": "進行中",
"end_status": false,
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
}
},
{
"id": "R1mg5wvg",
"name": "完了",
"end_status": true,
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
}
}
]
タスクステータス一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/projects/{プロジェクトID}/task-statuses
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクステータス ID |
| name | ○ | タスクステータス名 |
| end_status | ○ | 終端ステータスかどうかのフラグ。終端ステータスの場合には True、そうでない場合には False。 |
| project | ○ | プロジェクト情報 |
project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
タスクステータス情報の取得
例
curl 'https://api.timedesigner.com/v1/task-statuses/5vmq3wYR' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "5vmq3wYR",
"name": "未着手",
"end_status": false,
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
}
}
タスクステータス情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/task-statuses/{タスクステータスID}
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクステータス ID |
| name | ○ | タスクステータス名 |
| end_status | ○ | 終端ステータスかどうかのフラグ。終端ステータスの場合には True、そうでない場合には False。 |
| project | ○ | プロジェクト情報 |
project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
タスクステータス情報の作成
例
curl -X POST 'https://api.timedesigner.com/v1/task-statuses' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"project_id": "3AKnP92l",
"name": "保留"
}'
# レスポンス
{
"id": "aGm2Pwbl",
"name": "保留",
"end_status": false,
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
}
}
タスクステータス情報を作成します。
エンドポイント:
POST https://api.timedesigner.com/v1/task-statuses
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| project_id | ○ | max-length:20 | プロジェクトID |
| name | ○ | max-length:20 | タスクステータス名 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクステータス ID |
| name | ○ | タスクステータス名 |
| end_status | ○ | 終端ステータスかどうかのフラグ。終端ステータスの場合には True、そうでない場合には False。 |
| project | ○ | プロジェクト情報 |
project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
タスクステータス情報の更新
例
curl -X PUT 'https://api.timedesigner.com/v1/task-statuses/6GmQ8Ka1' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"name": "保留"
}'
# レスポンス
{
"id": "aGm2Pwbl",
"name": "保留",
"end_status": false,
"project": {
"id": "3AKnP92l",
"name": "PJ-0010 宇宙ビジネス市場調査"
}
}
タスクステータス情報を更新します。
エンドポイント:
PUT https://api.timedesigner.com/v1/task-statuses/{タスクステータスID}
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| name | ○ | max-length:20 | タスクステータス名 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクステータス ID |
| name | ○ | タスクステータス名 |
| end_status | ○ | 終端ステータスかどうかのフラグ。終端ステータスの場合には True、そうでない場合には False。 |
| project | ○ | プロジェクト情報 |
project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
タスクステータス情報の削除
例
curl -X DELETE 'https://api.timedesigner.com/v1/task-statuses/6GmQ8Ka1' \
--basic -u api_token:${APIトークン}
# レスポンス
なし (204 No Content)
タスクステータス情報を削除します。
タスクステータスを削除すると、属しているタスクは指定した別のタスクステータスに移動されます。
エンドポイント:
DELETE https://api.timedesigner.com/v1/task-statuses/{タスクステータスID}
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| task_move_destination_task_status_id | ○ | 終端ステータスは指定できない | 削除するステータスに属するタスクの、移動先となるタスクステータス ID |
レスポンス・データ
なし
作業したカレンダーの予定
作業したカレンダーの予定の情報を参照する API について、以下に記載します。
作業したカレンダーの予定一覧の取得
例
curl 'https://api.timedesigner.com/v1/calendar-events?page=1&page_size=50' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 50,
"page": 1,
"total_count": 1,
"total_page_count": 1,
"has_next_page": false,
"has_previous_page": false,
"items": [
{
"id": "A79OG9ld",
"calendar_type": "GoogleCalendar",
"event_name": "定例ミーティング",
"start_date_time": "2022-07-18T03:00:00Z",
"end_date_time": "2022-07-18T04:00:00Z",
"working_time_sec": 3600,
"third_party_calendar_event_id": "5jl9l7scj7ajefbl6r8oeh29m0",
"project": {
"id": "2VwxaKX8",
"name": "部内会議"
},
"task": {
"id": "MLwJkKYN",
"title": "定例MTG"
}
}
]
}
作業したカレンダーの予定一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/calendar-events
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 作業したカレンダーの予定の ID |
| calendar_type | ○ | 作業したカレンダーの予定の種別 |
| event_name | ○ | 作業したカレンダーの予定名 |
| start_date_time | ○ | 開始日時 |
| end_date_time | ○ | 終了日時 |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| third_party_calendar_event_id | ○ | 外部サービスの作業したカレンダーの予定 ID |
| project | ○ | プロジェクト情報 |
| task | ○ | タスク情報 |
project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクID |
| title | ○ | タスクのタイトル |
作業したカレンダーの予定情報の取得
例
curl 'https://api.timedesigner.com/v1/calendar-events/A79OG9ld' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "A79OG9ld",
"calendar_type": "GoogleCalendar",
"event_name": "定例ミーティング",
"start_date_time": "2022-07-18T03:00:00Z",
"end_date_time": "2022-07-18T04:00:00Z",
"working_time_sec": 3600,
"third_party_calendar_event_id": "5jl9l7scj7ajefbl6r8oeh29m0",
"project": {
"id": "2VwxaKX8",
"name": "部内会議"
},
"task": {
"id": "MLwJkKYN",
"title": "定例MTG"
}
}
作業したカレンダーの予定情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/calendar-events/{作業したカレンダーの予定ID}
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 作業したカレンダーの予定の ID |
| calendar_type | ○ | 作業したカレンダーの予定の種別 |
| event_name | ○ | 作業したカレンダーの予定名 |
| start_date_time | ○ | 開始日時 |
| end_date_time | ○ | 終了日時 |
| working_time_sec | ○ | 作業時間（単位: 秒） |
| third_party_calendar_event_id | ○ | 外部サービスの作業したカレンダーの予定 ID |
| project | ○ | プロジェクト情報 |
| task | ○ | タスク情報 |
project
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトID |
| name | ○ | プロジェクト名 |
task
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクID |
| title | ○ | タスクのタイトル |
プロジェクトテンプレート
プロジェクトテンプレートの情報を参照する API について、以下に記載します。
プロジェクトテンプレートを事前に作成し、タスクテンプレートをその中に作成しておけば、
プロジェクトテンプレートから新規のプロジェクトを作成することができます。
プロジェクトテンプレート一覧の取得
例
curl 'https://api.timedesigner.com/v1/project-templates?page=1&page_size=50' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 50,
"page": 1,
"total_count": 1,
"total_page_count": 1,
"has_next_page": false,
"has_previous_page": false,
"items": [
{
"id": "A79OG9ld",
"name": "テンプレート",
"client": {
"id": "MLwJkKYN",
"name": "サンプル取引先"
}
}
]
}
プロジェクトテンプレート一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/project-templates
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトテンプレートの ID |
| name | ○ | プロジェクトテンプレート名 |
| client | 紐付けられている取引先 |
client
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先ID |
| name | ○ | 取引先名 |
プロジェクトテンプレート情報の取得
例
curl 'https://api.timedesigner.com/v1/project-templates/A79OG9ld' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "A79OG9ld",
"name": "テンプレート",
"client": {
"id": "MLwJkKYN",
"name": "サンプル取引先"
}
}
プロジェクトテンプレート情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/project-templates/{プロジェクトテンプレートID}
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトテンプレートの ID |
| name | ○ | プロジェクトテンプレート名 |
| client | 紐付けられている取引先 |
client
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先ID |
| name | ○ | 取引先名 |
プロジェクトテンプレート情報の作成
例
curl -X POST 'https://api.timedesigner.com/v1/project-templates' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"name": "テンプレート2",
"client_id": "MLwJkKYN"
}'
# レスポンス
{
"id": "pkm5OwGA",
"name": "テンプレート2",
"client": {
"id": "MLwJkKYN",
"name": "サンプル取引先"
}
}
プロジェクトテンプレート情報を作成します。
エンドポイント:
POST https://api.timedesigner.com/v1/project-templates
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| name | ○ | max-length:100 | プロジェクトテンプレート名 |
| client_id | 紐付ける取引先 ID |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトテンプレートの ID |
| name | ○ | プロジェクトテンプレート名 |
| client | 紐付けられている取引先 |
client
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先ID |
| name | ○ | 取引先名 |
プロジェクトテンプレート情報の更新
例
curl -X PUT 'https://api.timedesigner.com/v1/project-templates/2p9pbKQM' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"name": "テンプレート3",
"client_id": "MLwJkKYN"
}'
# レスポンス
{
"id": "pkm5OwGA",
"name": "テンプレート3",
"client": {
"id": "MLwJkKYN",
"name": "サンプル取引先"
}
}
プロジェクトテンプレート情報を更新します。
エンドポイント:
PUT https://api.timedesigner.com/v1/project-templates/{プロジェクトテンプレートID}
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| name | ○ | max-length:100 | プロジェクトテンプレート名 |
| client_id | 紐付ける取引先 ID |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトテンプレートの ID |
| name | ○ | プロジェクトテンプレート名 |
| client | 紐付けられている取引先 |
client
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | 取引先ID |
| name | ○ | 取引先名 |
プロジェクトテンプレート情報の削除
例
curl -X DELETE 'https://api.timedesigner.com/v1/project-templates/2p9pbKQM' \
--basic -u api_token:${APIトークン}
# レスポンス
なし (204 No Content)
プロジェクト情報を削除します。
エンドポイント:
DELETE https://api.timedesigner.com/v1/project-templates/{プロジェクトID}
リクエスト・パラメータ
なし
レスポンス・データ
なし
タスクテンプレート
タスクテンプレートの情報を参照する API について、以下に記載します。
タスクテンプレート一覧の取得
例
curl 'https://api.timedesigner.com/v1/task-templates?page=1&page_size=50' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 50,
"page": 1,
"total_count": 2,
"total_page_count": 1,
"has_next_page": false,
"has_previous_page": false,
"items": [
{
"id": "pkm5OwGA",
"title": "日報作成",
"task_template_status": {
"id": "A79OG9ld",
"name": "未着手"
},
"project_template": {
"id": "A79OG9ld",
"name": "テンプレート"
},
"priority": null,
"estimate_time_sec": null,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
}
},
...
]
}
タスクテンプレート一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/task-templates
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
|
| project_template_id | プロジェクトテンプレートID。プロジェクトテンプレートで絞り込みしたい場合に指定します。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクテンプレートの ID |
| title | ○ | タスクテンプレートのタイトル |
| task_template_status | ○ | タスクテンプレートステータス情報 |
| project_template | ○ | プロジェクトテンプレートステータス情報 |
| priority | 優先度。詳細は下記を参照してください。 | |
| estimate_time_sec | 見積もり時間（単位: 秒） | |
| created_member | ○ | タスクを作成したメンバー情報 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
task_template_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクテンプレートステータスID |
| name | ○ | タスクテンプレートステータス名 |
project_template
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトテンプレートID |
| name | ○ | プロジェクトテンプレート名 |
created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
指定したプロジェクトテンプレートに属するタスクテンプレート一覧の取得
例
curl 'https://api.timedesigner.com/v1/project-templates/A79OG9ld/task-templates?page=1&page_size=50' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"page_size": 50,
"page": 1,
"total_count": 2,
"total_page_count": 1,
"has_next_page": false,
"has_previous_page": false,
"items": [
{
"id": "pkm5OwGA",
"title": "日報作成",
"task_template_status": {
"id": "A79OG9ld",
"name": "未着手"
},
"project_template": {
"id": "A79OG9ld",
"name": "テンプレート"
},
"priority": null,
"estimate_time_sec": null,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
}
},
...
]
}
指定したプロジェクトテンプレートに属するタスクテンプレート一覧の取得を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/project-templates/{プロジェクトテンプレートID}/task-templates
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| page | default:1 | 一覧取得はページング取得となります。何ページ目のデータを取得するかを指定します。このパラメータの指定は任意です。省略した場合は 1 が指定されます。 |
|
| page_size | default:50 | 1 ページあたりのデータ件数を指定します。このパラメータの指定は任意です。省略した場合は 50 が指定されます。 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| page_size | ○ | 1 ページあたりの件数 |
| page | ○ | 指定したページ位置 |
| total_count | ○ | 全データの件数 |
| total_page_count | ○ | 全ページ数 |
| has_next_page | ○ | 次のページがあるかどうか |
| has_previous_page | ○ | 前のページがあるかどうか |
| total_page_count | ○ | 全ページ数 |
| items | ○ | 取得した情報の配列。配列の中身は以下を参照してください。 |
items
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクテンプレートの ID |
| title | ○ | タスクテンプレートのタイトル |
| task_template_status | ○ | タスクテンプレートステータス情報 |
| project_template | ○ | プロジェクトテンプレートステータス情報 |
| priority | 優先度。詳細は下記を参照してください。 | |
| estimate_time_sec | 見積もり時間（単位: 秒） | |
| created_member | ○ | タスクを作成したメンバー情報 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
task_template_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクテンプレートステータスID |
| name | ○ | タスクテンプレートステータス名 |
project_template
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトテンプレートID |
| name | ○ | プロジェクトテンプレート名 |
created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
タスクテンプレート情報の取得
例
curl 'https://api.timedesigner.com/v1/task-templates/pkm5OwGA' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "pkm5OwGA",
"title": "日報作成",
"task_template_status": {
"id": "A79OG9ld",
"name": "未着手"
},
"project_template": {
"id": "A79OG9ld",
"name": "テンプレート"
},
"priority": null,
"estimate_time_sec": null,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
}
}
タスクテンプレート情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/task-templates/{タスクテンプレートID}
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクテンプレートの ID |
| title | ○ | タスクテンプレートのタイトル |
| task_template_status | ○ | タスクテンプレートステータス情報 |
| project_template | ○ | プロジェクトテンプレートステータス情報 |
| priority | 優先度。詳細は下記を参照してください。 | |
| estimate_time_sec | 見積もり時間（単位: 秒） | |
| created_member | ○ | タスクを作成したメンバー情報 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
task_template_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクテンプレートステータスID |
| name | ○ | タスクテンプレートステータス名 |
project_template
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトテンプレートID |
| name | ○ | プロジェクトテンプレート名 |
created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
タスクテンプレート情報の作成
例
curl -X POST 'https://api.timedesigner.com/v1/task-templates' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"project_template_id": "A79OG9ld",
"title": "請求書作成",
"priority": "High",
"estimate_time_sec": 100
}'
# レスポンス
{
"id": "Vlwz59Ra",
"title": "請求書作成",
"task_template_status": {
"id": "A79OG9ld",
"name": "未着手"
},
"project_template": {
"id": "A79OG9ld",
"name": "テンプレート"
},
"priority": "High",
"estimate_time_sec": 100,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
}
}
タスクテンプレート情報を作成します。
エンドポイント:
POST https://api.timedesigner.com/v1/task-templates
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| project_template_id | ○ | プロジェクトテンプレート ID | |
| title | ○ | max-length:100 | タスクテンプレートのタイトル |
| priority | 優先度。詳細は下記を参照してください。 | ||
| estimate_time_sec | 見積もり時間（単位: 秒） |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクテンプレートの ID |
| title | ○ | タスクテンプレートのタイトル |
| task_template_status | ○ | タスクテンプレートステータス情報 |
| project_template | ○ | プロジェクトテンプレートステータス情報 |
| priority | 優先度。詳細は下記を参照してください。 | |
| estimate_time_sec | 見積もり時間（単位: 秒） | |
| created_member | ○ | タスクを作成したメンバー情報 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
task_template_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクテンプレートステータスID |
| name | ○ | タスクテンプレートステータス名 |
project_template
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトテンプレートID |
| name | ○ | プロジェクトテンプレート名 |
created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
タスクテンプレート情報の更新
例
curl -X PUT 'https://api.timedesigner.com/v1/task-templates/Vlwz59Ra' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"title": "テンプレート２",
"priority": "Low",
"estimate_time_sec": 200
}'
# レスポンス
{
"id": "Vlwz59Ra",
"title": "テンプレート２",
"task_template_status": {
"id": "A79OG9ld",
"name": "未着手"
},
"project_template": {
"id": "A79OG9ld",
"name": "テンプレート"
},
"priority": "Low",
"estimate_time_sec": 200,
"created_member": {
"id": "pkm5OwGA",
"name": "山口 博一"
}
}
タスクテンプレート情報を更新します。
エンドポイント:
PUT https://api.timedesigner.com/v1/task-templates/{タスクテンプレートID}
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| title | ○ | max-length:100 | タスクテンプレートのタイトル |
| priority | 優先度。詳細は下記を参照してください。 | ||
| estimate_time_sec | 見積もり時間（単位: 秒） |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクテンプレートの ID |
| title | ○ | タスクテンプレートのタイトル |
| task_template_status | ○ | タスクテンプレートステータス情報 |
| project_template | ○ | プロジェクトテンプレートステータス情報 |
| priority | 優先度。詳細は下記を参照してください。 | |
| estimate_time_sec | 見積もり時間（単位: 秒） | |
| created_member | ○ | タスクを作成したメンバー情報 |
priority
| High | 優先度高 |
| Normal | 優先度中 |
| Low | 優先度低 |
task_template_status
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクテンプレートステータスID |
| name | ○ | タスクテンプレートステータス名 |
project_template
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトテンプレートID |
| name | ○ | プロジェクトテンプレート名 |
created_member
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | メンバーID |
| name | ○ | 名前 |
タスクテンプレート情報の削除
例
curl -X DELETE 'https://api.timedesigner.com/v1/task-templates/Vlwz59Ra' \
--basic -u api_token:${APIトークン}
# レスポンス
なし (204 No Content)
タスクテンプレート情報を削除します。
エンドポイント:
DELETE https://api.timedesigner.com/v1/task-templates/{タスクテンプレートID}
リクエスト・パラメータ
なし
レスポンス・データ
なし
タスクテンプレートステータス
タスクテンプレートステータスの情報を参照する API について、以下に記載します。
タスクテンプレートステータス一覧の取得
例
curl 'https://api.timedesigner.com/v1/project-templates/2p9pbKQM/task-template-statuses' \
--basic -u api_token:${APIトークン}
# レスポンス
[
{
"id": "A79OG9ld",
"name": "未着手",
"end_status": false,
"project_template": {
"id": "A79OG9ld",
"name": "テンプレート"
}
},
...
]
タスクテンプレートステータス一覧を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/project-templates/{プロジェクトテンプレートID}/task-template-statuses
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクテンプレートステータス ID |
| name | ○ | タスクテンプレートステータス名 |
| end_status | ○ | 終端ステータスかどうかのフラグ。終端ステータスの場合には True、そうでない場合には False。 |
| project_template | ○ | プロジェクトテンプレート情報。 |
project_template
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトテンプレートID |
| name | ○ | プロジェクトテンプレート名 |
タスクテンプレートステータス情報の取得
例
curl 'https://api.timedesigner.com/v1/task-template-statuses/A79OG9ld' \
--basic -u api_token:${APIトークン}
# レスポンス
{
"id": "A79OG9ld",
"name": "未着手",
"end_status": false,
"project_template": {
"id": "A79OG9ld",
"name": "テンプレート"
}
}
タスクテンプレートステータス情報を取得します。
エンドポイント:
GET https://api.timedesigner.com/v1/task-template-statuses/{タスクテンプレートステータスID}
リクエスト・パラメータ
なし
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクテンプレートステータス ID |
| name | ○ | タスクテンプレートステータス名 |
| end_status | ○ | 終端ステータスかどうかのフラグ。終端ステータスの場合には True、そうでない場合には False。 |
| project_template | ○ | プロジェクトテンプレート情報。 |
project_template
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトテンプレートID |
| name | ○ | プロジェクトテンプレート名 |
タスクテンプレートステータス情報の作成
例
curl -X POST 'https://api.timedesigner.com/v1/task-template-statuses' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"project_template_id": "A79OG9ld",
"name": "テンプレート2"
}'
# レスポンス
{
"id": "MLwJkKYN",
"name": "テンプレート2",
"end_status": false,
"project_template": {
"id": "A79OG9ld",
"name": "テンプレート"
}
}
タスクテンプレートステータス情報を作成します。
エンドポイント:
POST https://api.timedesigner.com/v1/task-template-statuses
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| project_template_id | ○ | プロジェクトテンプレートID | |
| name | ○ | max-length:20 | タスクテンプレートステータス名 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクテンプレートステータス ID |
| name | ○ | タスクテンプレートステータス名 |
| end_status | ○ | 終端ステータスかどうかのフラグ。終端ステータスの場合には True、そうでない場合には False。 |
| project_template | ○ | プロジェクトテンプレート情報。 |
project_template
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトテンプレートID |
| name | ○ | プロジェクトテンプレート名 |
タスクテンプレートステータス情報の更新
例
curl -X PUT 'https://api.timedesigner.com/v1/task-template-statuses/A79OG9ld' \
--basic -u api_token:${APIトークン} \
-H 'Content-Type: application/json' \
--data '{
"name": "テンプレート２"
}'
# レスポンス
{
"id": "A79OG9ld",
"name": "テンプレート2",
"end_status": false,
"project_template": {
"id": "A79OG9ld",
"name": "テンプレート"
}
}
タスクテンプレートステータス情報を更新します。
エンドポイント:
PUT https://api.timedesigner.com/v1/task-template-statuses/{タスクテンプレートステータスID}
リクエスト・パラメータ
| パラメーター | 必須 | 制約 | 内容 |
|---|---|---|---|
| name | ○ | max-length:20 | タスクテンプレートステータス名 |
レスポンス・データ
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | タスクテンプレートステータス ID |
| name | ○ | タスクテンプレートステータス名 |
| end_status | ○ | 終端ステータスかどうかのフラグ。終端ステータスの場合には True、そうでない場合には False。 |
| project_template | ○ | プロジェクトテンプレート情報。 |
project_template
| レスポンス | 必須 | 内容 |
|---|---|---|
| id | ○ | プロジェクトテンプレートID |
| name | ○ | プロジェクトテンプレート名 |
タスクテンプレートステータス情報の削除
例
curl -X DELETE 'https://api.timedesigner.com/v1/task-template-statuses/A79OG9ld' \
--basic -u api_token:${APIトークン}
# レスポンス
なし (204 No Content)
タスクテンプレートステータス情報を削除します。
エンドポイント:
DELETE https://api.timedesigner.com/v1/task-template-statuses/{タスクテンプレートステータスID}
リクエスト・パラメータ
なし
レスポンス・データ
なし
リリースノート
| 日付 | 修正内容 |
|---|---|
| 2022/08/22 | タイムデザイナーAPIをリリース |
| 2022/10/24 | プロジェクト作成時・更新時のパラメータに任意項目として「color」を追加。プロジェクト情報のレスポンスに「color」を追加。 |
| 2022/10/31 | チームを作成するAPIに、参加メンバーを指定できるパラメータを追加しました。チームへメンバーを追加・削除するAPIを追加しました。 |