You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 18, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: schema.md
+17-7
Original file line number
Diff line number
Diff line change
@@ -47,14 +47,15 @@ Field | Definition
47
47
------- | --------------- | --------------
48
48
Title | Human-readable name of the asset. Should be in plain English and include sufficient detail to facilitate search and discovery. | title
49
49
Description | Human-readable description (e.g., an abstract) with sufficient detail to enable a user to quickly understand whether the asset is of interest. | description
50
-
Tags | Tags (or keywords) help users discover your dataset, please include terms that would be used by technical and non-technical users. | keyword
51
-
Bureau Code | Combined agency and bureau code from [OMB A-11, Appendix C](http://www.whitehouse.gov/sites/default/files/omb/assets/a11_current_year/app_c.pdf) | bureauCode
50
+
Tags | Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users. | keyword
51
+
Bureau Code | Combined agency and bureau code from [OMB Circular A-11, Appendix C](http://www.whitehouse.gov/sites/default/files/omb/assets/a11_current_year/app_c.pdf) in the format of “015:010”. | bureauCode
52
52
Last Update | Most recent date on which the dataset was changed, updated or modified. | modified
53
53
Publisher | The publishing agency. | publisher
54
54
Contact Name | Contact person's name for the asset. | contactPoint
Unique Identifier | A unique identifier for the dataset or API as maintained within an Agency catalog or database. | identifier
57
-
Public Access Level | The degree to which this dataset **could** be made publicly-available, *regardless of whether it has been made available*. Choices: public (is or *could be* made publicly available), restricted public (available under certain conditions), or non-public (never able to be made publicly available) | accessLevel
57
+
Program Office | Primary program related to this data asset, from the Federal Program Inventory on Performance.gov. | programOffice
58
+
Public Access Level | 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) | accessLevel
58
59
59
60
60
61
"Common Core" Required-if-Applicable Fields
@@ -64,12 +65,11 @@ The following fields must be used to describe each dataset if they are applicabl
64
65
{: .table .table-striped}
65
66
Field | Definition |JSON
66
67
------- | --------------- | --------------
67
-
Access Level Comment | Explanation of how to access a restricted public dataset, or why a private dataset cannot be released. | accessLevelComment
68
+
Access Level Comment | An explanation for the selected **accessLevel** including instructions forof how to access a restricted file, if applicable, or explanation for why “non-public” or “restricted public” data assets is not “public,” if applicable. | accessLevelComment
68
69
Download URL | URL providing direct access to the downloadable distribution of a dataset. | accessURL
69
70
Endpoint | Endpoint of web service to access dataset. | webService
70
71
Format | The file format or API type of the distribution. | format
71
72
License | The license dataset or API is published with. See [Open Licenses](/open-licenses/) for more information. | license
72
-
Program Office | The program office responsible for the dataset | programOffice
73
73
Spatial | The range of spatial applicability of a dataset. Could include a spatial region like a bounding box or a named place. | spatial
74
74
Temporal | The range of temporal applicability of a dataset (i.e., a start and end date of applicability for the data). | temporal
75
75
@@ -110,6 +110,15 @@ Further Metadata Field Guidance
110
110
**Usage Notes** | This field refers to degree to which this dataset *could be made available* to the public, regardless of whether it is currently available to the public. For example, if a member of the public can walk into your agency and obtain a dataset, that entry is **public** even if there are no files online. A *restricted public* dataset is one only available under certain conditions or to certain audiences (such as researchers who sign a waiver). A *non-public* dataset is one that could never be made available to the public for privacy, security, or other reasons as determined by your agency.
111
111
**Example** | `{"accessLevel":"public"}`
112
112
113
+
{: .table .table-striped}
114
+
**Field** | **accessLevelComment**
115
+
----- | -----
116
+
**Cardinality** | (0,1)
117
+
**Required** | Yes, if accessLevel is "restricted public" or "non-public"
118
+
**Accepted Values** | String
119
+
**Usage Notes** | An explanation for the selected “accessLevel” including instructions forof how to access a restricted file, if applicable, or explanation for why “non-public” or “restricted public” data assets is not “public,” if applicable.
120
+
**Example** | `{"accessLevelComment":"This dataset contains Personally Identifiable Information and could not be released for public access. A statistical analysis of the data contained herein, stripped of all personal identifiers, is available at http://another.website.gov/dataset."}`
121
+
113
122
{: .table .table-striped}
114
123
**Field** | **accessURL**
115
124
----- | -----
@@ -197,6 +206,7 @@ Further Metadata Field Guidance
197
206
]
198
207
199
208
{: .table .table-striped}
209
+
200
210
**Field** | **format**
201
211
----- | -----
202
212
**Cardinality** | (0,1)
@@ -290,9 +300,9 @@ Further Metadata Field Guidance
290
300
**Field** | **programOffice**
291
301
----- | -----
292
302
**Cardinality** | (0,n)
293
-
**Required** | Yes, if a program office owns or co-owns this dataset.
303
+
**Required** | Yes, always
294
304
**Accepted Values** | Array of strings
295
-
**Usage Notes** | Enter the name of the program office responsible for the dataset, as found in the [Federal Program Inventory](http://goals.performance.gov/federalprograminventory).
305
+
**Usage Notes** | Enter the name of the program office responsible for the dataset, as found in the [Federal Program Inventory](http://goals.performance.gov/federalprograminventory). Enter "None" if not assigned to a program office.
296
306
**Example** | `{"programOffice":["2.31. Survivors’ and Dependents’ Educational Assistance"]}`
0 commit comments