Create a Collection.
Create a TextAPI Collection with an optional
slug for the Collection ID and return it.
Headers
slugCreate a Collection. › Request Body
titlesThe title(s) of the collection. First item in the array is the main title
Personal entities responsible for the collection
Personal entities responsible for the edition
Entities (e.g. organizations or individual persons) responsible for funding the project in which the text(s) in focus is/are edited
IRI(s) / ID(s) of holding collection(s)
Human readable description of the collection
IRI pointing to an Annotation Collection for the complete collection
If created from an existing collection, hold its former ID
Previous revision of this collection (slug)
The TextAPI version covered by the implementation. MUST be at least 2.0.0.
IRI pointing to this collection
The revision of this Collection Object
Total number of collections or manifests included in this collection
A set of collections included in this collection. If collections is set, the holding collection MUST NOT contain manifests.
A set of manifests included in this collection. If manifests is set, the holding collection MUST NOT contain collections.
The time this Collection Object was created
The time this Collection Object was modified
Create a Collection. › Responses
The created Collection.
titlesThe title(s) of the collection. First item in the array is the main title
Personal entities responsible for the collection
textapiVersion^(0|[1-9]\d*)\.(0|[1… · requiredThe TextAPI version covered by the implementation. MUST be at least 2.0.0.
createdThe time this Collection Object was created
modifiedThe time this Collection Object was modified.
idIRI pointing to this collection
textapiTypeMUST be TextApiCollection.
totalTotal number of collections or manifests included in this collection
revisionThe revision of this Collection Object
Personal entities responsible for the edition
Entities (e.g. organizations or individual persons) responsible for funding the project in which the text(s) in focus is/are edited
IRI(s) / ID(s) of holding collection(s)
Human readable description of the collection
IRI pointing to an Annotation Collection for the complete collection
If created from an existing collection, hold its former ID
Previous revision of this collection (slug)
A set of collections included in this collection. If collections is set, the holding collection MUST NOT contain manifests.
A set of manifests included in this collection. If manifests is set, the holding collection MUST NOT contain collections.
Retrieve a Collection.
Retrieve a TextAPI Collection.
path Parameters
slugRetrieve a Collection. › Responses
The requested Collection.
titlesThe title(s) of the collection. First item in the array is the main title
Personal entities responsible for the collection
textapiVersion^(0|[1-9]\d*)\.(0|[1… · requiredThe TextAPI version covered by the implementation. MUST be at least 2.0.0.
createdThe time this Collection Object was created
modifiedThe time this Collection Object was modified.
idIRI pointing to this collection
textapiTypeMUST be TextApiCollection.
totalTotal number of collections or manifests included in this collection
revisionThe revision of this Collection Object
Personal entities responsible for the edition
Entities (e.g. organizations or individual persons) responsible for funding the project in which the text(s) in focus is/are edited
IRI(s) / ID(s) of holding collection(s)
Human readable description of the collection
IRI pointing to an Annotation Collection for the complete collection
If created from an existing collection, hold its former ID
Previous revision of this collection (slug)
A set of collections included in this collection. If collections is set, the holding collection MUST NOT contain manifests.
A set of manifests included in this collection. If manifests is set, the holding collection MUST NOT contain collections.
Replace a Collection.
Replace the latest revision of a TextAPI Collection.
path Parameters
slugReplace a Collection. › Request Body
titlesThe title(s) of the collection. First item in the array is the main title
Personal entities responsible for the collection
Personal entities responsible for the edition
Entities (e.g. organizations or individual persons) responsible for funding the project in which the text(s) in focus is/are edited
IRI(s) / ID(s) of holding collection(s)
Human readable description of the collection
IRI pointing to an Annotation Collection for the complete collection
If created from an existing collection, hold its former ID
Previous revision of this collection (slug)
The TextAPI version covered by the implementation. MUST be at least 2.0.0.
IRI pointing to this collection
The revision of this Collection Object
Total number of collections or manifests included in this collection
A set of collections included in this collection. If collections is set, the holding collection MUST NOT contain manifests.
A set of manifests included in this collection. If manifests is set, the holding collection MUST NOT contain collections.
The time this Collection Object was created
The time this Collection Object was modified
Replace a Collection. › Responses
The updated Collection.
titlesThe title(s) of the collection. First item in the array is the main title
Personal entities responsible for the collection
textapiVersion^(0|[1-9]\d*)\.(0|[1… · requiredThe TextAPI version covered by the implementation. MUST be at least 2.0.0.
createdThe time this Collection Object was created
modifiedThe time this Collection Object was modified.
idIRI pointing to this collection
textapiTypeMUST be TextApiCollection.
totalTotal number of collections or manifests included in this collection
revisionThe revision of this Collection Object
Personal entities responsible for the edition
Entities (e.g. organizations or individual persons) responsible for funding the project in which the text(s) in focus is/are edited
IRI(s) / ID(s) of holding collection(s)
Human readable description of the collection
IRI pointing to an Annotation Collection for the complete collection
If created from an existing collection, hold its former ID
Previous revision of this collection (slug)
A set of collections included in this collection. If collections is set, the holding collection MUST NOT contain manifests.
A set of manifests included in this collection. If manifests is set, the holding collection MUST NOT contain collections.
Create a new collection revision.
Create a TextAPI Collection revision with an optional
slug for the revision ID and return it.
path Parameters
collection_slugHeaders
slugCreate a new collection revision. › Request Body
titlesThe title(s) of the collection. First item in the array is the main title
Personal entities responsible for the collection
Personal entities responsible for the edition
Entities (e.g. organizations or individual persons) responsible for funding the project in which the text(s) in focus is/are edited
IRI(s) / ID(s) of holding collection(s)
Human readable description of the collection
IRI pointing to an Annotation Collection for the complete collection
If created from an existing collection, hold its former ID
Previous revision of this collection (slug)
The TextAPI version covered by the implementation. MUST be at least 2.0.0.
IRI pointing to this collection
The revision of this Collection Object
Total number of collections or manifests included in this collection
A set of collections included in this collection. If collections is set, the holding collection MUST NOT contain manifests.
A set of manifests included in this collection. If manifests is set, the holding collection MUST NOT contain collections.
The time this Collection Object was created
The time this Collection Object was modified
Create a new collection revision. › Responses
The created collection revision.
titlesThe title(s) of the collection. First item in the array is the main title
Personal entities responsible for the collection
textapiVersion^(0|[1-9]\d*)\.(0|[1… · requiredThe TextAPI version covered by the implementation. MUST be at least 2.0.0.
createdThe time this Collection Object was created
modifiedThe time this Collection Object was modified.
idIRI pointing to this collection
textapiTypeMUST be TextApiCollection.
totalTotal number of collections or manifests included in this collection
revisionThe revision of this Collection Object
Personal entities responsible for the edition
Entities (e.g. organizations or individual persons) responsible for funding the project in which the text(s) in focus is/are edited
IRI(s) / ID(s) of holding collection(s)
Human readable description of the collection
IRI pointing to an Annotation Collection for the complete collection
If created from an existing collection, hold its former ID
Previous revision of this collection (slug)
A set of collections included in this collection. If collections is set, the holding collection MUST NOT contain manifests.
A set of manifests included in this collection. If manifests is set, the holding collection MUST NOT contain collections.
Retrieve a Collection revision.
Retrieve a TextAPI Collection revision.
path Parameters
collection_slugrev_slugRetrieve a Collection revision. › Responses
The requested Collection revision.
titlesThe title(s) of the collection. First item in the array is the main title
Personal entities responsible for the collection
textapiVersion^(0|[1-9]\d*)\.(0|[1… · requiredThe TextAPI version covered by the implementation. MUST be at least 2.0.0.
createdThe time this Collection Object was created
modifiedThe time this Collection Object was modified.
idIRI pointing to this collection
textapiTypeMUST be TextApiCollection.
totalTotal number of collections or manifests included in this collection
revisionThe revision of this Collection Object
Personal entities responsible for the edition
Entities (e.g. organizations or individual persons) responsible for funding the project in which the text(s) in focus is/are edited
IRI(s) / ID(s) of holding collection(s)
Human readable description of the collection
IRI pointing to an Annotation Collection for the complete collection
If created from an existing collection, hold its former ID
Previous revision of this collection (slug)
A set of collections included in this collection. If collections is set, the holding collection MUST NOT contain manifests.
A set of manifests included in this collection. If manifests is set, the holding collection MUST NOT contain collections.
Replace a Collection revision.
Replace a TextAPI Collection revision.
path Parameters
collection_slugrev_slugReplace a Collection revision. › Request Body
titlesThe title(s) of the collection. First item in the array is the main title
Personal entities responsible for the collection
Personal entities responsible for the edition
Entities (e.g. organizations or individual persons) responsible for funding the project in which the text(s) in focus is/are edited
IRI(s) / ID(s) of holding collection(s)
Human readable description of the collection
IRI pointing to an Annotation Collection for the complete collection
If created from an existing collection, hold its former ID
Previous revision of this collection (slug)
The TextAPI version covered by the implementation. MUST be at least 2.0.0.
IRI pointing to this collection
The revision of this Collection Object
Total number of collections or manifests included in this collection
A set of collections included in this collection. If collections is set, the holding collection MUST NOT contain manifests.
A set of manifests included in this collection. If manifests is set, the holding collection MUST NOT contain collections.
The time this Collection Object was created
The time this Collection Object was modified
Replace a Collection revision. › Responses
The Collection revision after replacement.
titlesThe title(s) of the collection. First item in the array is the main title
Personal entities responsible for the collection
textapiVersion^(0|[1-9]\d*)\.(0|[1… · requiredThe TextAPI version covered by the implementation. MUST be at least 2.0.0.
createdThe time this Collection Object was created
modifiedThe time this Collection Object was modified.
idIRI pointing to this collection
textapiTypeMUST be TextApiCollection.
totalTotal number of collections or manifests included in this collection
revisionThe revision of this Collection Object
Personal entities responsible for the edition
Entities (e.g. organizations or individual persons) responsible for funding the project in which the text(s) in focus is/are edited
IRI(s) / ID(s) of holding collection(s)
Human readable description of the collection
IRI pointing to an Annotation Collection for the complete collection
If created from an existing collection, hold its former ID
Previous revision of this collection (slug)
A set of collections included in this collection. If collections is set, the holding collection MUST NOT contain manifests.
A set of manifests included in this collection. If manifests is set, the holding collection MUST NOT contain collections.