{"_id":"553a9a0e69c2630d00a8563b","project":"55357364e02d480d0003c6d3","user":"55356ede6040a20d00454508","version":{"_id":"553591cd63cc650d00312925","project":"55357364e02d480d0003c6d3","__v":13,"forked_from":"55357365e02d480d0003c6d6","createdAt":"2015-04-20T23:54:53.134Z","releaseDate":"2015-04-20T23:54:53.134Z","categories":["553591cd63cc650d00312926","553591cd63cc650d00312927","5536e4d39f7f2d0d00b1cd54","5536e55c20d5ca0d0001580a","5536e6bf7fe60f0d000fd1c0","5536f5bba171250d00c00556","553a974369c2630d00a8562e","553a97c60074c80d00621c2a","553a98332af5f20d000fc32a","553a9b9869c2630d00a85642","556e0f23d02e0b190042f13d","563249b1dcc27a1700823650","5639113f049e420d00476b03","59a5dd94aaa11d003334edb4"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"__v":1,"category":{"_id":"553a98332af5f20d000fc32a","version":"553591cd63cc650d00312925","__v":2,"pages":["553a9a0e69c2630d00a8563b","553a9b8f861cb10d00e32933"],"project":"55357364e02d480d0003c6d3","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-04-24T19:23:31.834Z","from_sync":false,"order":6,"slug":"files","title":"Files"},"editedParams":true,"editedParams2":true,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-24T19:31:26.936Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"id\": \"9989e4b3-091f-4a72-bfce-efe573aed4f0\",\n  \"createdDate\": \"2015-04-09T20:05:30\",\n  \"type\": \"image/jpeg\",\n  \"link\": \"https://<Dynamically Generated URL>\",\n  \"linkExpiration\": \"2015-04-09T13:20:14.137453-07:00\"\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"name":"","code":"GET https://api.goformz.com/v2/files/9989e4b3-091f-4a72-bfce-efe573aed4f0","language":"http"}]},"method":"get","auth":"required","params":[{"_id":"553a9e760074c80d00621c30","ref":"","in":"path","required":true,"desc":"Id of the file","default":"","type":"string","name":"id"}],"url":"/files/{id}"},"isReference":false,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Get the File Summary object\"\n}\n[/block]\nMake a request to the `Files` endpoint using the HTTP GET Method and including the `id` of the file.   This will return a file summary object containing information about the file.\n\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Download the File\"\n}\n[/block]\nOnce you have obtained the file summary object, you can now use the value of the `link` property to download the file.  *Note*: that this is a temporary link, the `LinkExpiration` property indicates when the link will no longer be available.\n\n</br><a href=\"https://api.goformz.com/docs/api/explorer/index#!/Files/Files_Get\" target=\"_blank\"><img src=\"https://files.readme.io/9Z82WIZnS7mZmco8oi4u_TryItNow3.png\" style=\"margin-left:15px\" width=\"128\" height=\"42\" ></a>","excerpt":"Downloading a file is a two step process.","slug":"retrieving-a-file","type":"endpoint","title":"Retrieving a File"}

getRetrieving a File

Downloading a file is a two step process.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
Id of the file

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Get the File Summary object" } [/block] Make a request to the `Files` endpoint using the HTTP GET Method and including the `id` of the file. This will return a file summary object containing information about the file. [block:api-header] { "type": "basic", "title": "Download the File" } [/block] Once you have obtained the file summary object, you can now use the value of the `link` property to download the file. *Note*: that this is a temporary link, the `LinkExpiration` property indicates when the link will no longer be available. </br><a href="https://api.goformz.com/docs/api/explorer/index#!/Files/Files_Get" target="_blank"><img src="https://files.readme.io/9Z82WIZnS7mZmco8oi4u_TryItNow3.png" style="margin-left:15px" width="128" height="42" ></a>