概要

タスク管理・タイムマネジメントツール「Clock It!」の開発者向けAPIの公式仕様書です。

エンドポイント

Clock It!のAPIはRESTの原則に基づいてAPI設計されています。

プロジェクト、タスク、作業履歴データといったリソースに対して、固有の一意なURI(エンドポイント)が用意されています。
各エンドポイントに対してGETやPOST、PUT、DELETE等のHTTPメソッドで、リクエストを送ることで各リソースの操作を行います。

エンドポイントのベースURIは、https://api.clock-it.com/v1となります。
※エンドポイントへは https でアクセスする必要があります。

今後、APIのバージョンが上がった場合は/v1のバージョン部分が変更され、旧バージョンのAPIは一定の移行期間の間維持されます。

https://api.clock-it.com/v1

認証

認証トークンを確認する

APIエンドポイントを利用する際には、認証を行う必要があります。

Clock It!の設定メニューを開くと「APIトークン」を確認できます。
このAPIトークンは、各ユーザーに対して一意な値が発行されています。

設定メニュー

APIトークンの使用

APIエンドポイントを利用する際には、上記のAPIトークンを使用して認証を行います。
認証の方法は、Basic認証・もしくは、URLパラメータでの指定の2種類です。
※Basic認証を推奨いたします。

Basic認証の場合、ユーザー名にapi_tokenを指定し、パスワードに上記APIトークンを指定してください。

URLパラメータの場合、パラメータのキーにapi_tokenを指定し、値として上記APIトークンを指定してください。

認証
Basic認証
curl --basic -u api_token:${APIトークン} https://api.clock-it.com/v1/...
URLパラメータ認証
curl https://api.clock-it.com/v1/...?api_token=${APIトークン}

APIフォーマット

コンテンツタイプ

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」となります。

二重処理の防止

データの登録・更新・削除を行うAPIの場合には、HTTPヘッダーにX-ClockIt-RequestIDを設定することで、同じリクエストが1回しか処理されないように制御することが出来ます。
ヘッダーの値には一意で任意の値を設定設定します
この値が同じリクエストは、2回以上処理されることはありません。
このヘッダーの設定は任意となります。

curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/projects/1/tasks" \
		-X POST \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345" \
		--data '{
			"title": "新しいタスク名",
			"note": "ノート情報も\n更新する。",
			"estimate": {
				"end": "2018-02-01T00:00:00Z",
				"duration": 3600
			}
		}'

	    #レスポンス
		{
          "id": 1,
          "project_id": 1,
          "name": "新しいタスク名",
          "description": "ノート情報も\n更新する。",
          "estimate": {
            "end": "2018-02-01T00:00:00Z",
            "duration": 3600
          },
          "actual": {
            "start": null,
            "end": null,
            "duration": 0
          },
          "remain": {
            "actual_duration": 3600,
            "predictional_duration": null
          },
          "progress": 0,
          "completed": false,
          "complete_at": null,
          "tracking": false,
          "create_at": "2018-01-11T15:31:26Z",
          "create_member_id": 1
        }
							  
							  

レスポンス

APIを呼び出した結果の成否は、レスポンスのHTTPステータスコードを以て判定してください。
右記の表が、返却されるステータスコードの一覧となります。

結果がエラーの場合には、以下のようにmessageというキーに、エラーの概要が記載されます。
また、エラーの詳細情報がerrorsに配列で記載されます。
errorsの中には、以下の情報が記載されます。

  • field・・・エラーの原因項目
  • code・・・エラーの詳細を示すコード
  • data・・・エラーの補足情報
{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "code": "LENGTH",
      "data": {
         "min": 0,
         "max": 100
      }
    }
  ]
}
								

レスポンス
200 - OK リクエストは正常に処理された。
201 - Created リクエストは正常に処理され、新たにリソースが作成された。
204 - No Content リクエストは正常に処理され、返却するべき値はない。
400 - Bad Request リクエストの送信内容に不備がある。
401 - Unauthorized 認証を行うことが出来なかった。
404 - Not Found 指定したリソースが存在しない。
403 - Forbidden 存在しないエンドポイントが指定された。
409 - Conflict リソースの更新に競合が発生した。
429 - Too Many Requests リクエスト数が多すぎる。
500, 502, 503, 504 - Server Errors Clock It!のAPIサーバー側で問題が発生している。

チーム

チームプランをご利用の場合には、ご契約毎に1つのチームが作成されます。

チームの情報を取得・更新するAPIについて、以下に記載します。

チーム一覧の取得

自分が所属しているチームの一覧を取得します。

エンドポイント:
GET https://api.clock-it.com/v1/teams
リクエスト・パラメータ
  • page optional default: 1 min: 1 max: 1

    チーム一覧取得はページング取得となります。
    何ページ目のデータを取得するかを指定します。
    このパラメータの指定は任意です。省略した場合は1が指定されます。

  • per_page optional default: 100 min: 1 max: 100

    1ページあたりのデータ件数を指定します。
    このパラメータの指定は任意です。省略した場合は100が指定されます。



レスポンス・データ
  • per_page

    1ページあたりのデータ件数

  • page

    指定したページ位置

  • total_count

    全データの件数

  • total_page_count

    全ページ数

  • items

    所属しているチーム情報の配列
    配列の中身のチーム情報部分については、以下を参照してください。

items
  • id

    チームのID

  • name

    チームの名称

  • alias

    チームの識別子。
    ※チームのURLに使用される文字列です。

curl --basic -u api_token:${APIトークン} \
  "https://api.clock-it.com/v1/teams"

#レスポンス
{
  "per_page": 100,
  "page": 1,
  "total_count": 1,
  "total_page_count": 1,
  "items": [
    {
      "id": 1,
      "name": "サンプルチーム",
      "alias": "SAMPLE"
    }
  ]
}
							  
							  

チーム情報の取得

指定したチームの情報を取得します。

エンドポイント:
GET https://api.clock-it.com/v1/teams/{チームID}
リクエスト・パラメータ
  • なし
レスポンス・データ
  • id

    チームのID

  • name

    チームの名称

  • alias

    チームの識別子。
    ※チームのURLに使用される文字列です。

curl --basic -u api_token:${APIトークン} \
  "https://api.clock-it.com/v1/teams/1"

#レスポンス
{
  "id": 1,
  "name": "サンプルチーム",
  "alias": "SAMPLE"
}
							  
							  

チーム情報の更新

指定したチームの情報を更新します。

エンドポイント:
PUT https://api.clock-it.com/v1/teams/{チームID}
リクエスト・パラメータ
  • name optional max-length: 20

    チームの名称


  • alias optional max-length: 10 半角英数字のみ許容

    チームの識別子



レスポンス・データ
  • id

    チームのID

  • name

    チームの名称

  • alias

    チームの識別子。
    ※チームのURLに使用される文字列です。

curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/teams/1" \
		-X PUT \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345" \
		--data '{
			"name": "新しいチーム名",
			"alias": "新しい識別子"
		}'

#レスポンス
{
  "id": 1,
  "name": "新しいチーム名",
  "alias": "新しい識別子"
}
							  
							  

メンバー

自分自身や、チームのメンバーの情報を参照するAPIについて、以下に記載します。

自分の情報の取得

自分自身のメンバー情報を取得します。

エンドポイント:
GET https://api.clock-it.com/v1/members/me
リクエスト・パラメータ
  • なし
レスポンス・データ
  • id

    メンバーのID

  • name

    名前

  • mail_address

    メールアドレス

curl --basic -u api_token:${APIトークン} \
  "https://api.clock-it.com/v1/members/me"

#レスポンス
{
  "id": 1,
  "name": "サンプル太郎",
  "mail_address": "sample@clock-it.com"
}
							  
							  

チームメンバー一覧の取得

指定したチームのメンバー一覧を取得します。

エンドポイント:
GET https://api.clock-it.com/v1/teams/{チームID}/members
リクエスト・パラメータ
  • page optional default: 1 min: 1 max: 1

    メンバー一覧取得はページング取得となります。
    何ページ目のデータを取得するかを指定します。
    このパラメータの指定は任意です。省略した場合は1が指定されます。

  • per_page optional default: 100 min: 1 max: 100

    1ページあたりのデータ件数を指定します。
    このパラメータの指定は任意です。省略した場合は100が指定されます。



レスポンス・データ
  • per_page

    1ページあたりのデータ件数

  • page

    指定したページ位置

  • total_count

    全データの件数

  • total_page_count

    全ページ数

  • items

    メンバー情報の配列
    配列の中身の情報部分については、以下を参照してください。

items
  • id

    メンバーのID

  • name

    名前

  • mail_address

    メールアドレス

curl --basic -u api_token:${APIトークン} \
  "https://api.clock-it.com/v1/teams/1/members"

#レスポンス
{
  "per_page": 100,
  "page": 1,
  "total_count": 1,
  "total_page_count": 1,
  "items": [
    {
      "id": 1,
      "name": "サンプル太郎",
      "mail_address": "sample@clock-it.com"
    }
  ]
}
							  
							  

メンバー情報の取得

指定したメンバーの情報を取得します。

エンドポイント:
GET https://api.clock-it.com/v1/members/{メンバーID}
リクエスト・パラメータ
  • なし
レスポンス・データ
  • id

    メンバーのID

  • name

    名前

  • mail_address

    メールアドレス

curl --basic -u api_token:${APIトークン} \
  "https://api.clock-it.com/v1/members/1"

#レスポンス
{
  "id": 1,
  "name": "サンプル太郎",
  "mail_address": "sample@clock-it.com"
}
							  
							  

取引先

取引先の情報を取得・更新するAPIについて、以下に記載します。

※取引先はチームプランをご利用の場合に、登録・管理することが出来ます。

取引先一覧の取得

指定したチームの取引先一覧を取得します。

エンドポイント:
GET https://api.clock-it.com/v1/teams/{チームID}/clients
リクエスト・パラメータ
  • page optional default: 1 min: 1 max: 1

    取引先の一覧取得はページング取得となります。
    何ページ目のデータを取得するかを指定します。
    このパラメータの指定は任意です。省略した場合は1が指定されます。

  • per_page optional default: 100 min: 1 max: 100

    1ページあたりのデータ件数を指定します。
    このパラメータの指定は任意です。省略した場合は100が指定されます。



レスポンス・データ
  • per_page

    1ページあたりのデータ件数

  • page

    指定したページ位置

  • total_count

    全データの件数

  • total_page_count

    全ページ数

  • items

    取引先情報の配列
    配列の中身の情報部分については、以下を参照してください。

items
  • id

    取引先のID

  • team_id

    チームのID

  • name

    取引先の名称

  • description optional

    取引先の備考


curl --basic -u api_token:${APIトークン} \
  "https://api.clock-it.com/v1/teams/1/clients"

#レスポンス
{
  "per_page": 100,
  "page": 1,
  "total_count": 1,
  "total_page_count": 1,
  "items": [
    {
      "id": 1,
      "team_id": 1,
      "name": "㈱サンプルコーポレーション",
      "description": "サンプル企業です。"
    }
  ]
}
							  
							  

取引先情報の取得

指定した取引先の情報を取得します。

エンドポイント:
GET https://api.clock-it.com/v1/clients/{取引先ID}
リクエスト・パラメータ
  • なし
レスポンス・データ
  • id

    取引先のID

  • team_id

    チームのID

  • name

    取引先の名称

  • description optional

    取引先の備考


curl --basic -u api_token:${APIトークン} \
  "https://api.clock-it.com/v1/clients/1"

#レスポンス
{
  "id": 1,
  "team_id": 1,
  "name": "㈱サンプルコーポレーション",
  "description": "サンプル企業です。"
}
							  
							  

取引先情報の作成

指定したチームに、新規に取引先を作成します。

エンドポイント:
POST https://api.clock-it.com/v1/teams/{チームID}/clients
リクエスト・パラメータ
  • name require max-length: 100

    取引先の名称


  • description optional max-length: 1000

    取引先の備考情報



レスポンス・データ
  • id

    取引先のID

  • team_id

    チームのID

  • name

    取引先の名称

  • description optional

    取引先の備考


curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/teams/1/clients" \
		-X POST \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345" \
		--data '{
			"name": "新しい取引先",
			"description": "メモ情報"
		}'

#レスポンス
{
  "id": 2,
  "team_id": 1,
  "name": "新しい取引先",
  "description": "メモ情報"
}
							  
							  

取引先情報の更新

指定した取引先の情報を更新します。

エンドポイント:
PUT https://api.clock-it.com/v1/clients/{取引先ID}
リクエスト・パラメータ
  • name optional max-length: 100

    取引先の名称


  • description optional max-length: 1000

    取引先の備考情報



レスポンス・データ
  • id

    取引先のID

  • team_id

    チームのID

  • name

    取引先の名称

  • description optional

    取引先の備考


curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/clients/1" \
		-X PUT \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345" \
		--data '{
			"name": "新しい取引先",
			"description": "メモ情報"
		}'

#レスポンス
{
  "id": 1,
  "team_id": 1,
  "name": "新しい取引先",
  "description": "メモ情報"
}
							  
							  

取引先情報の削除

指定した取引先を削除します。

エンドポイント:
DELETE https://api.clock-it.com/v1/clients/{取引先ID}
リクエスト・パラメータ
  • なし
レスポンス・データ
  • なし
curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/clients/1" \
		-X DELETE \
		-H "X-ClockIt-RequestID: 12345"

#レスポンス
なし (204 No Content)
							  
							  

プロジェクト

プロジェクトの情報を取得・更新するAPIについて、以下に記載します。

プロジェクト一覧の取得

プロジェクトの一覧を取得します。
チームIDを指定しない場合には、非チームのプロジェクトを取得します。
チームIDを指定した場合には、指定したチームのプロジェクトを取得します。

エンドポイント:
GET https://api.clock-it.com/v1/projects
GET https://api.clock-it.com/v1/teams/{チームID}/projects
リクエスト・パラメータ
  • page optional default: 1 min: 1 max: 1

    プロジェクトの一覧取得はページング取得となります。
    何ページ目のデータを取得するかを指定します。
    このパラメータの指定は任意です。省略した場合は1が指定されます。

  • per_page optional default: 100 min: 1 max: 100

    1ページあたりのデータ件数を指定します。
    このパラメータの指定は任意です。省略した場合は100が指定されます。



  • uncompleted optional default: true

    未完了ステータスのプロジェクトを表示するかどうかを指定します。
    省略した場合、Trueが適用されます。



  • completed optional default: false

    完了ステータスのプロジェクトを表示するかどうかを指定します。
    省略した場合、Falseが適用されます。



  • joined optional default: true

    Teamプランをご利用の場合に関係があります。
    自分が参加しているプロジェクトを表示するかどうかを指定します。
    省略した場合、Trueが適用されます。




  • joined optional default: false

    Teamプランをご利用の場合に関係があります。
    自分が参加していないプロジェクトを表示するかどうかを指定します。
    省略した場合、Falseが適用されます。



レスポンス・データ
  • per_page

    1ページあたりのデータ件数

  • page

    指定したページ位置

  • total_count

    全データの件数

  • total_page_count

    全ページ数

  • items

    プロジェクト情報の配列
    配列の中身の情報部分については、以下を参照してください。

items
  • id

    プロジェクトのID

  • name

    プロジェクト名

  • description optional

    ノート情報


  • team_id optional

    チームのID



  • client_id optional

    取引先のID



  • inbox

    Inboxプロジェクトか否かのフラグ。
    InboxプロジェクトならTrue,それ以外ならFalse。

  • private

    共有プロジェクトがどうかのフラグ。
    チームプラン場合の場合のみ、共有プロジェクトが存在します。
    共有プロジェクトならTrue,非共有プロジェクトならFalse。

  • completed

    プロジェクトの完了ステータス。
    完了していたらTrue,未完了ならFalse。

  • create_at

    プロジェクトが作成された日時

  • create_member_id

    プロジェクトを作成したメンバーのID

  • aggregate_tasks

    プロジェクト内のタスクの集計情報。
    詳細については下記を参照してください。

aggregate_tasks
  • estimate_duration optional

    プロジェクト内のタスクの合計予定作業時間。単位は秒。
    ※例)予定作業時間が1時間なら「3600」となる。

    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • actual_duration

    プロジェクト内のタスクの合計実作業時間。単位は秒。

  • remain_duration optional

    プロジェクト内のタスクの合計残作業時間。単位は秒。
    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • predictional_duration optional

    プロジェクト内のタスクの合計予想残作業時間。単位は秒。
    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • expire_soon_task_count

    プロジェクト内の〆切日が近い未完了タスクの件数

  • expire_soon_task_count

    プロジェクト内の〆切日が過ぎている未完了タスクの件数

curl --basic -u api_token:${APIトークン} \
  "https://api.clock-it.com/v1/projects?page=1&per_page=100"

#レスポンス
{
  "per_page": 100,
  "page": 1,
  "total_count": 1,
  "total_page_count": 1,
  "items": [
    {
      "team_id": null,
      "id": 1,
      "name": "Inbox",
      "description": null,
      "client_id": null,
      "inbox": true,
      "private": false,
      "completed": false,
      "create_at": "2018-01-01T16:37:33Z",
      "create_member_id": 1,
      "aggregate_tasks": {
        "estimate_duration": null,
        "actual_duration": 0,
        "remain_duration": null,
        "predictional_duration": null,
        "expire_soon_task_count": 0,
        "expired_task_count": 0
      }
    }
  ]
}
							  
							  

プロジェクト情報の取得

指定したプロジェクトの情報を取得します。

エンドポイント:
GET https://api.clock-it.com/v1/projects/{プロジェクトID}
リクエスト・パラメータ
  • なし
レスポンス・データ
  • id

    プロジェクトのID

  • name

    プロジェクト名

  • description optional

    ノート情報


  • team_id optional

    チームのID



  • client_id optional

    取引先のID



  • inbox

    Inboxプロジェクトか否かのフラグ。
    InboxプロジェクトならTrue,それ以外ならFalse。

  • private

    共有プロジェクトがどうかのフラグ。
    チームプラン場合の場合のみ、共有プロジェクトが存在します。
    共有プロジェクトならTrue,非共有プロジェクトならFalse。

  • completed

    プロジェクトの完了ステータス。
    完了していたらTrue,未完了ならFalse。

  • create_at

    プロジェクトが作成された日時

  • create_member_id

    プロジェクトを作成したメンバーのID

  • aggregate_tasks

    プロジェクト内のタスクの集計情報。
    詳細については下記を参照してください。

aggregate_tasks
  • estimate_duration optional

    プロジェクト内のタスクの合計予定作業時間。単位は秒。
    ※例)予定作業時間が1時間なら「3600」となる。

    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • actual_duration

    プロジェクト内のタスクの合計実作業時間。単位は秒。

  • remain_duration optional

    プロジェクト内のタスクの合計残作業時間。単位は秒。
    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • predictional_duration optional

    プロジェクト内のタスクの合計予想残作業時間。単位は秒。
    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • expire_soon_task_count

    プロジェクト内の〆切日が近い未完了タスクの件数

  • expire_soon_task_count

    プロジェクト内の〆切日が過ぎている未完了タスクの件数

curl --basic -u api_token:${APIトークン} \
  "https://api.clock-it.com/v1/projects/1"

#レスポンス
{
  "team_id": null,
  "id": 1,
  "name": "Inbox",
  "description": null,
   "client_id": null,
   "inbox": true,
   "private": false,
   "completed": false,
   "create_at": "2018-01-01T16:37:33Z",
   "create_member_id": 1,
   "aggregate_tasks": {
     "estimate_duration": null,
     "actual_duration": 0,
     "remain_duration": null,
     "predictional_duration": null,
     "expire_soon_task_count": 0,
     "expired_task_count": 0
  }
}
							  
							  

プロジェクトの作成

新規にプロジェクトを作成します。

チームIDを指定した場合には、指定したチームにプロジェクトを作成します。
チームIDを指定しない場合には、非チームとしてプロジェクトを作成します。

エンドポイント:
POST https://api.clock-it.com/v1/projects
POST https://api.clock-it.com/v1/teams/{チームID}/projects
リクエスト・パラメータ
  • name require max-length: 100

    プロジェクト名


  • description optional max-length: 5000

    プロジェクトのノート情報



  • client_id optional

    取引先のID



レスポンス・データ
  • id

    プロジェクトのID

  • name

    プロジェクト名

  • description optional

    ノート情報


  • team_id optional

    チームのID



  • client_id optional

    取引先のID



  • inbox

    Inboxプロジェクトか否かのフラグ。
    InboxプロジェクトならTrue,それ以外ならFalse。

  • private

    共有プロジェクトがどうかのフラグ。
    チームプラン場合の場合のみ、共有プロジェクトが存在します。
    共有プロジェクトならTrue,非共有プロジェクトならFalse。

  • completed

    プロジェクトの完了ステータス。
    完了していたらTrue,未完了ならFalse。

  • create_at

    プロジェクトが作成された日時

  • create_member_id

    プロジェクトを作成したメンバーのID

  • aggregate_tasks

    プロジェクト内のタスクの集計情報。
    詳細については下記を参照してください。

aggregate_tasks
  • estimate_duration optional

    プロジェクト内のタスクの合計予定作業時間。単位は秒。
    ※例)予定作業時間が1時間なら「3600」となる。

    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • actual_duration

    プロジェクト内のタスクの合計実作業時間。単位は秒。

  • remain_duration optional

    プロジェクト内のタスクの合計残作業時間。単位は秒。
    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • predictional_duration optional

    プロジェクト内のタスクの合計予想残作業時間。単位は秒。
    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • expire_soon_task_count

    プロジェクト内の〆切日が近い未完了タスクの件数

  • expire_soon_task_count

    プロジェクト内の〆切日が過ぎている未完了タスクの件数

curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/projects" \
		-X POST \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345" \
		--data '{
			"name": "新しいプロジェクト",
			"description": "ノート情報の\n情報です"
		}'

#レスポンス
{
  "team_id": null,
  "id": 2,
  "name": "新しいプロジェクト",
  "description": "ノート情報の\n情報です",
   "client_id": null,
   "inbox": false,
   "private": false,
   "completed": false,
   "create_at": "2018-01-01T16:37:33Z",
   "create_member_id": 1,
   "aggregate_tasks": {
     "estimate_duration": null,
     "actual_duration": 0,
     "remain_duration": null,
     "predictional_duration": null,
     "expire_soon_task_count": 0,
     "expired_task_count": 0
  }
}
							  
							  

プロジェクト情報の更新

指定したプロジェクトの情報を更新します。

エンドポイント:
PUT https://api.clock-it.com/v1/projects/{プロジェクトID}
リクエスト・パラメータ
  • name optional max-length: 100

    プロジェクト名


  • description optional max-length: 5000

    プロジェクトのノート情報



  • client_id optional

    取引先のID



レスポンス・データ
  • id

    プロジェクトのID

  • name

    プロジェクト名

  • description optional

    ノート情報


  • team_id optional

    チームのID



  • client_id optional

    取引先のID



  • inbox

    Inboxプロジェクトか否かのフラグ。
    InboxプロジェクトならTrue,それ以外ならFalse。

  • private

    共有プロジェクトがどうかのフラグ。
    チームプラン場合の場合のみ、共有プロジェクトが存在します。
    共有プロジェクトならTrue,非共有プロジェクトならFalse。

  • completed

    プロジェクトの完了ステータス。
    完了していたらTrue,未完了ならFalse。

  • create_at

    プロジェクトが作成された日時

  • create_member_id

    プロジェクトを作成したメンバーのID

  • aggregate_tasks

    プロジェクト内のタスクの集計情報。
    詳細については下記を参照してください。

aggregate_tasks
  • estimate_duration optional

    プロジェクト内のタスクの合計予定作業時間。単位は秒。
    ※例)予定作業時間が1時間なら「3600」となる。

    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • actual_duration

    プロジェクト内のタスクの合計実作業時間。単位は秒。

  • remain_duration optional

    プロジェクト内のタスクの合計残作業時間。単位は秒。
    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • predictional_duration optional

    プロジェクト内のタスクの合計予想残作業時間。単位は秒。
    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • expire_soon_task_count

    プロジェクト内の〆切日が近い未完了タスクの件数

  • expire_soon_task_count

    プロジェクト内の〆切日が過ぎている未完了タスクの件数

curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/projects/2" \
		-X PUT \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345" \
		--data '{
			"name": "新しいプロジェクト",
			"description": "ノート情報の\n情報です"
		}'

#レスポンス
{
  "team_id": null,
  "id": 2,
  "name": "新しいプロジェクト",
  "description": "ノート情報の\n情報です",
   "client_id": null,
   "inbox": false,
   "private": false,
   "completed": false,
   "create_at": "2018-01-01T16:37:33Z",
   "create_member_id": 1,
   "aggregate_tasks": {
     "estimate_duration": null,
     "actual_duration": 0,
     "remain_duration": null,
     "predictional_duration": null,
     "expire_soon_task_count": 0,
     "expired_task_count": 0
  }
}
							  
							  

プロジェクトを完了する

指定したプロジェクトを完了ステータスに変更します。

エンドポイント:
PUT https://api.clock-it.com/v1/projects/{プロジェクトID}/complete
リクエスト・パラメータ
  • なし
レスポンス・データ
  • project

    完了したプロジェクトの情報。
    詳細は下記を参照してください。

  • task optional

    プロジェクトを完了した際に、作業記録中のタスクが存在していた場合には、自動的に作業記録が停止されます。
    もし作業停止したタスクがあった場合には、こちらに情報が記載されます。
    もし作業停止したタスクが無ければ、nullとなります。
    詳細は下記を参照してください。

  • time_entry optional

    プロジェクトを完了した際に、作業記録中のタスクが存在していた場合には、自動的に作業記録が停止されます。
    もし作業停止したタスクがあった場合には、停止された作業記録データの情報が記載されます。
    もし作業停止したタスクが無ければ、nullとなります。
    詳細は下記を参照してください。

project
  • id

    プロジェクトのID

  • name

    プロジェクト名

  • description optional

    ノート情報


  • team_id optional

    チームのID



  • client_id optional

    取引先のID



  • inbox

    Inboxプロジェクトか否かのフラグ。
    InboxプロジェクトならTrue,それ以外ならFalse。

  • private

    共有プロジェクトがどうかのフラグ。
    チームプラン場合の場合のみ、共有プロジェクトが存在します。
    共有プロジェクトならTrue,非共有プロジェクトならFalse。

  • completed

    プロジェクトの完了ステータス。
    完了していたらTrue,未完了ならFalse。

  • create_at

    プロジェクトが作成された日時

  • create_member_id

    プロジェクトを作成したメンバーのID

  • aggregate_tasks

    プロジェクト内のタスクの集計情報。
    詳細については下記を参照してください。

aggregate_tasks
  • estimate_duration optional

    プロジェクト内のタスクの合計予定作業時間。単位は秒。
    ※例)予定作業時間が1時間なら「3600」となる。

    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • actual_duration

    プロジェクト内のタスクの合計実作業時間。単位は秒。

  • remain_duration optional

    プロジェクト内のタスクの合計残作業時間。単位は秒。
    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • predictional_duration optional

    プロジェクト内のタスクの合計予想残作業時間。単位は秒。
    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • expire_soon_task_count

    プロジェクト内の〆切日が近い未完了タスクの件数

  • expire_soon_task_count

    プロジェクト内の〆切日が過ぎている未完了タスクの件数

task
  • id

    タスクのID

  • name

    タスク名

  • description optional

    ノート情報


  • project_id

    プロジェクトのID

  • completed

    タスクの完了ステータス。
    完了していたらTrue,未完了ならFalse。

  • tracking

    タスクが作業中かどうかのフラグ。
    作業中ならTrue,そうでなければFalse。

  • progress

    進捗率

  • create_at

    プロジェクトが作成された日時

  • create_at

    プロジェクトが作成された日時

  • create_member_id

    タスクを作成したメンバーのID

  • assigned_member_id

    担当者メンバーのID(タスクへの担当者を付与する機能を、今後提供予定です。)

  • estimate

    タスクの作業予定情報。
    詳細については下記を参照してください。

  • actual

    タスクの実作業情報。
    詳細については下記を参照してください。

  • remain

    タスクの残作業情報。
    詳細については下記を参照してください。

task.estimate
  • end optional

    〆切日



  • duration optional

    作業予定時間(単位は秒)



task.actual
  • start optional

    実作業開始日時



  • end optional

    実作業終了日時



  • duration

    実作業時間(単位は秒)



task.remain
  • actual_duration optional

    残作業時間。単位は秒。
    予定作業時間が登録されていない場合には、nullとなる。

  • predictional_duration optional

    予想残作業時間。単位は秒。
    予定作業時間が登録されていない場合には、nullとなる。

time_entry
  • id

    作業履歴のID

  • description optional

    ノート情報


  • task_id

    タスクのID

  • create_member_id

    作業したメンバーのID

  • start

    作業開始した日時

  • end optional

    作業停止した日時。
    作業をまだ停止していない場合には、nullとなる。


  • duration

    作業時間(単位は秒)

curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/projects/2/complete" \
		-X PUT \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345" \

#レスポンス
{
  "project": {
    "team_id": null,
    "id": 2,
    "name": "新しいプロジェクト",
    "description": "ノート情報の\n情報です",
     "client_id": null,
     "inbox": false,
     "private": false,
     "completed": false,
     "create_at": "2018-01-01T16:37:33Z",
     "create_member_id": 1,
     "aggregate_tasks": {
       "estimate_duration": null,
       "actual_duration": 0,
       "remain_duration": null,
       "predictional_duration": null,
       "expire_soon_task_count": 0,
       "expired_task_count": 0
    }
  },
  "task": {
	"id": 8,
	"project_id": 2,
	"name": "起動中のタスク",
	"description": null,
	"estimate": {
	  "end": null,
	  "duration": null
	},
	"actual": {
	  "start": "2014-06-02T20:12:23Z",
	  "end": "2018-01-11T21:08:48Z",
	  "duration": 3020399
    },
    "remain": {
	  "actual_duration": null,
	  "predictional_duration": null
	},
	"progress": 0,
	"completed": false,
	"complete_at": null,
	"tracking": false,
	"create_at": "2014-06-10T15:00:00Z",
	"create_member_id": 1
  },
  "time_entry": {
	"id": 1,
	"member_id": 1,
	"task_id": 8,
	"start": "2014-06-02T20:12:23Z",
	"end": "2018-01-11T21:08:47.849Z",
	"description": "起動中のタイムトラッキング",
	"duration": 113964984
  }
}
							  
							  

プロジェクトを未完了にする

指定したプロジェクトを未完了ステータスに変更します。

エンドポイント:
PUT https://api.clock-it.com/v1/projects/{プロジェクトID}/uncomplete
リクエスト・パラメータ
  • なし
レスポンス・データ
  • id

    プロジェクトのID

  • name

    プロジェクト名

  • description optional

    ノート情報


  • team_id optional

    チームのID



  • client_id optional

    取引先のID



  • inbox

    Inboxプロジェクトか否かのフラグ。
    InboxプロジェクトならTrue,それ以外ならFalse。

  • private

    共有プロジェクトがどうかのフラグ。
    チームプラン場合の場合のみ、共有プロジェクトが存在します。
    共有プロジェクトならTrue,非共有プロジェクトならFalse。

  • completed

    プロジェクトの完了ステータス。
    完了していたらTrue,未完了ならFalse。

  • create_at

    プロジェクトが作成された日時

  • create_member_id

    プロジェクトを作成したメンバーのID

  • aggregate_tasks

    プロジェクト内のタスクの集計情報。
    詳細については下記を参照してください。

aggregate_tasks
  • estimate_duration optional

    プロジェクト内のタスクの合計予定作業時間。単位は秒。
    ※例)予定作業時間が1時間なら「3600」となる。

    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • actual_duration

    プロジェクト内のタスクの合計実作業時間。単位は秒。

  • remain_duration optional

    プロジェクト内のタスクの合計残作業時間。単位は秒。
    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • predictional_duration optional

    プロジェクト内のタスクの合計予想残作業時間。単位は秒。
    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • expire_soon_task_count

    プロジェクト内の〆切日が近い未完了タスクの件数

  • expire_soon_task_count

    プロジェクト内の〆切日が過ぎている未完了タスクの件数

curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/projects/2/uncomplete" \
		-X PUT \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345" \

#レスポンス
{
  "team_id": null,
  "id": 2,
  "name": "新しいプロジェクト",
  "description": "ノート情報の\n情報です",
  "client_id": null,
  "inbox": false,
  "private": false,
  "completed": false,
  "create_at": "2018-01-01T16:37:33Z",
  "create_member_id": 1,
  "aggregate_tasks": {
     "estimate_duration": null,
     "actual_duration": 0,
     "remain_duration": null,
     "predictional_duration": null,
     "expire_soon_task_count": 0,
     "expired_task_count": 0
  }
}
							  
							  

プロジェクトを共有する

指定したプロジェクトを共有状態に変更します。

エンドポイント:
PUT https://api.clock-it.com/v1/projects/{プロジェクトID}/public
リクエスト・パラメータ
  • なし
レスポンス・データ
  • id

    プロジェクトのID

  • name

    プロジェクト名

  • description optional

    ノート情報


  • team_id optional

    チームのID



  • client_id optional

    取引先のID



  • inbox

    Inboxプロジェクトか否かのフラグ。
    InboxプロジェクトならTrue,それ以外ならFalse。

  • private

    共有プロジェクトがどうかのフラグ。
    チームプラン場合の場合のみ、共有プロジェクトが存在します。
    共有プロジェクトならTrue,非共有プロジェクトならFalse。

  • completed

    プロジェクトの完了ステータス。
    完了していたらTrue,未完了ならFalse。

  • create_at

    プロジェクトが作成された日時

  • create_member_id

    プロジェクトを作成したメンバーのID

  • aggregate_tasks

    プロジェクト内のタスクの集計情報。
    詳細については下記を参照してください。

aggregate_tasks
  • estimate_duration optional

    プロジェクト内のタスクの合計予定作業時間。単位は秒。
    ※例)予定作業時間が1時間なら「3600」となる。

    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • actual_duration

    プロジェクト内のタスクの合計実作業時間。単位は秒。

  • remain_duration optional

    プロジェクト内のタスクの合計残作業時間。単位は秒。
    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • predictional_duration optional

    プロジェクト内のタスクの合計予想残作業時間。単位は秒。
    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • expire_soon_task_count

    プロジェクト内の〆切日が近い未完了タスクの件数

  • expire_soon_task_count

    プロジェクト内の〆切日が過ぎている未完了タスクの件数

curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/projects/2/public" \
		-X PUT \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345" \

#レスポンス
{
  "team_id": null,
  "id": 2,
  "name": "新しいプロジェクト",
  "description": "ノート情報の\n情報です",
   "client_id": null,
   "inbox": false,
   "private": false,
   "completed": false,
   "create_at": "2018-01-01T16:37:33Z",
  "create_member_id": 1,
   "aggregate_tasks": {
     "estimate_duration": null,
     "actual_duration": 0,
     "remain_duration": null,
     "predictional_duration": null,
     "expire_soon_task_count": 0,
     "expired_task_count": 0
  }
}
							  
							  

プロジェクトを非共有にする

指定したプロジェクトを非共有状態に変更します。

エンドポイント:
PUT https://api.clock-it.com/v1/projects/{プロジェクトID}/private
リクエスト・パラメータ
  • なし
レスポンス・データ
  • id

    プロジェクトのID

  • name

    プロジェクト名

  • description optional

    ノート情報


  • team_id optional

    チームのID



  • client_id optional

    取引先のID



  • inbox

    Inboxプロジェクトか否かのフラグ。
    InboxプロジェクトならTrue,それ以外ならFalse。

  • private

    共有プロジェクトがどうかのフラグ。
    チームプラン場合の場合のみ、共有プロジェクトが存在します。
    共有プロジェクトならTrue,非共有プロジェクトならFalse。

  • completed

    プロジェクトの完了ステータス。
    完了していたらTrue,未完了ならFalse。

  • create_at

    プロジェクトが作成された日時

  • create_member_id

    プロジェクトを作成したメンバーのID

  • aggregate_tasks

    プロジェクト内のタスクの集計情報。
    詳細については下記を参照してください。

aggregate_tasks
  • estimate_duration optional

    プロジェクト内のタスクの合計予定作業時間。単位は秒。
    ※例)予定作業時間が1時間なら「3600」となる。

    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • actual_duration

    プロジェクト内のタスクの合計実作業時間。単位は秒。

  • remain_duration optional

    プロジェクト内のタスクの合計残作業時間。単位は秒。
    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • predictional_duration optional

    プロジェクト内のタスクの合計予想残作業時間。単位は秒。
    1つも予定作業時間が登録されているタスクが存在しない場合には、nullとなる。

  • expire_soon_task_count

    プロジェクト内の〆切日が近い未完了タスクの件数

  • expire_soon_task_count

    プロジェクト内の〆切日が過ぎている未完了タスクの件数

curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/projects/2/private" \
		-X PUT \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345" \

#レスポンス
{
  "team_id": null,
  "id": 2,
  "name": "新しいプロジェクト",
  "description": "ノート情報の\n情報です",
  "client_id": null,
  "inbox": false,
  "private": true,
  "completed": false,
  "create_at": "2018-01-01T16:37:33Z",
  "create_member_id": 1,
  "aggregate_tasks": {
     "estimate_duration": null,
     "actual_duration": 0,
     "remain_duration": null,
     "predictional_duration": null,
     "expire_soon_task_count": 0,
     "expired_task_count": 0
  }
}
							  
							  

プロジェクトの削除

指定したプロジェクトを削除します。

エンドポイント:
DELETE https://api.clock-it.com/v1/projects/{プロジェクトID}
リクエスト・パラメータ
  • なし
レスポンス・データ
  • なし
curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/projects/1" \
		-X DELETE \
		-H "X-ClockIt-RequestID: 12345"

#レスポンス
なし (204 No Content)
							  
							  

タスク

タスクの情報を取得・更新するAPIについて、以下に記載します。

タスク一覧の取得

指定したプロジェクトのタスク一覧を取得します。

エンドポイント:
GET https://api.clock-it.com/v1/projects/{プロジェクトID}/tasks
リクエスト・パラメータ
  • page optional default: 1 min: 1 max: 1

    タスクの一覧取得はページング取得となります。
    何ページ目のデータを取得するかを指定します。
    このパラメータの指定は任意です。省略した場合は1が指定されます。

  • per_page optional default: 100 min: 1 max: 100

    1ページあたりのデータ件数を指定します。
    このパラメータの指定は任意です。省略した場合は100が指定されます。



  • uncompleted optional default: true

    未完了ステータスのタスクを表示するかどうかを指定します。
    省略した場合、Trueが適用されます。



  • completed optional default: false

    完了ステータスのタスクを表示するかどうかを指定します。
    省略した場合、Falseが適用されます。



レスポンス・データ
  • per_page

    1ページあたりのデータ件数

  • page

    指定したページ位置

  • total_count

    全データの件数

  • total_page_count

    全ページ数

  • items

    タスク情報の配列
    配列の中身の情報部分については、以下を参照してください。

items
    • id

      タスクのID

    • name

      タスク名

    • description optional

      ノート情報


    • project_id

      プロジェクトのID

    • completed

      タスクの完了ステータス。
      完了していたらTrue,未完了ならFalse。

    • tracking

      タスクが作業中かどうかのフラグ。
      作業中ならTrue,そうでなければFalse。

    • progress

      進捗率

    • create_at

      プロジェクトが作成された日時

    • create_at

      プロジェクトが作成された日時

    • create_member_id

      タスクを作成したメンバーのID

    • assigned_member_id

      担当者メンバーのID(タスクへの担当者を付与する機能を、今後提供予定です。)

    • estimate

      タスクの作業予定情報。
      詳細については下記を参照してください。

    • actual

      タスクの実作業情報。
      詳細については下記を参照してください。

    • remain

      タスクの残作業情報。
      詳細については下記を参照してください。

    estimate
    • end optional

      〆切日



    • duration optional

      作業予定時間(単位は秒)



    actual
    • start optional

      実作業開始日時



    • end optional

      実作業終了日時



    • duration

      実作業時間(単位は秒)



    remain
    • actual_duration optional

      残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

    • predictional_duration optional

      予想残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

curl --basic -u api_token:${APIトークン} \
  "https://api.clock-it.com/v1/projects/2/tasks?page=1&per_page=100"

#レスポンス
{
  "per_page": 100,
  "page": 1,
  "total_count": 1,
  "total_page_count": 1,
  "items": [
	{
  	  "id": 8,
  	  "project_id": 2,
	  "name": "タスク",
	  "description": null,
	  "estimate": {
	    "end": null,
	    "duration": null
	  },
	  "actual": {
	    "start": "2014-06-02T20:12:23Z",
	    "end": "2018-01-11T21:08:48Z",
	    "duration": 3020399
      },
      "remain": {
	    "actual_duration": null,
	    "predictional_duration": null
	  },
	  "progress": 0,
	  "completed": false,
	  "complete_at": null,
	  "tracking": false,
	  "create_at": "2014-06-10T15:00:00Z",
	  "create_member_id": 1
    }
  ]
}
							  
							  

タスク情報の取得

指定したタスクの情報を取得します。

エンドポイント:
GET https://api.clock-it.com/v1/tasks/{タスクID}
リクエスト・パラメータ
  • なし
レスポンス・データ
    • id

      タスクのID

    • name

      タスク名

    • description optional

      ノート情報


    • project_id

      プロジェクトのID

    • completed

      タスクの完了ステータス。
      完了していたらTrue,未完了ならFalse。

    • tracking

      タスクが作業中かどうかのフラグ。
      作業中ならTrue,そうでなければFalse。

    • progress

      進捗率

    • create_at

      プロジェクトが作成された日時

    • create_at

      プロジェクトが作成された日時

    • create_member_id

      タスクを作成したメンバーのID

    • assigned_member_id

      担当者メンバーのID(タスクへの担当者を付与する機能を、今後提供予定です。)

    • estimate

      タスクの作業予定情報。
      詳細については下記を参照してください。

    • actual

      タスクの実作業情報。
      詳細については下記を参照してください。

    • remain

      タスクの残作業情報。
      詳細については下記を参照してください。

    estimate
    • end optional

      〆切日



    • duration optional

      作業予定時間(単位は秒)



    actual
    • start optional

      実作業開始日時



    • end optional

      実作業終了日時



    • duration

      実作業時間(単位は秒)



    remain
    • actual_duration optional

      残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

    • predictional_duration optional

      予想残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

curl --basic -u api_token:${APIトークン} \
  "https://api.clock-it.com/v1/tasks/8"

#レスポンス
{
  "id": 8,
  "project_id": 2,
  "name": "タスク",
  "description": null,
  "estimate": {
    "end": null,
    "duration": null
  },
  "actual": {
    "start": "2014-06-02T20:12:23Z",
    "end": "2018-01-11T21:08:48Z",
    "duration": 3020399
  },
  "remain": {
    "actual_duration": null,
    "predictional_duration": null
  },
  "progress": 0,
  "completed": false,
  "complete_at": null,
  "tracking": false,
  "create_at": "2014-06-10T15:00:00Z",
  "create_member_id": 1
}

							  
							  

タスクの作成

指定したプロジェクトに、新規にタスクを作成します。

エンドポイント:
POST https://api.clock-it.com/v1/projects/{プロジェクトID}/tasks
リクエスト・パラメータ
  • name require max-length: 100

    タスク名


  • description optional max-length: 10000

    タスクのノート情報



  • assigned_member_id

    担当者メンバーのID(タスクへの担当者を付与する機能を、今後提供予定です。)

  • estimate optional

    作業予定情報。
    詳細は下記を参照してください。


estimate
  • end optional

    〆切日時



  • duration optional min: 0

    作業予定時間。単位は秒。



レスポンス・データ
    • id

      タスクのID

    • name

      タスク名

    • description optional

      ノート情報


    • project_id

      プロジェクトのID

    • completed

      タスクの完了ステータス。
      完了していたらTrue,未完了ならFalse。

    • tracking

      タスクが作業中かどうかのフラグ。
      作業中ならTrue,そうでなければFalse。

    • progress

      進捗率

    • create_at

      プロジェクトが作成された日時

    • create_at

      プロジェクトが作成された日時

    • create_member_id

      タスクを作成したメンバーのID

    • assigned_member_id

      担当者メンバーのID(タスクへの担当者を付与する機能を、今後提供予定です。)

    • estimate

      タスクの作業予定情報。
      詳細については下記を参照してください。

    • actual

      タスクの実作業情報。
      詳細については下記を参照してください。

    • remain

      タスクの残作業情報。
      詳細については下記を参照してください。

    estimate
    • end optional

      〆切日



    • duration optional

      作業予定時間(単位は秒)



    actual
    • start optional

      実作業開始日時



    • end optional

      実作業終了日時



    • duration

      実作業時間(単位は秒)



    remain
    • actual_duration optional

      残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

    • predictional_duration optional

      予想残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/projects/1/tasks" \
		-X POST \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345" \
		--data '{
			"name": "新しいタスク",
			"description": "ノート情報の\n情報です",
		  	"estimate": {
		      "end": "2018-02-01T00:00:00Z",
		      "duration": 3600
	        }
		}'

#レスポンス
{
    "id": 2,
    "project_id": 1,
    "name": "新しいタスク",
    "description": "ノート情報の\n情報です",
    "estimate": {
        "end": "2018-02-01T00:00:00Z",
        "duration": 3600
    },
    "actual": {
        "start": null,
        "end": null,
        "duration": 0
    },
    "remain": {
        "actual_duration": 3600,
        "predictional_duration": null
    },
    "progress": 0,
    "completed": false,
    "complete_at": null,
    "tracking": false,
    "create_at": "2018-01-11T22:15:50Z",
    "create_member_id": 1
}
							  
							  

タスクの更新

指定したタスクの情報を更新します。

エンドポイント:
PUT https://api.clock-it.com/v1/tasks/{タスクID}
リクエスト・パラメータ
  • name require max-length: 100

    タスク名


  • description optional max-length: 10000

    タスクのノート情報



  • progress optional min: 0 max: 100

    進捗率





  • assigned_member_id

    担当者メンバーのID(タスクへの担当者を付与する機能を、今後提供予定です。)

  • estimate optional

    作業予定情報。
    詳細は下記を参照してください。


estimate
  • end optional

    〆切日時



  • duration optional min: 0

    作業予定時間。単位は秒。



レスポンス・データ
    • id

      タスクのID

    • name

      タスク名

    • description optional

      ノート情報


    • project_id

      プロジェクトのID

    • completed

      タスクの完了ステータス。
      完了していたらTrue,未完了ならFalse。

    • tracking

      タスクが作業中かどうかのフラグ。
      作業中ならTrue,そうでなければFalse。

    • progress

      進捗率

    • create_at

      プロジェクトが作成された日時

    • create_at

      プロジェクトが作成された日時

    • create_member_id

      タスクを作成したメンバーのID

    • assigned_member_id

      担当者メンバーのID(タスクへの担当者を付与する機能を、今後提供予定です。)

    • estimate

      タスクの作業予定情報。
      詳細については下記を参照してください。

    • actual

      タスクの実作業情報。
      詳細については下記を参照してください。

    • remain

      タスクの残作業情報。
      詳細については下記を参照してください。

    estimate
    • end optional

      〆切日



    • duration optional

      作業予定時間(単位は秒)



    actual
    • start optional

      実作業開始日時



    • end optional

      実作業終了日時



    • duration

      実作業時間(単位は秒)



    remain
    • actual_duration optional

      残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

    • predictional_duration optional

      予想残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/tasks/1" \
		-X PUT \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345" \
		--data '{
			"name": "新しいタスク",
			"description": "ノート情報の\n情報です",
			"progress": 50,
		  	"estimate": {
		      "end": "2018-02-01T00:00:00Z",
		      "duration": 3600
	        }
		}'

#レスポンス
{
    "id": 2,
    "project_id": 1,
    "name": "新しいタスク",
    "description": "ノート情報の\n情報です",
    "estimate": {
        "end": "2018-02-01T00:00:00Z",
        "duration": 3600
    },
    "actual": {
        "start": null,
        "end": null,
        "duration": 0
    },
    "remain": {
        "actual_duration": 3600,
        "predictional_duration": null
    },
    "progress": 50,
    "completed": false,
    "complete_at": null,
    "tracking": false,
    "create_at": "2018-01-11T22:15:50Z",
    "create_member_id": 1
}
							  
							  

タスクを作業開始する

指定したタスクを作業記録開始します。

エンドポイント:
PUT https://api.clock-it.com/v1/tasks/{タスクID}/start
リクエスト・パラメータ
  • なし
レスポンス・データ
    • start

      作業開始したタスクと、作業記録データの情報。
      詳細は下記を参照してください。

    • stop optional

      すでに他に作業中のタスクが存在していた場合には、自動的にそちらのタスクは停止されます。
      停止されたタスクがあった場合に、そのタスクと作業記録データの情報が入ります。
      詳細は下記を参照してください。

    start / stop
    • task

      開始/停止されたタスクの情報
      詳細は下記を参照してください。

    • time_entry

      開始/停止された作業記録データの情報
      詳細は下記を参照してください。

    start.task / stop.task
    • id

      タスクのID

    • name

      タスク名

    • description optional

      ノート情報


    • project_id

      プロジェクトのID

    • completed

      タスクの完了ステータス。
      完了していたらTrue,未完了ならFalse。

    • tracking

      タスクが作業中かどうかのフラグ。
      作業中ならTrue,そうでなければFalse。

    • progress

      進捗率

    • create_at

      プロジェクトが作成された日時

    • create_at

      プロジェクトが作成された日時

    • create_member_id

      タスクを作成したメンバーのID

    • assigned_member_id

      担当者メンバーのID(タスクへの担当者を付与する機能を、今後提供予定です。)

    • estimate

      タスクの作業予定情報。
      詳細については下記を参照してください。

    • actual

      タスクの実作業情報。
      詳細については下記を参照してください。

    • remain

      タスクの残作業情報。
      詳細については下記を参照してください。

    task.estimate
    • end optional

      〆切日



    • duration optional

      作業予定時間(単位は秒)



    task.actual
    • start optional

      実作業開始日時



    • end optional

      実作業終了日時



    • duration

      実作業時間(単位は秒)



    task.remain
    • actual_duration optional

      残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

    • predictional_duration optional

      予想残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

    start.time_entry / stop.time_entry
    • id

      作業履歴のID

    • description optional

      ノート情報


    • task_id

      タスクのID

    • create_member_id

      作業したメンバーのID

    • start

      作業開始した日時

    • end optional

      作業停止した日時。
      作業をまだ停止していない場合には、nullとなる。


    • duration

      作業時間(単位は秒)

curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/tasks/1/start" \
		-X PUT \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345"

#レスポンス
{
    "start": {
        "task": {
            "id": 1,
            "project_id": 10,
            "name": "タスク2",
            "description": null,
            "estimate": {
                "end": "2018-02-01T00:00:00Z",
                "duration": 3600
            },
            "actual": {
                "start": "2018-01-11T22:33:19Z",
                "end": null,
                "duration": 0
            },
            "remain": {
                "actual_duration": 3600,
                "predictional_duration": null
            },
            "progress": 0,
            "completed": false,
            "complete_at": null,
            "tracking": true,
            "create_at": "2018-01-11T22:15:50Z",
            "create_member_id": 1
        },
        "time_entry": {
            "id": 45,
            "create_member_id": 1,
            "task_id": 92,
            "start": "2018-01-11T22:33:19.403Z",
            "end": null,
            "description": null,
            "duration": 0
        }
    },
    "stop": {
        "task": {
            "id": 2,
            "project_id": 10,
            "name": "タスク1",
            "description": null,
            "estimate": {
                "end": "2018-02-01T00:00:00Z",
                "duration": 3600
            },
            "actual": {
                "start": "2018-01-11T22:32:53Z",
                "end": "2018-01-11T22:33:19Z",
                "duration": 26
            },
            "remain": {
                "actual_duration": 3574,
                "predictional_duration": null
            },
            "progress": 0,
            "completed": false,
            "complete_at": null,
            "tracking": false,
            "create_at": "2018-01-11T22:17:16Z",
            "create_member_id": 1
        },
        "time_entry": {
            "id": 44,
            "create_member_id": 1,
            "task_id": 93,
            "start": "2018-01-11T22:32:53Z",
            "end": "2018-01-11T22:33:19.403Z",
            "description": null,
            "duration": 26
        }
    }
}
							  
							  

タスクを作業停止する

指定したタスクを作業記録停止します。

エンドポイント:
PUT https://api.clock-it.com/v1/tasks/{タスクID}/stop
リクエスト・パラメータ
  • なし
レスポンス・データ
    • task

      停止されたタスクの情報
      詳細は下記を参照してください。

    • time_entry

      停止された作業記録データの情報
      詳細は下記を参照してください。

    task
    • id

      タスクのID

    • name

      タスク名

    • description optional

      ノート情報


    • project_id

      プロジェクトのID

    • completed

      タスクの完了ステータス。
      完了していたらTrue,未完了ならFalse。

    • tracking

      タスクが作業中かどうかのフラグ。
      作業中ならTrue,そうでなければFalse。

    • progress

      進捗率

    • create_at

      プロジェクトが作成された日時

    • create_at

      プロジェクトが作成された日時

    • create_member_id

      タスクを作成したメンバーのID

    • estimate

      タスクの作業予定情報。
      詳細については下記を参照してください。

    • actual

      タスクの実作業情報。
      詳細については下記を参照してください。

    • remain

      タスクの残作業情報。
      詳細については下記を参照してください。

    task.estimate
    • end optional

      〆切日



    • duration optional

      作業予定時間(単位は秒)



    task.actual
    • start optional

      実作業開始日時



    • end optional

      実作業終了日時



    • duration

      実作業時間(単位は秒)



    task.remain
    • actual_duration optional

      残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

    • predictional_duration optional

      予想残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

    time_entry
    • id

      作業履歴のID

    • description optional

      ノート情報


    • task_id

      タスクのID

    • create_member_id

      作業したメンバーのID

    • assigned_member_id

      担当者メンバーのID(タスクへの担当者を付与する機能を、今後提供予定です。)

    • start

      作業開始した日時

    • end optional

      作業停止した日時。
      作業をまだ停止していない場合には、nullとなる。


    • duration

      作業時間(単位は秒)

curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/tasks/1/stop" \
		-X PUT \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345"

#レスポンス
{
	"task": {
        "id": 2,
        "project_id": 10,
        "name": "タスク1",
        "description": null,
        "estimate": {
			"end": "2018-02-01T00:00:00Z",
			"duration": 3600
		},
		"actual": {
			"start": "2018-01-11T22:32:53Z",
			"end": "2018-01-11T22:33:19Z",
			"duration": 26
		},
		"remain": {
			"actual_duration": 3574,
			"predictional_duration": null
		},
		"progress": 0,
		"completed": false,
		"complete_at": null,
		"tracking": false,
		"create_at": "2018-01-11T22:17:16Z",
		"create_member_id": 1
	},
	"time_entry": {
		"id": 44,
		"create_member_id": 1,
		"task_id": 93,
		"start": "2018-01-11T22:32:53Z",
		"end": "2018-01-11T22:33:19.403Z",
		"description": null,
		"duration": 26
	}
}
							  
							  

タスクを完了する

指定したタスクを完了ステータスに変更します。

エンドポイント:
PUT https://api.clock-it.com/v1/tasks/{タスクID}/complete
リクエスト・パラメータ
  • なし
レスポンス・データ
    • task

      完了されたタスクの情報
      詳細は下記を参照してください。

    • time_entry optional

      もし完了ステータスに変更したタスクが作業中の場合、自動的に作業停止されます。
      作業停止された作業記録データがあった場合に、こちらに情報が記載されます。
      詳細は下記を参照してください。

    task
    • id

      タスクのID

    • name

      タスク名

    • description optional

      ノート情報


    • project_id

      プロジェクトのID

    • completed

      タスクの完了ステータス。
      完了していたらTrue,未完了ならFalse。

    • tracking

      タスクが作業中かどうかのフラグ。
      作業中ならTrue,そうでなければFalse。

    • progress

      進捗率

    • create_at

      プロジェクトが作成された日時

    • create_at

      プロジェクトが作成された日時

    • create_member_id

      タスクを作成したメンバーのID

    • assigned_member_id

      担当者メンバーのID(タスクへの担当者を付与する機能を、今後提供予定です。)

    • estimate

      タスクの作業予定情報。
      詳細については下記を参照してください。

    • actual

      タスクの実作業情報。
      詳細については下記を参照してください。

    • remain

      タスクの残作業情報。
      詳細については下記を参照してください。

    task.estimate
    • end optional

      〆切日



    • duration optional

      作業予定時間(単位は秒)



    task.actual
    • start optional

      実作業開始日時



    • end optional

      実作業終了日時



    • duration

      実作業時間(単位は秒)



    task.remain
    • actual_duration optional

      残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

    • predictional_duration optional

      予想残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

    time_entry
    • id

      作業履歴のID

    • description optional

      ノート情報


    • task_id

      タスクのID

    • create_member_id

      作業したメンバーのID

    • start

      作業開始した日時

    • end optional

      作業停止した日時。
      作業をまだ停止していない場合には、nullとなる。


    • duration

      作業時間(単位は秒)

curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/tasks/1/complete" \
		-X PUT \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345"

#レスポンス
{
	"task": {
        "id": 2,
        "project_id": 10,
        "name": "タスク1",
        "description": null,
        "estimate": {
			"end": "2018-02-01T00:00:00Z",
			"duration": 3600
		},
		"actual": {
			"start": "2018-01-11T22:32:53Z",
			"end": "2018-01-11T22:33:19Z",
			"duration": 26
		},
		"remain": {
			"actual_duration": 3574,
			"predictional_duration": null
		},
		"progress": 0,
		"completed": true,
		"complete_at": "2018-01-11T22:32:53Z",
		"tracking": false,
		"create_at": "2018-01-11T22:17:16Z",
		"create_member_id": 1
	},
	"time_entry": {
		"id": 44,
		"create_member_id": 1,
		"task_id": 93,
		"start": "2018-01-11T22:32:53Z",
		"end": "2018-01-11T22:33:19.403Z",
		"description": null,
		"duration": 26
	}
}
							  
							  

タスクを未完了にする

指定したタスクを未完了ステータスに変更します。

エンドポイント:
PUT https://api.clock-it.com/v1/tasks/{タスクID}/uncomplete
リクエスト・パラメータ
  • なし
レスポンス・データ
    • id

      タスクのID

    • name

      タスク名

    • description optional

      ノート情報


    • project_id

      プロジェクトのID

    • completed

      タスクの完了ステータス。
      完了していたらTrue,未完了ならFalse。

    • tracking

      タスクが作業中かどうかのフラグ。
      作業中ならTrue,そうでなければFalse。

    • progress

      進捗率

    • create_at

      プロジェクトが作成された日時

    • create_at

      プロジェクトが作成された日時

    • create_member_id

      タスクを作成したメンバーのID

    • assigned_member_id

      担当者メンバーのID(タスクへの担当者を付与する機能を、今後提供予定です。)

    • estimate

      タスクの作業予定情報。
      詳細については下記を参照してください。

    • actual

      タスクの実作業情報。
      詳細については下記を参照してください。

    • remain

      タスクの残作業情報。
      詳細については下記を参照してください。

    estimate
    • end optional

      〆切日



    • duration optional

      作業予定時間(単位は秒)



    actual
    • start optional

      実作業開始日時



    • end optional

      実作業終了日時



    • duration

      実作業時間(単位は秒)



    remain
    • actual_duration optional

      残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

    • predictional_duration optional

      予想残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/tasks/1/uncomplete" \
		-X PUT \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345"

#レスポンス
{
	"id": 1,
	"project_id": 10,
	"name": "タスク1",
	"description": null,
	"estimate": {
		"end": "2018-02-01T00:00:00Z",
		"duration": 3600
	},
	"actual": {
		"start": "2018-01-11T22:32:53Z",
		"end": "2018-01-11T22:33:19Z",
		"duration": 26
	},
	"remain": {
		"actual_duration": 3574,
		"predictional_duration": null
	},
	"progress": 0,
	"completed": false,
	"complete_at": null,
	"tracking": false,
	"create_at": "2018-01-11T22:17:16Z",
	"create_member_id": 1
}
							  
							  

タスクの削除

指定したタスクを削除します。

エンドポイント:
DELETE https://api.clock-it.com/v1/tasks/{タスクID}
リクエスト・パラメータ
  • なし
レスポンス・データ
  • なし
curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/tasks/1" \
		-X DELETE \
		-H "X-ClockIt-RequestID: 12345"

#レスポンス
なし (204 No Content)
							  
							  

作業履歴

作業履歴の情報を取得・更新するAPIについて、以下に記載します。

作業履歴一覧の取得

指定したタスクの作業履歴データの一覧を取得します。

エンドポイント:
GET https://api.clock-it.com/v1/tasks/{タスクID}/time_entries
リクエスト・パラメータ
  • page optional default: 1 min: 1 max: 1

    作業履歴の一覧取得はページング取得となります。
    何ページ目のデータを取得するかを指定します。
    このパラメータの指定は任意です。省略した場合は1が指定されます。

  • per_page optional default: 100 min: 1 max: 100

    1ページあたりのデータ件数を指定します。
    このパラメータの指定は任意です。省略した場合は100が指定されます。



レスポンス・データ
  • per_page

    1ページあたりのデータ件数

  • page

    指定したページ位置

  • total_count

    全データの件数

  • total_page_count

    全ページ数

  • items

    作業履歴データの配列
    配列の中身の情報部分については、以下を参照してください。

items
  • id

    作業履歴のID

  • description optional

    ノート情報


  • task_id

    タスクのID

  • create_member_id

    作業したメンバーのID

  • start

    作業開始した日時

  • end optional

    作業停止した日時。
    作業をまだ停止していない場合には、nullとなる。


  • duration

    作業時間(単位は秒)

curl --basic -u api_token:${APIトークン} \
  "https://api.clock-it.com/v1/tasks/1/time_entries?page=1&per_page=100"

#レスポンス
{
  "per_page": 100,
  "page": 1,
  "total_count": 1,
  "total_page_count": 1,
  "items": [
	{
		"id": 44,
		"create_member_id": 1,
		"task_id": 1,
		"start": "2018-01-11T22:32:53Z",
		"end": "2018-01-11T22:33:19.403Z",
		"description": null,
		"duration": 26
    }
  ]
}
							  
							  

作業履歴情報の取得

指定した作業履歴データの情報を取得します。

エンドポイント:
GET https://api.clock-it.com/v1/time_entries/{作業履歴ID}
リクエスト・パラメータ
  • なし
レスポンス・データ
  • id

    作業履歴のID

  • description optional

    ノート情報


  • task_id

    タスクのID

  • create_member_id

    作業したメンバーのID

  • start

    作業開始した日時

  • end optional

    作業停止した日時。
    作業をまだ停止していない場合には、nullとなる。


  • duration

    作業時間(単位は秒)

curl --basic -u api_token:${APIトークン} \
  "https://api.clock-it.com/v1/time_entries/1"

#レスポンス
{
	"id": 1,
	"create_member_id": 1,
	"task_id": 1,
	"start": "2018-01-11T22:32:53Z",
	"end": "2018-01-11T22:33:19.403Z",
	"description": null,
	"duration": 26
}
							  
							  

作業履歴の作成

指定したタスクに、新規に作業履歴を作成します。

エンドポイント:
POST https://api.clock-it.com/v1/tasks/{タスクID}/time_entries
リクエスト・パラメータ
  • start require

    作業開始日時
    ※未来の日時は指定出来ません。

  • end require

    作業停止日時
    ※未来の日時は指定出来ません。
    ※startよりも後の日時しか指定出来ません。

  • description optional max-length: 10000

    ノート情報



レスポンス・データ
    • task

      タスクの情報。
      詳細は下記を参照してください。

    • time_entry optional

      作成された作業履歴の情報。
      詳細は下記を参照してください。

    task
    • id

      タスクのID

    • name

      タスク名

    • description optional

      ノート情報


    • project_id

      プロジェクトのID

    • completed

      タスクの完了ステータス。
      完了していたらTrue,未完了ならFalse。

    • tracking

      タスクが作業中かどうかのフラグ。
      作業中ならTrue,そうでなければFalse。

    • progress

      進捗率

    • create_at

      プロジェクトが作成された日時

    • create_at

      プロジェクトが作成された日時

    • create_member_id

      タスクを作成したメンバーのID

    • assigned_member_id

      担当者メンバーのID(タスクへの担当者を付与する機能を、今後提供予定です。)

    • estimate

      タスクの作業予定情報。
      詳細については下記を参照してください。

    • actual

      タスクの実作業情報。
      詳細については下記を参照してください。

    • remain

      タスクの残作業情報。
      詳細については下記を参照してください。

    task.estimate
    • end optional

      〆切日



    • duration optional

      作業予定時間(単位は秒)



    task.actual
    • start optional

      実作業開始日時



    • end optional

      実作業終了日時



    • duration

      実作業時間(単位は秒)



    task.remain
    • actual_duration optional

      残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

    • predictional_duration optional

      予想残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

    time_entry
    • id

      作業履歴のID

    • description optional

      ノート情報


    • task_id

      タスクのID

    • create_member_id

      作業したメンバーのID

    • start

      作業開始した日時

    • end optional

      作業停止した日時。
      作業をまだ停止していない場合には、nullとなる。


    • duration

      作業時間(単位は秒)

curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/time_entries/44" \
		-X PUT \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345" \
		--data '{
		    "start": "2018-01-11T22:32:53Z",
		    "end": "2018-01-11T22:33:19.403Z",
			"description": "ノート情報の\n情報です"
		}'

#レスポンス
{
	"task": {
        "id": 1,
        "project_id": 10,
        "name": "タスク1",
        "description": null,
        "estimate": {
			"end": "2018-02-01T00:00:00Z",
			"duration": 3600
		},
		"actual": {
			"start": "2018-01-11T22:32:53Z",
			"end": "2018-01-11T22:33:19Z",
			"duration": 26
		},
		"remain": {
			"actual_duration": 3574,
			"predictional_duration": null
		},
		"progress": 0,
		"completed": true,
		"complete_at": "2018-01-11T22:32:53Z",
		"tracking": false,
		"create_at": "2018-01-11T22:17:16Z",
		"create_member_id": 1
	},
	"time_entry": {
		"id": 44,
		"create_member_id": 1,
		"task_id": 1,
		"start": "2018-01-11T22:32:53Z",
		"end": "2018-01-11T22:33:19.403Z",
		"description": "ノート情報の\n情報です",
		"duration": 26
	}
}
							  
							  

作業履歴の更新

指定した作業履歴の情報を更新します。

エンドポイント:
PUT https://api.clock-it.com/v1/time_entries/{作業履歴ID}
リクエスト・パラメータ
  • start optional

    作業開始日時
    ※未来の日時は指定出来ません。

  • end optional

    作業停止日時
    ※作業中の場合には指定出来ません。
    ※未来の日時は指定出来ません。
    ※startよりも後の日時しか指定出来ません。

  • description optional max-length: 10000

    ノート情報



レスポンス・データ
    • task

      タスクの情報。
      詳細は下記を参照してください。

    • time_entry optional

      更新された作業履歴の情報。
      詳細は下記を参照してください。

    task
    • id

      タスクのID

    • name

      タスク名

    • description optional

      ノート情報


    • project_id

      プロジェクトのID

    • completed

      タスクの完了ステータス。
      完了していたらTrue,未完了ならFalse。

    • tracking

      タスクが作業中かどうかのフラグ。
      作業中ならTrue,そうでなければFalse。

    • progress

      進捗率

    • create_at

      プロジェクトが作成された日時

    • create_at

      プロジェクトが作成された日時

    • create_member_id

      タスクを作成したメンバーのID

    • assigned_member_id

      担当者メンバーのID(タスクへの担当者を付与する機能を、今後提供予定です。)

    • estimate

      タスクの作業予定情報。
      詳細については下記を参照してください。

    • actual

      タスクの実作業情報。
      詳細については下記を参照してください。

    • remain

      タスクの残作業情報。
      詳細については下記を参照してください。

    task.estimate
    • end optional

      〆切日



    • duration optional

      作業予定時間(単位は秒)



    task.actual
    • start optional

      実作業開始日時



    • end optional

      実作業終了日時



    • duration

      実作業時間(単位は秒)



    task.remain
    • actual_duration optional

      残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

    • predictional_duration optional

      予想残作業時間。単位は秒。
      予定作業時間が登録されていない場合には、nullとなる。

    time_entry
    • id

      作業履歴のID

    • description optional

      ノート情報


    • task_id

      タスクのID

    • create_member_id

      作業したメンバーのID

    • start

      作業開始した日時

    • end optional

      作業停止した日時。
      作業をまだ停止していない場合には、nullとなる。


    • duration

      作業時間(単位は秒)

curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/tasks/1/time_entries" \
		-X PUT \
		-H "Content-Type: application/json" \
		-H "X-ClockIt-RequestID: 12345" \
		--data '{
		    "start": "2018-01-11T22:32:53Z",
		    "end": "2018-01-11T22:33:19.403Z",
			"description": "ノート情報の\n情報です"
		}'

#レスポンス
{
	"task": {
        "id": 1,
        "project_id": 10,
        "name": "タスク1",
        "description": null,
        "estimate": {
			"end": "2018-02-01T00:00:00Z",
			"duration": 3600
		},
		"actual": {
			"start": "2018-01-11T22:32:53Z",
			"end": "2018-01-11T22:33:19Z",
			"duration": 26
		},
		"remain": {
			"actual_duration": 3574,
			"predictional_duration": null
		},
		"progress": 0,
		"completed": true,
		"complete_at": "2018-01-11T22:32:53Z",
		"tracking": false,
		"create_at": "2018-01-11T22:17:16Z",
		"create_member_id": 1
	},
	"time_entry": {
		"id": 44,
		"create_member_id": 1,
		"task_id": 1,
		"start": "2018-01-11T22:32:53Z",
		"end": "2018-01-11T22:33:19.403Z",
		"description": "ノート情報の\n情報です",
		"duration": 26
	}
}
							  
							  

作業履歴の削除

指定した作業履歴を削除します。

エンドポイント:
DELETE https://api.clock-it.com/v1/time_entries/{作業履歴ID}
リクエスト・パラメータ
  • なし
レスポンス・データ
  • なし
curl --basic -u api_token:${APIトークン} \
  		"https://api.clock-it.com/v1/time_entries/1" \
		-X DELETE \
		-H "X-ClockIt-RequestID: 12345"

#レスポンス
なし (204 No Content)