{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/timesheets.json","auth":"required","examples":{"codes":[{"name":"","language":"json","code":"var tsDate = $('#tsDate').val() || \"2015-04-16T00:00:00\"\nvar hours = $('#hours').val() || \"8\"\nvar data = {\n                \"adminTypeId\": null,\n                \"date\": tsDate,\n                \"hours\": hours,\n                \"projectId\": projectId,\n                \"taskId\": taskId,\n                \"resouceId\": resourceId,                \n                \"name\": null\n}\n\n$.ajax({\n      type: \"POST\", \n   \t\turl: \"/api/v1/timesheets.json\", \n   \t\tcontentType: 'application/json', \n   \t\tdataType: \"json\", \n   \t\tsuccess: worked, \n   \t\tdata: JSON.stringify(data),\n      headers: { apiKey: apiKey }\n});"}]},"method":"post","params":[{"name":"resourceId","type":"int","default":"","desc":"The unique identifier of the resource the timesheet is for.","required":true,"in":"body","ref":"","_id":"55651b27b893840d0044473e"},{"name":"projectId","type":"int","default":"","desc":"The id of the project that the time is being recorded against.","required":true,"in":"body","ref":"","_id":"55651b27b893840d0044473d"},{"name":"taskId","type":"int","default":"","desc":"The id of the Task that the time is being recorded against. The task must belong to the project  denoted by the project  Id.","required":true,"in":"body","ref":"","_id":"55651b27b893840d0044473c"},{"name":"adminTypeId","type":"int","default":"","desc":"Admin Type Id (e.g. Sick leave). If this field is specified, projectId and taskId should be empty.","required":true,"in":"body","ref":"","_id":"55651b27b893840d0044473b"},{"name":"date","type":"yyyy-mm-dd","default":"","desc":"The date that the timesheet entry is for.","required":true,"in":"body","ref":"","_id":"55651b27b893840d0044473a"},{"name":"Hours","type":"float","default":"","desc":"The number of hours recorded by the timesheet entry.","required":true,"in":"body","ref":"","_id":"55651b27b893840d00444739"},{"name":"name","type":"string","default":"","desc":"Description of the timesheet entry.","required":false,"in":"body","ref":"","_id":"55651b27b893840d00444738"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \tstatus: \"Okay\",\n \t\ttimesheet: {\n        \"adminTypeId\": null,\n        \"date\": \"2015-04-16T00:00:00\",\n        \"hours\": 8,\n        \"projectId\": projectId,\n        \"taskId\": taskId,\n        \"resouceId\": resourceId,\n        \"name\": \"Timesheet desc\"\n\t\t}\n}","name":""}]},"settings":""},"next":{"description":"","pages":[]},"title":"Create a Timesheet","type":"endpoint","slug":"add-a-timesheet","excerpt":"A Timesheet instance records the number of hours spent on Tasks and Administrative activities for a particular Resource.\n\nA Timesheet entry is for a particular day, and there can only be one Timesheet record per Resource for a particular task or admin type for a specific date.\n\nUse this API to retrieve create a Timesheet record.","body":"Use this API to retrieve create a Timesheet record.","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"55651b27b893840d00444737","category":{"sync":{"isSync":false,"url":""},"pages":["55651a9c03b6710d00916948","55651b27b893840d00444737","55651cb603b6710d0091694c","55651d35b893840d00444740","55652662eb1615230053fd54","556526c1b60f251900703445","556527157a60a419000627f7"],"title":"Timesheets","slug":"timesheets","order":4,"from_sync":false,"reference":false,"_id":"55651a0c65a1130d00400c2b","project":"5548466bd2c8410d006c2143","version":"5548466bd2c8410d006c2146","__v":7,"createdAt":"2015-05-27T01:12:44.934Z"},"editedParams":true,"githubsync":"","parentDoc":null,"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5548466cd2c8410d006c2147","554a69ba0b54d30d007fe128","554a7f3338e3620d0082192e","5565162e03b6710d00916942","55651a0c65a1130d00400c2b","55651d4565a1130d00400c2f","55651e0165a1130d00400c32","5565217903b6710d0091695f"],"_id":"5548466bd2c8410d006c2146","createdAt":"2015-05-05T04:26:19.796Z","project":"5548466bd2c8410d006c2143","__v":8,"releaseDate":"2015-05-05T04:26:19.796Z"},"project":"5548466bd2c8410d006c2143","editedParams2":true,"user":"555a5da8bcb32e19006f816f","__v":2,"createdAt":"2015-05-27T01:17:27.434Z"}

postCreate a Timesheet

A Timesheet instance records the number of hours spent on Tasks and Administrative activities for a particular Resource. A Timesheet entry is for a particular day, and there can only be one Timesheet record per Resource for a particular task or admin type for a specific date. Use this API to retrieve create a Timesheet record.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

resourceId:
required
integer
The unique identifier of the resource the timesheet is for.
projectId:
required
integer
The id of the project that the time is being recorded against.
taskId:
required
integer
The id of the Task that the time is being recorded against. The task must belong to the project denoted by the project Id.
adminTypeId:
required
integer
Admin Type Id (e.g. Sick leave). If this field is specified, projectId and taskId should be empty.
date:
required
yyyy-mm-dd
The date that the timesheet entry is for.
Hours:
required
float
The number of hours recorded by the timesheet entry.
name:
string
Description of the timesheet entry.

Examples


Result Format


Documentation

Use this API to retrieve create a Timesheet record.