cocina-models 0.31.1 → 0.32.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (15) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +6 -12
  3. data/docs/index.html +20 -0
  4. data/docs/maps/DRO.json +1 -1
  5. data/lib/cocina/models/access.rb +4 -0
  6. data/lib/cocina/models/dro_access.rb +7 -1
  7. data/lib/cocina/models/event.rb +1 -1
  8. data/lib/cocina/models/version.rb +1 -1
  9. data/openapi.yml +113 -26
  10. metadata +3 -7
  11. data/docs/README.md +0 -9
  12. data/docs/_config.yml +0 -1
  13. data/docs/meta.json +0 -9
  14. data/docs/schema.json +0 -1654
  15. data/docs/schema.md +0 -268
data/docs/schema.md DELETED
@@ -1,268 +0,0 @@
1
-
2
- ## <a name="resource-Agent">Agent</a>
3
-
4
-
5
- An Agent - Person, Group, Organization, or other Acting body.
6
-
7
- ### Attributes
8
-
9
- | Name | Type | Description | Example |
10
- | ------- | ------- | ------- | ------- |
11
- | **name** | *string* | Primary label or name for an Agent. | `"example"` |
12
- | **sunetID** | *string* | Stanford University NetID for the Agent. | `"example"` |
13
-
14
-
15
- ## <a name="resource-Collection">Digital Repository Collection</a>
16
-
17
-
18
- A group of Digital Repository Objects that indicate some type of conceptual grouping within the domain that is worth reusing across the system.
19
-
20
- ### Attributes
21
-
22
- | Name | Type | Description | Example |
23
- | ------- | ------- | ------- | ------- |
24
- | **@context** | *string* | URI for the JSON-LD context definitions. | `"example"` |
25
- | **@type** | *string* | The content type of the Collection. Selected from an established set of values.<br/> **one of:**`"http://cocina.sul.stanford.edu/models/collection.jsonld"` or `"http://cocina.sul.stanford.edu/models/curated-collection.jsonld"` or `"http://cocina.sul.stanford.edu/models/user-collection.jsonld"` or `"http://cocina.sul.stanford.edu/models/exhibit.jsonld"` or `"http://cocina.sul.stanford.edu/models/series.jsonld"` | `"http://cocina.sul.stanford.edu/models/collection.jsonld"` |
26
- | **access:access** | *string* | Access level for the Collection.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
27
- | **access:copyright** | *string* | The human readable copyright statement that applies to the Collection. | `"example"` |
28
- | **access:download** | *string* | Download level for the Collection metadata.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
29
- | **access:embargoReleaseDate** | *date-time* | Date when the Collection is released from an embargo, if an embargo exists. | `"2015-01-01T12:00:00Z"` |
30
- | **access:license** | *string* | The license governing reuse of the Collection. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.). | `"example"` |
31
- | **access:termsOfUse** | *string* | License or terms of use governing reuse of the Collection. Should be a text statement. | `"example"` |
32
- | **access:useAndReproductionStatement** | *string* | The human readable reuse and reproduction statement that applies to the Collection. | `"example"` |
33
- | **administrative:created** | *date-time* | When the resource in SDR was created. | `"2015-01-01T12:00:00Z"` |
34
- | **administrative:deleted** | *boolean* | If the resource has been deleted (but not purged). | `true` |
35
- | **administrative:gravestoneMessage** | *string* | Message describing why the object was deleted. | `"example"` |
36
- | **administrative:isDescribedBy** | *string* | PURL/XML file that is a traditional representation of the metadata for the Collection. | `"example"` |
37
- | **administrative:lastUpdated** | *date-time* | When the resource in SDR was last updated. | `"2015-01-01T12:00:00Z"` |
38
- | **administrative:partOfProject** | *string* | Administrative or Internal project this resource is a part of. | `"example"` |
39
- | **administrative:releaseTags** | *array* | Tags for release | `[{"to":"Searchworks","what":"self","date":"2015-01-01T12:00:00Z","who":"example","release":true}]` |
40
- | **administrative:remediatedBy** | *array* | The Agent (User, Group, Application, Department, other) that remediated a Collection in SDR. | `[{"name":"example","sunetID":"example"}]` |
41
- | **administrative:sdrPreserve** | *boolean* | If this resource should be sent to Preservation. | `true` |
42
- | **citation** | *string* | Citation for the resource, including identifier, label, version, and a persistent URL to the object with SDR at the very least. | `"example"` |
43
- | **dedupeIdentifier** | *string* | Identifier retrieved from identification.sourceId that stands for analog or source identifier that this resource is a digital representation of. | `"example"` |
44
- | **depositor:name** | *string* | Primary label or name for an Agent. | `"example"` |
45
- | **depositor:sunetID** | *string* | Stanford University NetID for the Agent. | `"example"` |
46
- | **description:title** | *array* | The title of the item. | `[{"primary":true,"titleFull":"example"}]` |
47
- | **externalIdentifier** | *string* | Identifier for the resource within the SDR architecture but outside of the repository. DRUID or UUID depending on resource type. Constant across resource versions. What clients will use calling the repository. Same as `identification.identifier` | `"example"` |
48
- | **followingVersion** | *string* | Following version for the Collection within SDR. | `"example"` |
49
- | **identification:DOI** | *string* | Digital Object Identifier (DOI) for the Collection within this repository. | `"example"` |
50
- | **identification:catalogLinks/catalog** | *string* | Catalog that is the source of the linked record. | `"example"` |
51
- | **identification:catalogLinks/catalogRecordId** | *string* | Record identifier that is unique within the context of the linked record's catalog. | `"example"` |
52
- | **identification:catalogLinks/deliverMetadata** | *boolean* | If the linked record should be automatically updated when the Collection descriptive metadata changes. | `true` |
53
- | **identification:catalogLinks/deriveMetadata** | *boolean* | If the Collection descriptive metadata should be automatically updated when the linked record changes. | `true` |
54
- | **identification:catalogLinks/recordSchema** | *string* | Metadata schema of the linked record. | `"example"` |
55
- | **identification:catalogLinks/recordScope** | *string* | Whether the linked record describes a resource that is broader than, equivalent to, or narrower than the resource the Collection represents.<br/> **one of:**`"broader"` or `"equivalent"` or `"narrower"` | `"broader"` |
56
- | **identification:identifier** | *string* | Identifier for the Collection within the Stanford Digital Repository system | `"example"` |
57
- | **identification:sameAs** | *string* | Another object, either external or internal to the system (if duplication occurs) that is the same digital resource as this Collection. | `"example"` |
58
- | **identification:sdrUUID** | *string* | UUID previously minted for the resource within SDR2 / Fedora 3. | `"example"` |
59
- | **identification:sourceId** | *string* | A source resource or object (perhaps but not necessarily analog or physical) that the Collection is a digital representation of. | `"example"` |
60
- | **internalIdentifier** | *string* | Identifier for the resource within the repository. UUID, unique for each new version of a repository resource. | `"example"` |
61
- | **label** | *string* | Primary processing label (can be same as title) for a Collection. | `"example"` |
62
- | **precedingVersion** | *string* | Preceding version for the Collection within SDR. | `"example"` |
63
- | **structural:hasAgreement** | *string* | Agreement that covers the deposit of the Collection into SDR. | `"example"` |
64
- | **structural:hasMember** | *array* | Component digital repository objects or collections that are a part of this collection. | `[null]` |
65
- | **structural:hasMemberOrders** | *array* | Provided sequences or orderings of members of the Collection, including some metadata about each sequence (i.e. sequence label, sequence type, if the sequence is primary, etc.). | `[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/sequence.jsonld","label":"example","startMember":"example","members":[null],"viewingDirection":"left-to-right"}]` |
66
- | **structural:isTargetOf** | *string* | An Annotation instance that applies to the Collection. | `"example"` |
67
- | **version** | *integer* | Version for the Collection within SDR. | `42` |
68
-
69
-
70
- ## <a name="resource-DRO">Digital Repository Object</a>
71
-
72
-
73
- Domain-defined abstraction of a 'work'. Digital Repository Objects' abstraction is describable for our domain’s purposes, i.e. for management needs within our system.
74
-
75
- ### Attributes
76
-
77
- | Name | Type | Description | Example |
78
- | ------- | ------- | ------- | ------- |
79
- | **@context** | *string* | URI for the JSON-LD context definitions. | `"example"` |
80
- | **@type** | *string* | The content type of the DRO. Selected from an established set of values.<br/> **one of:**`"http://cocina.sul.stanford.edu/models/object.jsonld"` or `"http://cocina.sul.stanford.edu/models/3d.jsonld"` or `"http://cocina.sul.stanford.edu/models/agreement.jsonld"` or `"http://cocina.sul.stanford.edu/models/book.jsonld"` or `"http://cocina.sul.stanford.edu/models/document.jsonld"` or `"http://cocina.sul.stanford.edu/models/geo.jsonld"` or `"http://cocina.sul.stanford.edu/models/image.jsonld"` or `"http://cocina.sul.stanford.edu/models/page.jsonld"` or `"http://cocina.sul.stanford.edu/models/photograph.jsonld"` or `"http://cocina.sul.stanford.edu/models/manuscript.jsonld"` or `"http://cocina.sul.stanford.edu/models/map.jsonld"` or `"http://cocina.sul.stanford.edu/models/media.jsonld"` or `"http://cocina.sul.stanford.edu/models/track.jsonld"` or `"http://cocina.sul.stanford.edu/models/webarchive-binary.jsonld"` or `"http://cocina.sul.stanford.edu/models/webarchive-seed.jsonld"` | `"http://cocina.sul.stanford.edu/models/object.jsonld"` |
81
- | **access:access** | *string* | Access level for the DRO.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
82
- | **access:copyright** | *string* | The human readable copyright statement that applies to the DRO. | `"example"` |
83
- | **access:download** | *string* | Download level for the DRO metadata.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
84
- | **access:embargo:access** | *string* | Access level for the DRO when released from embargo.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
85
- | **access:embargo:releaseDate** | *date-time* | Date when the DRO is released from an embargo. | `"2015-01-01T12:00:00Z"` |
86
- | **access:embargo:useAndReproductionStatement** | *string* | The human readable reuse and reproduction statement that applies to the DRO when released from embargo. | `"example"` |
87
- | **access:license** | *string* | The license governing reuse of the DRO. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.). | `"example"` |
88
- | **access:termsOfUse** | *string* | License or terms of use governing reuse of the DRO. Should be a text statement. | `"example"` |
89
- | **access:useAndReproductionStatement** | *string* | The human readable reuse and reproduction statement that applies to the DRO. | `"example"` |
90
- | **access:visibility** | *integer* | Percentage of the DRO that is visibility during an embargo period | `42` |
91
- | **administrative:created** | *date-time* | When the resource in SDR was created. | `"2015-01-01T12:00:00Z"` |
92
- | **administrative:deleted** | *boolean* | If the resource has been deleted (but not purged). | `true` |
93
- | **administrative:gravestoneMessage** | *string* | Message describing why the object was deleted. | `"example"` |
94
- | **administrative:isDescribedBy** | *string* | Pointer to the PURL/XML file that is a traditional representation of the metadata for the DRO. | `"example"` |
95
- | **administrative:lastUpdated** | *date-time* | When the resource in SDR was last updated. | `"2015-01-01T12:00:00Z"` |
96
- | **administrative:partOfProject** | *string* | Administrative or Internal project this resource is a part of. | `"example"` |
97
- | **administrative:releaseTags** | *array* | Tags for release | `[{"to":"Searchworks","what":"self","date":"2015-01-01T12:00:00Z","who":"example","release":true}]` |
98
- | **administrative:remediatedBy** | *array* | The Agent (User, Group, Application, Department, other) that remediated a DRO in SDR. | `[{"name":"example","sunetID":"example"}]` |
99
- | **administrative:sdrPreserve** | *boolean* | If this resource should be sent to Preservation. | `true` |
100
- | **citation** | *string* | Citation for the resource, including identifier, label, version, and a persistent URL to the object with SDR at the very least. | `"example"` |
101
- | **dedupeIdentifier** | *string* | Identifier retrieved from identification.sourceId that stands for analog or source identifier that this resource is a digital representation of. | `"example"` |
102
- | **depositor:name** | *string* | Primary label or name for an Agent. | `"example"` |
103
- | **depositor:sunetID** | *string* | Stanford University NetID for the Agent. | `"example"` |
104
- | **description:title** | *array* | The title of the item. | `[{"primary":true,"titleFull":"example"}]` |
105
- | **externalIdentifier** | *string* | Identifier for the resource within the SDR architecture but outside of the repository. DRUID or UUID depending on resource type. Constant across resource versions. What clients will use calling the repository. Same as `identification.identifier` | `"example"` |
106
- | **followingVersion** | *string* | Following version for the Object within SDR. | `"example"` |
107
- | **geographic:iso19139** | *string* | Geographic ISO 19139 XML metadata | `"example"` |
108
- | **identification:catalogLinks/catalog** | *string* | Catalog that is the source of the linked record. | `"example"` |
109
- | **identification:catalogLinks/catalogRecordId** | *string* | Record identifier that is unique within the context of the linked record's catalog. | `"example"` |
110
- | **identification:catalogLinks/deliverMetadata** | *boolean* | If the linked record should be automatically updated when the DRO descriptive metadata changes. | `true` |
111
- | **identification:catalogLinks/deriveMetadata** | *boolean* | If the DRO descriptive metadata should be automatically updated when the linked record changes. | `true` |
112
- | **identification:catalogLinks/recordSchema** | *string* | Metadata schema of the linked record. | `"example"` |
113
- | **identification:catalogLinks/recordScope** | *string* | Whether the linked record describes a resource that is broader than, equivalent to, or narrower than the resource the DRO represents.<br/> **one of:**`"broader"` or `"equivalent"` or `"narrower"` | `"broader"` |
114
- | **identification:doi** | *string* | Digital Object Identifier (DOI) for the DRO within this repository. | `"example"` |
115
- | **identification:identifier** | *string* | Identifier for the Digital Repository Object within the Stanford Digital Repository system | `"example"` |
116
- | **identification:sameAs** | *string* | Another object, either external or internal to the system (if duplication occurs) that is the same digital resource as this DRO. | `"example"` |
117
- | **identification:sdrUUID** | *string* | UUID previously minted for the resource within SDR2 / Fedora 3. | `"example"` |
118
- | **identification:sourceId** | *string* | A source resource or object (perhaps but not necessarily analog or physical) that the DRO is a digital representation of. | `"example"` |
119
- | **internalIdentifier** | *string* | Identifier for the resource within the repository. UUID, unique for each new version of a repository resource. | `"example"` |
120
- | **label** | *string* | Primary processing label (can be same as title) for a DRO. | `"example"` |
121
- | **permissions:approvalRequired** | *boolean* | Indicates if approval is required to deposit or manage the resource in SDR. | `true` |
122
- | **permissions:approvers** | *array* | Agents who are required to approve deposit or management of this resource in SDR. | `[{"name":"example","sunetID":"example"}]` |
123
- | **precedingVersion** | *string* | Preceding version for the Object within SDR. | `"example"` |
124
- | **structural:contains** | *array* | Filesets that contain the digital representations (Files) of the DRO. | `[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/fileset.jsonld","depositor":{"name":"example","sunetID":"example"},"label":"example","externalIdentifier":"example","internalIdentifier":"example","version":42,"precedingVersion":"example","followingVersion":"example","access":{"access":"world","download":"world"},"administrative":{"created":"2015-01-01T12:00:00Z","deleted":true,"gravestoneMessage":"example","lastUpdated":"2015-01-01T12:00:00Z","partOfProject":"example","sdrPreserve":true,"remediatedBy":[{"name":"example","sunetID":"example"}]},"identification":{"identifier":"example","sdrUUID":"example"},"structural":{"contains":[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/file.jsonld","depositor":{"name":"example","sunetID":"example"},"externalIdentifier":"example","filename":"example","format":"example","hasMessageDigests":[{"type":"md5","digest":"example"}],"hasMimeType":"example","label":"example","presentation":{"height":42,"width":42},"size":42,"internalIdentifier":"example","use":"example","version":42,"precedingVersion":"example","followingVersion":"example","access":{"access":"world","download":"world"},"administrative":{"created":"2015-01-01T12:00:00Z","deleted":true,"gravestoneMessage":"example","lastUpdated":"2015-01-01T12:00:00Z","partOfProject":"example","sdrPreserve":true,"shelve":true,"remediatedBy":[{"name":"example","sunetID":"example"}]},"identification":{"filename":"example","identifier":"example","sdrUUID":"example"},"structural":{"isContainedBy":"example","isTargetOf":"example"}}],"isContainedBy":"example","isTargetOf":"example"}}]` |
125
- | **structural:hasAgreement** | *string* | Agreement that covers the deposit of the DRO into SDR. | `"example"` |
126
- | **structural:hasMember** | *array* | Component or 'children' digital repository objects that are a part or portion of this 'parent' or aggregate DRO. | `[null]` |
127
- | **structural:hasMemberOrders** | *array* | Provided sequences or orderings of members of the Object, including some metadata about each sequence (i.e. sequence label, sequence type, if the sequence is primary, etc.). | `[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/sequence.jsonld","label":"example","startMember":"example","members":[null],"viewingDirection":"left-to-right"}]` |
128
- | **structural:isMemberOf** | *string* | Collection that this DRO is a member of | `"example"` |
129
- | **structural:isTargetOf** | *string* | An Annotation instance that applies to the DRO. | `"example"` |
130
- | **version** | *integer* | Version for the DRO within SDR. | `42` |
131
-
132
-
133
- ## <a name="resource-Description">Description</a>
134
-
135
-
136
- The description of a work
137
-
138
- ### Attributes
139
-
140
- | Name | Type | Description | Example |
141
- | ------- | ------- | ------- | ------- |
142
- | **title** | *array* | The title of the item. | `[{"primary":true,"titleFull":"example"}]` |
143
-
144
-
145
- ## <a name="resource-File">File</a>
146
-
147
-
148
- Binaries that are the basis of what our domain manages. Binaries here do not include metadata files generated for the domain's own management purposes.
149
-
150
- ### Attributes
151
-
152
- | Name | Type | Description | Example |
153
- | ------- | ------- | ------- | ------- |
154
- | **@context** | *string* | URI for the JSON-LD context definitions. | `"example"` |
155
- | **@type** | *string* | The content type of the File.<br/> **one of:**`"http://cocina.sul.stanford.edu/models/file.jsonld"` | `"http://cocina.sul.stanford.edu/models/file.jsonld"` |
156
- | **access:access** | *string* | Access level for the File. If "dark" this won't go into public xml contentMetadata.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
157
- | **access:download** | *string* | Download level for the File binary.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
158
- | **administrative:created** | *date-time* | When the resource in SDR was created. | `"2015-01-01T12:00:00Z"` |
159
- | **administrative:deleted** | *boolean* | If the resource has been deleted (but not purged). | `true` |
160
- | **administrative:gravestoneMessage** | *string* | Message describing why the resource was deleted. | `"example"` |
161
- | **administrative:lastUpdated** | *date-time* | When the resource in SDR was last updated. | `"2015-01-01T12:00:00Z"` |
162
- | **administrative:partOfProject** | *string* | Administrative or Internal project this resource is a part of. | `"example"` |
163
- | **administrative:remediatedBy** | *array* | The Agent (User, Group, Application, Department, other) that remediated this File in SDR. | `[{"name":"example","sunetID":"example"}]` |
164
- | **administrative:sdrPreserve** | *boolean* | If this resource should be sent to Preservation. | `true` |
165
- | **administrative:shelve** | *boolean* | If this resource should be sent to Stacks. | `true` |
166
- | **depositor:name** | *string* | Primary label or name for an Agent. | `"example"` |
167
- | **depositor:sunetID** | *string* | Stanford University NetID for the Agent. | `"example"` |
168
- | **externalIdentifier** | *string* | Identifier for the resource within the SDR architecture but outside of the repository. UUID. Constant across resource versions. What clients will use calling the repository. Same as `identification.identifier` | `"example"` |
169
- | **filename** | *string* | Filename for a file. Can be same as label. | `"example"` |
170
- | **followingVersion** | *string* | Following version for the File within SDR. | `"example"` |
171
- | **format** | *string* | Format of the File. | `"example"` |
172
- | **hasMessageDigests/digest** | *string* | The digest value | `"example"` |
173
- | **hasMessageDigests/type** | *string* | The algorithm that was used<br/> **one of:**`"md5"` or `"sha1"` | `"md5"` |
174
- | **hasMimeType** | *string* | MIME Type of the File. | `"example"` |
175
- | **identification:filename** | *string* | Filename for the File from originating systems. | `"example"` |
176
- | **identification:identifier** | *string* | Identifier for the File within the Stanford Digital Repository system | `"example"` |
177
- | **identification:sdrUUID** | *string* | UUID previously minted for the resource within SDR2 / Fedora 3. | `"example"` |
178
- | **internalIdentifier** | *string* | Identifier for the resource within the repository. UUID, unique for each new version of a repository resource. | `"example"` |
179
- | **label** | *string* | Primary processing label (can be same as title) for a File. | `"example"` |
180
- | **precedingVersion** | *string* | Preceding version for the File within SDR. | `"example"` |
181
- | **presentation:height** | *integer* | Height in pixels | `42` |
182
- | **presentation:width** | *integer* | Width in pixels | `42` |
183
- | **size** | *integer* | Size of the File (binary) in bytes. | `42` |
184
- | **structural:isContainedBy** | *string* | Fileset that contains this File. | `"example"` |
185
- | **structural:isTargetOf** | *string* | An Annotation instance that applies to this File. | `"example"` |
186
- | **use** | *string* | Use for the File. | `"example"` |
187
- | **version** | *integer* | Version for the File within SDR. | `42` |
188
-
189
-
190
- ## <a name="resource-Fileset">Fileset</a>
191
-
192
-
193
- Relevant groupings of Files. Also called a File Grouping.
194
-
195
- ### Attributes
196
-
197
- | Name | Type | Description | Example |
198
- | ------- | ------- | ------- | ------- |
199
- | **@context** | *string* | URI for the JSON-LD context definitions. | `"example"` |
200
- | **@type** | *string* | The content type of the Fileset.<br/> **one of:**`"http://cocina.sul.stanford.edu/models/fileset.jsonld"` | `"http://cocina.sul.stanford.edu/models/fileset.jsonld"` |
201
- | **access:access** | *string* | Access level for the Fileset.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
202
- | **access:download** | *string* | Download level for the Fileset metadata.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
203
- | **administrative:created** | *date-time* | When the resource in SDR was created. | `"2015-01-01T12:00:00Z"` |
204
- | **administrative:deleted** | *boolean* | If the resource has been deleted (but not purged). | `true` |
205
- | **administrative:gravestoneMessage** | *string* | Message describing why the resource was deleted. | `"example"` |
206
- | **administrative:lastUpdated** | *date-time* | When the resource in SDR was last updated. | `"2015-01-01T12:00:00Z"` |
207
- | **administrative:partOfProject** | *string* | Administrative or Internal project this resource is a part of. | `"example"` |
208
- | **administrative:remediatedBy** | *array* | The Agent (User, Group, Application, Department, other) that remediated a Fileset in SDR. | `[{"name":"example","sunetID":"example"}]` |
209
- | **administrative:sdrPreserve** | *boolean* | If this resource should be sent to Preservation. | `true` |
210
- | **depositor:name** | *string* | Primary label or name for an Agent. | `"example"` |
211
- | **depositor:sunetID** | *string* | Stanford University NetID for the Agent. | `"example"` |
212
- | **externalIdentifier** | *string* | Identifier for the resource within the SDR architecture but outside of the repository. UUID. Constant across resource versions. What clients will use calling the repository. Same as `identification.identifier` | `"example"` |
213
- | **followingVersion** | *string* | Following version for the Fileset within SDR. | `"example"` |
214
- | **identification:identifier** | *string* | Identifier for the Fileset within the Stanford Digital Repository system | `"example"` |
215
- | **identification:sdrUUID** | *string* | UUID previously minted for the resource within SDR2 / Fedora 3. | `"example"` |
216
- | **internalIdentifier** | *string* | Identifier for the resource within the repository. UUID, unique for each new version of a repository resource. | `"example"` |
217
- | **label** | *string* | Primary processing label (can be same as title) for a Fileset. | `"example"` |
218
- | **precedingVersion** | *string* | Preceding version for the Fileset within SDR. | `"example"` |
219
- | **structural:contains** | *array* | Files that are members of the fileset. | `[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/file.jsonld","depositor":{"name":"example","sunetID":"example"},"externalIdentifier":"example","filename":"example","format":"example","hasMessageDigests":[{"type":"md5","digest":"example"}],"hasMimeType":"example","label":"example","presentation":{"height":42,"width":42},"size":42,"internalIdentifier":"example","use":"example","version":42,"precedingVersion":"example","followingVersion":"example","access":{"access":"world","download":"world"},"administrative":{"created":"2015-01-01T12:00:00Z","deleted":true,"gravestoneMessage":"example","lastUpdated":"2015-01-01T12:00:00Z","partOfProject":"example","sdrPreserve":true,"shelve":true,"remediatedBy":[{"name":"example","sunetID":"example"}]},"identification":{"filename":"example","identifier":"example","sdrUUID":"example"},"structural":{"isContainedBy":"example","isTargetOf":"example"}}]` |
220
- | **structural:isContainedBy** | *string* | Parent DRO that is represented by the files in this Fileset. | `"example"` |
221
- | **structural:isTargetOf** | *string* | An Annotation instance that applies to this Fileset. | `"example"` |
222
- | **version** | *integer* | Version for the Fileset within SDR. | `42` |
223
-
224
-
225
- ## <a name="resource-ReleaseTag">Release Tag</a>
226
-
227
-
228
- A tag that indicates the item or collection should be released.
229
-
230
- ### Attributes
231
-
232
- | Name | Type | Description | Example |
233
- | ------- | ------- | ------- | ------- |
234
- | **date** | *date-time* | When did this action happen | `"2015-01-01T12:00:00Z"` |
235
- | **release** | *boolean* | Should it be released or withdrawn. Release is coded as true and withdraw as false | `true` |
236
- | **to** | *string* | What platform is it released to<br/> **one of:**`"Searchworks"` or `"Earthworks"` | `"Searchworks"` |
237
- | **what** | *string* | What is being released. This item or the whole collection.<br/> **one of:**`"self"` or `"collection"` | `"self"` |
238
- | **who** | *string* | Who did this release | `"example"` |
239
-
240
-
241
- ## <a name="resource-Sequence">Resource Sequence</a>
242
-
243
-
244
- A sequence or ordering of resources within a Collection or Object.
245
-
246
- ### Attributes
247
-
248
- | Name | Type | Description | Example |
249
- | ------- | ------- | ------- | ------- |
250
- | **@context** | *string* | URI for the JSON-LD context definitions. | `"example"` |
251
- | **@type** | *string* | The type of Sequence.<br/> **one of:**`"http://cocina.sul.stanford.edu/models/sequence.jsonld"` or `"http://cocina.sul.stanford.edu/models/primary-sequence.jsonld"` | `"http://cocina.sul.stanford.edu/models/sequence.jsonld"` |
252
- | **label** | *string* | Label for the sequence or ordering. | `"example"` |
253
- | **members** | *array* | Identifiers for Members in their stated Order for the Sequence. | `[null]` |
254
- | **startMember** | *string* | Identifier for the first member of the sequence. | `"example"` |
255
- | **viewingDirection** | *string* | The direction that a sequence of canvases should be displayed to the user<br/> **one of:**`"left-to-right"` or `"right-to-left"` or `"top-to-bottom"` or `"bottom-to-top"` | `"left-to-right"` |
256
-
257
-
258
- ## <a name="resource-Title">Title</a>
259
-
260
-
261
- A title of a work
262
-
263
- ### Attributes
264
-
265
- | Name | Type | Description | Example |
266
- | ------- | ------- | ------- | ------- |
267
- | **primary** | *boolean* | Is this the primary title for the object | `true` |
268
- | **titleFull** | *string* | The full title for the object | `"example"` |