{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/timestamped_exports/:id","auth":"required","settings":"","examples":{"codes":[{"language":"curl","code":"curl -X GET -d 'api_token=secret-api-token' 'https://api.fountain.com/v2/timestamped_exports/550e8400-e29b-41d4-a716-446655440000'\n\n"},{"language":"text","code":"https://www.onboardiq.com/api/v2/timestamped_exports/550e8400-e29b-41d4-a716-446655440000?api_token=secret-api-token"}]},"method":"get","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"created_at\": \"2016-04-26T02:58:21.190-07:00\",\n  \"updated_at\": \"2016-04-26T02:58:21.190-07:00\",\n  \"state\": \"finished\",\n  \"template\": {\n    \"id\": \"ecead312-c780-40f3-8380-31dee487daff\",\n    \"title\": \"National Operations Developer\"\n  },\n  \"file_url\": \"https://aaa.bbbb/export.csv\"\n}"}]},"params":[{"name":"id","type":"string","default":"550e8400-e29b-41d4-a716-446655440000","desc":"The id of the timestamped export","required":false,"in":"path","ref":"","_id":"576851c0d98cfd0e00676157"},{"name":"api_token","type":"string","default":"secret-api-token","desc":"Required if api_token is not passed in header","required":false,"in":"query","ref":"","_id":"576851c0d98cfd0e00676156"}]},"next":{"description":"","pages":[]},"title":"Download Timestamped Export","type":"endpoint","slug":"download-timestamped-export","excerpt":"","body":"## Download a timestamped export\nDownload an export that you've created specified by `id`. Obtain an `id` from [Create Timestamped Export](doc:create-timestamped-export).\n\nThe `file_url` will return an HTTP 404 until `state` is `finished`. You may decide to poll this endpoint until the file is ready.\n\n`file_url` will expire 1 week from creation. This is to ensure that your exports are up to date.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"`id` refers to the id of this export, whereas `template_id` refers to the source template. You'll use `id` to GET the export that you've created.\",\n  \"title\": \"NOTE: id vs. template_id\"\n}\n[/block]\n## Response Schema\n\n* **id**\n     * Required: no\n     * Type: string\n     * Example: \"550e8400-e29b-41d4-a716-446655440000\"\n* **created_at**\n     * Required: no\n     * Type: string\n     * Format: date-time\n     * Example: \"2016-04-26T02:58:21.190-07:00\"\n* **updated_at**\n     * Required: no\n     * Type: string\n     * Format: date-time\n     * Example: \"2016-04-26T02:58:21.190-07:00\"\n* **state**\n     * Required: no\n     * Type: string\n     * Example: \"finished\"\n* **template**\n     * Required: no\n     * additionalProperties: false\n     * **id**\n          * Required: no\n          * Type: string\n          * Example: \"ecead312-c780-40f3-8380-31dee487daff\"\n     * **title**\n          * Required: no\n          * Type: string\n          * Example: \"National Operations Developer\"\n* **file_url**\n     * Required: no\n     * Type: string\n     * Example: \"https://aaa.bbbb/export.csv\"","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59de6011debd1200240f6914","user":"547504ed59fade080004cb8b","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z"},"parentDoc":null,"project":"59de6011debd1200240f68ec","__v":8,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Export Management","slug":"exports","order":8,"from_sync":false,"reference":false,"_id":"59de6011debd1200240f68f9","__v":0,"project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","createdAt":"2016-05-24T19:12:00.251Z"},"createdAt":"2016-06-13T23:11:24.164Z","githubsync":""}

getDownload Timestamped Export


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
string550e8400-e29b-41d4-a716-446655440000
The id of the timestamped export

Query Params

api_token:
stringsecret-api-token
Required if api_token is not passed in header

Examples


Result Format


Documentation

## Download a timestamped export Download an export that you've created specified by `id`. Obtain an `id` from [Create Timestamped Export](doc:create-timestamped-export). The `file_url` will return an HTTP 404 until `state` is `finished`. You may decide to poll this endpoint until the file is ready. `file_url` will expire 1 week from creation. This is to ensure that your exports are up to date. [block:callout] { "type": "warning", "body": "`id` refers to the id of this export, whereas `template_id` refers to the source template. You'll use `id` to GET the export that you've created.", "title": "NOTE: id vs. template_id" } [/block] ## Response Schema * **id** * Required: no * Type: string * Example: "550e8400-e29b-41d4-a716-446655440000" * **created_at** * Required: no * Type: string * Format: date-time * Example: "2016-04-26T02:58:21.190-07:00" * **updated_at** * Required: no * Type: string * Format: date-time * Example: "2016-04-26T02:58:21.190-07:00" * **state** * Required: no * Type: string * Example: "finished" * **template** * Required: no * additionalProperties: false * **id** * Required: no * Type: string * Example: "ecead312-c780-40f3-8380-31dee487daff" * **title** * Required: no * Type: string * Example: "National Operations Developer" * **file_url** * Required: no * Type: string * Example: "https://aaa.bbbb/export.csv"

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}