--- title: "Create a data release." method: POST path: "/datacatalog/api/data-release" tags: ["Data Release"] --- # Create a data release. `POST /datacatalog/api/data-release` ## Request - Base URL: `https://data.usgs.gov` (the document declares no server; this is the origin it was published from) - URL: `https://data.usgs.gov/datacatalog/api/data-release` - Auth: OAuth 2 - Authorization code: `https://auth.globus.org/v2/oauth2/authorize?scope=openid` - Token URL: `https://data.usgs.gov/datacatalog/api/auth/login` Creates a data release. Takes DataReleaseInitiation JSON as input. Kicks off the Data Release Creation Workflow. Only USGS identities or members of USGS Data Release Create group can create a data release using this endpoint. If successful, returns a success message and the data model for the data release that was created only once the document has been written to the Globus Search Index If unsuccessful, returns an error message. Invalidates the user's group membership cache so that they can see their new group membership. Uses :func:`crud.DataRelease.create`. **Data Release Management Groups** Optionally, a user may choose to control access to a data release. This is done by providing Globus groups upon data release creation. For more information about Globus groups, visit: https://docs.globus.org/api/groups/. A read-only and a read-write group will need to be created in Globus. .. code-block:: from globus_sdk import GroupsClient, AccessTokenAuthorizer # 1. Obtain an authorizer (using your access token) # See https://globus-sdk-python.readthedocs.io/en/3.x-line/user_guide/getting_started/minimal_script.html authorizer = AccessTokenAuthorizer("") # 2. Initialize the GroupsClient groups_client = GroupsClient(authorizer=authorizer) # 3. Create the group # See https://globus-sdk-python.readthedocs.io/en/3.x-line/services/groups.html group_data = { "name": "Read-write group", "description": "Read-write permissions group for data release", } new_group = groups_client.create_group(group_data) print(f"Group created with ID: {new_group['id']}") The Horizon service will need to be given permission in the group. Please contact .. code-block:: import globus_sdk # 1. Setup the GroupsClient (assumes you have a valid authorizer) groups_client = globus_sdk.GroupsClient(authorizer=your_authorizer) # 2. Add the identity with the 'manager' role group_id = "your-group-uuid" identity_id = "contact ask-sdm@usgs.gov for the value to use" response = groups_client.add_member( group_id, identity_id, role="manager" ) print(f"Successfully added manager: {response}") The resulting UUIDs from the creation of the groups should be saved and included in the request to create the data release. :param release: The DataReleaseInitiation JSON of the data release to create. :param token: A valid bearer token for the user. ## Request body - CreateDataReleaseInput - `usgsApprovalIdentifier` string, required - `title` string, required - `creator` Creator[], required - `entity_id` string, nullable - `name` string, required - `nameType` 'USGS Personal' | 'Personal' | 'Organizational' | 'Service': The type of entity described by a name usgs_personal = "USGS Personal" USGS Federal staff or contractors personal = "Personal" Person who is not affiliated with USGS or a USGS contractor organizational = "Organizational" A government, nonprofit, research, or other organization service = "Service" Software that performs automated tasks - `nameIdentifier` string, nullable - `email` string, nullable - `position` integer, required - `affiliation` string, nullable - `affiliationIdentifier` string, nullable - `license` License, required: A legal document under which the resource is made available. licenseIdentifier: A short, standardized version of the license name. license: The full version of the license name or free text description of the license or rights associated with the resource. licenseUri: The URI of the license. licenseIdentifierScheme: The name of the license identifier scheme schemeUri: The URI of the licenseIdentifierScheme - `licenseIdentifier` string, nullable - `license` string, required - `licenseUri` string, uri, nullable - `licenseIdentifierScheme` string, nullable - `schemeUri` string, uri, nullable - `usgsDataSource` UsgsDataSource, required: The USGS Science Center or Program responsible for managing the resource. The name and dataSourceId should come from Gluebucket. - `name` string, required - `dataSourceId` string, required - `usgsMissionArea` UsgsMissionArea: The USGS Mission Area responsible for managing the resource. The Mission Area name and ID should come from Gluebucket service. - `name` string, required - `missionAreaId` string, required - `relation` RelatedIdentifier[], nullable - `dataciteRelationType` 'IsCitedBy' | 'Cites' | 'IsSupplementTo' | 'IsSupplementedBy' | 'IsContinuedBy' | 'Continues' | 'IsNewVersionOf' | 'IsPreviousVersionOf' | 'IsPartOf' | 'HasPart' | 'IsReferencedBy' | 'References' | 'IsDocumentedBy' | 'Documents' | 'IsCompiledBy' | 'Compiles' | 'IsVariantFormOf' | 'IsOriginalFormOf' | 'IsIdenticalTo' | 'HasMetadata' | 'IsMetadataFor' | 'Reviews' | 'IsReviewedBy' | 'IsDerivedFrom' | 'IsSourceOf' | 'Describes' | 'IsDescribedBy' | 'HasVersion' | 'IsVersionOf' | 'Requires' | 'IsRequiredBy' | 'Obsoletes' | 'IsObsoletedBy' | 'IsPublishedIn', required: Description of the relationship of the resource being described and the related resource. - `relatedIdentifier` string, required - `isPrimaryRelatedIdentifier` boolean, required - `relatedIdentifierType` 'ARK' | 'arXiv' | 'bibcode' | 'DOI' | 'EAN13' | 'EISSN' | 'Handle' | 'IGSN' | 'ISBN' | 'ISSN' | 'ISTC' | 'LISSN' | 'LSID' | 'PMID' | 'PURL' | 'UPC' | 'URL' | 'URN' | 'w3id', required: The type of related identifier. - `description` string, nullable - `alternateIdentifier` AlternateIdentifier[], nullable - `alternateIdentifier` string, required - `alternateIdentifierType` 'ARK' | 'Servcat Number' | 'Genbank Accession Number' | 'IGSN' | 'LSID' | 'PURL' | 'Ref Seq ID' | 'Local Identifier' | 'Metadata Identifier' | 'ScienceBase Alt ID', required: The type of alternate identifier "ARK", "Servcat Number", "Genbank Accession Number", "IGSN", "LSID", "PURL", "Ref Seq ID", "Local Identifier", "Metadata Identifier", "ScienceBase Alt ID" - `qualifiedAttribution` Contributor[], nullable - `entity_id` string, nullable - `name` string, required - `nameType` 'USGS Personal' | 'Personal' | 'Organizational' | 'Service': The type of entity described by a name usgs_personal = "USGS Personal" USGS Federal staff or contractors personal = "Personal" Person who is not affiliated with USGS or a USGS contractor organizational = "Organizational" A government, nonprofit, research, or other organization service = "Service" Software that performs automated tasks - `nameIdentifier` string, nullable - `email` string, nullable - `position` integer, required - `affiliation` string, nullable - `affiliationIdentifier` string, nullable - `contributorType` 'Contact Person' | 'Data Collector' | 'Data Curator' | 'Data Manager' | 'Distributor' | 'Editor' | 'Hosting Institution' | 'Producer' | 'Project Leader' | 'Project Manager' | 'Project Member' | 'Registration Agency' | 'Registration Authority' | 'Related Person' | 'Researcher' | 'Research Group' | 'Rights Holder' | 'Sponsor' | 'Supervisor' | 'Work Package Leader' | 'Other', required: The type of contributor of the resource. See DataCite Metadata Schema for definitions: https://schema.datacite.org/ - `versionHistory` VersionHistory[], nullable - `version` string, nullable - `issued` string, date, nullable - `usgsApprovalIdentifier` string, nullable - `versionNotes` string, nullable - `systemKeyword` Keyword[], nullable - `concept` string, required - `conceptScheme` string, nullable - `conceptUri` string, uri, nullable - `conceptType` string, nullable - `usgsReleaseType` 'Data Release' | 'Dynamic' | 'Legacy' | 'Software Release': The type of release. Different types of releases fall under different USGS policy requirements. dataRelease = "Data Release" Data that are released as a static dataset and governed by USGS Survey Manual Chapter 502.8 dynamic = "Dynamic" Data that are continually collected, processed, quality-controlled, and released in real-time or near-real-time. legacy = "Legacy" Data that were released prior to the implementation of USGS Survey Manual Chapter 502.8. softwareRelease = "Software Release" Software that were released prior to the requirement to publish software at code.usgs.gov. - `r_group_uuid` string, nullable - `rw_group_uuid` string, nullable ## Response `200` Successful Response - HorizonAPICreateDataReleaseResponse - `success` boolean, required: A boolean (true/false) indicating if the request was successful. - `message` union, required: Descriptive text providing context or further information about the request. - 'Created' | 'A component with componentName "{componentName}" already exists in this data release. Please provide a unique componentName.' | 'Deleted' | 'Deletion error' | 'Unable to delete component.' | 'Data release contains components. All components must be deleted before the data release can be deleted.' | 'DOI assigned to Data Release' | 'An entity_id is missing for some or all creators or contributors. Please add any missing entity_id values and try again.' | 'The useForPreview value may only be set to True for .png or .jpg files.' | 'The Globus Search query was not valid. See https://docs.globus.org/api/search/reference/post_query/ for query syntax.' | 'Globus transfer request successfully submitted' | 'A transfer with identical paths has not yet completed. The current transfer may be terminated in the Globus console or contact ask-sdm@usgs.gov for assistance.' | 'Invalid scopes found for transfer. Please re-authenticated and retry transfer.' | 'A transfer path cannot include a directory.' | 'Duplicate filenames not allowed for transfer.' | 'The source endpoint for the Globus transfer was unavailable. Please confirm source Globus collection is available and try again.' | 'A file name cannot contain any of the following characters: < > : " / \ | ? *. On Microsoft Windows, file paths must be formatted like /C/Users/username/filename.csv.' | 'On Microsoft Windows, file paths must be formatted like /C/Users/username/filename.csv.' | 'An unknown error occurred during the transfer. Please try again later or contact ask-sdm@usgs.gov for assistance' | 'This task cannot be found. Please check the task ID.' | 'Internal server error' | 'Invalid schema' | 'File limit reached in collection.' | 'Metadata file not selected. Select a metadata file before performing index files.' | 'Metadata file not found. Please verify metadata file exists in the collection.' | 'Not authenticated' | 'Not Authorized' | 'Item not found' | 'Permissions updated' | 'Some permission changes could not be applied. See the errors in the response for details.' | 'Request processed successfully' | 'Delete not allowed for published releases' | 'Search not avaiable for data releases with more than 10000 components.' | 'Unable to update status at this time. Contact ask-sdm@usgs.gov for assistance.' | 'Updated' | 'User provided groups must grant manager permission to Horizon identity.' | 'User provided groups must not grant admin permission to the Horizon identity.' - string - `data` union, required - DataReleaseInitiation: Basic metadata schema for initiating a data release. Fields ------ usgsIdentifier: Identifier used to internally identify a resource within a particular system identifier: A unique identifier of the resource being described or cataloged. This identifier should be represented by a URI. usgsAssetType: The type of asset cataloged: data, model, publication, software usgsHasPart: Indicates whether the resource has a part or parts that are cataloged separately. If true, the resource has parts that are cataloged. usgsCreated: Date and time that the resource's record was created in the catalog usgsCreatedBy: The entity responsible for creating the resource's record in the catalog. usgsModified: Date and time that the resource's record was last modified usgsModifiedBy: The entity responsible for modifying the resource's record in the catalog. accessRights: Information about who can access the resource or an indication of its security status. publisher: The entity responsible for making the resource available. distribution: An available distribution of the dataset. - `usgsApprovalIdentifier` string, required - `title` string, required - `creator` Creator[], required - `entity_id` string, nullable - `name` string, required - `nameType` 'USGS Personal' | 'Personal' | 'Organizational' | 'Service': The type of entity described by a name usgs_personal = "USGS Personal" USGS Federal staff or contractors personal = "Personal" Person who is not affiliated with USGS or a USGS contractor organizational = "Organizational" A government, nonprofit, research, or other organization service = "Service" Software that performs automated tasks - `nameIdentifier` string, nullable - `email` string, nullable - `position` integer, required - `affiliation` string, nullable - `affiliationIdentifier` string, nullable - `license` License, required: A legal document under which the resource is made available. licenseIdentifier: A short, standardized version of the license name. license: The full version of the license name or free text description of the license or rights associated with the resource. licenseUri: The URI of the license. licenseIdentifierScheme: The name of the license identifier scheme schemeUri: The URI of the licenseIdentifierScheme - `licenseIdentifier` string, nullable - `license` string, required - `licenseUri` string, uri, nullable - `licenseIdentifierScheme` string, nullable - `schemeUri` string, uri, nullable - `usgsDataSource` UsgsDataSource, required: The USGS Science Center or Program responsible for managing the resource. The name and dataSourceId should come from Gluebucket. - `name` string, required - `dataSourceId` string, required - `usgsMissionArea` UsgsMissionArea: The USGS Mission Area responsible for managing the resource. The Mission Area name and ID should come from Gluebucket service. - `name` string, required - `missionAreaId` string, required - `relation` RelatedIdentifier[], nullable - `dataciteRelationType` 'IsCitedBy' | 'Cites' | 'IsSupplementTo' | 'IsSupplementedBy' | 'IsContinuedBy' | 'Continues' | 'IsNewVersionOf' | 'IsPreviousVersionOf' | 'IsPartOf' | 'HasPart' | 'IsReferencedBy' | 'References' | 'IsDocumentedBy' | 'Documents' | 'IsCompiledBy' | 'Compiles' | 'IsVariantFormOf' | 'IsOriginalFormOf' | 'IsIdenticalTo' | 'HasMetadata' | 'IsMetadataFor' | 'Reviews' | 'IsReviewedBy' | 'IsDerivedFrom' | 'IsSourceOf' | 'Describes' | 'IsDescribedBy' | 'HasVersion' | 'IsVersionOf' | 'Requires' | 'IsRequiredBy' | 'Obsoletes' | 'IsObsoletedBy' | 'IsPublishedIn', required: Description of the relationship of the resource being described and the related resource. - `relatedIdentifier` string, required - `isPrimaryRelatedIdentifier` boolean, required - `relatedIdentifierType` 'ARK' | 'arXiv' | 'bibcode' | 'DOI' | 'EAN13' | 'EISSN' | 'Handle' | 'IGSN' | 'ISBN' | 'ISSN' | 'ISTC' | 'LISSN' | 'LSID' | 'PMID' | 'PURL' | 'UPC' | 'URL' | 'URN' | 'w3id', required: The type of related identifier. - `description` string, nullable - `alternateIdentifier` AlternateIdentifier[], nullable - `alternateIdentifier` string, required - `alternateIdentifierType` 'ARK' | 'Servcat Number' | 'Genbank Accession Number' | 'IGSN' | 'LSID' | 'PURL' | 'Ref Seq ID' | 'Local Identifier' | 'Metadata Identifier' | 'ScienceBase Alt ID', required: The type of alternate identifier "ARK", "Servcat Number", "Genbank Accession Number", "IGSN", "LSID", "PURL", "Ref Seq ID", "Local Identifier", "Metadata Identifier", "ScienceBase Alt ID" - `qualifiedAttribution` Contributor[], nullable - `entity_id` string, nullable - `name` string, required - `nameType` 'USGS Personal' | 'Personal' | 'Organizational' | 'Service': The type of entity described by a name usgs_personal = "USGS Personal" USGS Federal staff or contractors personal = "Personal" Person who is not affiliated with USGS or a USGS contractor organizational = "Organizational" A government, nonprofit, research, or other organization service = "Service" Software that performs automated tasks - `nameIdentifier` string, nullable - `email` string, nullable - `position` integer, required - `affiliation` string, nullable - `affiliationIdentifier` string, nullable - `contributorType` 'Contact Person' | 'Data Collector' | 'Data Curator' | 'Data Manager' | 'Distributor' | 'Editor' | 'Hosting Institution' | 'Producer' | 'Project Leader' | 'Project Manager' | 'Project Member' | 'Registration Agency' | 'Registration Authority' | 'Related Person' | 'Researcher' | 'Research Group' | 'Rights Holder' | 'Sponsor' | 'Supervisor' | 'Work Package Leader' | 'Other', required: The type of contributor of the resource. See DataCite Metadata Schema for definitions: https://schema.datacite.org/ - `versionHistory` VersionHistory[], nullable - `version` string, nullable - `issued` string, date, nullable - `usgsApprovalIdentifier` string, nullable - `versionNotes` string, nullable - `systemKeyword` Keyword[], nullable - `concept` string, required - `conceptScheme` string, nullable - `conceptUri` string, uri, nullable - `conceptType` string, nullable - `usgsReleaseType` 'Data Release' | 'Dynamic' | 'Legacy' | 'Software Release': The type of release. Different types of releases fall under different USGS policy requirements. dataRelease = "Data Release" Data that are released as a static dataset and governed by USGS Survey Manual Chapter 502.8 dynamic = "Dynamic" Data that are continually collected, processed, quality-controlled, and released in real-time or near-real-time. legacy = "Legacy" Data that were released prior to the implementation of USGS Survey Manual Chapter 502.8. softwareRelease = "Software Release" Software that were released prior to the requirement to publish software at code.usgs.gov. - `usgsIdentifier` string, required - `identifier` string, uri, nullable - `usgsAssetType` 'Data' | 'Model' | 'Publication' | 'Software' - `usgsHasPart` boolean, nullable - `usgsCreated` string, date-time - `usgsCreatedBy` Entity: Person, Organization, or Service related to a resource Fields ------ entity_id: Identifier to uniquely identify an entity within a given system name: Name by which an entity is known nameType: The type of entity described by a name nameIdentifier: A globally unique persistent identifier for an entity (e.g., ORCID iD, ROR ID). - `entity_id` string, nullable - `name` string, required - `nameType` 'USGS Personal' | 'Personal' | 'Organizational' | 'Service': The type of entity described by a name usgs_personal = "USGS Personal" USGS Federal staff or contractors personal = "Personal" Person who is not affiliated with USGS or a USGS contractor organizational = "Organizational" A government, nonprofit, research, or other organization service = "Service" Software that performs automated tasks - `nameIdentifier` string, nullable - `email` string, nullable - `usgsModified` string, date-time - `usgsModifiedBy` Entity: Person, Organization, or Service related to a resource Fields ------ entity_id: Identifier to uniquely identify an entity within a given system name: Name by which an entity is known nameType: The type of entity described by a name nameIdentifier: A globally unique persistent identifier for an entity (e.g., ORCID iD, ROR ID). - `entity_id` string, nullable - `name` string, required - `nameType` 'USGS Personal' | 'Personal' | 'Organizational' | 'Service': The type of entity described by a name usgs_personal = "USGS Personal" USGS Federal staff or contractors personal = "Personal" Person who is not affiliated with USGS or a USGS contractor organizational = "Organizational" A government, nonprofit, research, or other organization service = "Service" Software that performs automated tasks - `nameIdentifier` string, nullable - `email` string, nullable - `accessRights` 'Public' | 'Non Public' - `publisher` Entity: Person, Organization, or Service related to a resource Fields ------ entity_id: Identifier to uniquely identify an entity within a given system name: Name by which an entity is known nameType: The type of entity described by a name nameIdentifier: A globally unique persistent identifier for an entity (e.g., ORCID iD, ROR ID). - `entity_id` string, nullable - `name` string, required - `nameType` 'USGS Personal' | 'Personal' | 'Organizational' | 'Service': The type of entity described by a name usgs_personal = "USGS Personal" USGS Federal staff or contractors personal = "Personal" Person who is not affiliated with USGS or a USGS contractor organizational = "Organizational" A government, nonprofit, research, or other organization service = "Service" Software that performs automated tasks - `nameIdentifier` string, nullable - `email` string, nullable - `distribution` Distribution[], nullable - `title` string, nullable - `name` string, nullable - `description` string, nullable - `format` string, nullable - `mediaType` string, nullable - `conformsTo` string, uri, nullable - `downloadURL` string, uri, nullable - `accessURL` string, uri, nullable - `byteSize` integer, nullable - `checksum` Checksum: A Checksum is a value that allows to check the integrity of the contents of a file. Even small changes to the content of the file will change its checksum. This class allows the results of a variety of checksum and cryptographic message digest algorithms to be represented. Fields ------ algorithm: Identifies the algorithm used to produce the subject Checksum (should use SPDX) checksumValue: The checksumValue property provides a lowercase hexadecimal encoded digest value produced using a specific algorithm - `algorithm` string, required - `checksumValue` string, required - `modifiedBy` Entity: Person, Organization, or Service related to a resource Fields ------ entity_id: Identifier to uniquely identify an entity within a given system name: Name by which an entity is known nameType: The type of entity described by a name nameIdentifier: A globally unique persistent identifier for an entity (e.g., ORCID iD, ROR ID). - `entity_id` string, nullable - `name` string, required - `nameType` 'USGS Personal' | 'Personal' | 'Organizational' | 'Service': The type of entity described by a name usgs_personal = "USGS Personal" USGS Federal staff or contractors personal = "Personal" Person who is not affiliated with USGS or a USGS contractor organizational = "Organizational" A government, nonprofit, research, or other organization service = "Service" Software that performs automated tasks - `nameIdentifier` string, nullable - `email` string, nullable - `modified` string, date-time, nullable - `useForPreview` boolean, nullable - `status` 'Created' | 'Submitted' | 'Locked' | 'Provisional' | 'Published' | 'Under Revision' | 'Revision Submitted' | 'Revised' | 'Deprecated': The status of a data release within the curation process. created = "Created" Default status when a record is first created in the repository. submitted = "Submitted" Data release has been submitted to the curation team locked = "Locked" Data release is not public but has been locked to edits to allow for an external review period. provisional = "Provisional" Data release is subject to revision and has been released prior to Bureau approval to meet an immediate need. published = "Published" Data release has received Bureau approval and is publicly available. underRevision = "Under Revision" Data release is being revised. The dataset metadata may be available but files are not accessible. revisionSubmitted = "Revision Submitted" Data release has been submitted to the curation team for revision. revised = "Revised" Data release has been revised. deprecated = "Deprecated" Data release was previously published but access to the data files needed to be removed due to errors or sensitivity converns. - DataRelease: Class that extends Dataset to include properties necessary for curating data within a data repository. usgsApprovalIdentifier: The identifier associated with the original record of approval for the data release. status: The status of a data release within the curation process. usgsReleaseType: The type of release. Different types of releases fall under different USGS policy requirements. - `usgsIdentifier` string, required - `identifier` string, uri, nullable - `title` string, required - `usgsAssetType` 'Data' | 'Model' | 'Publication' | 'Software', required - `usgsHasPart` boolean, nullable - `isPartOf` string, nullable - `usgsCreated` string, date-time, required - `usgsCreatedBy` Entity: Person, Organization, or Service related to a resource Fields ------ entity_id: Identifier to uniquely identify an entity within a given system name: Name by which an entity is known nameType: The type of entity described by a name nameIdentifier: A globally unique persistent identifier for an entity (e.g., ORCID iD, ROR ID). - `entity_id` string, nullable - `name` string, required - `nameType` 'USGS Personal' | 'Personal' | 'Organizational' | 'Service': The type of entity described by a name usgs_personal = "USGS Personal" USGS Federal staff or contractors personal = "Personal" Person who is not affiliated with USGS or a USGS contractor organizational = "Organizational" A government, nonprofit, research, or other organization service = "Service" Software that performs automated tasks - `nameIdentifier` string, nullable - `email` string, nullable - `usgsModified` string, date-time, required - `usgsModifiedBy` Entity: Person, Organization, or Service related to a resource Fields ------ entity_id: Identifier to uniquely identify an entity within a given system name: Name by which an entity is known nameType: The type of entity described by a name nameIdentifier: A globally unique persistent identifier for an entity (e.g., ORCID iD, ROR ID). - `entity_id` string, nullable - `name` string, required - `nameType` 'USGS Personal' | 'Personal' | 'Organizational' | 'Service': The type of entity described by a name usgs_personal = "USGS Personal" USGS Federal staff or contractors personal = "Personal" Person who is not affiliated with USGS or a USGS contractor organizational = "Organizational" A government, nonprofit, research, or other organization service = "Service" Software that performs automated tasks - `nameIdentifier` string, nullable - `email` string, nullable - `description` string, required - `accessRights` 'Public' | 'Non Public', required - `usgsCitation` string, required - `issued` string, date, required - `modified` string, date-time, nullable - `temporal` PeriodOfTime: An interval of time that is named or defined by its start and end dates. The interval can be open. For example, it can have just a start or just an end. In DCAT, temporal must be a string with two iso-8601 datetimes separated by '/'. We retain a list here and defer the conversion to DCAT's preference in the serialization. Fields ------ startDate: The start of the period. endDate: The end of the period. - `startDate` string, date, nullable - `endDate` string, date, nullable - `creator` Creator[], required - `entity_id` string, nullable - `name` string, required - `nameType` 'USGS Personal' | 'Personal' | 'Organizational' | 'Service': The type of entity described by a name usgs_personal = "USGS Personal" USGS Federal staff or contractors personal = "Personal" Person who is not affiliated with USGS or a USGS contractor organizational = "Organizational" A government, nonprofit, research, or other organization service = "Service" Software that performs automated tasks - `nameIdentifier` string, nullable - `email` string, nullable - `position` integer, required - `affiliation` string, nullable - `affiliationIdentifier` string, nullable - `contactPoint` Entity, required: Person, Organization, or Service related to a resource Fields ------ entity_id: Identifier to uniquely identify an entity within a given system name: Name by which an entity is known nameType: The type of entity described by a name nameIdentifier: A globally unique persistent identifier for an entity (e.g., ORCID iD, ROR ID). - `entity_id` string, nullable - `name` string, required - `nameType` 'USGS Personal' | 'Personal' | 'Organizational' | 'Service': The type of entity described by a name usgs_personal = "USGS Personal" USGS Federal staff or contractors personal = "Personal" Person who is not affiliated with USGS or a USGS contractor organizational = "Organizational" A government, nonprofit, research, or other organization service = "Service" Software that performs automated tasks - `nameIdentifier` string, nullable - `email` string, nullable - `usgsMetadataContactPoint` Entity, required: Person, Organization, or Service related to a resource Fields ------ entity_id: Identifier to uniquely identify an entity within a given system name: Name by which an entity is known nameType: The type of entity described by a name nameIdentifier: A globally unique persistent identifier for an entity (e.g., ORCID iD, ROR ID). - `entity_id` string, nullable - `name` string, required - `nameType` 'USGS Personal' | 'Personal' | 'Organizational' | 'Service': The type of entity described by a name usgs_personal = "USGS Personal" USGS Federal staff or contractors personal = "Personal" Person who is not affiliated with USGS or a USGS contractor organizational = "Organizational" A government, nonprofit, research, or other organization service = "Service" Software that performs automated tasks - `nameIdentifier` string, nullable - `email` string, nullable - `usgsDataSource` UsgsDataSource, required: The USGS Science Center or Program responsible for managing the resource. The name and dataSourceId should come from Gluebucket. - `name` string, required - `dataSourceId` string, required - `usgsMissionArea` UsgsMissionArea: The USGS Mission Area responsible for managing the resource. The Mission Area name and ID should come from Gluebucket service. - `name` string, required - `missionAreaId` string, required - `qualifiedAttribution` Contributor[], nullable - `entity_id` string, nullable - `name` string, required - `nameType` 'USGS Personal' | 'Personal' | 'Organizational' | 'Service': The type of entity described by a name usgs_personal = "USGS Personal" USGS Federal staff or contractors personal = "Personal" Person who is not affiliated with USGS or a USGS contractor organizational = "Organizational" A government, nonprofit, research, or other organization service = "Service" Software that performs automated tasks - `nameIdentifier` string, nullable - `email` string, nullable - `position` integer, required - `affiliation` string, nullable - `affiliationIdentifier` string, nullable - `contributorType` 'Contact Person' | 'Data Collector' | 'Data Curator' | 'Data Manager' | 'Distributor' | 'Editor' | 'Hosting Institution' | 'Producer' | 'Project Leader' | 'Project Manager' | 'Project Member' | 'Registration Agency' | 'Registration Authority' | 'Related Person' | 'Researcher' | 'Research Group' | 'Rights Holder' | 'Sponsor' | 'Supervisor' | 'Work Package Leader' | 'Other', required: The type of contributor of the resource. See DataCite Metadata Schema for definitions: https://schema.datacite.org/ - `publisher` Entity, required: Person, Organization, or Service related to a resource Fields ------ entity_id: Identifier to uniquely identify an entity within a given system name: Name by which an entity is known nameType: The type of entity described by a name nameIdentifier: A globally unique persistent identifier for an entity (e.g., ORCID iD, ROR ID). - `entity_id` string, nullable - `name` string, required - `nameType` 'USGS Personal' | 'Personal' | 'Organizational' | 'Service': The type of entity described by a name usgs_personal = "USGS Personal" USGS Federal staff or contractors personal = "Personal" Person who is not affiliated with USGS or a USGS contractor organizational = "Organizational" A government, nonprofit, research, or other organization service = "Service" Software that performs automated tasks - `nameIdentifier` string, nullable - `email` string, nullable - `distribution` Distribution[], required - `title` string, nullable - `name` string, nullable - `description` string, nullable - `format` string, nullable - `mediaType` string, nullable - `conformsTo` string, uri, nullable - `downloadURL` string, uri, nullable - `accessURL` string, uri, nullable - `byteSize` integer, nullable - `checksum` Checksum: A Checksum is a value that allows to check the integrity of the contents of a file. Even small changes to the content of the file will change its checksum. This class allows the results of a variety of checksum and cryptographic message digest algorithms to be represented. Fields ------ algorithm: Identifies the algorithm used to produce the subject Checksum (should use SPDX) checksumValue: The checksumValue property provides a lowercase hexadecimal encoded digest value produced using a specific algorithm - `algorithm` string, required - `checksumValue` string, required - `modifiedBy` Entity: Person, Organization, or Service related to a resource Fields ------ entity_id: Identifier to uniquely identify an entity within a given system name: Name by which an entity is known nameType: The type of entity described by a name nameIdentifier: A globally unique persistent identifier for an entity (e.g., ORCID iD, ROR ID). - `entity_id` string, nullable - `name` string, required - `nameType` 'USGS Personal' | 'Personal' | 'Organizational' | 'Service': The type of entity described by a name usgs_personal = "USGS Personal" USGS Federal staff or contractors personal = "Personal" Person who is not affiliated with USGS or a USGS contractor organizational = "Organizational" A government, nonprofit, research, or other organization service = "Service" Software that performs automated tasks - `nameIdentifier` string, nullable - `email` string, nullable - `modified` string, date-time, nullable - `useForPreview` boolean, nullable - `license` License, required: A legal document under which the resource is made available. licenseIdentifier: A short, standardized version of the license name. license: The full version of the license name or free text description of the license or rights associated with the resource. licenseUri: The URI of the license. licenseIdentifierScheme: The name of the license identifier scheme schemeUri: The URI of the licenseIdentifierScheme - `licenseIdentifier` string, nullable - `license` string, required - `licenseUri` string, uri, nullable - `licenseIdentifierScheme` string, nullable - `schemeUri` string, uri, nullable - `usgsPurpose` string, nullable - `keyword` Keyword[], nullable - `concept` string, required - `conceptScheme` string, nullable - `conceptUri` string, uri, nullable - `conceptType` string, nullable - `systemKeyword` Keyword[], nullable - `concept` string, required - `conceptScheme` string, nullable - `conceptUri` string, uri, nullable - `conceptType` string, nullable - `spatial` Location: A spatial region of named place Fields ------ geometry: Geometry Not included in initial schema. Could be added in the future bbox: The spatial limits of a bounding box. centroid: The longitude and latitude coordinates of the Location's centroid - `bbox` BoundingBox: The spatial limits of a bounding box. Fields ------ westBoundLongitude: Western longitudinal dimension of the bounding box: -180 to 180 eastBoundLongitude: Eastern longitudinal dimension of the bounding box: -180 to 180 southBoundLatitude: Southern latitudinal dimensions of the bounding box: -90 to 90 northBoundLatitude: Northern latitudinal dimensions of the bounding box: -90 to 90 - `westBoundLongitude` string, required - `eastBoundLongitude` string, required - `southBoundLatitude` string, required - `northBoundLatitude` string, required - `centroid` Centroid: The longitude and latitude coordinates of the Location's centroid Fields ------ point_longitude: Longitude decimal degrees: -180 to 180 point_latitude: Latitude decimal degrees: -90 to 90 - `pointLongitude` string, required - `pointLatitude` string, required - `relation` RelatedIdentifier[], nullable - `dataciteRelationType` 'IsCitedBy' | 'Cites' | 'IsSupplementTo' | 'IsSupplementedBy' | 'IsContinuedBy' | 'Continues' | 'IsNewVersionOf' | 'IsPreviousVersionOf' | 'IsPartOf' | 'HasPart' | 'IsReferencedBy' | 'References' | 'IsDocumentedBy' | 'Documents' | 'IsCompiledBy' | 'Compiles' | 'IsVariantFormOf' | 'IsOriginalFormOf' | 'IsIdenticalTo' | 'HasMetadata' | 'IsMetadataFor' | 'Reviews' | 'IsReviewedBy' | 'IsDerivedFrom' | 'IsSourceOf' | 'Describes' | 'IsDescribedBy' | 'HasVersion' | 'IsVersionOf' | 'Requires' | 'IsRequiredBy' | 'Obsoletes' | 'IsObsoletedBy' | 'IsPublishedIn', required: Description of the relationship of the resource being described and the related resource. - `relatedIdentifier` string, required - `isPrimaryRelatedIdentifier` boolean, required - `relatedIdentifierType` 'ARK' | 'arXiv' | 'bibcode' | 'DOI' | 'EAN13' | 'EISSN' | 'Handle' | 'IGSN' | 'ISBN' | 'ISSN' | 'ISTC' | 'LISSN' | 'LSID' | 'PMID' | 'PURL' | 'UPC' | 'URL' | 'URN' | 'w3id', required: The type of related identifier. - `description` string, nullable - `alternateIdentifier` AlternateIdentifier[], nullable - `alternateIdentifier` string, required - `alternateIdentifierType` 'ARK' | 'Servcat Number' | 'Genbank Accession Number' | 'IGSN' | 'LSID' | 'PURL' | 'Ref Seq ID' | 'Local Identifier' | 'Metadata Identifier' | 'ScienceBase Alt ID', required: The type of alternate identifier "ARK", "Servcat Number", "Genbank Accession Number", "IGSN", "LSID", "PURL", "Ref Seq ID", "Local Identifier", "Metadata Identifier", "ScienceBase Alt ID" - `versionHistory` VersionHistory[], nullable - `version` string, nullable - `issued` string, date, nullable - `usgsApprovalIdentifier` string, nullable - `versionNotes` string, nullable - `usgsApprovalIdentifier` string, required - `status` 'Created' | 'Submitted' | 'Locked' | 'Provisional' | 'Published' | 'Under Revision' | 'Revision Submitted' | 'Revised' | 'Deprecated': The status of a data release within the curation process. created = "Created" Default status when a record is first created in the repository. submitted = "Submitted" Data release has been submitted to the curation team locked = "Locked" Data release is not public but has been locked to edits to allow for an external review period. provisional = "Provisional" Data release is subject to revision and has been released prior to Bureau approval to meet an immediate need. published = "Published" Data release has received Bureau approval and is publicly available. underRevision = "Under Revision" Data release is being revised. The dataset metadata may be available but files are not accessible. revisionSubmitted = "Revision Submitted" Data release has been submitted to the curation team for revision. revised = "Revised" Data release has been revised. deprecated = "Deprecated" Data release was previously published but access to the data files needed to be removed due to errors or sensitivity converns. - `usgsReleaseType` 'Data Release' | 'Dynamic' | 'Legacy' | 'Software Release': The type of release. Different types of releases fall under different USGS policy requirements. dataRelease = "Data Release" Data that are released as a static dataset and governed by USGS Survey Manual Chapter 502.8 dynamic = "Dynamic" Data that are continually collected, processed, quality-controlled, and released in real-time or near-real-time. legacy = "Legacy" Data that were released prior to the implementation of USGS Survey Manual Chapter 502.8. softwareRelease = "Software Release" Software that were released prior to the requirement to publish software at code.usgs.gov. ## Other responses - `404`: Not found - `422`: Validation Error --- [API](https://skmtc.dev/usgs/apis/usgs-science-data-catalog-api-documentation.md) - [All operations](https://skmtc.dev/usgs/apis/usgs-science-data-catalog-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/usgs/apis/usgs-science-data-catalog-api-documentation/revisions/f5f6a07ba13f?raw)