---
title: "Update a data release component."
method: PUT
path: "/datacatalog/api/component/{id}"
tags: ["Data Release"]
---

# Update a data release component.

`PUT /datacatalog/api/component/{id}`

## 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/component/{id}`
- Auth: OAuth 2
  - Authorization code: `https://auth.globus.org/v2/oauth2/authorize?scope=openid`
  - Token URL: `https://data.usgs.gov/datacatalog/api/auth/login`

Update a data release component.

## Path parameters

- `id` string, required

## Request body

- ComponentUpdate: This defines the fields available for component update.
  - `title` string, nullable, required
  - `description` string, nullable, required
  - `creator` Creator[]
    - `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
  - `identifier` string, uri, nullable
  - `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
  - `isCatalogRecord` boolean

## Response `200`

Successful Response

- unknown

## 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)