{"_id":"564b498aeed7de0d003672c3","parentDoc":null,"project":"563a252d50bf950d00e09798","user":"54c7fdeae317000d007c2765","version":{"_id":"563a252d50bf950d00e0979b","__v":7,"project":"563a252d50bf950d00e09798","createdAt":"2015-11-04T15:33:01.701Z","releaseDate":"2015-11-04T15:33:01.701Z","categories":["563a252e50bf950d00e0979c","563a2a691846790d008952fe","563a3394daf1c00d00136d9b","563a3467d25e8919005f3f0c","563a347850bf950d00e097b4","570e5cec10aa423200391fb5","5890d358d6cb8e2500a3f311"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"563a252e50bf950d00e0979c","project":"563a252d50bf950d00e09798","pages":["563a252f50bf950d00e0979e","563a35ac1846790d0089532c","563d1407d8f2d20d00448d3c","563d1d3f9799fb0d0004776a","564509aa2c74cf1900da48c7","56453b7e9f3f550d00fa3c7b","564b498aeed7de0d003672c3","564b523ce5d9d61700d580e0","564b58ea1a8e610d006bfd49","564b59baee12850d00958656","564b6773d969330d00aba984","564b69b2d7b95d0d00ed050f","564b7fa8cc472d0d00da9447","564b905fa8a0ba21002ad6b1","564ba051288b1a2b00b3ae83","564ba6275cc43717009bcff1","564bb2138841060d00abb2e0","564bb74e05c99e1700161dd1","564c8ad60ddedc210051e582","564cca42d0c5b42b002305e8","564cca8ecfa4452b0019926d","564ce34f404ce53500fdb255","564cea76404ce53500fdb272","564cedb77d4d31170028dd2e","564cefc1bc81632100b10468","564cf17d1f42792b00820515","564cf5462248461700bd4017","564ddd49a8671617004e7b90","564ddf9ead1d5217003e2e18","564de1dea8671617004e7b99","564de3c11133043500f4bf96","564de669e39c4435005a1f65","564df3f16eaa3a2100868961","5655d3519347d30d00d7e8e2"],"version":"563a252d50bf950d00e0979b","__v":34,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-04T15:33:02.244Z","from_sync":false,"order":9999,"slug":"documentation","title":"Documentation"},"__v":14,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-17T15:36:42.330Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":11,"body":"[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"POST /datasources/{id}/:::at:::/enable\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Enable the specific datasource id.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"datasource.edit\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/datasources/{id}/@/enable\",\n    \"3-1\": \"id={datasource id}\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\nPOST https://app.klipfolio.com/api/1/datasources/0123456789abcdef0123456789abcdef/@/enable\n\n##Example Response\n```\n{\n\"data\": {\n     \"op_requested\":\"enable\"\n},\n\"meta\": {\n    \"status\": 200,\n    \"success\": true\n}\n}\n```\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"POST /datasources/{id}/@/disable\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Disable the specific datasource ID.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"datasource.edit\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/datasources/{id}/@/disable\",\n    \"3-1\": \"id={datasource id}\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\nPOST https://app.klipfolio.com/api/1/datasources/0123456789abcdef0123456789abcdef/@/disable\n\n##Example Response\n```\n{\n\"data\": {\n    \"op_requested\":\"disable\"\n},\n\"meta\": {\n   \"status\": 200,\n   \"success\": true\n}\n}\n```\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"POST /datasources/{id}/@/import\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Import the data source into the client account specified in the post data by the client id. The location of the newly imported data source is returned on successful completion.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"datasource.import\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/datasources/{id}/@/import\",\n    \"3-1\": \"id={datasource id}\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\nPOST https://app.klipfolio.com/api/1/datasources/abc01234567/@/import  -d \n\"{'client_id': '0123456789abcdef0123456789abcdef'}\"\n\n##Example Response\n```\n{\n \"meta\": { \"success\": true, \n \"status\": 201,\n “location”: “/datasources/abc01234567”},\n \"data\": { \"op_requested\": \"import\" }\n}\n```\n\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"POST /datasources/{id}/@/delete_instances\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"0-1\": \"Delete instances related to a specified data source.\",\n    \"1-1\": \"datasource.delete\",\n    \"3-1\": \"last_access (optional: Unix time) Only deletes instances that haven't been accessed since the specified time. If not specified, deletes all instances of the specified data source.\\nkeep_latest_instance (boolean). Deletes all specified instances except the one most recently  accessed.\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/datasources/{id}/@/delete_instances\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\nPOST https://app.klipfolio.com/api/1/datasources/1234asdfg1234asdfg/@/delete_instances?last_access=50004\n\n##Example Response\n```\n{\n  \"meta\": {\n    \"success\": true,\n    \"status\": 200\n  },\n  \"data\": {}\n}\n```","excerpt":"Perform tasks related to the data source including refresh the data source, enable or disable the data source and import a data source.","slug":"data-source-operations","type":"basic","title":"Data Source Operations"}

Data Source Operations

Perform tasks related to the data source including refresh the data source, enable or disable the data source and import a data source.

[block:api-header] { "type": "post", "title": "POST /datasources/{id}/@/enable" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Enable the specific datasource id.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "datasource.edit", "2-1": "https://app.klipfolio.com/api/1.0/datasources/{id}/@/enable", "3-1": "id={datasource id}" }, "cols": 2, "rows": 4 } [/block] ##Example Request POST https://app.klipfolio.com/api/1/datasources/0123456789abcdef0123456789abcdef/@/enable ##Example Response ``` { "data": { "op_requested":"enable" }, "meta": { "status": 200, "success": true } } ``` [block:api-header] { "type": "post", "title": "POST /datasources/{id}/@/disable" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Disable the specific datasource ID.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "datasource.edit", "2-1": "https://app.klipfolio.com/api/1.0/datasources/{id}/@/disable", "3-1": "id={datasource id}" }, "cols": 2, "rows": 4 } [/block] ##Example Request POST https://app.klipfolio.com/api/1/datasources/0123456789abcdef0123456789abcdef/@/disable ##Example Response ``` { "data": { "op_requested":"disable" }, "meta": { "status": 200, "success": true } } ``` [block:api-header] { "type": "post", "title": "POST /datasources/{id}/@/import" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Import the data source into the client account specified in the post data by the client id. The location of the newly imported data source is returned on successful completion.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "datasource.import", "2-1": "https://app.klipfolio.com/api/1.0/datasources/{id}/@/import", "3-1": "id={datasource id}" }, "cols": 2, "rows": 4 } [/block] ##Example Request POST https://app.klipfolio.com/api/1/datasources/abc01234567/@/import -d "{'client_id': '0123456789abcdef0123456789abcdef'}" ##Example Response ``` { "meta": { "success": true, "status": 201, “location”: “/datasources/abc01234567”}, "data": { "op_requested": "import" } } ``` [block:api-header] { "type": "post", "title": "POST /datasources/{id}/@/delete_instances" } [/block] [block:parameters] { "data": { "0-0": "Description", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "0-1": "Delete instances related to a specified data source.", "1-1": "datasource.delete", "3-1": "last_access (optional: Unix time) Only deletes instances that haven't been accessed since the specified time. If not specified, deletes all instances of the specified data source.\nkeep_latest_instance (boolean). Deletes all specified instances except the one most recently accessed.", "2-1": "https://app.klipfolio.com/api/1.0/datasources/{id}/@/delete_instances" }, "cols": 2, "rows": 4 } [/block] ##Example Request POST https://app.klipfolio.com/api/1/datasources/1234asdfg1234asdfg/@/delete_instances?last_access=50004 ##Example Response ``` { "meta": { "success": true, "status": 200 }, "data": {} } ```