forked from project-open-data/project-open-data.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsingle_entry.json
209 lines (209 loc) · 9.33 KB
/
single_entry.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://project-open-data.github.io/schema/1_0_final/single_entry.json#",
"title": "Common Core Metadata Schema",
"description": "The metadata format for all federal open data. Validates a single JSON object entry (as opposed to entire Data.json catalog).",
"type": "object",
"required": ["title", "description", "keyword", "modified", "publisher", "contactPoint", "mbox", "identifier", "accessLevel"],
"properties": {
"accessLevel": {
"description":"The degree to which this dataset could be made publicly-available, regardless of whether it has been made available. Choices: public (Data asset is or could be made publicly available to all without restrictions), restricted public (Data asset is available under certain use restrictions), or non-public (Data asset is not available to members of the public)",
"title": "Public Access Level",
"enum": ["public", "restricted public", "non-public"]
},
"accessLevelComment": {
"title":"Access Level Comment",
"description":"An explanation for the selected \"accessLevel\" including instructions for how to access a restricted file, if applicable, or explanation for why a \"non-public\" or \"restricted public\" data assetis not \"public,\" if applicable. Text, 255 characters.",
"type": "string",
"maxLength":255
},
"accrualPeriodicity": {
"title":"Frequency",
"description":"Frequency with which dataset is published.",
"enum": ["Annual", "Bimonthly", "Semiweekly", "Daily", "Biweekly", "Semiannual", "Biennial", "Triennial",
"Three times a week", "Three times a month", "Continuously updated", "Monthly", "Quarterly", "Semimonthly",
"Three times a year", "Weekly", "Completely irregular"]
},
"bureauCode": {
"title":"Bureau Code",
"description":"Federal agencies, combined agency and bureau code from <a href=\"http://www.whitehouse.gov/sites/default/files/omb/assets/a11_current_year/app_c.pdf\">OMB Circular A-11, Appendix C</a> in the format of <code>015:010</code>.",
"type": "array",
"items": {
"type": "string",
"pattern": "[0-9]{3}:[0-9]{2}"
},
"minItems": 1,
"uniqueItems": true
},
"contactPoint": {
"title":"Contact Name",
"description":"Contact person’s name for the asset.",
"type": "string"
},
"dataDictionary": {
"title":"Data Dictionary",
"description":"URL to the data dictionary for the dataset or API. Note that documentation other than a data dictionary can be referenced using Related Documents as shown in the expanded fields.",
"type": "string",
"format": "uri"
},
"dataQuality": {
"title":"Data Quality",
"description":"Whether the dataset meets the agency’s Information Quality Guidelines (true/false).",
"type": "boolean"
},
"description": {
"title" : "Description",
"description": "Human-readable description (e.g., an abstract) with sufficient detail to enable a user to quickly understand whether the asset is of interest.",
"type": "string"
},
"distribution": {
"title":"Distribution",
"description":"Holds multiple download URLs for datasets composed of multiple files and/or file types",
"type": "array",
"items": {
"type": "object",
"properties": {
"accessURL": {
"title":"Download URL",
"description":"URL providing direct access to the downloadable distribution of a dataset.",
"type": "string",
"format": "uri"
},
"format": {
"title":"Format",
"description":"The file format or API type of the distribution.",
"pattern": "^[-\\w]+/[-\\w]+([+][-\\w]+)?$",
"type": "string"
}
}
},
"minItems": 1,
"uniqueItems": true
},
"identifier": {
"title":"Unique Identifier",
"description":"A unique identifier for the dataset or API as maintained within an Agency catalog or database.",
"type": "string",
"pattern": "[\\w]+"
},
"issued": {
"title":"Release Date",
"description":"Date of formal issuance.",
"type": "string",
"format": "date-time"
},
"keyword": {
"title": "Tags",
"description": "Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
},
"landingPage": {
"title":"Homepage URL",
"description":"Alternative landing page used to redirect user to a contextual, Agency-hosted “homepage” for the Dataset or API when selecting this resource from the Data.gov user interface.",
"type": "string",
"format": "uri"
},
"language": {
"title":"Language",
"description":"The language of the dataset.",
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-zA-Z0-9-]+/[a-zA-Z0-9-]+([+][a-zA-Z0-9-]+)$"
}
},
"license": {
"title":"License",
"description":"The license dataset or API is published with. See <a href=\"http://project-open-data.github.io/open-licenses/\">Open Licenses</a> for more information.",
"type": "string"
},
"mbox": {
"title":"Contact Email",
"description":"Contact person’s email address.",
"type": "string",
"format": "email"
},
"modified": {
"title": "Last Update",
"description": "Most recent date on which the dataset was changed, updated or modified.",
"type": "string",
"format": "date-time"
},
"PrimaryITInvestmentUII": {
"title":"Primary IT Investment UII",
"description":"For linking a dataset with an IT Unique Investment Identifier (UII)",
"type": "string"
},
"programCode": {
"title":"Program Code",
"description":"Federal agencies, list the primary program related to this data asset, from the <a href=\"http://goals.performance.gov/sites/default/files/images/FederalProgramInventory_FY13_MachineReadable_091613.xls\">Federal Program Inventory</a>. Use the format of <code>015:001</code>",
"type": "array",
"items": {
"type": "string",
"pattern": "[0-9]{3}:[0-9]{3}"
},
"minItems": 1,
"uniqueItems": true
},
"publisher": {
"title":"Publisher",
"description": "The publishing entity.",
"type": "string"
},
"references": {
"title":"Related Documents",
"description":"Related documents such as technical information about a dataset, developer documentation, etc.",
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"minItems": 1,
"uniqueItems": true
},
"spatial": {
"title":"Spatial",
"description":"The range of spatial applicability of a dataset. Could include a spatial region like a bounding box or a named place.",
"type": "string"
},
"systemOfRecords": {
"title":"System of Records",
"description":"If the systems is designated as a system of records under the Privacy Act of 1974, provide the URL to the System of Records Notice related to this dataset.",
"type": "string"
},
"temporal": {
"title":"Temporal",
"description":"The range of temporal applicability of a dataset (i.e., a start and end date of applicability for the data).",
"type": "array",
"items": {
"type": "string"
}
},
"theme": {
"title":"Category",
"description":"Main thematic category of the dataset.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
},
"title": {
"title": "Title",
"description": "Human-readable name of the asset. Should be in plain English and include sufficient detail to facilitate search and discovery.",
"type": "string"
},
"webService": {
"title":"Endpoint",
"description":"Endpoint of web service to access dataset.",
"type": "string",
"format": "uri"
}
}
}