Download OpenAPI specification:Download
Opendatasoft REST API to manage your portal and its catalog
Datasets are at the core of the platform. A dataset is composed of:
Through the Automation API, it is possible to:
List all the datasets that can be edited by this user.
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
dataset_id | string Find a dataset from its |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "uid": "da_qf2hyt",
- "dataset_id": "counties-united-states-of-america",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "is_published": false,
- "is_restricted": true,
- "metadata": {
- "default": {
- "title": {
- "value": "Counties - United States of America",
- "remote_value": "Counties - United States of America",
- "override_remote_value": false
}, - "description": {
- "value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "remote_value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "override_remote_value": false
}, - "keyword": {
- "value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "remote_value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "override_remote_value": false
}, - "modified": {
- "value": "2023-01-01T00:00:00Z",
- "remote_value": "2023-01-01T00:00:00Z",
- "override_remote_value": false
}, - "modified_updates_on_metadata_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "modified_updates_on_data_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "geographic_reference": {
- "value": [
- "world_us"
], - "remote_value": [
- "world_us"
], - "override_remote_value": false
}, - "geographic_reference_auto": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "language": {
- "value": "en",
- "remote_value": "en",
- "override_remote_value": false
}, - "timezone": {
- "value": "US/Pacific",
- "remote_value": "US/Pacific",
- "override_remote_value": false
}, - "publisher": {
- "value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "remote_value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "override_remote_value": false
}, - "references": {
- "override_remote_value": false
}, - "attributions": {
- "value": [
- "U.S. Census Bureau"
], - "remote_value": [
- "U.S. Census Bureau"
], - "override_remote_value": false
}
}, - "visualization": { },
- "internal": {
- "license_id": {
- "value": "38js5ao",
- "remote_value": "38js5ao",
- "override_remote_value": false
}, - "theme_id": {
- "value": [
- "38js5ao"
], - "remote_value": [
- "38js5ao"
], - "override_remote_value": false
}, - "draft": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}
}, - "custom_template_name": {
- "field_name_1": {
- "value": "field_value_1"
}, - "field_name_2": {
- "value": "field_value_2",
- "override_remote_value": true
}
}
}, - "default_security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}
}
]
}
Create a dataset.
dataset_id | string non-empty Human-readable identifier of the dataset that can be modified when the dataset is not published |
is_restricted | boolean Defines if the dataset is visible for anonymous visitors.
|
required | object (DatasetMetadata) The data describing the dataset itself. |
object (DatasetSecurity) The dataset default security ruleset when the dataset is restricted. This ruleset applies to all users who do not have any ruleset declared for them |
{- "dataset_id": "counties-united-states-of-america",
- "is_restricted": true,
- "metadata": {
- "default": {
- "title": {
- "value": "Counties - United States of America",
- "remote_value": "Counties - United States of America",
- "override_remote_value": false
}, - "description": {
- "value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "remote_value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "override_remote_value": false
}, - "keyword": {
- "value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "remote_value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "override_remote_value": false
}, - "modified": {
- "value": "2023-01-01T00:00:00Z",
- "remote_value": "2023-01-01T00:00:00Z",
- "override_remote_value": false
}, - "modified_updates_on_metadata_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "modified_updates_on_data_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "geographic_reference": {
- "value": [
- "world_us"
], - "remote_value": [
- "world_us"
], - "override_remote_value": false
}, - "geographic_reference_auto": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "language": {
- "value": "en",
- "remote_value": "en",
- "override_remote_value": false
}, - "timezone": {
- "value": "US/Pacific",
- "remote_value": "US/Pacific",
- "override_remote_value": false
}, - "publisher": {
- "value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "remote_value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "override_remote_value": false
}, - "references": {
- "override_remote_value": false
}, - "attributions": {
- "value": [
- "U.S. Census Bureau"
], - "remote_value": [
- "U.S. Census Bureau"
], - "override_remote_value": false
}
}, - "visualization": { },
- "internal": {
- "license_id": {
- "value": "38js5ao",
- "remote_value": "38js5ao",
- "override_remote_value": false
}, - "theme_id": {
- "value": [
- "38js5ao"
], - "remote_value": [
- "38js5ao"
], - "override_remote_value": false
}, - "draft": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}
}, - "custom_template_name": {
- "field_name_1": {
- "value": "field_value_1"
}, - "field_name_2": {
- "value": "field_value_2",
- "override_remote_value": true
}
}
}, - "default_security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}
}
{- "uid": "da_qf2hyt",
- "dataset_id": "counties-united-states-of-america",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "is_published": false,
- "is_restricted": true,
- "metadata": {
- "default": {
- "title": {
- "value": "Counties - United States of America",
- "remote_value": "Counties - United States of America",
- "override_remote_value": false
}, - "description": {
- "value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "remote_value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "override_remote_value": false
}, - "keyword": {
- "value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "remote_value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "override_remote_value": false
}, - "modified": {
- "value": "2023-01-01T00:00:00Z",
- "remote_value": "2023-01-01T00:00:00Z",
- "override_remote_value": false
}, - "modified_updates_on_metadata_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "modified_updates_on_data_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "geographic_reference": {
- "value": [
- "world_us"
], - "remote_value": [
- "world_us"
], - "override_remote_value": false
}, - "geographic_reference_auto": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "language": {
- "value": "en",
- "remote_value": "en",
- "override_remote_value": false
}, - "timezone": {
- "value": "US/Pacific",
- "remote_value": "US/Pacific",
- "override_remote_value": false
}, - "publisher": {
- "value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "remote_value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "override_remote_value": false
}, - "references": {
- "override_remote_value": false
}, - "attributions": {
- "value": [
- "U.S. Census Bureau"
], - "remote_value": [
- "U.S. Census Bureau"
], - "override_remote_value": false
}
}, - "visualization": { },
- "internal": {
- "license_id": {
- "value": "38js5ao",
- "remote_value": "38js5ao",
- "override_remote_value": false
}, - "theme_id": {
- "value": [
- "38js5ao"
], - "remote_value": [
- "38js5ao"
], - "override_remote_value": false
}, - "draft": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}
}, - "custom_template_name": {
- "field_name_1": {
- "value": "field_value_1"
}, - "field_name_2": {
- "value": "field_value_2",
- "override_remote_value": true
}
}
}, - "default_security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}
}
Retrieve a dataset
dataset_uid required | string Example: da_qf2hyt |
{- "uid": "da_qf2hyt",
- "dataset_id": "counties-united-states-of-america",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "is_published": false,
- "is_restricted": true,
- "metadata": {
- "default": {
- "title": {
- "value": "Counties - United States of America",
- "remote_value": "Counties - United States of America",
- "override_remote_value": false
}, - "description": {
- "value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "remote_value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "override_remote_value": false
}, - "keyword": {
- "value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "remote_value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "override_remote_value": false
}, - "modified": {
- "value": "2023-01-01T00:00:00Z",
- "remote_value": "2023-01-01T00:00:00Z",
- "override_remote_value": false
}, - "modified_updates_on_metadata_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "modified_updates_on_data_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "geographic_reference": {
- "value": [
- "world_us"
], - "remote_value": [
- "world_us"
], - "override_remote_value": false
}, - "geographic_reference_auto": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "language": {
- "value": "en",
- "remote_value": "en",
- "override_remote_value": false
}, - "timezone": {
- "value": "US/Pacific",
- "remote_value": "US/Pacific",
- "override_remote_value": false
}, - "publisher": {
- "value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "remote_value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "override_remote_value": false
}, - "references": {
- "override_remote_value": false
}, - "attributions": {
- "value": [
- "U.S. Census Bureau"
], - "remote_value": [
- "U.S. Census Bureau"
], - "override_remote_value": false
}
}, - "visualization": { },
- "internal": {
- "license_id": {
- "value": "38js5ao",
- "remote_value": "38js5ao",
- "override_remote_value": false
}, - "theme_id": {
- "value": [
- "38js5ao"
], - "remote_value": [
- "38js5ao"
], - "override_remote_value": false
}, - "draft": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}
}, - "custom_template_name": {
- "field_name_1": {
- "value": "field_value_1"
}, - "field_name_2": {
- "value": "field_value_2",
- "override_remote_value": true
}
}
}, - "default_security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}
}
Update a dataset
dataset_uid required | string Example: da_qf2hyt |
dataset_id | string non-empty Human-readable identifier of the dataset that can be modified when the dataset is not published |
is_restricted | boolean Defines if the dataset is visible for anonymous visitors.
|
required | object (DatasetMetadata) The data describing the dataset itself. |
object (DatasetSecurity) The dataset default security ruleset when the dataset is restricted. This ruleset applies to all users who do not have any ruleset declared for them |
{- "dataset_id": "counties-united-states-of-america",
- "is_restricted": true,
- "metadata": {
- "default": {
- "title": {
- "value": "Counties - United States of America",
- "remote_value": "Counties - United States of America",
- "override_remote_value": false
}, - "description": {
- "value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "remote_value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "override_remote_value": false
}, - "keyword": {
- "value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "remote_value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "override_remote_value": false
}, - "modified": {
- "value": "2023-01-01T00:00:00Z",
- "remote_value": "2023-01-01T00:00:00Z",
- "override_remote_value": false
}, - "modified_updates_on_metadata_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "modified_updates_on_data_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "geographic_reference": {
- "value": [
- "world_us"
], - "remote_value": [
- "world_us"
], - "override_remote_value": false
}, - "geographic_reference_auto": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "language": {
- "value": "en",
- "remote_value": "en",
- "override_remote_value": false
}, - "timezone": {
- "value": "US/Pacific",
- "remote_value": "US/Pacific",
- "override_remote_value": false
}, - "publisher": {
- "value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "remote_value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "override_remote_value": false
}, - "references": {
- "override_remote_value": false
}, - "attributions": {
- "value": [
- "U.S. Census Bureau"
], - "remote_value": [
- "U.S. Census Bureau"
], - "override_remote_value": false
}
}, - "visualization": { },
- "internal": {
- "license_id": {
- "value": "38js5ao",
- "remote_value": "38js5ao",
- "override_remote_value": false
}, - "theme_id": {
- "value": [
- "38js5ao"
], - "remote_value": [
- "38js5ao"
], - "override_remote_value": false
}, - "draft": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}
}, - "custom_template_name": {
- "field_name_1": {
- "value": "field_value_1"
}, - "field_name_2": {
- "value": "field_value_2",
- "override_remote_value": true
}
}
}, - "default_security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}
}
{- "uid": "da_qf2hyt",
- "dataset_id": "counties-united-states-of-america",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "is_published": false,
- "is_restricted": true,
- "metadata": {
- "default": {
- "title": {
- "value": "Counties - United States of America",
- "remote_value": "Counties - United States of America",
- "override_remote_value": false
}, - "description": {
- "value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "remote_value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "override_remote_value": false
}, - "keyword": {
- "value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "remote_value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "override_remote_value": false
}, - "modified": {
- "value": "2023-01-01T00:00:00Z",
- "remote_value": "2023-01-01T00:00:00Z",
- "override_remote_value": false
}, - "modified_updates_on_metadata_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "modified_updates_on_data_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "geographic_reference": {
- "value": [
- "world_us"
], - "remote_value": [
- "world_us"
], - "override_remote_value": false
}, - "geographic_reference_auto": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "language": {
- "value": "en",
- "remote_value": "en",
- "override_remote_value": false
}, - "timezone": {
- "value": "US/Pacific",
- "remote_value": "US/Pacific",
- "override_remote_value": false
}, - "publisher": {
- "value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "remote_value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "override_remote_value": false
}, - "references": {
- "override_remote_value": false
}, - "attributions": {
- "value": [
- "U.S. Census Bureau"
], - "remote_value": [
- "U.S. Census Bureau"
], - "override_remote_value": false
}
}, - "visualization": { },
- "internal": {
- "license_id": {
- "value": "38js5ao",
- "remote_value": "38js5ao",
- "override_remote_value": false
}, - "theme_id": {
- "value": [
- "38js5ao"
], - "remote_value": [
- "38js5ao"
], - "override_remote_value": false
}, - "draft": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}
}, - "custom_template_name": {
- "field_name_1": {
- "value": "field_value_1"
}, - "field_name_2": {
- "value": "field_value_2",
- "override_remote_value": true
}
}
}, - "default_security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}
}
Make the dataset modifications available through the explore API. It may entail the processing of all the records.
dataset_uid required | string Example: da_qf2hyt |
{- "detail": "ok"
}
Stop the current processing job and keep the processed records available in the explore API.
dataset_uid required | string Example: da_qf2hyt |
{- "detail": "ok"
}
Copy a dataset
dataset_uid required | string Example: da_qf2hyt |
{- "uid": "da_qf2hyt",
- "dataset_id": "counties-united-states-of-america",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "is_published": false,
- "is_restricted": true,
- "metadata": {
- "default": {
- "title": {
- "value": "Counties - United States of America",
- "remote_value": "Counties - United States of America",
- "override_remote_value": false
}, - "description": {
- "value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "remote_value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "override_remote_value": false
}, - "keyword": {
- "value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "remote_value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "override_remote_value": false
}, - "modified": {
- "value": "2023-01-01T00:00:00Z",
- "remote_value": "2023-01-01T00:00:00Z",
- "override_remote_value": false
}, - "modified_updates_on_metadata_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "modified_updates_on_data_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "geographic_reference": {
- "value": [
- "world_us"
], - "remote_value": [
- "world_us"
], - "override_remote_value": false
}, - "geographic_reference_auto": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "language": {
- "value": "en",
- "remote_value": "en",
- "override_remote_value": false
}, - "timezone": {
- "value": "US/Pacific",
- "remote_value": "US/Pacific",
- "override_remote_value": false
}, - "publisher": {
- "value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "remote_value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "override_remote_value": false
}, - "references": {
- "override_remote_value": false
}, - "attributions": {
- "value": [
- "U.S. Census Bureau"
], - "remote_value": [
- "U.S. Census Bureau"
], - "override_remote_value": false
}
}, - "visualization": { },
- "internal": {
- "license_id": {
- "value": "38js5ao",
- "remote_value": "38js5ao",
- "override_remote_value": false
}, - "theme_id": {
- "value": [
- "38js5ao"
], - "remote_value": [
- "38js5ao"
], - "override_remote_value": false
}, - "draft": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}
}, - "custom_template_name": {
- "field_name_1": {
- "value": "field_value_1"
}, - "field_name_2": {
- "value": "field_value_2",
- "override_remote_value": true
}
}
}, - "default_security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}
}
Retrieves the current dataset status.
The dataset status describes the current state of a dataset, stating if it's published or not and the running operation. It is a finite state machine, with the following properties:
dataset_uid required | string Example: da_qf2hyt |
{- "status": "idle",
- "previous": "processing",
- "next": null,
- "since": "2019-08-24T14:15:22Z",
- "is_published": true,
- "message": null,
- "records_errors": [ ],
- "params": { }
}
[- {
- "type": "jsonfile",
- "label": "JSON File",
- "parameters": [
- [
- {
- "type": "boolean",
- "is_mandatory": false,
- "name": "extract_filename",
- "label": "Extract filename",
- "description": "Extract the filename in a field"
}, - {
- "type": "string",
- "is_mandatory": false,
- "name": "json_root",
- "label": "JSON root",
- "description": "Path to the JSON array that contains the objects that will become the dataset records"
}, - {
- "type": "string",
- "is_mandatory": false,
- "name": "json_object",
- "label": "JSON object",
- "description": "Relative path to the JSON object to extract"
}
]
]
}
]
List all resources that are linked to a dataset.
dataset_uid required | string Example: da_qf2hyt |
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
expand | string Enum: "datasource.connection" "datasource.dataset" The list of fields to expand. |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "uid": "re_qf2hyt",
- "type": "csvfile",
- "title": "Fromages",
- "extraction_infos": {
- "label": "CSV File",
- "type": "csvfile"
}, - "origin": {
- "label": "HTTP",
- "type": "http"
}, - "params": {
- "doublequote": true,
- "encoding": "utf-8",
- "first_row_no": 1,
- "headers_first_row": true,
- "separator": ";"
}, - "datasource": {
- "type": "http",
- "connection": {
- "uid": "co_qf2hyt"
}, - "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "relative_url": "/fromages.csv"
}, - "updated_at": "2022-01-01T00:00:00Z"
}
]
}
Create a new resource for the dataset. For now the supported resources in the API are HTTP, (s)FTP, uploaded files, S3, Azure Blob Storage, dataset federation, Snowflake, JCDecaux, Sharepoint and Google Drive.
dataset_uid required | string Example: da_qf2hyt |
type required | string non-empty Extractor type that should handle this resource |
title required | string non-empty User defined title for identifying the resource |
params | object Parameters passed to the extractor |
required | object (Datasource) |
{- "type": "csvfile",
- "title": "fromages.csv",
- "params": {
- "doublequote": true,
- "encoding": "utf-8",
- "first_row_no": 1,
- "headers_first_row": true,
- "separator": ";"
}, - "datasource": {
- "type": "http",
- "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "relative_url": "/fromages.csv"
}
}
{- "uid": "re_qf2hyt",
- "type": "csvfile",
- "title": "Fromages",
- "extraction_infos": {
- "label": "CSV File",
- "type": "csvfile"
}, - "origin": {
- "label": "HTTP",
- "type": "http"
}, - "params": {
- "doublequote": true,
- "encoding": "utf-8",
- "first_row_no": 1,
- "headers_first_row": true,
- "separator": ";"
}, - "datasource": {
- "type": "http",
- "connection": {
- "uid": "co_qf2hyt"
}, - "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "relative_url": "/fromages.csv"
}, - "updated_at": "2022-01-01T00:00:00Z"
}
Guess the resource extractors
dataset_uid required | string Example: da_qf2hyt |
required | object (Datasource) |
{- "datasource": {
- "type": "http",
- "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "relative_url": "/fromages.csv"
}
}
[- {
- "type": "jsonfile",
- "label": "JSON File",
- "parameters": [
- [
- {
- "type": "boolean",
- "is_mandatory": false,
- "name": "extract_filename",
- "label": "Extract filename",
- "description": "Extract the filename in a field"
}, - {
- "type": "string",
- "is_mandatory": false,
- "name": "json_root",
- "label": "JSON root",
- "description": "Path to the JSON array that contains the objects that will become the dataset records"
}, - {
- "type": "string",
- "is_mandatory": false,
- "name": "json_object",
- "label": "JSON object",
- "description": "Relative path to the JSON object to extract"
}
]
]
}
]
Guess the extractor parameters
dataset_uid required | string Example: da_qf2hyt |
required | object (Datasource) |
type required | string |
{- "datasource": {
- "type": "http",
- "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "relative_url": "/fromages.csv"
}, - "type": "csvfile"
}
{- "extractor": "csvfile",
- "params": {
- "doublequote": true,
- "encoding": "utf-8",
- "first_row_no": 1,
- "headers_first_row": true,
- "separator": ";"
}
}
In order to test a resource configuration, it can be useful to preview the data. This endpoint uses a resource configuration passed in the payload to generate a preview.
The preview is composed of the fields definitions and the content of the first records up to 20.
dataset_uid required | string Example: da_qf2hyt |
required | object (Datasource) |
type required | string |
object |
{- "datasource": {
- "type": "http",
- "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "relative_url": "/fromages.csv"
}, - "type": "csvfile",
- "params": {
- "doublequote": true,
- "encoding": "utf-8",
- "first_row_no": 1,
- "headers_first_row": true,
- "separator": ";"
}
}
{- "fields": [
- {
- "label": "Year",
- "name": "year",
- "type": "date",
- "annotations": [
- {
- "name": "timeserie_precision",
- "args": [
- "year"
]
}, - {
- "name": "facet"
}
]
}, - {
- "label": "Official Name State",
- "name": "ste_name",
- "type": "text",
- "annotations": [ ]
}
], - "records": [
- {
- "year": "2022",
- "ste_name": "Missouri"
}, - {
- "year": "2022",
- "ste_name": "North Carolina"
}
]
}
Retrieve one dataset resource specified by its uid
.
dataset_uid required | string Example: da_qf2hyt |
resource_uid required | string Example: re_qf2hyt |
expand | string Enum: "datasource.connection" "datasource.dataset" The list of fields to expand. |
{- "uid": "re_qf2hyt",
- "type": "csvfile",
- "title": "Fromages",
- "extraction_infos": {
- "label": "CSV File",
- "type": "csvfile"
}, - "origin": {
- "label": "HTTP",
- "type": "http"
}, - "params": {
- "doublequote": true,
- "encoding": "utf-8",
- "first_row_no": 1,
- "headers_first_row": true,
- "separator": ";"
}, - "datasource": {
- "type": "http",
- "connection": {
- "uid": "co_qf2hyt"
}, - "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "relative_url": "/fromages.csv"
}, - "updated_at": "2022-01-01T00:00:00Z"
}
Update one dataset resource specified by its uid
.
dataset_uid required | string Example: da_qf2hyt |
resource_uid required | string Example: re_qf2hyt |
type required | string non-empty Extractor type that should handle this resource |
title required | string non-empty User defined title for identifying the resource |
params | object Parameters passed to the extractor |
required | object (Datasource) |
{- "type": "csvfile",
- "title": "fromages.csv",
- "params": {
- "doublequote": true,
- "encoding": "utf-8",
- "first_row_no": 1,
- "headers_first_row": true,
- "separator": ";"
}, - "datasource": {
- "type": "http",
- "connection": {
- "uid": "co_qf2hyt"
}, - "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "relative_url": "/fromages.csv"
}
}
{- "uid": "re_qf2hyt",
- "type": "csvfile",
- "title": "Fromages",
- "extraction_infos": {
- "label": "CSV File",
- "type": "csvfile"
}, - "origin": {
- "label": "HTTP",
- "type": "http"
}, - "params": {
- "doublequote": true,
- "encoding": "utf-8",
- "first_row_no": 1,
- "headers_first_row": true,
- "separator": ";"
}, - "datasource": {
- "type": "http",
- "connection": {
- "uid": "co_qf2hyt"
}, - "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "relative_url": "/fromages.csv"
}, - "updated_at": "2022-01-01T00:00:00Z"
}
Guess the resource extractors
dataset_uid required | string Example: da_qf2hyt |
resource_uid required | string Example: re_qf2hyt |
[- {
- "type": "jsonfile",
- "label": "JSON File",
- "parameters": [
- [
- {
- "type": "boolean",
- "is_mandatory": false,
- "name": "extract_filename",
- "label": "Extract filename",
- "description": "Extract the filename in a field"
}, - {
- "type": "string",
- "is_mandatory": false,
- "name": "json_root",
- "label": "JSON root",
- "description": "Path to the JSON array that contains the objects that will become the dataset records"
}, - {
- "type": "string",
- "is_mandatory": false,
- "name": "json_object",
- "label": "JSON object",
- "description": "Relative path to the JSON object to extract"
}
]
]
}
]
Guess the resource extractor parameters
dataset_uid required | string Example: da_qf2hyt |
resource_uid required | string Example: re_qf2hyt |
{- "extractor": "csvfile",
- "params": {
- "doublequote": true,
- "encoding": "utf-8",
- "first_row_no": 1,
- "headers_first_row": true,
- "separator": ";"
}
}
In order to test a resource configuration, it can be useful to preview the data. This endpoint uses the configuration of a resource specified by its uid
to generate a preview.
The preview is composed of the fields definitions and the content of the first records up to 20.
dataset_uid required | string Example: da_qf2hyt |
resource_uid required | string Example: re_qf2hyt |
{- "fields": [
- {
- "label": "Year",
- "name": "year",
- "type": "date",
- "annotations": [
- {
- "name": "timeserie_precision",
- "args": [
- "year"
]
}, - {
- "name": "facet"
}
]
}, - {
- "label": "Official Name State",
- "name": "ste_name",
- "type": "text",
- "annotations": [ ]
}
], - "records": [
- {
- "year": "2022",
- "ste_name": "Missouri"
}, - {
- "year": "2022",
- "ste_name": "North Carolina"
}
]
}
Recover the data of a realtime resource. The dataset must be published.
dataset_uid required | string Example: da_qf2hyt |
resource_uid required | string Example: re_qf2hyt |
{- "uid": "re_qf2hyt",
- "type": "csvfile",
- "title": "Fromages",
- "extraction_infos": {
- "label": "CSV File",
- "type": "csvfile"
}, - "origin": {
- "label": "HTTP",
- "type": "http"
}, - "params": {
- "doublequote": true,
- "encoding": "utf-8",
- "first_row_no": 1,
- "headers_first_row": true,
- "separator": ";"
}, - "datasource": {
- "type": "http",
- "connection": {
- "uid": "co_qf2hyt"
}, - "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "relative_url": "/fromages.csv"
}, - "updated_at": "2022-01-01T00:00:00Z"
}
Delete the recovered data of a realtime resource. The dataset must be published.
dataset_uid required | string Example: da_qf2hyt |
resource_uid required | string Example: re_qf2hyt |
{- "uid": "re_qf2hyt",
- "type": "csvfile",
- "title": "Fromages",
- "extraction_infos": {
- "label": "CSV File",
- "type": "csvfile"
}, - "origin": {
- "label": "HTTP",
- "type": "http"
}, - "params": {
- "doublequote": true,
- "encoding": "utf-8",
- "first_row_no": 1,
- "headers_first_row": true,
- "separator": ";"
}, - "datasource": {
- "type": "http",
- "connection": {
- "uid": "co_qf2hyt"
}, - "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "relative_url": "/fromages.csv"
}, - "updated_at": "2022-01-01T00:00:00Z"
}
Enable a realtime resource
dataset_uid required | string Example: da_qf2hyt |
resource_uid required | string Example: re_qf2hyt |
{- "uid": "re_qf2hyt",
- "type": "csvfile",
- "title": "Fromages",
- "extraction_infos": {
- "label": "CSV File",
- "type": "csvfile"
}, - "origin": {
- "label": "HTTP",
- "type": "http"
}, - "params": {
- "doublequote": true,
- "encoding": "utf-8",
- "first_row_no": 1,
- "headers_first_row": true,
- "separator": ";"
}, - "datasource": {
- "type": "http",
- "connection": {
- "uid": "co_qf2hyt"
}, - "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "relative_url": "/fromages.csv"
}, - "updated_at": "2022-01-01T00:00:00Z"
}
Disable a realtime resource
dataset_uid required | string Example: da_qf2hyt |
resource_uid required | string Example: re_qf2hyt |
{- "uid": "re_qf2hyt",
- "type": "csvfile",
- "title": "Fromages",
- "extraction_infos": {
- "label": "CSV File",
- "type": "csvfile"
}, - "origin": {
- "label": "HTTP",
- "type": "http"
}, - "params": {
- "doublequote": true,
- "encoding": "utf-8",
- "first_row_no": 1,
- "headers_first_row": true,
- "separator": ";"
}, - "datasource": {
- "type": "http",
- "connection": {
- "uid": "co_qf2hyt"
}, - "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "relative_url": "/fromages.csv"
}, - "updated_at": "2022-01-01T00:00:00Z"
}
Renew a realtime resource API key
dataset_uid required | string Example: da_qf2hyt |
resource_uid required | string Example: re_qf2hyt |
{- "uid": "re_qf2hyt",
- "type": "csvfile",
- "title": "Fromages",
- "extraction_infos": {
- "label": "CSV File",
- "type": "csvfile"
}, - "origin": {
- "label": "HTTP",
- "type": "http"
}, - "params": {
- "doublequote": true,
- "encoding": "utf-8",
- "first_row_no": 1,
- "headers_first_row": true,
- "separator": ";"
}, - "datasource": {
- "type": "http",
- "connection": {
- "uid": "co_qf2hyt"
}, - "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "relative_url": "/fromages.csv"
}, - "updated_at": "2022-01-01T00:00:00Z"
}
Upload a file to be used in a dataset resource. The HTTP request must be a multipart request with a file
property.
dataset_uid required | string Example: da_qf2hyt |
file required | string <binary> |
{- "uid": "fromages.csv",
- "filename": "fromages.csv",
- "mimetype": "text/csv",
- "created_at": "2019-08-24T14:15:22Z"
}
Retrieve a dataset resource uploaded file
dataset_uid required | string Example: da_qf2hyt |
file_uid required | string Example: fromages.csv |
{- "uid": "fromages.csv",
- "filename": "fromages.csv",
- "mimetype": "text/csv",
- "created_at": "2019-08-24T14:15:22Z"
}
Download a dataset resource file
dataset_uid required | string Example: da_qf2hyt |
file_uid required | string Example: fromages.csv |
{- "error_code": "not_found",
- "message": "Not found."
}
Metadata is data describing the dataset itself. This is a set of fields describing the data, such as a title, a description, a list of keywords, a modification date, or whether the dataset is compliant to a specific geospatial norm. Adding metadata on a dataset is important to make sure it can be found, understood, and reused by users. In some cases, it can also be important for interoperability, to make sure other systems can understand the content of the dataset.
Dataset metadata are grouped within metadata templates that you can think of as namespaces. On top of the default metadata template, you may also find (depending on your domain's configuration) the Inspire, DCAT or CitadelJSON templates. Many other templates also exist and you can contact the support to define your own templates.
Returns the set of metadata for the dataset with the given UID.
dataset_uid required | string Example: da_qf2hyt |
{- "default": {
- "title": {
- "value": "Counties - United States of America",
- "remote_value": "Counties - United States of America",
- "override_remote_value": false
}, - "description": {
- "value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "remote_value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "override_remote_value": false
}, - "keyword": {
- "value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "remote_value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "override_remote_value": false
}, - "modified": {
- "value": "2023-01-01T00:00:00Z",
- "remote_value": "2023-01-01T00:00:00Z",
- "override_remote_value": false
}, - "modified_updates_on_metadata_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "modified_updates_on_data_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "geographic_reference": {
- "value": [
- "world_us"
], - "remote_value": [
- "world_us"
], - "override_remote_value": false
}, - "geographic_reference_auto": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "language": {
- "value": "en",
- "remote_value": "en",
- "override_remote_value": false
}, - "timezone": {
- "value": "US/Pacific",
- "remote_value": "US/Pacific",
- "override_remote_value": false
}, - "publisher": {
- "value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "remote_value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "override_remote_value": false
}, - "references": {
- "override_remote_value": false
}, - "attributions": {
- "value": [
- "U.S. Census Bureau"
], - "remote_value": [
- "U.S. Census Bureau"
], - "override_remote_value": false
}
}, - "visualization": { },
- "internal": {
- "license_id": {
- "value": "38js5ao",
- "remote_value": "38js5ao",
- "override_remote_value": false
}, - "theme_id": {
- "value": [
- "38js5ao"
], - "remote_value": [
- "38js5ao"
], - "override_remote_value": false
}, - "draft": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}
}, - "custom_template_name": {
- "field_name_1": {
- "value": "field_value_1"
}, - "field_name_2": {
- "value": "field_value_2",
- "override_remote_value": true
}
}
}
Update all dataset metadata at once. This operation replaces the dataset metadata with the given payload: if a metadata is omitted, it will be removed from the dataset.
dataset_uid required | string Example: da_qf2hyt |
required | object (DatasetMetadataDefault) The standard set of metadata common to all Opendatasoft datasets. |
object (DatasetMetadataVisualization) This set of metadata is used to configure the dataset visualizations on your portal. | |
object (DatasetMetadataInternal) This set of metadata is used for dataset configuration and won't appear on your portal. | |
object (DatasetMetadataCustom) Additional values for custom metadata templates you have configured on your portal. |
{- "default": {
- "title": {
- "value": "Counties - United States of America",
- "remote_value": "Counties - United States of America",
- "override_remote_value": false
}, - "description": {
- "value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "remote_value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "override_remote_value": false
}, - "keyword": {
- "value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "remote_value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "override_remote_value": false
}, - "modified": {
- "value": "2023-01-01T00:00:00Z",
- "remote_value": "2023-01-01T00:00:00Z",
- "override_remote_value": false
}, - "modified_updates_on_metadata_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "modified_updates_on_data_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "geographic_reference": {
- "value": [
- "world_us"
], - "remote_value": [
- "world_us"
], - "override_remote_value": false
}, - "geographic_reference_auto": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "language": {
- "value": "en",
- "remote_value": "en",
- "override_remote_value": false
}, - "timezone": {
- "value": "US/Pacific",
- "remote_value": "US/Pacific",
- "override_remote_value": false
}, - "publisher": {
- "value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "remote_value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "override_remote_value": false
}, - "references": {
- "override_remote_value": false
}, - "attributions": {
- "value": [
- "U.S. Census Bureau"
], - "remote_value": [
- "U.S. Census Bureau"
], - "override_remote_value": false
}
}, - "visualization": { },
- "internal": {
- "license_id": {
- "value": "38js5ao",
- "remote_value": "38js5ao",
- "override_remote_value": false
}, - "theme_id": {
- "value": [
- "38js5ao"
], - "remote_value": [
- "38js5ao"
], - "override_remote_value": false
}, - "draft": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}
}, - "custom_template_name": {
- "field_name_1": {
- "value": "field_value_1"
}, - "field_name_2": {
- "value": "field_value_2",
- "override_remote_value": true
}
}
}
{- "default": {
- "title": {
- "value": "Counties - United States of America",
- "remote_value": "Counties - United States of America",
- "override_remote_value": false
}, - "description": {
- "value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "remote_value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "override_remote_value": false
}, - "keyword": {
- "value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "remote_value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "override_remote_value": false
}, - "modified": {
- "value": "2023-01-01T00:00:00Z",
- "remote_value": "2023-01-01T00:00:00Z",
- "override_remote_value": false
}, - "modified_updates_on_metadata_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "modified_updates_on_data_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "geographic_reference": {
- "value": [
- "world_us"
], - "remote_value": [
- "world_us"
], - "override_remote_value": false
}, - "geographic_reference_auto": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "language": {
- "value": "en",
- "remote_value": "en",
- "override_remote_value": false
}, - "timezone": {
- "value": "US/Pacific",
- "remote_value": "US/Pacific",
- "override_remote_value": false
}, - "publisher": {
- "value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "remote_value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "override_remote_value": false
}, - "references": {
- "override_remote_value": false
}, - "attributions": {
- "value": [
- "U.S. Census Bureau"
], - "remote_value": [
- "U.S. Census Bureau"
], - "override_remote_value": false
}
}, - "visualization": { },
- "internal": {
- "license_id": {
- "value": "38js5ao",
- "remote_value": "38js5ao",
- "override_remote_value": false
}, - "theme_id": {
- "value": [
- "38js5ao"
], - "remote_value": [
- "38js5ao"
], - "override_remote_value": false
}, - "draft": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}
}, - "custom_template_name": {
- "field_name_1": {
- "value": "field_value_1"
}, - "field_name_2": {
- "value": "field_value_2",
- "override_remote_value": true
}
}
}
Returns the set of metadata within the given template for the dataset.
dataset_uid required | string Example: da_qf2hyt |
template_name required | string Example: template_name Metadata template name |
{- "title": {
- "value": "Counties - United States of America",
- "remote_value": "Counties - United States of America",
- "override_remote_value": false
}, - "description": {
- "value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "remote_value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "override_remote_value": false
}, - "keyword": {
- "value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "remote_value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "override_remote_value": false
}, - "modified": {
- "value": "2023-01-01T00:00:00Z",
- "remote_value": "2023-01-01T00:00:00Z",
- "override_remote_value": false
}, - "modified_updates_on_metadata_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "modified_updates_on_data_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "geographic_reference": {
- "value": [
- "world_us"
], - "remote_value": [
- "world_us"
], - "override_remote_value": false
}, - "geographic_reference_auto": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "language": {
- "value": "en",
- "remote_value": "en",
- "override_remote_value": false
}, - "timezone": {
- "value": "US/Pacific",
- "remote_value": "US/Pacific",
- "override_remote_value": false
}, - "publisher": {
- "value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "remote_value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "override_remote_value": false
}, - "references": {
- "override_remote_value": false
}, - "attributions": {
- "value": [
- "U.S. Census Bureau"
], - "remote_value": [
- "U.S. Census Bureau"
], - "override_remote_value": false
}
}
Update dataset metadata within a given template. This operation replaces the dataset metadata with the given payload: if a metadata is omitted, it will be removed from the dataset.
dataset_uid required | string Example: da_qf2hyt |
template_name required | string Example: template_name Metadata template name |
required | object (DatasetMetadataValue) Title of the dataset. |
object (DatasetMetadataValue) Description of the dataset. | |
object (DatasetMetadataValue) Keywords to define the dataset and better find it through searches. Keywords are one of the catalog filters available in the front office of an Opendatasoft portal. | |
required | object (DatasetMetadataValue) Date indicating when the dataset was last modified. |
object (DatasetMetadataValue) If the | |
object (DatasetMetadataValue) If the | |
object (DatasetMetadataValue) Geographic References. | |
object (DatasetMetadataValue) Geographic References automatic computation. | |
required | object (DatasetMetadataValue) Language of the data in the dataset. |
object (DatasetMetadataValue) Forces the dataset visualizations to use the defined timezone for the date and datetime fields. It avoids the dataset visualizations to depend on the timezone on which the user's computer is set. | |
object (DatasetMetadataValue) Name of the person or organization who published the dataset. | |
object (DatasetMetadataValue) Link to the source of the dataset. | |
object (DatasetMetadataValue) Link to a source of the dataset that should be mentioned for legal reasons (e.g. if the license demands the mention of a specific source or organization). |
{- "title": {
- "value": "Counties - United States of America",
- "remote_value": "Counties - United States of America",
- "override_remote_value": false
}, - "description": {
- "value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "remote_value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "override_remote_value": false
}, - "keyword": {
- "value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "remote_value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "override_remote_value": false
}, - "modified": {
- "value": "2023-01-01T00:00:00Z",
- "remote_value": "2023-01-01T00:00:00Z",
- "override_remote_value": false
}, - "modified_updates_on_metadata_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "modified_updates_on_data_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "geographic_reference": {
- "value": [
- "world_us"
], - "remote_value": [
- "world_us"
], - "override_remote_value": false
}, - "geographic_reference_auto": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "language": {
- "value": "en",
- "remote_value": "en",
- "override_remote_value": false
}, - "timezone": {
- "value": "US/Pacific",
- "remote_value": "US/Pacific",
- "override_remote_value": false
}, - "publisher": {
- "value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "remote_value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "override_remote_value": false
}, - "references": {
- "override_remote_value": false
}, - "attributions": {
- "value": [
- "U.S. Census Bureau"
], - "remote_value": [
- "U.S. Census Bureau"
], - "override_remote_value": false
}
}
{- "title": {
- "value": "Counties - United States of America",
- "remote_value": "Counties - United States of America",
- "override_remote_value": false
}, - "description": {
- "value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "remote_value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "override_remote_value": false
}, - "keyword": {
- "value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "remote_value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "override_remote_value": false
}, - "modified": {
- "value": "2023-01-01T00:00:00Z",
- "remote_value": "2023-01-01T00:00:00Z",
- "override_remote_value": false
}, - "modified_updates_on_metadata_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "modified_updates_on_data_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "geographic_reference": {
- "value": [
- "world_us"
], - "remote_value": [
- "world_us"
], - "override_remote_value": false
}, - "geographic_reference_auto": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "language": {
- "value": "en",
- "remote_value": "en",
- "override_remote_value": false
}, - "timezone": {
- "value": "US/Pacific",
- "remote_value": "US/Pacific",
- "override_remote_value": false
}, - "publisher": {
- "value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "remote_value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "override_remote_value": false
}, - "references": {
- "override_remote_value": false
}, - "attributions": {
- "value": [
- "U.S. Census Bureau"
], - "remote_value": [
- "U.S. Census Bureau"
], - "override_remote_value": false
}
}
Retrieve the metadata with the given name within the given template.
dataset_uid required | string Example: da_qf2hyt |
template_name required | string Example: template_name Metadata template name |
template_field_name required | string Example: field_name Metadata template field name |
{- "value": "Metadata value",
- "remote_value": "Metadata value on the remote dataset, if there is one",
- "override_remote_value": true
}
Update the metadata with the given name within the given template.
dataset_uid required | string Example: da_qf2hyt |
template_name required | string Example: template_name Metadata template name |
template_field_name required | string Example: field_name Metadata template field name |
value required | any The effective metadata value. If the dataset is linked to a remote dataset and |
override_remote_value | boolean Defines if the remote value is overridden ( |
{- "value": "Metadata value",
- "remote_value": "Metadata value on the remote dataset, if there is one",
- "override_remote_value": true
}
{- "value": "Metadata value",
- "remote_value": "Metadata value on the remote dataset, if there is one",
- "override_remote_value": true
}
Delete the metadata with the given name within the given template.
dataset_uid required | string Example: da_qf2hyt |
template_name required | string Example: template_name Metadata template name |
template_field_name required | string Example: field_name Metadata template field name |
""
The dataset security is the set of rules that defines who (which users / groups) can access what (which metadata / records / fields) at what frequency (API calls quota) for a given this dataset.
It is defined through 3 variables:
is_restricted
dataset property.dataset/{uid}/security/
API endpoints described in this section.default_security
dataset property.List the dataset user-level security rulesets
dataset_uid required | string Example: da_qf2hyt |
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}, - "permissions": [
- "explore_restricted_dataset"
], - "user": {
- "username": "louise.data"
}
}
]
}
Create a dataset user-level security ruleset
dataset_uid required | string Example: da_qf2hyt |
object (DatasetSecurity) | |
permissions | Array of strings unique Items Enum: "explore_restricted_dataset" "edit_dataset" "publish_dataset" "manage_dataset" List of special permissions granted to the target. |
required | object (RelatedUser) The user targeted by this ruleset. |
{- "security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}, - "permissions": [
- "explore_restricted_dataset"
], - "user": {
- "username": "louise.data"
}
}
{- "security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}, - "permissions": [
- "explore_restricted_dataset"
], - "user": {
- "username": "louise.data"
}
}
Retrieve a dataset user-level security ruleset
dataset_uid required | string Example: da_qf2hyt |
username required | string Example: louise.data |
object (DatasetSecurity) | |
permissions | Array of strings unique Items Enum: "explore_restricted_dataset" "edit_dataset" "publish_dataset" "manage_dataset" List of special permissions granted to the target. |
required | object (RelatedUser) The user targeted by this ruleset. |
{- "security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}, - "permissions": [
- "explore_restricted_dataset"
], - "user": {
- "username": "louise.data"
}
}
{- "security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}, - "permissions": [
- "explore_restricted_dataset"
], - "user": {
- "username": "louise.data"
}
}
Update a dataset user-level security ruleset
dataset_uid required | string Example: da_qf2hyt |
username required | string Example: louise.data |
object (DatasetSecurity) | |
permissions | Array of strings unique Items Enum: "explore_restricted_dataset" "edit_dataset" "publish_dataset" "manage_dataset" List of special permissions granted to the target. |
required | object (RelatedUser) The user targeted by this ruleset. |
{- "security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}, - "permissions": [
- "explore_restricted_dataset"
], - "user": {
- "username": "louise.data"
}
}
{- "security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}, - "permissions": [
- "explore_restricted_dataset"
], - "user": {
- "username": "louise.data"
}
}
List the dataset group level security rulesets
dataset_uid required | string Example: da_qf2hyt |
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}, - "permissions": [
- "explore_restricted_dataset"
], - "group": {
- "uid": "content_designers"
}
}
]
}
Create a dataset group level security ruleset
dataset_uid required | string Example: da_qf2hyt |
object (DatasetSecurity) | |
permissions | Array of strings unique Items Enum: "explore_restricted_dataset" "edit_dataset" "publish_dataset" "manage_dataset" List of special permissions granted to the target. |
required | object The group targeted by this ruleset. |
{- "security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}, - "permissions": [
- "explore_restricted_dataset"
], - "group": {
- "uid": "content_designers"
}
}
{- "security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}, - "permissions": [
- "explore_restricted_dataset"
], - "group": {
- "uid": "content_designers"
}
}
Retrieve a dataset group level security ruleset
dataset_uid required | string Example: da_qf2hyt |
group_uid required | string Example: group_identifier |
object (DatasetSecurity) | |
permissions | Array of strings unique Items Enum: "explore_restricted_dataset" "edit_dataset" "publish_dataset" "manage_dataset" List of special permissions granted to the target. |
required | object The group targeted by this ruleset. |
{- "security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}, - "permissions": [
- "explore_restricted_dataset"
], - "group": {
- "uid": "content_designers"
}
}
{- "security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}, - "permissions": [
- "explore_restricted_dataset"
], - "group": {
- "uid": "content_designers"
}
}
Update a dataset group level security ruleset
dataset_uid required | string Example: da_qf2hyt |
group_uid required | string Example: group_identifier |
object (DatasetSecurity) | |
permissions | Array of strings unique Items Enum: "explore_restricted_dataset" "edit_dataset" "publish_dataset" "manage_dataset" List of special permissions granted to the target. |
required | object The group targeted by this ruleset. |
{- "security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}, - "permissions": [
- "explore_restricted_dataset"
], - "group": {
- "uid": "content_designers"
}
}
{- "security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}, - "permissions": [
- "explore_restricted_dataset"
], - "group": {
- "uid": "content_designers"
}
}
The Opendatasoft platform allows you to apply one or more processors to a dataset.
These processors are units of data transformation and other processing. Each processor represents a configurable operation that will be applied to all rows of a dataset.
Examples of what you can do with a processor include replacing text with a regex, geocoding an address into geographical coordinates, creating a new column that contains the result of a substraction between two existing columns and much more.
A general-purpose presentation of processors and their capabilities is available in the data processing documentation.
List configured processors for a dataset. Please note that it reads in the order in which processors are applied.
dataset_uid required | string Example: da_qf2hyt |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "uid": "pr_qf2hyt",
- "type": "string_replace",
- "label": "replace old value with new value",
- "field": "my_field",
- "old": "old_value",
- "new": "new_value"
}
]
}
Create a new processor for the dataset. The processor will be appended to the end of the processing stack.
dataset_uid required | string Example: da_qf2hyt |
type required | string Type of the processor |
label required | string Friendly label of the processor |
property name* additional property | any |
{- "type": "string_replace",
- "label": "replace old value with new value",
- "field": "my_field",
- "old": "old_value",
- "new": "new_value"
}
{- "uid": "pr_qf2hyt",
- "type": "string_replace",
- "label": "replace old value with new value",
- "field": "my_field",
- "old": "old_value",
- "new": "new_value"
}
Retrieve a dataset processor
dataset_uid required | string Example: da_qf2hyt |
processor_uid required | string Example: pr_qf2hyt |
{- "uid": "pr_qf2hyt",
- "type": "string_replace",
- "label": "replace old value with new value",
- "field": "my_field",
- "old": "old_value",
- "new": "new_value"
}
Update a processor in a dataset
dataset_uid required | string Example: da_qf2hyt |
processor_uid required | string Example: pr_qf2hyt |
type required | string Type of the processor |
label required | string Friendly label of the processor |
property name* additional property | any |
{- "type": "string_replace",
- "label": "replace old value with new value",
- "field": "my_field",
- "old": "old_value",
- "new": "new_value"
}
{- "uid": "pr_qf2hyt",
- "type": "string_replace",
- "label": "replace old value with new value",
- "field": "my_field",
- "old": "old_value",
- "new": "new_value"
}
List all processors available on domain.
[- {
- "uid": "pr_qf2hyt",
- "type": "string_replace",
- "label": "replace old value with new value",
- "field": "my_field",
- "old": "old_value",
- "new": "new_value"
}
]
The feedback feature allows users to suggest improvements to portal administrators. Feedback can either be about an existing record, or to request the addition of a new record in the dataset.
Feedback is an optional feature and is not activated on every Opendatasoft portal. Activation is done by a portal's administrators, and then has to be activated individually on each dataset.
List all dataset feedbacks. Archived feedbacks aren't listed by default, use the is_archived
parameter to query them.
dataset_uid required | string Example: da_qf2hyt |
record_id | string Find feedbacks made on a record with this id |
is_archived | boolean Default: 0 If true, list only archived feedbacks |
sort | string Default: "-created_at" Example: sort=created_at Sort by date of submission |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "uid": "df_qf2hyt",
- "record_id": "95969ddab924fc5db5e39c3fb2a7634f4d7dd51c",
- "user": {
- "username": "john.doe"
}, - "comment": "I like this record, it provides meanigful insights",
- "is_archived": false,
- "values": {
- "username": {
- "value": "A missing value",
- "type": "string"
}, - "age": {
- "value": 39,
- "type": "double"
}
}
}
]
}
Retrieve a dataset feedback
dataset_uid required | string Example: da_qf2hyt |
feedback_uid required | string Example: df_qf2hyt Unique identifier for the feedback |
{- "uid": "df_qf2hyt",
- "record_id": "95969ddab924fc5db5e39c3fb2a7634f4d7dd51c",
- "user": {
- "username": "john.doe"
}, - "comment": "I like this record, it provides meanigful insights",
- "is_archived": false,
- "values": {
- "username": {
- "value": "A missing value",
- "type": "string"
}, - "age": {
- "value": 39,
- "type": "double"
}
}
}
Archive a dataset feedback
dataset_uid required | string Example: da_qf2hyt |
feedback_uid required | string Example: df_qf2hyt Unique identifier for the feedback |
{- "uid": "df_qf2hyt",
- "record_id": "95969ddab924fc5db5e39c3fb2a7634f4d7dd51c",
- "user": {
- "username": "john.doe"
}, - "comment": "I like this record, it provides meanigful insights",
- "is_archived": false,
- "values": {
- "username": {
- "value": "A missing value",
- "type": "string"
}, - "age": {
- "value": 39,
- "type": "double"
}
}
}
Dataset fields can be configured using a variety of options. These options include their type, their label, whether they are a filter or not, whether they should be discarded, or even how fields are ordered.
These configuration options, collectively refered to as fields configuration, are accessed using processor-like objects.
Type of the field configuration:
rename
- Fields are identified by a technical name, and have a human-friendly label; both are editable using this configuration item.type
- Types are the most basic way of qualifying fields. Different types unlock different kinds of visualizations and agregations. Below is the list of types supported by the platform.annotate
- Annotation are a mean to configure special behavior for the fields. Some annotations are only available for certain field types. Setting the facet annotation on a field unlocks other annotations for the fielddescription
- Description are a mean to qualify and give some extra details about the content of the field. Descriptions are available when consulting the data.order
- Fields are processed and displayed in a definite order, this annotation can be used to change that order.delete
- Some fields present in the data source are not useful or redundant. This configuration item allows to discard them.List fields configurations for a dataset. Please note that it reads in the order in which processors are applied.
dataset_uid required | string Example: da_qf2hyt |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "uid": "pr_qf2hyt",
- "type": "annotate",
- "label": "Making field_id as a facet",
- "field": "field_id",
- "annotation": "facet"
}
]
}
Create a new field configuration for the dataset. The processor will be appended to the end of the fields configuration stack.
dataset_uid required | string Example: da_qf2hyt |
Create a field configuration in a dataset
type required | string non-empty |
label required | string Friendly label of the field configuration |
from_name required | string non-empty The original technical identifier |
to_name required | string non-empty The new technical identifier |
field_label required | string non-empty A user friendly label for the field |
{- "type": "rename",
- "label": "Renaming field original_field_id",
- "from_name": "original_field_id",
- "to_name": "new_field_id",
- "field_label": "New user friendly label"
}
{- "uid": "pr_qf2hyt",
- "type": "rename",
- "label": "Renaming field original_field_id",
- "from_name": "original_field_id",
- "to_name": "new_field_id",
- "field_label": "New user friendly label"
}
Retrieve a dataset field configuration
dataset_uid required | string Example: da_qf2hyt |
field_uid required | string Example: pr_qf2hyt |
{- "uid": "pr_qf2hyt",
- "type": "rename",
- "label": "Renaming field original_field_id",
- "from_name": "original_field_id",
- "to_name": "new_field_id",
- "field_label": "New user friendly label"
}
Update a field configuration in a dataset
dataset_uid required | string Example: da_qf2hyt |
field_uid required | string Example: pr_qf2hyt |
type required | string non-empty |
label required | string Friendly label of the field configuration |
from_name required | string non-empty The original technical identifier |
to_name required | string non-empty The new technical identifier |
field_label required | string non-empty A user friendly label for the field |
{- "type": "rename",
- "label": "Renaming field original_field_id",
- "from_name": "original_field_id",
- "to_name": "new_field_id",
- "field_label": "New user friendly label"
}
{- "uid": "pr_qf2hyt",
- "type": "rename",
- "label": "Renaming field original_field_id",
- "from_name": "original_field_id",
- "to_name": "new_field_id",
- "field_label": "New user friendly label"
}
List dataset schedules
dataset_uid required | string Example: da_qf2hyt |
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "uid": "sc_qf2hyt",
- "cron_schedule": "0 * * * *"
}
]
}
Create a dataset schedule
dataset_uid required | string Example: da_qf2hyt |
cron_schedule required | string non-empty The schedule using the unix-cron string format |
{- "cron_schedule": "0 * * * *"
}
{- "uid": "sc_qf2hyt",
- "cron_schedule": "0 * * * *"
}
Retrieve a dataset schedule
dataset_uid required | string Example: da_qf2hyt |
schedule_uid required | string Example: sc_qf2hyt |
{- "uid": "sc_qf2hyt",
- "cron_schedule": "0 * * * *"
}
Update a dataset schedule
dataset_uid required | string Example: da_qf2hyt |
schedule_uid required | string Example: sc_qf2hyt |
cron_schedule required | string non-empty The schedule using the unix-cron string format |
{- "cron_schedule": "0 * * * *"
}
{- "uid": "sc_qf2hyt",
- "cron_schedule": "0 * * * *"
}
The versions of a dataset describe subsequent changes of states that affected the different sections of a dataset.
Every action taken on any resource through POST, PUT or DELETE creates a version object that can be retrieved and acted upon.
List the dataset versions.
Note: only the last 20 versions of a dataset are stored in the platform database. For this reason, the API response will contain at most 20 results.
dataset_uid required | string Example: da_qf2hyt |
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "uid": "ch_qf2hyt",
- "sections": [
- "data"
], - "created_by": {
- "username": "louise.data"
}, - "can_restore": true,
- "created_at": "2019-08-24T14:15:22Z"
}
]
}
Retrieve a dataset version.
version_uid required | string Example: ch_qf2hyt |
dataset_uid required | string Example: da_qf2hyt |
{- "uid": "ch_qf2hyt",
- "sections": [
- "data"
], - "created_by": {
- "username": "louise.data"
}, - "can_restore": true,
- "created_at": "2019-08-24T14:15:22Z"
}
Restores a dataset to the selected version. Restoring a version will not erase the versions history, but rather create a new version encapsulating the restoration.
version_uid required | string Example: ch_qf2hyt |
dataset_uid required | string Example: da_qf2hyt |
{- "uid": "da_qf2hyt",
- "dataset_id": "counties-united-states-of-america",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "is_published": false,
- "is_restricted": true,
- "metadata": {
- "default": {
- "title": {
- "value": "Counties - United States of America",
- "remote_value": "Counties - United States of America",
- "override_remote_value": false
}, - "description": {
- "value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "remote_value": "This dataset is part of the Geographical repository maintained by Opendatasoft. This dataset contains data for counties and equivalent entities in United States of America.",
- "override_remote_value": false
}, - "keyword": {
- "value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "remote_value": [
- "territory",
- "geography",
- "boundary",
- "county",
- "usa"
], - "override_remote_value": false
}, - "modified": {
- "value": "2023-01-01T00:00:00Z",
- "remote_value": "2023-01-01T00:00:00Z",
- "override_remote_value": false
}, - "modified_updates_on_metadata_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "modified_updates_on_data_change": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "geographic_reference": {
- "value": [
- "world_us"
], - "remote_value": [
- "world_us"
], - "override_remote_value": false
}, - "geographic_reference_auto": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}, - "language": {
- "value": "en",
- "remote_value": "en",
- "override_remote_value": false
}, - "timezone": {
- "value": "US/Pacific",
- "remote_value": "US/Pacific",
- "override_remote_value": false
}, - "publisher": {
- "value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "remote_value": "U.S. Department of Commerce, U.S. Census Bureau, Geography Division, Spatial Data Collection and Products Branch",
- "override_remote_value": false
}, - "references": {
- "override_remote_value": false
}, - "attributions": {
- "value": [
- "U.S. Census Bureau"
], - "remote_value": [
- "U.S. Census Bureau"
], - "override_remote_value": false
}
}, - "visualization": { },
- "internal": {
- "license_id": {
- "value": "38js5ao",
- "remote_value": "38js5ao",
- "override_remote_value": false
}, - "theme_id": {
- "value": [
- "38js5ao"
], - "remote_value": [
- "38js5ao"
], - "override_remote_value": false
}, - "draft": {
- "value": false,
- "remote_value": false,
- "override_remote_value": false
}
}, - "custom_template_name": {
- "field_name_1": {
- "value": "field_value_1"
}, - "field_name_2": {
- "value": "field_value_2",
- "override_remote_value": true
}
}
}, - "default_security": {
- "is_data_visible": true,
- "visible_fields": [
- "year",
- "coty_code"
], - "filter_query": "year!=2022",
- "api_calls_quota": {
- "unit": "month",
- "limit": 12000
}
}
}
Dataset attachments are files that are exposed along with a dataset. These files help make sense of the data.
List all attachments to a dataset.
dataset_uid required | string Example: da_qf2hyt |
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "uid": "fromages.csv",
- "filename": "fromages.csv",
- "mimetype": "text/csv",
- "created_at": "2019-08-24T14:15:22Z"
}
]
}
Create a dataset attachment
dataset_uid required | string Example: da_qf2hyt |
file required | string <binary> |
{- "uid": "fromages.csv",
- "filename": "fromages.csv",
- "mimetype": "text/csv",
- "created_at": "2019-08-24T14:15:22Z"
}
Retrieve a dataset attachment
dataset_uid required | string Example: da_qf2hyt |
attachment_uid required | string Example: at_qf2hyt |
{- "uid": "fromages.csv",
- "filename": "fromages.csv",
- "mimetype": "text/csv",
- "created_at": "2019-08-24T14:15:22Z"
}
Download the dataset attachment file
dataset_uid required | string Example: da_qf2hyt |
attachment_uid required | string Example: at_qf2hyt |
{- "error_code": "not_found",
- "message": "Not found."
}
Dataset alternative exports are custom dataset exports made outside the platform but available for end users to download like a normal export in the export menu.
Alternative exports are useful to expose exports in formats not supported by the platform, or in a specific geographic coordinate system. Alternative exports come in two types:
Uploaded File: This type of alternative export enables publishers to upload their own file one the platform. Since uploaded file alternative exports are static files instead of a dynamic exports, they tend to be very fast to download for end users and can be useful to offer a very large dataset export.
URL: This type allows publishers to provide a URL pointing to an external file that can be hosted outside the platform.
List dataset alternative exports
dataset_uid required | string Example: da_qf2hyt |
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "uid": "ae_mm8lbn",
- "title": "Alternative export title",
- "description": "Alternative export description",
- "mimetype": "text/csv",
- "type": "url",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Create a dataset alternative export
dataset_uid required | string Example: da_qf2hyt |
title required | string non-empty |
type required | string Value: "uploaded_file" |
file required | string <binary> |
description | string |
{- "uid": "ae_mm8lbn",
- "title": "Alternative export title",
- "description": "Alternative export description",
- "mimetype": "text/csv",
- "type": "uploaded_file",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "fromages.csv"
}
Retrieve a dataset alternative export
dataset_uid required | string Example: da_qf2hyt |
export_uid required | string Example: ae_qf2hyt |
{- "uid": "ae_mm8lbn",
- "title": "Alternative export title",
- "description": "Alternative export description",
- "mimetype": "text/csv",
- "type": "uploaded_file",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "fromages.csv"
}
Update a dataset alternative export
dataset_uid required | string Example: da_qf2hyt |
export_uid required | string Example: ae_qf2hyt |
title required | string non-empty |
type required | string Value: "uploaded_file" |
description | string |
{- "title": "string",
- "type": "uploaded_file",
- "description": "string"
}
{- "uid": "ae_mm8lbn",
- "title": "Alternative export title",
- "description": "Alternative export description",
- "mimetype": "text/csv",
- "type": "uploaded_file",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "filename": "fromages.csv"
}
Download the uploaded file alternative export or be redirected to the URL alternative export.
dataset_uid required | string Example: da_qf2hyt |
export_uid required | string Example: ae_qf2hyt |
{- "error_code": "not_found",
- "message": "Not found."
}
Harvesters provide a way for administrators to create and update an important number of datasets by importing them from an external source such as a CSW catalog or an ArcGIS service, among many others. Your user and your API key need the permissions create_dataset
, edit_dataset
and publish_dataset
.
Through the Automation API, it is possible to:
List the harvesters.
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "uid": "harvester-uid",
- "type": "string",
- "name": "Harvester title",
- "status": "idle",
- "version": 1,
- "restrict_datasets_visibility": true,
- "delete_missing_datasets": false,
- "forced_metas": {
- "default": {
- "publisher": "Paris Open Data"
}
}, - "remote_datasets_count": 100,
- "harvested_datasets_count": 98,
- "published_datasets_count": 30,
- "attached_datasets_count": 98,
- "has_error": false,
- "resource_errors_count": 2,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "username": "louise.data"
}, - "last_started_at": "2019-08-24T14:15:22Z",
- "last_success_at": "2019-08-24T14:15:22Z"
}
]
}
Create a harvester.
type required | string non-empty |
name required | string non-empty |
version | integer >= 1 Default: 1 |
restrict_datasets_visibility | boolean If the harvested datasets should be configured as private. By default, it has the same value as the domain configuration "Restrict new datasets by default" |
delete_missing_datasets | boolean Default: false If the source datasets are deleted on the harvested portal, delete them on this Opendatasoft portal too |
object Allow you to override some metadata in every harvested dataset | |
url required | string non-empty |
download_resources | boolean (download_resources) If you want to download resources instead of attaching them via URL. |
metadata_only | boolean (metadata_only) If you want to harvest the remote datasets metadata without their resources. |
{- "type": "arcgis",
- "name": "Harvester title",
- "version": 1,
- "restrict_datasets_visibility": true,
- "delete_missing_datasets": false,
- "forced_metas": {
- "default": {
- "publisher": "Paris Open Data"
}
}, - "download_resources": false,
- "metadata_only": false
}
{- "uid": "harvester-uid",
- "type": "arcgis",
- "name": "Harvester title",
- "status": "idle",
- "version": 1,
- "restrict_datasets_visibility": true,
- "delete_missing_datasets": false,
- "forced_metas": {
- "default": {
- "publisher": "Paris Open Data"
}
}, - "remote_datasets_count": 100,
- "harvested_datasets_count": 98,
- "published_datasets_count": 30,
- "attached_datasets_count": 98,
- "has_error": false,
- "resource_errors_count": 2,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "username": "louise.data"
}, - "last_started_at": "2019-08-24T14:15:22Z",
- "last_success_at": "2019-08-24T14:15:22Z",
- "download_resources": false,
- "metadata_only": false
}
Retrieve a harvester.
harvester_uid required | string Example: harvester_uid |
{- "uid": "harvester-uid",
- "type": "arcgis",
- "name": "Harvester title",
- "status": "idle",
- "version": 1,
- "restrict_datasets_visibility": true,
- "delete_missing_datasets": false,
- "forced_metas": {
- "default": {
- "publisher": "Paris Open Data"
}
}, - "remote_datasets_count": 100,
- "harvested_datasets_count": 98,
- "published_datasets_count": 30,
- "attached_datasets_count": 98,
- "has_error": false,
- "resource_errors_count": 2,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "username": "louise.data"
}, - "last_started_at": "2019-08-24T14:15:22Z",
- "last_success_at": "2019-08-24T14:15:22Z",
- "download_resources": false,
- "metadata_only": false
}
Update a harvester.
harvester_uid required | string Example: harvester_uid |
type required | string non-empty |
name required | string non-empty |
version | integer >= 1 Default: 1 |
restrict_datasets_visibility | boolean If the harvested datasets should be configured as private. By default, it has the same value as the domain configuration "Restrict new datasets by default" |
delete_missing_datasets | boolean Default: false If the source datasets are deleted on the harvested portal, delete them on this Opendatasoft portal too |
object Allow you to override some metadata in every harvested dataset | |
url required | string non-empty |
download_resources | boolean (download_resources) If you want to download resources instead of attaching them via URL. |
metadata_only | boolean (metadata_only) If you want to harvest the remote datasets metadata without their resources. |
{- "type": "arcgis",
- "name": "Harvester title",
- "version": 1,
- "restrict_datasets_visibility": true,
- "delete_missing_datasets": false,
- "forced_metas": {
- "default": {
- "publisher": "Paris Open Data"
}
}, - "download_resources": false,
- "metadata_only": false
}
{- "uid": "harvester-uid",
- "type": "arcgis",
- "name": "Harvester title",
- "status": "idle",
- "version": 1,
- "restrict_datasets_visibility": true,
- "delete_missing_datasets": false,
- "forced_metas": {
- "default": {
- "publisher": "Paris Open Data"
}
}, - "remote_datasets_count": 100,
- "harvested_datasets_count": 98,
- "published_datasets_count": 30,
- "attached_datasets_count": 98,
- "has_error": false,
- "resource_errors_count": 2,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "username": "louise.data"
}, - "last_started_at": "2019-08-24T14:15:22Z",
- "last_success_at": "2019-08-24T14:15:22Z",
- "download_resources": false,
- "metadata_only": false
}
Delete the harvester. If delete_attached_datasets=true, also delete all its attached datasets.
harvester_uid required | string Example: harvester_uid |
delete_attached_datasets required | boolean Control whether all attached datasets should be deleted with the harvester, or detached from it. |
""
Abort the harvesting of a harvester.
harvester_uid required | string Example: harvester_uid |
{- "uid": "harvester-uid",
- "type": "arcgis",
- "name": "Harvester title",
- "status": "idle",
- "version": 1,
- "restrict_datasets_visibility": true,
- "delete_missing_datasets": false,
- "forced_metas": {
- "default": {
- "publisher": "Paris Open Data"
}
}, - "remote_datasets_count": 100,
- "harvested_datasets_count": 98,
- "published_datasets_count": 30,
- "attached_datasets_count": 98,
- "has_error": false,
- "resource_errors_count": 2,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "username": "louise.data"
}, - "last_started_at": "2019-08-24T14:15:22Z",
- "last_success_at": "2019-08-24T14:15:22Z",
- "download_resources": false,
- "metadata_only": false
}
Start a harvester.
harvester_uid required | string Example: harvester_uid |
{- "uid": "harvester-uid",
- "type": "arcgis",
- "name": "Harvester title",
- "status": "idle",
- "version": 1,
- "restrict_datasets_visibility": true,
- "delete_missing_datasets": false,
- "forced_metas": {
- "default": {
- "publisher": "Paris Open Data"
}
}, - "remote_datasets_count": 100,
- "harvested_datasets_count": 98,
- "published_datasets_count": 30,
- "attached_datasets_count": 98,
- "has_error": false,
- "resource_errors_count": 2,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "username": "louise.data"
}, - "last_started_at": "2019-08-24T14:15:22Z",
- "last_success_at": "2019-08-24T14:15:22Z",
- "download_resources": false,
- "metadata_only": false
}
List errors which occurred during the last or current harvesting.
harvester_uid required | string Example: harvester_uid |
{- "harvester": "A fatal error occured. Please check the harvester configuration.",
- "resources": {
- "remote_resource_id": "Could not harvest the dataset."
}
}
Preview the datasets which will be harvested.
harvester_uid required | string Example: harvester_uid |
{- "total_count": 42,
- "results": [
- {
- "id": "georef-united-states-of-america-zc-point",
- "title": "US Zip Codes Points- United States of America",
- "description": "Contains most USPS zip codes (lat/long)."
}
]
}
Preview the datasets which will be harvested with a given configuration. At the contrary of the preview endpoint which returns the results for the currently saved harvester, this endpoint allows to preview the results with a configuration change not yet saved. The given parameters will be merged with the saved harvester configuration.
harvester_uid required | string Example: harvester_uid |
type required | string non-empty |
name required | string non-empty |
version | integer >= 1 Default: 1 |
restrict_datasets_visibility | boolean If the harvested datasets should be configured as private. By default, it has the same value as the domain configuration "Restrict new datasets by default" |
delete_missing_datasets | boolean Default: false If the source datasets are deleted on the harvested portal, delete them on this Opendatasoft portal too |
object Allow you to override some metadata in every harvested dataset | |
url required | string non-empty |
download_resources | boolean (download_resources) If you want to download resources instead of attaching them via URL. |
metadata_only | boolean (metadata_only) If you want to harvest the remote datasets metadata without their resources. |
{- "type": "arcgis",
- "name": "Harvester title",
- "version": 1,
- "restrict_datasets_visibility": true,
- "delete_missing_datasets": false,
- "forced_metas": {
- "default": {
- "publisher": "Paris Open Data"
}
}, - "download_resources": false,
- "metadata_only": false
}
{- "total_count": 42,
- "results": [
- {
- "id": "georef-united-states-of-america-zc-point",
- "title": "US Zip Codes Points- United States of America",
- "description": "Contains most USPS zip codes (lat/long)."
}
]
}
List harvester schedules.
harvester_uid required | string Example: harvester_uid |
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "uid": "sc_qf2hyt",
- "cron_schedule": "1 30 * * *",
- "timezone": "Europe/Berlin"
}
]
}
Create a harvester schedule. A harvester can only have one schedule.
harvester_uid required | string Example: harvester_uid |
cron_schedule required | string non-empty The schedule using the unix-cron string format |
timezone required | string non-empty The schedule timezone |
{- "cron_schedule": "1 30 * * *",
- "timezone": "Europe/Berlin"
}
{- "uid": "sc_qf2hyt",
- "cron_schedule": "1 30 * * *",
- "timezone": "Europe/Berlin"
}
Retrieve a harvester schedule.
harvester_uid required | string Example: harvester_uid |
schedule_uid required | string Example: harvester_uid |
{- "uid": "sc_qf2hyt",
- "cron_schedule": "1 30 * * *",
- "timezone": "Europe/Berlin"
}
Update a harvester schedule.
harvester_uid required | string Example: harvester_uid |
schedule_uid required | string Example: harvester_uid |
cron_schedule required | string non-empty The schedule using the unix-cron string format |
timezone required | string non-empty The schedule timezone |
{- "cron_schedule": "1 30 * * *",
- "timezone": "Europe/Berlin"
}
{- "uid": "sc_qf2hyt",
- "cron_schedule": "1 30 * * *",
- "timezone": "Europe/Berlin"
}
A user is a person who authentifies themself to utilize the platform.
Most of the times, users are invited on a domain via an e-mail:
if the user doesn't have an Opendatasoft account, the e-mail provides them a link to create their account and choose a password,
this invitation links the new user or existing user to this domain, allowing domain administrators to grant them permissions to perform specific actions.
In other words, user accounts are shared between all Opendatasoft domains, but a user must be linked to a specific domain via an invitation before being granted specific permissions on this domain.
Through the Automation API, it is possible to:
List users
search | string Example: search=alice full-text search among username, first name, last name and email |
sort | Array of strings Items Enum: "username" "first_name" "last_name" "last_seen_at" Example: sort=username,first_name sort results according to username, first name or last_name |
permissions | Array of strings (Permission) Items Enum: "edit_domain" "create_page" "edit_page" "manage_page" "explore_restricted_page" "create_dataset" "edit_dataset" "publish_dataset" "manage_dataset" "explore_restricted_dataset" "edit_reuse" "manage_subdomains" "explore_monitoring" "edit_theme" Example: permissions=edit_dataset&permissions=create_dataset filter according to permissions granted directly to the users |
all_permissions | Array of strings (Permission) Items Enum: "edit_domain" "create_page" "edit_page" "manage_page" "explore_restricted_page" "create_dataset" "edit_dataset" "publish_dataset" "manage_dataset" "explore_restricted_dataset" "edit_reuse" "manage_subdomains" "explore_monitoring" "edit_theme" Example: all_permissions=edit_dataset&all_permissions=create_dataset filter according to permissions, whether granted directly or via a group |
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "username": "louise.data",
- "display_name": "louise.data",
- "first_name": "Louise",
- "last_name": "Data",
- "is_active": true,
- "email": "contact@email.com",
- "is_ods": false,
- "account_type": "global",
- "permissions": [
- "explore_restricted_dataset",
- "edit_domain"
], - "joined_at": "2019-08-24T14:15:22Z",
- "last_seen_at": "2019-08-24T14:15:22Z",
- "last_login_at": "2019-08-24T14:15:22Z",
- "expires_at": null,
- "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "gravatar_url": "//www.gravatar.com/avatar/6dde1de523fc80569f3dd80548e3eb9c?d=mm&s=80",
- "groups": [
- {
- "uid": "content_designers"
}
], - "identity_providers": [
- {
- "uid": "opendatasoft"
}
]
}
]
}
Retrieve user
username required | string Example: louise.data |
expand | string Example: expand=groups The list of fields to expand. |
{- "username": "louise.data",
- "display_name": "louise.data",
- "first_name": "Louise",
- "last_name": "Data",
- "is_active": true,
- "email": "contact@email.com",
- "is_ods": false,
- "account_type": "global",
- "permissions": [
- "explore_restricted_dataset",
- "edit_domain"
], - "joined_at": "2019-08-24T14:15:22Z",
- "last_seen_at": "2019-08-24T14:15:22Z",
- "last_login_at": "2019-08-24T14:15:22Z",
- "expires_at": null,
- "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "gravatar_url": "//www.gravatar.com/avatar/6dde1de523fc80569f3dd80548e3eb9c?d=mm&s=80",
- "groups": [
- {
- "uid": "content_designers"
}
], - "identity_providers": [
- {
- "uid": "opendatasoft"
}
]
}
Updates a user properties
username required | string Example: louise.data |
username | string The user's username |
first_name | string The user's first name |
last_name | string The user's last name |
email required | string The user's e-mail address |
permissions | Array of strings (Permission) Items Enum: "edit_domain" "create_page" "edit_page" "manage_page" "explore_restricted_page" "create_dataset" "edit_dataset" "publish_dataset" "manage_dataset" "explore_restricted_dataset" "edit_reuse" "manage_subdomains" "explore_monitoring" "edit_theme" A list of permissions granted to this user |
object (ExploreLimits) An object holding the user's quotas on this domain | |
management_limits | object (ManagementLimits) Deprecated An object holding the user's limits on this domain |
Array of objects or Array of User group schema (objects) A list of groups the user belongs to |
{- "username": "louise.data",
- "first_name": "Louise",
- "last_name": "Data",
- "email": "contact@email.com",
- "permissions": [
- "explore_restricted_dataset",
- "edit_domain"
], - "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "groups": [
- {
- "uid": "content_designers"
}
]
}
{- "username": "louise.data",
- "display_name": "louise.data",
- "first_name": "Louise",
- "last_name": "Data",
- "is_active": true,
- "email": "contact@email.com",
- "is_ods": false,
- "account_type": "global",
- "permissions": [
- "explore_restricted_dataset",
- "edit_domain"
], - "joined_at": "2019-08-24T14:15:22Z",
- "last_seen_at": "2019-08-24T14:15:22Z",
- "last_login_at": "2019-08-24T14:15:22Z",
- "expires_at": null,
- "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "gravatar_url": "//www.gravatar.com/avatar/6dde1de523fc80569f3dd80548e3eb9c?d=mm&s=80",
- "groups": [
- {
- "uid": "content_designers"
}
], - "identity_providers": [
- {
- "uid": "opendatasoft"
}
]
}
Removes the requested user from the domain. If the user is the only domain administrator left, the call will fail and an error specifying that the removal of the only domain administrator is not allowed will be returned.
username required | string Example: louise.data |
""
subdomains | string Subdomains to include in the CSV (requires the permission to export subdomains) |
delimiter | string = 1 characters Default: "," Example: delimiter=; Field separator |
username,last_name,first_name,email,date_joined,last_seen,groups,permissions louise.data,,,contact@mail.com,2022-08-19 11:43:58+00:00,2023-04-24 12:16:34.099404+00:00,Domain administrators;Data publishers,create_dataset;edit_dataset;explore_restricted_dataset;manage_dataset;publish_dataset
This bulk endpoint creates an account for each of the given users and sends them an email so that they can log in. Each item in the payload must contain at least an email address, and may contain additional fields, such as groups and permissions. Returned body is an object in which each key is the number of the requested user in the payload ("0" = first user) and value contains a status_code ("success" or "error") and either "data" corresponding to the user or "error" describing the error.
username | string The user's username |
first_name | string The user's first name |
last_name | string The user's last name |
email required | string The user's e-mail address |
permissions | Array of strings (Permission) Items Enum: "edit_domain" "create_page" "edit_page" "manage_page" "explore_restricted_page" "create_dataset" "edit_dataset" "publish_dataset" "manage_dataset" "explore_restricted_dataset" "edit_reuse" "manage_subdomains" "explore_monitoring" "edit_theme" A list of permissions granted to this user |
object (ExploreLimits) An object holding the user's quotas on this domain | |
management_limits | object (ManagementLimits) Deprecated An object holding the user's limits on this domain |
Array of objects or Array of User group schema (objects) A list of groups the user belongs to |
[- {
- "username": "louise.data",
- "first_name": "Louise",
- "last_name": "Data",
- "email": "contact@email.com",
- "permissions": [
- "explore_restricted_dataset",
- "edit_domain"
], - "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "groups": [
- {
- "uid": "content_designers"
}
]
}
]
{- "01": {
- "status_code": "success",
- "data": {
- "username": "louise.data",
- "display_name": "louise.data",
- "first_name": "Louise",
- "last_name": "Data",
- "is_active": true,
- "email": "contact@email.com",
- "is_ods": false,
- "account_type": "global",
- "permissions": [
- "explore_restricted_dataset",
- "edit_domain"
], - "joined_at": "2019-08-24T14:15:22Z",
- "last_seen_at": "2019-08-24T14:15:22Z",
- "last_login_at": "2019-08-24T14:15:22Z",
- "expires_at": null,
- "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "gravatar_url": "//www.gravatar.com/avatar/6dde1de523fc80569f3dd80548e3eb9c?d=mm&s=80",
- "groups": [
- {
- "uid": "content_designers"
}
], - "identity_providers": [
- {
- "uid": "opendatasoft"
}
]
}
}, - "02": {
- "status_code": "success",
- "data": {
- "username": "louise.data",
- "display_name": "louise.data",
- "first_name": "Louise",
- "last_name": "Data",
- "is_active": true,
- "email": "contact@email.com",
- "is_ods": false,
- "account_type": "global",
- "permissions": [
- "explore_restricted_dataset",
- "edit_domain"
], - "joined_at": "2019-08-24T14:15:22Z",
- "last_seen_at": "2019-08-24T14:15:22Z",
- "last_login_at": "2019-08-24T14:15:22Z",
- "expires_at": null,
- "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "gravatar_url": "//www.gravatar.com/avatar/6dde1de523fc80569f3dd80548e3eb9c?d=mm&s=80",
- "groups": [
- {
- "uid": "content_designers"
}
], - "identity_providers": [
- {
- "uid": "opendatasoft"
}
]
}
}
}
This bulk endpoint creates an account for each of the given users using the given identity provider. Each item in the payload must contain at least an identity provider, and may contain additional fields, such as groups and permissions. Returned body is an object in which each key is the number of the requested user in the payload ("0" = first user) and value contains a status_code ("success" or "error") and either "data" corresponding to the user or "error" describing the error.
username | string The user's username |
first_name | string The user's first name |
last_name | string The user's last name |
email required | string The user's e-mail address |
permissions | Array of strings (Permission) Items Enum: "edit_domain" "create_page" "edit_page" "manage_page" "explore_restricted_page" "create_dataset" "edit_dataset" "publish_dataset" "manage_dataset" "explore_restricted_dataset" "edit_reuse" "manage_subdomains" "explore_monitoring" "edit_theme" A list of permissions granted to this user |
object (ExploreLimits) An object holding the user's quotas on this domain | |
management_limits | object (ManagementLimits) Deprecated An object holding the user's limits on this domain |
Array of objects or Array of User group schema (objects) A list of groups the user belongs to | |
required | object |
identity_provider_attributes | object |
{- "username": "louise.data",
- "first_name": "Louise",
- "last_name": "Data",
- "email": "contact@email.com",
- "permissions": [
- "explore_restricted_dataset",
- "edit_domain"
], - "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "groups": [
- {
- "uid": "content_designers"
}
], - "identity_provider": {
- "uid": "opendatasoft"
}, - "identity_provider_attributes": { }
}
{- "01": {
- "status_code": "success",
- "data": {
- "username": "louise.data",
- "display_name": "louise.data",
- "first_name": "Louise",
- "last_name": "Data",
- "is_active": true,
- "email": "contact@email.com",
- "is_ods": false,
- "account_type": "global",
- "permissions": [
- "explore_restricted_dataset",
- "edit_domain"
], - "joined_at": "2019-08-24T14:15:22Z",
- "last_seen_at": "2019-08-24T14:15:22Z",
- "last_login_at": "2019-08-24T14:15:22Z",
- "expires_at": null,
- "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "gravatar_url": "//www.gravatar.com/avatar/6dde1de523fc80569f3dd80548e3eb9c?d=mm&s=80",
- "groups": [
- {
- "uid": "content_designers"
}
], - "identity_providers": [
- {
- "uid": "opendatasoft"
}
]
}
}, - "02": {
- "status_code": "success",
- "data": {
- "username": "louise.data",
- "display_name": "louise.data",
- "first_name": "Louise",
- "last_name": "Data",
- "is_active": true,
- "email": "contact@email.com",
- "is_ods": false,
- "account_type": "global",
- "permissions": [
- "explore_restricted_dataset",
- "edit_domain"
], - "joined_at": "2019-08-24T14:15:22Z",
- "last_seen_at": "2019-08-24T14:15:22Z",
- "last_login_at": "2019-08-24T14:15:22Z",
- "expires_at": null,
- "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "gravatar_url": "//www.gravatar.com/avatar/6dde1de523fc80569f3dd80548e3eb9c?d=mm&s=80",
- "groups": [
- {
- "uid": "content_designers"
}
], - "identity_providers": [
- {
- "uid": "opendatasoft"
}
]
}
}
}
A group is an entity comprising several users. When users are added to a group, they benefit from the permissions, quotas and limits of this group.
Through the Automation API, the following can be performed on the current domain:
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
search | string full-text search among |
sort | string Default: "updated_at" Enum: "created_at" "updated_at" "created_by__username" "updated_by__username" "user_count" "group__title" sort results with respect to the specified properties. |
permissions | Array of strings (Permission) Items Enum: "edit_domain" "create_page" "edit_page" "manage_page" "explore_restricted_page" "create_dataset" "edit_dataset" "publish_dataset" "manage_dataset" "explore_restricted_dataset" "edit_reuse" "manage_subdomains" "explore_monitoring" "edit_theme" filter groups according to the specified list of permissions |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "uid": "content_designers",
- "title": "Content Designers",
- "description": "This wonderful group is for designers only.",
- "user_count": 42,
- "permissions": [
- "explore_restricted_dataset"
], - "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "username": "louise.data"
}, - "updated_by": {
- "username": "louise.data"
}
}
]
}
title required | string The group title |
description | string The group description |
permissions | Array of strings (Permission) Items Enum: "edit_domain" "create_page" "edit_page" "manage_page" "explore_restricted_page" "create_dataset" "edit_dataset" "publish_dataset" "manage_dataset" "explore_restricted_dataset" "edit_reuse" "manage_subdomains" "explore_monitoring" "edit_theme" A list of permissions granted to the members of this group |
object (ExploreLimits) An object holding the group's quotas on this domain | |
management_limits | object (ManagementLimits) Deprecated An object holding the group's limits on this domain |
{- "title": "Content Designers",
- "description": "This wonderful group is for designers only.",
- "permissions": [
- "explore_restricted_dataset"
], - "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { }
}
{- "uid": "content_designers",
- "title": "Content Designers",
- "description": "This wonderful group is for designers only.",
- "user_count": 42,
- "permissions": [
- "explore_restricted_dataset"
], - "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "username": "louise.data"
}, - "updated_by": {
- "username": "louise.data"
}
}
group_uid required | string Example: group_identifier |
{- "uid": "content_designers",
- "title": "Content Designers",
- "description": "This wonderful group is for designers only.",
- "user_count": 42,
- "permissions": [
- "explore_restricted_dataset"
], - "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "username": "louise.data"
}, - "updated_by": {
- "username": "louise.data"
}
}
group_uid required | string Example: group_identifier |
title required | string The group title |
description | string The group description |
permissions | Array of strings (Permission) Items Enum: "edit_domain" "create_page" "edit_page" "manage_page" "explore_restricted_page" "create_dataset" "edit_dataset" "publish_dataset" "manage_dataset" "explore_restricted_dataset" "edit_reuse" "manage_subdomains" "explore_monitoring" "edit_theme" A list of permissions granted to the members of this group |
object (ExploreLimits) An object holding the group's quotas on this domain | |
management_limits | object (ManagementLimits) Deprecated An object holding the group's limits on this domain |
{- "title": "Content Designers",
- "description": "This wonderful group is for designers only.",
- "permissions": [
- "explore_restricted_dataset"
], - "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { }
}
{- "uid": "content_designers",
- "title": "Content Designers",
- "description": "This wonderful group is for designers only.",
- "user_count": 42,
- "permissions": [
- "explore_restricted_dataset"
], - "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "username": "louise.data"
}, - "updated_by": {
- "username": "louise.data"
}
}
group_uid required | string Example: group_identifier |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "username": "louise.data",
- "display_name": "louise.data",
- "first_name": "Louise",
- "last_name": "Data",
- "is_active": true,
- "email": "contact@email.com",
- "is_ods": false,
- "account_type": "global",
- "permissions": [
- "explore_restricted_dataset",
- "edit_domain"
], - "joined_at": "2019-08-24T14:15:22Z",
- "last_seen_at": "2019-08-24T14:15:22Z",
- "last_login_at": "2019-08-24T14:15:22Z",
- "expires_at": null,
- "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "gravatar_url": "//www.gravatar.com/avatar/6dde1de523fc80569f3dd80548e3eb9c?d=mm&s=80",
- "groups": [
- {
- "uid": "content_designers"
}
], - "identity_providers": [
- {
- "uid": "opendatasoft"
}
]
}
]
}
group_uid required | string Example: group_identifier |
username | string |
{- "username": "louise.data"
}
{- "username": "louise.data",
- "display_name": "louise.data",
- "first_name": "Louise",
- "last_name": "Data",
- "is_active": true,
- "email": "contact@email.com",
- "is_ods": false,
- "account_type": "global",
- "permissions": [
- "explore_restricted_dataset",
- "edit_domain"
], - "joined_at": "2019-08-24T14:15:22Z",
- "last_seen_at": "2019-08-24T14:15:22Z",
- "last_login_at": "2019-08-24T14:15:22Z",
- "expires_at": null,
- "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "gravatar_url": "//www.gravatar.com/avatar/6dde1de523fc80569f3dd80548e3eb9c?d=mm&s=80",
- "groups": [
- {
- "uid": "content_designers"
}
], - "identity_providers": [
- {
- "uid": "opendatasoft"
}
]
}
group_uid required | string Example: group_identifier |
username | string |
[- {
- "username": "louise.data"
}
]
{- "01": {
- "status_code": "success",
- "data": {
- "username": "louise.data",
- "display_name": "louise.data",
- "first_name": "Louise",
- "last_name": "Data",
- "is_active": true,
- "email": "contact@email.com",
- "is_ods": false,
- "account_type": "global",
- "permissions": [
- "explore_restricted_dataset",
- "edit_domain"
], - "joined_at": "2019-08-24T14:15:22Z",
- "last_seen_at": "2019-08-24T14:15:22Z",
- "last_login_at": "2019-08-24T14:15:22Z",
- "expires_at": null,
- "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "gravatar_url": "//www.gravatar.com/avatar/6dde1de523fc80569f3dd80548e3eb9c?d=mm&s=80",
- "groups": [
- {
- "uid": "content_designers"
}
], - "identity_providers": [
- {
- "uid": "opendatasoft"
}
]
}
}, - "02": {
- "status_code": "success",
- "data": {
- "username": "louise.data",
- "display_name": "louise.data",
- "first_name": "Louise",
- "last_name": "Data",
- "is_active": true,
- "email": "contact@email.com",
- "is_ods": false,
- "account_type": "global",
- "permissions": [
- "explore_restricted_dataset",
- "edit_domain"
], - "joined_at": "2019-08-24T14:15:22Z",
- "last_seen_at": "2019-08-24T14:15:22Z",
- "last_login_at": "2019-08-24T14:15:22Z",
- "expires_at": null,
- "explore_limits": {
- "api_calls": {
- "limit": 2000,
- "unit": "day"
}
}, - "management_limits": { },
- "gravatar_url": "//www.gravatar.com/avatar/6dde1de523fc80569f3dd80548e3eb9c?d=mm&s=80",
- "groups": [
- {
- "uid": "content_designers"
}
], - "identity_providers": [
- {
- "uid": "opendatasoft"
}
]
}
}
}
API keys are randomly generated passwords that can be used as an authentication method to access a protected API endpoint as an authorized user.
Through the Automation API, it is possible to list, create, lookup, update and delete API keys for one's own user.
List API keys
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "uid": "ak_qf2hyt",
- "label": "My API Key",
- "key": "63d534ca0c1806024215cfd99dba4ea188f55d4f1b53ac0b6eceb455",
- "permissions": [
- "explore_restricted_dataset"
], - "created_at": "2019-08-24T14:15:22Z",
- "user": {
- "username": "louise.data"
}, - "revocation_status": {
- "revoked_at": "2019-08-24T14:15:22Z",
- "revocation_reason": "Explanation why the API Key has been revoked"
}, - "is_revoked": true
}
]
}
Create an API key
label | string |
permissions | Array of strings (Permission) Items Enum: "edit_domain" "create_page" "edit_page" "manage_page" "explore_restricted_page" "create_dataset" "edit_dataset" "publish_dataset" "manage_dataset" "explore_restricted_dataset" "edit_reuse" "manage_subdomains" "explore_monitoring" "edit_theme" A list of permissions granted to this API Key |
{- "label": "My API Key",
- "permissions": [
- "explore_restricted_dataset"
]
}
{- "uid": "ak_qf2hyt",
- "label": "My API Key",
- "key": "63d534ca0c1806024215cfd99dba4ea188f55d4f1b53ac0b6eceb455",
- "permissions": [
- "explore_restricted_dataset"
], - "created_at": "2019-08-24T14:15:22Z",
- "user": {
- "username": "louise.data"
}, - "revocation_status": {
- "revoked_at": "2019-08-24T14:15:22Z",
- "revocation_reason": "Explanation why the API Key has been revoked"
}, - "is_revoked": true
}
Retrieve an API key
apikey_uid required | string Example: ak_qf2hyt |
expand | string Value: "user" The list of fields to expand. |
{- "uid": "ak_qf2hyt",
- "label": "My API Key",
- "key": "63d534ca0c1806024215cfd99dba4ea188f55d4f1b53ac0b6eceb455",
- "permissions": [
- "explore_restricted_dataset"
], - "created_at": "2019-08-24T14:15:22Z",
- "user": {
- "username": "louise.data"
}, - "revocation_status": {
- "revoked_at": "2019-08-24T14:15:22Z",
- "revocation_reason": "Explanation why the API Key has been revoked"
}, - "is_revoked": true
}
Update an API key
apikey_uid required | string Example: ak_qf2hyt |
label | string |
permissions | Array of strings (Permission) Items Enum: "edit_domain" "create_page" "edit_page" "manage_page" "explore_restricted_page" "create_dataset" "edit_dataset" "publish_dataset" "manage_dataset" "explore_restricted_dataset" "edit_reuse" "manage_subdomains" "explore_monitoring" "edit_theme" A list of permissions granted to this API Key |
{- "label": "My API Key",
- "permissions": [
- "explore_restricted_dataset"
]
}
{- "uid": "ak_qf2hyt",
- "label": "My API Key",
- "key": "63d534ca0c1806024215cfd99dba4ea188f55d4f1b53ac0b6eceb455",
- "permissions": [
- "explore_restricted_dataset"
], - "created_at": "2019-08-24T14:15:22Z",
- "user": {
- "username": "louise.data"
}, - "revocation_status": {
- "revoked_at": "2019-08-24T14:15:22Z",
- "revocation_reason": "Explanation why the API Key has been revoked"
}, - "is_revoked": true
}
Revoke an API key so that it is no longer valid. The reason for revocation can be provided.
apikey_uid required | string Example: ak_qf2hyt |
reason | string |
{- "reason": "Explanation why the API Key has been revoked"
}
{- "uid": "ak_qf2hyt",
- "label": "My API Key",
- "key": "63d534ca0c1806024215cfd99dba4ea188f55d4f1b53ac0b6eceb455",
- "permissions": [
- "explore_restricted_dataset"
], - "created_at": "2019-08-24T14:15:22Z",
- "user": {
- "username": "louise.data"
}, - "revocation_status": {
- "revoked_at": "2019-08-24T14:15:22Z",
- "revocation_reason": "Explanation why the API Key has been revoked"
}, - "is_revoked": true
}
Domain administrators can search for a specific API key, revoked or active.
key | string |
{- "key": "63d534ca0c1806024215cfd99dba4ea188f55d4f1b53ac0b6eceb455"
}
{- "found": true,
- "result": {
- "uid": "ak_qf2hyt",
- "label": "My API Key",
- "key": "63d534ca0c1806024215cfd99dba4ea188f55d4f1b53ac0b6eceb455",
- "permissions": [
- "explore_restricted_dataset"
], - "created_at": "2019-08-24T14:15:22Z",
- "user": {
- "username": "louise.data"
}, - "revocation_status": {
- "revoked_at": "2019-08-24T14:15:22Z",
- "revocation_reason": "Explanation why the API Key has been revoked"
}, - "is_revoked": true
}
}
List the datasources connections
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
sort | string Default: "created_at" Enum: "created_at" "updated_at" "type" "dataset_count" Sort results with respect to the specified properties. You can prefix the property with the minus sign ( |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "uid": "co_qf2hyt",
- "type": "string",
- "is_reusable": true,
- "can_reuse": true,
- "can_manage": true,
- "dataset_count": 59,
- "user_count": 7,
- "group_count": 4,
- "created_at": "2019-08-24",
- "updated_at": "2019-08-24"
}
]
}
Create a datasource connection
type required | string non-empty |
is_reusable | boolean Defines if the connection can be reused across multiple datasets |
url required | string non-empty |
Array of objects | |
HTTPAuth (object) or null |
{- "type": "http",
- "is_reusable": true,
- "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "auth": {
- "type": "basic_auth",
- "username": "my_username",
- "password": "my_password"
}
}
{- "uid": "co_qf2hyt",
- "type": "http",
- "is_reusable": true,
- "can_reuse": true,
- "can_manage": true,
- "dataset_count": 59,
- "user_count": 7,
- "group_count": 4,
- "created_at": "2019-08-24",
- "updated_at": "2019-08-24",
- "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "auth": {
- "type": "basic_auth",
- "username": "my_username",
- "password": "my_password"
}
}
Retrieve a datasource connection
connection_uid required | string Example: co_qf2hyt |
{- "uid": "co_qf2hyt",
- "type": "http",
- "is_reusable": true,
- "can_reuse": true,
- "can_manage": true,
- "dataset_count": 59,
- "user_count": 7,
- "group_count": 4,
- "created_at": "2019-08-24",
- "updated_at": "2019-08-24",
- "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "auth": {
- "type": "basic_auth",
- "username": "my_username",
- "password": "my_password"
}
}
Update a datasource connection. Datasets using this connection will be impacted, but won't be automatically republished.
connection_uid required | string Example: co_qf2hyt |
type required | string non-empty |
is_reusable | boolean Defines if the connection can be reused across multiple datasets |
url required | string non-empty |
Array of objects | |
HTTPAuth (object) or null |
{- "type": "http",
- "is_reusable": true,
- "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "auth": {
- "type": "basic_auth",
- "username": "my_username",
- "password": "my_password"
}
}
{- "uid": "co_qf2hyt",
- "type": "http",
- "is_reusable": true,
- "can_reuse": true,
- "can_manage": true,
- "dataset_count": 59,
- "user_count": 7,
- "group_count": 4,
- "created_at": "2019-08-24",
- "updated_at": "2019-08-24",
- "headers": [
- {
- "name": "header-name",
- "value": "header-value"
}
], - "auth": {
- "type": "basic_auth",
- "username": "my_username",
- "password": "my_password"
}
}
List the datasource connection user-level security rulesets
connection_uid required | string Example: co_qf2hyt |
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "user": {
- "username": "louise.data"
}, - "permissions": [
- "manage_connection"
]
}
]
}
Create a datasource connection user-level security ruleset
connection_uid required | string Example: co_qf2hyt |
object (RelatedUser) The user targeted by this ruleset. | |
permissions | Array of strings (PermissionEnum) Items Value: "manage_connection" List of special permissions granted to the target. |
{- "user": {
- "username": "louise.data"
}, - "permissions": [
- "manage_connection"
]
}
{- "user": {
- "username": "louise.data"
}, - "permissions": [
- "manage_connection"
]
}
Retrieve a datasource connection user-level security ruleset
connection_uid required | string Example: co_qf2hyt |
username required | string Example: louise.data |
{- "user": {
- "username": "louise.data"
}, - "permissions": [
- "manage_connection"
]
}
Update a datasource connection user-level security ruleset
connection_uid required | string Example: co_qf2hyt |
username required | string Example: louise.data |
object (RelatedUser) The user targeted by this ruleset. | |
permissions | Array of strings (PermissionEnum) Items Value: "manage_connection" List of special permissions granted to the target. |
{- "user": {
- "username": "louise.data"
}, - "permissions": [
- "manage_connection"
]
}
{- "user": {
- "username": "louise.data"
}, - "permissions": [
- "manage_connection"
]
}
List the datasource connection group-level security rulesets
connection_uid required | string Example: co_qf2hyt |
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "manage_connection"
]
}
]
}
Create a datasource connection group-level security ruleset
connection_uid required | string Example: co_qf2hyt |
object The group targeted by this ruleset. | |
permissions | Array of strings (PermissionEnum) Items Value: "manage_connection" List of special permissions granted to the target. |
{- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "manage_connection"
]
}
{- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "manage_connection"
]
}
Retrieve a datasource connection group-level security ruleset
connection_uid required | string Example: co_qf2hyt |
group_uid required | string Example: group_identifier |
{- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "manage_connection"
]
}
Update a datasource connection group-level security ruleset
connection_uid required | string Example: co_qf2hyt |
group_uid required | string Example: group_identifier |
object The group targeted by this ruleset. | |
permissions | Array of strings (PermissionEnum) Items Value: "manage_connection" List of special permissions granted to the target. |
{- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "manage_connection"
]
}
{- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "manage_connection"
]
}
Delete a datasource connection group-level security ruleset
connection_uid required | string Example: co_qf2hyt |
group_uid required | string Example: group_identifier |
""
Studio is the new no-code editor that is designed to help you do just that: create and edit pages, built on your data, in only minutes.
Through the Automation API, it is possible to manage studio pages as well as to configure their visiblity on the portal.
List studio pages
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "uid": "sp_qf2hyt",
- "slug": "my-page",
- "public": false,
- "contents": [
- {
- "version_name": "draft",
- "title": "My Page",
- "description": "A page saying hello",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "username": "louise.data"
}
}
], - "first_published_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "username": "louise.data"
}
}
]
}
Create a studio page
slug | string non-empty Human-readable identifier used to generate the page URL |
public | boolean Default: false Defines if the page is visible to a few specific users, or every user who can explore the portal |
{- "slug": "my-page",
- "public": false
}
{- "uid": "sp_qf2hyt",
- "slug": "my-page",
- "public": false,
- "contents": [
- {
- "version_name": "draft",
- "title": "My Page",
- "description": "A page saying hello",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "username": "louise.data"
}
}
], - "first_published_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "username": "louise.data"
}
}
Retrieve a studio page
studio_page_uid required | string Example: sp_qf2hyt |
{- "uid": "sp_qf2hyt",
- "slug": "my-page",
- "public": false,
- "contents": [
- {
- "version_name": "draft",
- "title": "My Page",
- "description": "A page saying hello",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "username": "louise.data"
}
}
], - "first_published_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "username": "louise.data"
}
}
Update a studio page
studio_page_uid required | string Example: sp_qf2hyt |
slug | string non-empty Human-readable identifier used to generate the page URL |
public | boolean Default: false Defines if the page is visible to a few specific users, or every user who can explore the portal |
{- "slug": "my-page",
- "public": false
}
{- "uid": "sp_qf2hyt",
- "slug": "my-page",
- "public": false,
- "contents": [
- {
- "version_name": "draft",
- "title": "My Page",
- "description": "A page saying hello",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "username": "louise.data"
}
}
], - "first_published_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "username": "louise.data"
}
}
The page security is the set of rules that defines who (which users / groups) can explore or edit a given studio page.
It is defined through 2 variables:
public
attribute in the page object, which defines if a page is visible to every user who can explore the portalIf the page isn't set as public
, then the page will only appear in the portal for users who have a ruleset declared for them, either directly or through a group. Other users won't have any access to the page.
Rulesets can also give users permission to edit the page.
List the studio page group level security rulesets
studio_page_uid required | string Example: sp_qf2hyt |
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "edit_page"
]
}
]
}
Create a studio page group level security ruleset
studio_page_uid required | string Example: sp_qf2hyt |
object The group targeted by this ruleset. | |
permissions | Array of strings (PermissionEnum-3) Items Value: "edit_page" List of special permissions granted to the target. |
{- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "edit_page"
]
}
{- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "edit_page"
]
}
Retrieve a studio page group level security ruleset
studio_page_uid required | string Example: sp_qf2hyt |
group_uid required | string Example: group_identifier |
{- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "edit_page"
]
}
Update a studio page group level security ruleset
studio_page_uid required | string Example: sp_qf2hyt |
group_uid required | string Example: group_identifier |
object The group targeted by this ruleset. | |
permissions | Array of strings (PermissionEnum-3) Items Value: "edit_page" List of special permissions granted to the target. |
{- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "edit_page"
]
}
{- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "edit_page"
]
}
List the studio page user-level security rulesets
studio_page_uid required | string Example: sp_qf2hyt |
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "user": {
- "username": "louise.data"
}, - "permissions": [
- "edit_page"
]
}
]
}
Create a studio page user-level security ruleset
studio_page_uid required | string Example: sp_qf2hyt |
object (RelatedUser) The user targeted by this ruleset. | |
permissions | Array of strings (PermissionEnum-3) Items Value: "edit_page" List of special permissions granted to the target. |
{- "user": {
- "username": "louise.data"
}, - "permissions": [
- "edit_page"
]
}
{- "user": {
- "username": "louise.data"
}, - "permissions": [
- "edit_page"
]
}
Retrieve a studio page user-level security ruleset
studio_page_uid required | string Example: sp_qf2hyt |
username required | string Example: louise.data |
{- "user": {
- "username": "louise.data"
}, - "permissions": [
- "edit_page"
]
}
Update a studio page user-level security ruleset
studio_page_uid required | string Example: sp_qf2hyt |
username required | string Example: louise.data |
object (RelatedUser) The user targeted by this ruleset. | |
permissions | Array of strings (PermissionEnum-3) Items Value: "edit_page" List of special permissions granted to the target. |
{- "user": {
- "username": "louise.data"
}, - "permissions": [
- "edit_page"
]
}
{- "user": {
- "username": "louise.data"
}, - "permissions": [
- "edit_page"
]
}
Code editor pages can be used to write editorial content directly on the platform, build advanced dashboards and organize data portals.
Through the Automation API, it is possible to list, create, edit and delete code editor pages as well as to configure pages visiblity on the portal.
List code editor pages
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "slug": "hello_world",
- "title": {
- "en": "Hello world"
}, - "description": "A page saying hello",
- "content": {
- "html": {
- "en": "<p>\n Hello world\n</p>"
}, - "css": {
- "en": ""
}
}, - "template": "custom.html",
- "tags": [
- "My tag"
], - "has_subdomain_copies": false,
- "is_pushed_by_parent": false,
- "is_restricted": true,
- "is_archived": false,
- "created_by": {
- "username": "louise.data"
}, - "updated_by": {
- "username": "louise.data"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z"
}
]
}
Create a code editor page
slug | string Human-readable identifier used to generate the page URL |
object Internationalized page title | |
description | string Page description |
required | object Internationalized page content |
template | string The HTML template used by this page |
tags | Array of strings List of strings used to classify and sort pages |
is_restricted | boolean Defines if the page is visible to a few specific users, or every user who can explore the portal |
is_archived | boolean Defines if the page is archived. An archived page isn't included in the license quota, but can't be edited and isn't available to users. |
{- "slug": "hello_world",
- "title": {
- "en": "Hello world"
}, - "description": "A page saying hello",
- "content": {
- "html": {
- "en": "<p>\n Hello world\n</p>"
}, - "css": {
- "en": ""
}
}, - "template": "custom.html",
- "tags": [
- "My tag"
], - "is_restricted": true,
- "is_archived": false
}
{- "slug": "hello_world",
- "title": {
- "en": "Hello world"
}, - "description": "A page saying hello",
- "content": {
- "html": {
- "en": "<p>\n Hello world\n</p>"
}, - "css": {
- "en": ""
}
}, - "template": "custom.html",
- "tags": [
- "My tag"
], - "has_subdomain_copies": false,
- "is_pushed_by_parent": false,
- "is_restricted": true,
- "is_archived": false,
- "created_by": {
- "username": "louise.data"
}, - "updated_by": {
- "username": "louise.data"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z"
}
Delete all code editor pages matching the search defined by the search
and slug
query parameters.
slug | Array of strings Example: slug=slug1&slug=slug2 List of page slug to be removed. |
search | string Example: search=My Page Title A search term to delete matching pages. |
[- "slug1",
- "slug2"
]
Retrieve a code editor page
page_slug required | string Example: page_slug |
{- "slug": "hello_world",
- "title": {
- "en": "Hello world"
}, - "description": "A page saying hello",
- "content": {
- "html": {
- "en": "<p>\n Hello world\n</p>"
}, - "css": {
- "en": ""
}
}, - "template": "custom.html",
- "tags": [
- "My tag"
], - "has_subdomain_copies": false,
- "is_pushed_by_parent": false,
- "is_restricted": true,
- "is_archived": false,
- "created_by": {
- "username": "louise.data"
}, - "updated_by": {
- "username": "louise.data"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z"
}
Update a code editor page
page_slug required | string Example: page_slug |
slug | string Human-readable identifier used to generate the page URL |
object Internationalized page title | |
description | string Page description |
required | object Internationalized page content |
template | string The HTML template used by this page |
tags | Array of strings List of strings used to classify and sort pages |
is_restricted | boolean Defines if the page is visible to a few specific users, or every user who can explore the portal |
is_archived | boolean Defines if the page is archived. An archived page isn't included in the license quota, but can't be edited and isn't available to users. |
{- "slug": "hello_world",
- "title": {
- "en": "Hello world"
}, - "description": "A page saying hello",
- "content": {
- "html": {
- "en": "<p>\n Hello world\n</p>"
}, - "css": {
- "en": ""
}
}, - "template": "custom.html",
- "tags": [
- "My tag"
], - "is_restricted": true,
- "is_archived": false
}
{- "slug": "hello_world",
- "title": {
- "en": "Hello world"
}, - "description": "A page saying hello",
- "content": {
- "html": {
- "en": "<p>\n Hello world\n</p>"
}, - "css": {
- "en": ""
}
}, - "template": "custom.html",
- "tags": [
- "My tag"
], - "has_subdomain_copies": false,
- "is_pushed_by_parent": false,
- "is_restricted": true,
- "is_archived": false,
- "created_by": {
- "username": "louise.data"
}, - "updated_by": {
- "username": "louise.data"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z"
}
The page security is the set of rules that defines who (which users / groups) can explore or edit a given code editor page.
It is defined through 2 variables:
is_restricted
attribute in the page object, which defines if a page is visible to every user who can explore the portalIf the page is set as restricted, then the page will only appear in the portal for users who have a ruleset declared for them, either directly or through a group. Other users won't have any access to the page.
Rulesets can also give users permission to edit the page and manage its security.
List the code editor page group level security rulesets
page_slug required | string Example: page_slug |
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "edit_page"
]
}
]
}
Create a code editor page group level security ruleset
page_slug required | string Example: page_slug |
object The group targeted by this ruleset. | |
permissions | Array of strings (PermissionEnum-2) Items Enum: "edit_page" "manage_page" List of special permissions granted to the target. |
{- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "edit_page"
]
}
{- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "edit_page"
]
}
Retrieve a code editor page group level security ruleset
page_slug required | string Example: page_slug |
group_uid required | string Example: group_identifier |
{- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "edit_page"
]
}
Update a code editor page group level security ruleset
page_slug required | string Example: page_slug |
group_uid required | string Example: group_identifier |
object The group targeted by this ruleset. | |
permissions | Array of strings (PermissionEnum-2) Items Enum: "edit_page" "manage_page" List of special permissions granted to the target. |
{- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "edit_page"
]
}
{- "group": {
- "uid": "content_designers"
}, - "permissions": [
- "edit_page"
]
}
List the code editor page user-level permissions
page_slug required | string Example: page_slug |
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "user": {
- "username": "louise.data"
}, - "permissions": [
- "edit_page"
]
}
]
}
Create a code editor page user-level security ruleset
page_slug required | string Example: page_slug |
object (RelatedUser) The user targeted by this ruleset. | |
permissions | Array of strings (PermissionEnum-2) Items Enum: "edit_page" "manage_page" List of special permissions granted to the target. |
{- "user": {
- "username": "louise.data"
}, - "permissions": [
- "edit_page"
]
}
{- "user": {
- "username": "louise.data"
}, - "permissions": [
- "edit_page"
]
}
Retrieve a code editor page user-level security ruleset
page_slug required | string Example: page_slug |
username required | string Example: louise.data |
{- "user": {
- "username": "louise.data"
}, - "permissions": [
- "edit_page"
]
}
Update a code editor page user-level security ruleset
page_slug required | string Example: page_slug |
username required | string Example: louise.data |
object (RelatedUser) The user targeted by this ruleset. | |
permissions | Array of strings (PermissionEnum-2) Items Enum: "edit_page" "manage_page" List of special permissions granted to the target. |
{- "user": {
- "username": "louise.data"
}, - "permissions": [
- "edit_page"
]
}
{- "user": {
- "username": "louise.data"
}, - "permissions": [
- "edit_page"
]
}
List all domain assets urls
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "url": "/assets/theme_image/Acronym-Turquoise.svg"
}
]
}
List all metadata templates of the current domain.
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
is_active | boolean If provided and True then it will list only all activated templates. If provided and False it lists non-activated templates. If not provided then it will lists both activated and non-activated templates. |
type | string Enum: "interop" "admin" "basic" "extra" Filter by type of Metadata Template. |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "name": "my-custom-template",
- "title": "My custom template",
- "is_active": true,
- "is_always_active": false,
- "is_system": false,
- "schema": [
- {
- "name": "my-custom-field",
- "type": "text",
- "label": "My custom field",
- "help_text": null,
- "is_hidden": false,
- "self_suggest": false,
- "is_filter": false,
- "i18n": false,
- "suggest_url": null,
- "choices": null,
- "labels": null,
- "requirement_level": "optional"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "username": "louise.data"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "username": "louise.data"
}, - "type": "basic"
}
]
}
You can only create basic
and admin
metadata templates.
name required | string non-empty Name (identifier) of the template |
title required | string Title (description) of the template |
is_active required | boolean True if the template is (needs to be) activated. False otherwise. |
required | Array of objects (MetadataTemplateField) |
type required | string Enum: "basic" "admin" The type of the template. Only templates with type |
{- "name": "my-custom-template",
- "title": "My custom template",
- "is_active": true,
- "schema": [
- {
- "name": "my-custom-field",
- "type": "text",
- "label": "My custom field",
- "help_text": null,
- "self_suggest": false,
- "is_filter": false,
- "i18n": false,
- "choices": null,
- "labels": null,
- "requirement_level": "optional"
}
], - "type": "basic"
}
{- "name": "my-custom-template",
- "title": "My custom template",
- "is_active": true,
- "is_always_active": false,
- "is_system": false,
- "schema": [
- {
- "name": "my-custom-field",
- "type": "text",
- "label": "My custom field",
- "help_text": null,
- "is_hidden": false,
- "self_suggest": false,
- "is_filter": false,
- "i18n": false,
- "suggest_url": null,
- "choices": null,
- "labels": null,
- "requirement_level": "optional"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "username": "louise.data"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "username": "louise.data"
}, - "type": "basic"
}
template_name required | string Example: template_name Metadata template name |
{- "name": "my-custom-template",
- "title": "My custom template",
- "is_active": true,
- "is_always_active": false,
- "is_system": false,
- "schema": [
- {
- "name": "my-custom-field",
- "type": "text",
- "label": "My custom field",
- "help_text": null,
- "is_hidden": false,
- "self_suggest": false,
- "is_filter": false,
- "i18n": false,
- "suggest_url": null,
- "choices": null,
- "labels": null,
- "requirement_level": "optional"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "username": "louise.data"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "username": "louise.data"
}, - "type": "basic"
}
Only non-system templates of type basic
and admin
can be fully editable. Other templates may be enabled. Templates with is_system=true
and is_always_active=true
are exceptions and can't be disabled.
template_name required | string Example: template_name Metadata template name |
name required | string non-empty Name (identifier) of the template |
title required | string Title (description) of the template |
is_active required | boolean True if the template is (needs to be) activated. False otherwise. |
required | Array of objects (MetadataTemplateField) |
type required | string Enum: "basic" "admin" The type of the template. Only templates with type |
{- "name": "my-custom-template",
- "title": "My custom template",
- "is_active": true,
- "schema": [
- {
- "name": "my-custom-field",
- "type": "text",
- "label": "My custom field",
- "help_text": null,
- "self_suggest": false,
- "is_filter": false,
- "i18n": false,
- "choices": null,
- "labels": null,
- "requirement_level": "optional"
}
], - "type": "basic"
}
{- "name": "my-custom-template",
- "title": "My custom template",
- "is_active": true,
- "is_always_active": false,
- "is_system": false,
- "schema": [
- {
- "name": "my-custom-field",
- "type": "text",
- "label": "My custom field",
- "help_text": null,
- "is_hidden": false,
- "self_suggest": false,
- "is_filter": false,
- "i18n": false,
- "suggest_url": null,
- "choices": null,
- "labels": null,
- "requirement_level": "optional"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "username": "louise.data"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "username": "louise.data"
}, - "type": "basic"
}
template_name required | string Example: template_name Metadata template name |
limit | number [ 0 .. 1000 ] Default: 20 Example: limit=20 The maximum number of results returned by the API when the response is paginated. Tip: You can make a request with the parameter "limit" set to 0 to get only the metadata ("results" property will contain an empty array). |
offset | number The number of results to skip before beginning the listing in case of a paginated response |
{- "total_count": 18,
- "next": null,
- "previous": null,
- "results": [
- {
- "name": "my-custom-field",
- "type": "text",
- "label": "My custom field",
- "help_text": null,
- "is_hidden": false,
- "self_suggest": false,
- "is_filter": false,
- "i18n": false,
- "suggest_url": null,
- "choices": null,
- "labels": null,
- "requirement_level": "optional"
}
]
}
template_name required | string Example: template_name Metadata template name |
template_field_name required | string Example: field_name Metadata template field name |
{- "name": "my-custom-field",
- "type": "text",
- "label": "My custom field",
- "help_text": null,
- "is_hidden": false,
- "self_suggest": false,
- "is_filter": false,
- "i18n": false,
- "suggest_url": null,
- "choices": null,
- "labels": null,
- "requirement_level": "optional"
}
List suggestions ("choices") for the provided template field name.
template_name required | string Example: template_name Metadata template name |
template_field_name required | string Example: field_name Metadata template field name |
query required | string The query to perform to the service providing the suggestions. Most likely, it will be a prefix of what you're looking for. |
count | number Number of results which will be provided in the response. |
{- "hits": [ ],
- "nb_hits": 0,
- "page": 0,
- "hits_per_page": 0,
- "exhaustive_nb_hits": true,
- "exhaustive_typo": true,
- "exhaustive": {
- "nb_hits": true,
- "typo": true
}, - "query": "string",
- "params": "string",
- "processing_time_ms": 0
}