Skip to content

Update enrichment fields section for sourceId #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
codycooperross wants to merge 1 commit into
base: v1.8
Choose a base branch
from
Open

Update enrichment fields section for sourceId #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions ...ntegrators and Harvesters/retrieve-metadata-with-an-api/metadata-enrichments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Enrichment records describe changes to DataCite DOI metadata, but they do not al
Enrichment records have three core pieces of information:

- The DOI on which the enrichment is asserting a change
- The provenance of the enrichment, i.e., the contributors and resources that produced the enrichment record
- The provenance of the enrichment, i.e., the resource that produced the enrichment record
Comment thread
KellyStathis marked this conversation as resolved.
- The enrichment action, i.e., the change the enrichment asserts to the DOI’s original metadata

#### Enrichment record fields
Expand All @@ -124,8 +124,7 @@ Each field of an enrichment record is described below:
| Field | Description |
| :------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| doi | The target DOI of the enrichment record. |
| contributors | Provenance information describing the source entities of the enrichment represented as an array of contributors. |
| resources | Provenance information referring to resources about the enrichment method, such as project documentation and related datasets, represented as an array of relatedIdentifiers. |
| sourceId | A DOI for a resource containing provenance information about the enrichment source, including project documentation and related datasets. |
| field | The top-level metadata field to enrich, e.g., creators, relatedIdentifiers, types, etc. |
| action | The action that the enrichment performs. The available actions are: update (change the entire top-level "field" from the "originalValue" to the "enrichedValue") updateChild (change a child object within the top-level "field" from the "originalValue" to the "enrichedValue") insert (insert the object in "enrichedValue" into the top-level "field") deleteChild (remove the object in "originalValue" within the top-level field specified in "field") |
| originalValue | When the action is update, updateChild, or deleteChild: the original value of the field or the child value to be replaced with the enrichedValue. Otherwise, this field is empty. |
Expand Down