Project settings object is used to define project specific features. It is not referenced in or referenced by any other metadata object. Also, apart from other metadata objects, there can be only one project settings object in a project.
...
| Code Block |
|---|
| title | Example of a dumped project settings |
|---|
| collapse | true |
|---|
|
{
"url": "/rest/projects/kt3hz932v53vabh8/md/projectSettings/qr0kekodkijcuhev",
"dumpTime": "2018-06-27T19:42:27Z",
"version": "1",
"content": {
"id": "qr0kekodkijcuhev",
"name": "project_settings_gb",
"type": "projectSettings",
"content": {
"geoSearchCountries": [
"GB"
],
"geoSearchProviders": [
"Mapbox"
]
},
"accessInfo": {
"createdAt": "2018-06-27T11:26:07Z"
},
"links": [
{
"rel": "self",
"href": "/rest/projects/kt3hz932v53vabh8/md/projectSettings/qr0kekodkijcuhev"
}
]
}
}
|
Additional syntax examples
| Code Block |
|---|
| title | Example of a projectSettings object with template |
|---|
| collapse | true |
|---|
|
{
"name": "project_settings_template",
"type": "projectSettings",
"content": {
"geoSearchCountries": [
"GB"
],
"geoSearchProviders": [
"Mapbox"
],
"projectTemplate": {
"templateDatasets": [
{
"dataset": "/rest/projects/$projectId/md/datasets?name=baskets"
}
]
}
}
} |
This example has a projectTemplate object with settings related to project templates.
Key description
content
| Key | Type | Optionality | Description | Constraints |
|---|
geoSearchCountries | array | | array of ISO 3166 alpha-2 country codes, to which the geographic search will be limited | (A-Z) |
geoSearchProviders | array | | list of geosearch providers default = [Mapbox] | [Mapbox] |
projectTemplate | object | | object containing settings related to project templates |
|
content.projectTemplate
| Key | Type | Optionality | Description | Constraints |
|---|
templateDatasets | array | | array of dataset links | size => 1 |
content.projectTemplate.dataset
| Key | Type | Optionality | Description | Constraints |
|---|
dataset | string | | URL link to the dataset, which will be loadable with data during custom create project | /rest/projects/$projectId/md/datasets?name={datasetName} |
Visual representation
Project settings do not have a visual representation in the application.