Open Data Catalog v2.0.0
dataset.ui.json
Go to the documentation of this file.
1 {
2  "@type": {
3  "ui:options": {
4  "widget": "hidden"
5  }
6  },
7  "title": {
8  "ui:options": {
9  "description": "Name of the asset, in plain language. Include sufficient detail to facilitate search and discovery."
10  }
11  },
12  "identifier": {
13  "ui:options": {
14  "widget": "dkan_uuid"
15  }
16  },
17  "description": {
18  "ui:options": {
19  "widget": "textarea",
20  "rows": 5,
21  "description": "Description (e.g., an abstract) with sufficient detail to enable a user to quickly understand whether the asset is of interest."
22  }
23  },
24  "contactPoint": {
25  "properties": {
26  "@type": {
27  "ui:options": {
28  "widget": "hidden"
29  }
30  }
31  }
32  },
33  "accessLevel": {
34  "ui:options": {
35  "description": "This refers to how the data can be accessed."
36  }
37  },
38  "spatial": {
39  "ui:options": {
40  "widget": "textarea",
41  "rows": 5,
42  "title": "Relevant Location",
43  "description": "If your dataset has a spatial component, please provide location such as place name or latitude/longitude pairs."
44  }
45  },
46  "temporal": {
47  "ui:options": {
48  "description": "The <a href=\"https://project-open-data.cio.gov/v1.1/schema/#temporal\">start and end dates</a> for which the dataset is applicable.",
49  "widget": "date_range"
50  }
51  },
52  "isPartOf": {
53  "ui:options": {
54  "widget": "hidden"
55  }
56  },
57  "publisher": {
58  "ui:options": {
59  "widget": "list",
60  "type": "autocomplete",
61  "allowCreate": "true",
62  "titleProperty": "name",
63  "source": {
64  "metastoreSchema": "publisher"
65  }
66  },
67  "properties": {
68  "@type": {
69  "ui:options": {
70  "widget": "hidden"
71  }
72  },
73  "subOrganizationOf": {
74  "ui:options": {
75  "widget": "hidden"
76  }
77  }
78  }
79  },
80  "license": {
81  "ui:options": {
82  "widget": "list",
83  "type": "select_other",
84  "other_type": "url",
85  "source": {
86  "enum": [
87  "https://creativecommons.org/licenses/by/4.0/",
88  "https://creativecommons.org/licenses/by-sa/4.0/",
89  "https://creativecommons.org/publicdomain/zero/1.0/",
90  "https://creativecommons.org/licenses/by-nc/2.5/",
91  "https://creativecommons.org/licenses/by-nc-nd/4.0/",
92  "https://www.gnu.org/licenses/fdl.html",
93  "https://opendatacommons.org/licenses/by/1.0/",
94  "https://opendatacommons.org/licenses/odbl/1.0/",
95  "http://opendefinition.org/licenses/odc-pddl/",
96  "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/2/"
97  ],
98  "enumNames": [
99  "Creative Commons Attribution",
100  "Creative Commons Attribution Share-Alike",
101  "Creative Commons CCZero",
102  "Creative Commons Non-Commercial (2.5)",
103  "Attribution NonCommercial NoDerivatives 4.0 International",
104  "GNU Free Documentation License",
105  "Open Data Commons Attribution License",
106  "Open Data Commons Open Database License (ODbL)",
107  "Open Data Commons Public Domain Dedication and Licence (PDDL)",
108  "UK Open Government Licence (OGL)"
109  ]
110  }
111  }
112  },
113  "distribution": {
114  "ui:options": {
115  "description": "A distribution is a container for the metadata specific to the data resource being shared. Each distribution should contain one <strong>Access URL</strong> or <strong>Download URL</strong>. When providing a Download URL, also include the format of the file."
116  },
117  "items": {
118  "@type": {
119  "ui:options": {
120  "widget": "hidden"
121  }
122  },
123  "title": {
124  "ui:options": {
125  "title": "File Title",
126  "description": ""
127  }
128  },
129  "mediaType": {
130  "ui:options": {
131  "widget": "hidden"
132  }
133  },
134  "description": {
135  "ui:options": {
136  "widget": "textarea",
137  "rows": 5,
138  "title": "File Description",
139  "description": ""
140  }
141  },
142  "format": {
143  "ui:options": {
144  "title": "File Format",
145  "widget": "list",
146  "type": "select_other",
147  "other_type": "textfield",
148  "description": "CSV files must be encoded in UTF-8 format to be imported correctly. UTF-8 encoding is an established standard that provides optimal compatibility between applications and operating systems. Note that Excel provides a <strong>CSV UTF-8</strong> option when saving data files.",
149  "source": {
150  "enum": [
151  "arcgis",
152  "csv",
153  "esri rest",
154  "geojson",
155  "json",
156  "kml",
157  "pdf",
158  "tsv",
159  "xls",
160  "xlsx",
161  "xml",
162  "zip"
163  ]
164  }
165  }
166  },
167  "downloadURL": {
168  "ui:options": {
169  "widget": "upload_or_link",
170  "extensions": "csv html xls json xlsx doc docx rdf txt jpg png gif tiff pdf odf ods odt tsv tab geojson xml zip kml kmz shp",
171  "progress_indicator": "bar",
172  "description": "URL providing direct access to a downloadable file."
173  }
174  },
175  "accessURL": {
176  "ui:options": {
177  "description": "URL providing indirect access to the data, for example via API or a graphical interface."
178  }
179  },
180  "describedBy": {
181  "ui:options": {
182  "description": "URL to the data dictionary for the file found at the Download URL."
183  }
184  },
185  "describedByType": {
186  "ui:options": {
187  "description": "The machine-readable file format (IANA Media Type or MIME Type) of the distribution’s Data Dictionary URL."
188  }
189  }
190  }
191  },
192  "references": {
193  "items": {
194  "ui:options": {
195  "placeholder": "http://"
196  }
197  }
198  },
199  "issued": {
200  "ui:options": {
201  "widget": "flexible_datetime"
202  }
203  },
204  "modified": {
205  "ui:options": {
206  "widget": "flexible_datetime",
207  "timeRequired": false,
208  "placeholder": "YYYY-MM-DD"
209  }
210  },
211  "describedBy": {
212  "ui:options": {
213  "placeholder": "http://"
214  }
215  },
216  "theme": {
217  "ui:options": {
218  "title": "Topics",
219  "hideActions": "true",
220  "child": "theme"
221  },
222  "items": {
223  "ui:options": {
224  "title": "Topic",
225  "widget": "list",
226  "type": "autocomplete",
227  "allowCreate": "true",
228  "multiple": "true",
229  "source": {
230  "metastoreSchema": "theme"
231  }
232  }
233  }
234  },
235  "keyword": {
236  "ui:options": {
237  "hideActions": "true",
238  "child": "keyword"
239  },
240  "items": {
241  "ui:options": {
242  "widget": "list",
243  "type": "autocomplete",
244  "allowCreate": "true",
245  "multiple": "true",
246  "source": {
247  "metastoreSchema": "keyword"
248  }
249  }
250  }
251  }
252 }