{ "uuid": "ca3333d2-dfb6-4bce-b62e-cb09957df13e", "lastMigration": 29, "name": "opendatasoft", "endpointPrefix": "api/v2", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "b65e331f-af35-4bc1-b120-9c455b773811", "documentation": "API entry point\n\nProvides links for:\n* catalog, your domain's list of datasets\n* opendatasoft, all datasets on the Opendatasoft network\n", "method": "get", "endpoint": "", "responses": [ { "uuid": "1d9e01f8-6311-4964-aa67-b602055f363f", "body": "{\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Provide a set of links to the most basic entry points in the API (sources)", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a3e9cbae-e04e-47aa-89fb-0366b1e30fb2", "documentation": "List of all pages from this portal.\n", "method": "get", "endpoint": "pages", "responses": [ { "uuid": "95311bff-9dd0-4400-a0c6-15ee059b640c", "body": "{\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"pages\": [\n {\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"page\": {\n \"description\": \"\",\n \"slug\": \"\",\n \"title\": {\n \"en\": \"\",\n \"fr\": \"\"\n }\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "List of all pages, each with their endpoint.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0387859d-45fd-4b3a-9aee-388f9ef9893a", "documentation": "A single page's metadata from this portal\n", "method": "get", "endpoint": "pages/:slug", "responses": [ { "uuid": "0d81e9b2-4906-4d67-9eaa-dfbb95c166cf", "body": "{\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"page\": {\n \"description\": \"\",\n \"slug\": \"\",\n \"title\": {\n \"en\": \"\",\n \"fr\": \"\"\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "A single page's metadata.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b04f6cb9-123a-4a36-8fb7-23680df298d5", "documentation": "Source entry points\n\nProvides links for the source's datasets and metadata.\n", "method": "get", "endpoint": ":source", "responses": [ { "uuid": "3ba07ea4-7e4e-4be3-9b8f-837a1023d575", "body": "{\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Provide a set of links to the basic entry points for the given source.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d89fbd55-f4ed-4b20-be0c-fea2903e5e03", "documentation": "**Deprecated, use `/datasets` instead.**\n", "method": "get", "endpoint": ":source/aggregates", "responses": [ { "uuid": "91c9ba96-ab66-4705-93b7-37c0aef27184", "body": "{\n \"aggregations\": [\n {\n \"count(*)\": 86\n }\n ],\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Aggregation result", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b6c5980b-5dc5-46e8-be55-4e83841dc2ed", "documentation": "List of available datasets, each with their endpoints, paginated.\n\nLinks provided:\n* previous page\n* next page\n* last page\n* first page\n", "method": "get", "endpoint": ":source/datasets", "responses": [ { "uuid": "6ce33f7c-0d20-4ed5-bb9c-7723e9150839", "body": "{\n \"datasets\": [\n {\n \"dataset\": {\n \"attachments\": [\n {}\n ],\n \"data_visible\": {{faker 'datatype.boolean'}},\n \"dataset_id\": \"\",\n \"features\": [\n \"\"\n ],\n \"fields\": [\n {\n \"annotations\": {},\n \"description\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"has_records\": {{faker 'datatype.boolean'}},\n \"metas\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"total_count\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "List of available datasets", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "36af6923-bd14-4583-b241-2aaef8598f18", "documentation": "List of available endpoints for the specified dataset, with metadata and endpoints.\n\nWill provide links for:\n* the attachments endpoint\n* the files endpoint\n* the records endpoint\n* the catalog endpoint\n", "method": "get", "endpoint": ":source/datasets/:dataset_id", "responses": [ { "uuid": "94913a74-2439-4683-969e-312b7720420b", "body": "{\n \"dataset\": {\n \"attachments\": [\n {}\n ],\n \"data_visible\": {{faker 'datatype.boolean'}},\n \"dataset_id\": \"\",\n \"features\": [\n \"\"\n ],\n \"fields\": [\n {\n \"annotations\": {},\n \"description\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"has_records\": {{faker 'datatype.boolean'}},\n \"metas\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The dataset", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d7e1ca5d-9cb4-4ebc-839f-458e266a5517", "documentation": "**Deprecated, use `/records` instead.**\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/aggregates", "responses": [ { "uuid": "05068ef9-7f30-4bb7-bae9-95beec565c57", "body": "{\n \"aggregations\": [\n {\n \"count(*)\": 86\n }\n ],\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Aggregation result", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e21e0f0a-b46e-4fe6-b9c1-b0c3dee1101e", "documentation": "Get list of all available attachments\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/attachments", "responses": [ { "uuid": "59efa91b-3206-4c10-89e7-9c6d8ae888ab", "body": "{\n \"attachments\": [\n {\n \"href\": \"\",\n \"metas\": {}\n }\n ],\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "List of all available attachments", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "10e68384-8415-460f-9412-82aacf58c020", "documentation": "Download attachment\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/attachments/:attachment_id", "responses": [ { "uuid": "20187ff9-47e0-4a2d-9889-72ab142a4a43", "body": "", "latency": 0, "statusCode": 200, "label": "The requested attachment", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "50ab16df-d74d-4d04-8f7e-139caa3de340", "documentation": "Export dataset in CSV format\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/exports/csv", "responses": [ { "uuid": "4a5fb322-15c7-45ff-8c6e-871b6a5fa6ec", "body": "", "latency": 0, "statusCode": 200, "label": "Return a CSV file", "headers": [{ "key": "Content-Type", "value": "text/csv" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5dc2c618-5c24-491c-a560-41f10e1a616a", "documentation": "Export dataset in GEOJSON format\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/exports/geojson", "responses": [ { "uuid": "6db613c5-6385-4525-9fb8-7516d34d2ea2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Return a GEOJSON file", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "da0b48de-55ba-43b3-b1ea-83fc61034f0a", "documentation": "Export dataset in ICAL format\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/exports/ical", "responses": [ { "uuid": "0b261719-84e4-42b8-8598-6e90dbfd3662", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Return an ICAL file", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7c2608ba-cf8d-4b8c-866f-7b381686572b", "documentation": "Export dataset in JSON format\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/exports/json", "responses": [ { "uuid": "deb390dc-1277-45bb-a76a-b301bd84ea7a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Return a JSON file", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "daf96323-650a-4950-96c3-dd4ebd6a6e28", "documentation": "Export dataset in OV2 format\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/exports/ov2", "responses": [ { "uuid": "6b75d379-f1cc-4750-933b-666b3bf4b457", "body": "", "latency": 0, "statusCode": 200, "label": "Return an ov2 file", "headers": [{ "key": "Content-Type", "value": "text/plain" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0713d64a-813c-45e6-90a1-8bf167dd7c11", "documentation": "Export dataset in Esri shapefile (shp) format\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/exports/shp", "responses": [ { "uuid": "d0f06505-044e-4582-a336-0a18a2139673", "body": "", "latency": 0, "statusCode": 200, "label": "Return a Shapefile zip", "headers": [{ "key": "Content-Type", "value": "application/zip" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4aa5b8fa-eaa8-4dcb-81cb-d5cc7fac8a1d", "documentation": "Export dataset in XLS (Excel) format\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/exports/xls", "responses": [ { "uuid": "c3eaf696-864b-484d-b2c9-69c1bb053f44", "body": "", "latency": 0, "statusCode": 200, "label": "Return an XLS file", "headers": [{ "key": "Content-Type", "value": "xls" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "30b0f426-67a5-473e-8fbb-807fd71fdaca", "documentation": "Enumerate facets values for records and return a list of values for each facet.\nCan be used to implement guided navigation in large result sets.\n\nRead [the facets documentation](https://help.opendatasoft.com/apis/ods-search-v2/#enumerating-facets-values) for more details.\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/facets", "responses": [ { "uuid": "aa5878b8-5acd-41cd-8ba3-9b401676afbb", "body": "{\n \"facets\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "Facets enumeration", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "32cdd9db-65b6-479c-bfab-4cef9da5716e", "documentation": "Create new feedback entry.\n", "method": "put", "endpoint": ":source/datasets/:dataset_id/feedback", "responses": [ { "uuid": "ae14079e-cc4f-449c-af55-f2ad131d7ae0", "body": "", "latency": 0, "statusCode": 201, "label": "Success message: {status: 'ok'}\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2aceb005-9ac5-4b72-92c0-e4b039ae55f1", "documentation": "Download file\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/files/:file_id", "responses": [ { "uuid": "ffca12f0-8237-4c7c-971a-d5ba57891c20", "body": "", "latency": 0, "statusCode": 200, "label": "The requested file, or its thumbnail (if thumbnail_size is specified)", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ec4209d3-8ce8-49c5-bee2-27275cb595d5", "documentation": "Search dataset's records.\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/records", "responses": [ { "uuid": "0b5064fb-9648-4e91-aed6-bb5b2fe8f216", "body": "{\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"records\": [\n {\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"record\": {\n \"fields\": {},\n \"id\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"timestamp\": \"\"\n }\n }\n ],\n \"total_count\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Records", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "81d7a4da-bc2a-4b25-ad26-bc563260944d", "documentation": "Retrieve a single record based on its ID.\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/records/:record_id", "responses": [ { "uuid": "039c9cbc-3c5b-4410-93d1-fd01e42ddc7c", "body": "{\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"record\": {\n \"fields\": {},\n \"id\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"timestamp\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A single record", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "969f2676-1815-4805-bdb2-7d3bc8a5f3ed", "documentation": "Get list of reuses\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/reuses", "responses": [ { "uuid": "9b58b8dd-e57e-498f-97f1-58e3131d982d", "body": "{\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"reuses\": [\n {\n \"created_at\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"thumbnail\": \"\",\n \"title\": \"\",\n \"url\": \"\",\n \"user\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"username\": \"\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "A paginated list of reuses\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d1bac397-ab30-452d-ae6c-d4cfe26587cd", "documentation": "Retrieve a single reuse based on its ID.\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/reuses/:reuse_id", "responses": [ { "uuid": "8b2e2d1c-652a-47e4-96f7-acc9ee5bc65d", "body": "{\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"reuse\": {\n \"created_at\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"thumbnail\": \"\",\n \"title\": \"\",\n \"url\": \"\",\n \"user\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"username\": \"\"\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "A paginated list of reuses\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "58c91053-d3e4-4a43-a6fa-fa27640d0161", "documentation": "List of all snapshots for this dataset.\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/snapshots", "responses": [ { "uuid": "083456f0-d34e-48b2-b835-1977522a92b5", "body": "{\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"snapshots\": [\n {\n \"created_at\": \"\",\n \"description\": \"\",\n \"href\": \"\",\n \"snapshot_id\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "List of all snapshots, each with their endpoint.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2539a330-899d-42cb-8b19-21bd42bbda26", "documentation": "List of all snapshots for this dataset.\n", "method": "get", "endpoint": ":source/datasets/:dataset_id/snapshots/:snapshot_id", "responses": [ { "uuid": "0d200edd-b461-42c8-965a-bdc5390dd49e", "body": "", "latency": 0, "statusCode": 200, "label": "The full dataset in the state it was in when the snapshot was created, in CSV", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "461833c4-f107-45b2-b38a-5c8070f1ef4d", "documentation": "Export catalog (source) in CSV format\n", "method": "get", "endpoint": ":source/exports/csv", "responses": [ { "uuid": "911633be-63c2-4454-8646-01d677fd7309", "body": "", "latency": 0, "statusCode": 200, "label": "Return a CSV file", "headers": [{ "key": "Content-Type", "value": "text/csv" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bd728bc9-3d0f-4d64-a585-04fdc5356fc9", "documentation": "Export catalog (source) in JSON format\n", "method": "get", "endpoint": ":source/exports/json", "responses": [ { "uuid": "96955b2a-37c0-4b5f-b3e1-1cfd250072b4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Return a JSON file", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "512bbd34-c743-41e3-9c07-cb76e12dabca", "documentation": "Export catalog (source) in RDF/XML format\n", "method": "get", "endpoint": ":source/exports/rdf", "responses": [ { "uuid": "f987dc76-9faf-48cb-9d09-c54c08d6933a", "body": "", "latency": 0, "statusCode": 200, "label": "Return a RDF XML file", "headers": [ { "key": "Content-Type", "value": "application/rdf+xml" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bbcb26cc-ad83-4cb3-a9e8-cfde64a861a7", "documentation": "Export catalog (source) in RSS format\n", "method": "get", "endpoint": ":source/exports/rss", "responses": [ { "uuid": "a0267774-426f-43b8-8381-3875f15f6ab8", "body": "", "latency": 0, "statusCode": 200, "label": "Return a JSON file", "headers": [{ "key": "Content-Type", "value": "text/xml" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "db37f55c-0655-43d8-9b5e-9adbd6c768ef", "documentation": "Export catalog (source) in TTL (turtle/rdf) format\n", "method": "get", "endpoint": ":source/exports/ttl", "responses": [ { "uuid": "87eb12b1-d861-4be8-a362-e0a510b2bc3b", "body": "", "latency": 0, "statusCode": 200, "label": "Return a TTL file", "headers": [{ "key": "Content-Type", "value": "text/turtle" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5cbc21c3-be43-417e-be24-8830f929a6d7", "documentation": "Export catalog (source) in XLS (Excel) format\n", "method": "get", "endpoint": ":source/exports/xls", "responses": [ { "uuid": "929a9c1c-3e6f-4698-8dfb-d16abd193aaa", "body": "", "latency": 0, "statusCode": 200, "label": "Return an XLS file", "headers": [{ "key": "Content-Type", "value": "xls" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cf3b1cd6-615a-46ad-ba5c-c9bd18d84ae5", "documentation": "Enumerate facets values for datasets and return a list of values for each facet.\nCan be used to implement guided navigation in large result sets.\n\nRead [the facets documentation](https://help.opendatasoft.com/apis/ods-search-v2/#enumerating-facets-values) for more details.\n", "method": "get", "endpoint": ":source/facets", "responses": [ { "uuid": "88a04e04-ab01-48ac-9075-301e894488b2", "body": "{\n \"facets\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "Facets enumeration", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9665c413-ce3c-44cc-928d-b16d61849ce1", "documentation": "List of available metadata templates types, each with their endpoints.\n", "method": "get", "endpoint": ":source/metadata_templates", "responses": [ { "uuid": "44afc09e-de45-4394-a224-c6736a96bea8", "body": "{\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "List of available metadata templates types", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e71afa41-a90b-4a0e-84fa-aa719dbebd07", "documentation": "List of metadata templates available for this type.\n", "method": "get", "endpoint": ":source/metadata_templates/:metadata_template_type", "responses": [ { "uuid": "a83343fe-90d6-48f8-a815-e23d7fb6363e", "body": "{\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"metadata_templates\": [\n {\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"metadata_template\": {\n \"name\": \"\",\n \"schema\": [\n {}\n ],\n \"type\": \"\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "List of metadata templates", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3d130d5d-be77-40af-9846-5cd1820e3228", "documentation": "A single metadata_template\n", "method": "get", "endpoint": ":source/metadata_templates/:metadata_template_type/:metadata_template_name", "responses": [ { "uuid": "4a23d112-d358-483c-b080-e526c658a829", "body": "{\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"metadata_template\": {\n \"name\": \"\",\n \"schema\": [\n {}\n ],\n \"type\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A metadata template selected by ID.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "b65e331f-af35-4bc1-b120-9c455b773811" }, { "type": "route", "uuid": "a3e9cbae-e04e-47aa-89fb-0366b1e30fb2" }, { "type": "route", "uuid": "0387859d-45fd-4b3a-9aee-388f9ef9893a" }, { "type": "route", "uuid": "b04f6cb9-123a-4a36-8fb7-23680df298d5" }, { "type": "route", "uuid": "d89fbd55-f4ed-4b20-be0c-fea2903e5e03" }, { "type": "route", "uuid": "b6c5980b-5dc5-46e8-be55-4e83841dc2ed" }, { "type": "route", "uuid": "36af6923-bd14-4583-b241-2aaef8598f18" }, { "type": "route", "uuid": "d7e1ca5d-9cb4-4ebc-839f-458e266a5517" }, { "type": "route", "uuid": "e21e0f0a-b46e-4fe6-b9c1-b0c3dee1101e" }, { "type": "route", "uuid": "10e68384-8415-460f-9412-82aacf58c020" }, { "type": "route", "uuid": "50ab16df-d74d-4d04-8f7e-139caa3de340" }, { "type": "route", "uuid": "5dc2c618-5c24-491c-a560-41f10e1a616a" }, { "type": "route", "uuid": "da0b48de-55ba-43b3-b1ea-83fc61034f0a" }, { "type": "route", "uuid": "7c2608ba-cf8d-4b8c-866f-7b381686572b" }, { "type": "route", "uuid": "daf96323-650a-4950-96c3-dd4ebd6a6e28" }, { "type": "route", "uuid": "0713d64a-813c-45e6-90a1-8bf167dd7c11" }, { "type": "route", "uuid": "4aa5b8fa-eaa8-4dcb-81cb-d5cc7fac8a1d" }, { "type": "route", "uuid": "30b0f426-67a5-473e-8fbb-807fd71fdaca" }, { "type": "route", "uuid": "32cdd9db-65b6-479c-bfab-4cef9da5716e" }, { "type": "route", "uuid": "2aceb005-9ac5-4b72-92c0-e4b039ae55f1" }, { "type": "route", "uuid": "ec4209d3-8ce8-49c5-bee2-27275cb595d5" }, { "type": "route", "uuid": "81d7a4da-bc2a-4b25-ad26-bc563260944d" }, { "type": "route", "uuid": "969f2676-1815-4805-bdb2-7d3bc8a5f3ed" }, { "type": "route", "uuid": "d1bac397-ab30-452d-ae6c-d4cfe26587cd" }, { "type": "route", "uuid": "58c91053-d3e4-4a43-a6fa-fa27640d0161" }, { "type": "route", "uuid": "2539a330-899d-42cb-8b19-21bd42bbda26" }, { "type": "route", "uuid": "461833c4-f107-45b2-b38a-5c8070f1ef4d" }, { "type": "route", "uuid": "bd728bc9-3d0f-4d64-a585-04fdc5356fc9" }, { "type": "route", "uuid": "512bbd34-c743-41e3-9c07-cb76e12dabca" }, { "type": "route", "uuid": "bbcb26cc-ad83-4cb3-a9e8-cfde64a861a7" }, { "type": "route", "uuid": "db37f55c-0655-43d8-9b5e-9adbd6c768ef" }, { "type": "route", "uuid": "5cbc21c3-be43-417e-be24-8830f929a6d7" }, { "type": "route", "uuid": "cf3b1cd6-615a-46ad-ba5c-c9bd18d84ae5" }, { "type": "route", "uuid": "9665c413-ce3c-44cc-928d-b16d61849ce1" }, { "type": "route", "uuid": "e71afa41-a90b-4a0e-84fa-aa719dbebd07" }, { "type": "route", "uuid": "3d130d5d-be77-40af-9846-5cd1820e3228" } ] }