{"_id":"55651fb6b893840d00444746","user":"555a5da8bcb32e19006f816f","version":{"_id":"5548466bd2c8410d006c2146","project":"5548466bd2c8410d006c2143","__v":8,"createdAt":"2015-05-05T04:26:19.796Z","releaseDate":"2015-05-05T04:26:19.796Z","categories":["5548466cd2c8410d006c2147","554a69ba0b54d30d007fe128","554a7f3338e3620d0082192e","5565162e03b6710d00916942","55651a0c65a1130d00400c2b","55651d4565a1130d00400c2f","55651e0165a1130d00400c32","5565217903b6710d0091695f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":1,"category":{"_id":"55651e0165a1130d00400c32","project":"5548466bd2c8410d006c2143","__v":6,"pages":["55651e6103b6710d00916957","55651ead65a1130d00400c33","55651fb6b893840d00444746","556523f5b60f251900703442","556524f3eb1615230053fd4d","55652555eb1615230053fd4f"],"version":"5548466bd2c8410d006c2146","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-05-27T01:29:37.594Z","from_sync":false,"order":5,"slug":"files","title":"Files"},"project":"5548466bd2c8410d006c2143","parentDoc":null,"editedParams":true,"editedParams2":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-05-27T01:36:54.851Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"var data = new FormData();\n$.each(event.target.files, function (key, value) {\n    data.append(key, value);\n});\ndata.append(\"folderId\", folderId);\n$.ajax({\n    url: 'https://api.projectmanager.com/api/v1/files.json',\n    type: 'POST',\n    data: data,\n    cache: false,\n    dataType: 'json',\n    processData: false, // Don't process the files\n    contentType: false, // Set content type to false as jQuery will tell the server its a query string request\n    headers: {apiKey: \"6120fce4-376c-4602-ad3e-e3e7480ec13d\"},\n}).done(function(data) {\n  console.log(data);\n});","language":"javascript"}]},"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"status\": \"Okay\",\n    \"file\": {\n        \"url\": \"https://secure.projectmanager.com/Share/Public/UserFile.aspx?hid=60F80&bid=c75bd554-5263-4de7-9905-656bacb24f88\",\n        \"id\": 397184,\n        \"name\": \"12%20-%201.jpg\"\n    }\n}","name":""}]},"auth":"required","params":[{"_id":"55651fb6b893840d00444747","ref":"","in":"body","required":true,"desc":"Files send by multipart/form-data, example below.","default":"","type":"string","name":"file"},{"_id":"55651fb6b893840d0044474a","ref":"","in":"body","required":false,"desc":"The folder your file will upload to.","default":"My Docs if no timesheet or project id provided, otherwise default to project root folder","type":"string","name":"folderId"},{"_id":"55651fb6b893840d00444749","ref":"","in":"body","required":false,"desc":"The task your file will belong to.","default":"","type":"string","name":"taskId"},{"_id":"55651fb6b893840d00444748","ref":"","in":"body","required":false,"desc":"The timesheet your file will belong to.","default":"","type":"string","name":"timesheetId"}],"url":"/files.json"},"isReference":false,"order":5,"body":"Returns the File resource that has just been uploaded.\n\nA File resource is represented by the following properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"Id\",\n    \"0-1\": \"The unique identifier of the File.\",\n    \"1-1\": \"The download url of the file.\",\n    \"1-0\": \"Url\",\n    \"2-0\": \"Name\",\n    \"2-1\": \"The name of the file.\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","excerpt":"Use this API to upload a file into a Folder, or attach a file against a Task or Timesheet record.","slug":"upload-a-file","type":"endpoint","title":"Upload a File"}

postUpload a File

Use this API to upload a file into a Folder, or attach a file against a Task or Timesheet record.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

file:
required
string
Files send by multipart/form-data, example below.
folderId:
stringMy Docs if no timesheet or project id provided, otherwise default to project root folder
The folder your file will upload to.
taskId:
string
The task your file will belong to.
timesheetId:
string
The timesheet your file will belong to.

Examples


Result Format


Documentation

Returns the File resource that has just been uploaded. A File resource is represented by the following properties: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "Id", "0-1": "The unique identifier of the File.", "1-1": "The download url of the file.", "1-0": "Url", "2-0": "Name", "2-1": "The name of the file." }, "cols": 2, "rows": 3 } [/block]