items

Download schema

List of revisions.

GET

https://editions.sub.uni-goettingen.de/textapi/v2

/items/{slug}/revisions/

List all revisions for a given Item slug.

List of revisions. › path Parameters

slug

string · required

List of revisions. › Responses

A list of revisions for a requested Item.

string[]

Create an Item.

PUT

https://editions.sub.uni-goettingen.de/textapi/v2

/items/revisions/

Create a TextAPI Item with an optional slug for the Item ID and return it.

Create an Item. › Headers

slug

Create an Item. › Request Body

An Item object as posted by the user on create.

InputItem

textItemType

TextItemType · enum · required

The type of this item

Enum values:

fragment

section

page

full

languages

string[] · required

Languages present in this item as ISO 639-3 language codes.

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

Content[] · required

Different serializations of the item, e.g. HTML, plain text, XML.

IRI of the previous revision of this item.

The title(s) of the item.

The division label for this item.

Alternative language name or code (when there is no ISO 639-3 code available, e.g. karshuni).

A short description of the item.

Image(s) representing the item.

IRI pointing to an Annotation Collection for this item.

If created from an existing collection, save its previous id to via.

IRI(s) / ID(s) of holding manifest(s).

Default: https://editions.sub.uni-goettingen.de/context.json

The TextAPI version covered by the implementation. MUST be at least 2.0.0.

Default: 2.0.0

IRI pointing to this item

Default: TextApiItem

The revision of this Item Object.

The time this Item Object was created

The time this Item Object was modified

Create an Item. › Responses

The created Item.

Item output class.

Item

textItemType

TextItemType · enum · required

The type of this item

Enum values:

fragment

section

page

full

languages

string[] · required

Languages present in this item as ISO 639-3 language codes.

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

Content[] · required

Different serializations of the item, e.g. HTML, plain text, XML.

id

string · uri · required

IRI pointing to this item.

required

revision

string · required

The revision of this Item Object

created

string · required

The time this Item Object was created.

modified

string · required

The time this Item Object was modified.

IRI of the previous revision of this item.

The title(s) of the item.

The division label for this item.

Alternative language name or code (when there is no ISO 639-3 code available, e.g. karshuni).

A short description of the item.

Image(s) representing the item.

IRI pointing to an Annotation Collection for this item.

If created from an existing collection, save its previous id to via.

IRI(s) / ID(s) of holding manifest(s).

textapiVersion

string · pattern: ^(0|[1-9]\d*)\.(0|[1…

The TextAPI version covered by the implementation.

Default: 2.0.0

textapiType

string · const

Const value: TextApiItem

Default: TextApiItem

PUT/items/revisions/

curl --request PUT \
  --url https://editions.sub.uni-goettingen.de/textapi/v2/items/revisions \
  --header 'Content-Type: application/json' \
  --data '
{
  "textItemType": "section",
  "languages": [
    "eng"
  ],
  "contents": [
    {
      "id": "https://example.com/index.html",
      "contentType": "text/html"
    }
  ]
}
'

Example Request Body

{
  "textItemType": "section",
  "languages": [
    "eng"
  ],
  "contents": [
    {
      "id": "https://example.com/index.html",
      "contentType": "text/html"
    }
  ]
}

json

A minimal example to showcase the additions by the OutputItem.

application/json

Example Responses

{
  "prevRevision": "https://www.example.com/path/to/resource",
  "titles": [
    "string"
  ],
  "textItemType": "fragment",
  "division": "string",
  "languages": [
    "aaa"
  ],
  "langAlt": [
    "string"
  ],
  "contents": [
    {
      "id": "id",
      "contentType": "contentType",
      "integrity": {
        "algorithm": "algorithm",
        "checksum": "checksum",
        "textapiType": "TextApiIntegrity"
      }
    }
  ],
  "description": "string",
  "images": [
    {
      "id": "https://www.example.com/path/to/resource",
      "mimetype": "application/ld+json;profile=\"http://iiif.io/api/image/3/context.json",
      "license": "license",
      "copyright": "string"
    }
  ],
  "annotationCollection": "https://www.example.com/path/to/resource",
  "via": "string",
  "partOf": [
    "https://www.example.com/path/to/resource"
  ],
  "textapiVersion": "2.0.0",
  "id": "https://www.example.com/path/to/resource",
  "@context": "https://www.example.com/path/to/resource",
  "textapiType": "TextApiItem",
  "revision": "revision",
  "created": "created",
  "modified": "modified"
}

text

application/ld+json;profile='https://editions.sub.uni-goettingen.de/context.json'

Create an Item.

POST

https://editions.sub.uni-goettingen.de/textapi/v2

/items/

Create a TextAPI Item with an optional slug for the Item ID and return it.

Create an Item. › Headers

slug

Create an Item. › Request Body

An Item object as posted by the user on create.

InputItem

textItemType

TextItemType · enum · required

The type of this item

Enum values:

fragment

section

page

full

languages

string[] · required

Languages present in this item as ISO 639-3 language codes.

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

Content[] · required

Different serializations of the item, e.g. HTML, plain text, XML.

IRI of the previous revision of this item.

The title(s) of the item.

The division label for this item.

Alternative language name or code (when there is no ISO 639-3 code available, e.g. karshuni).

A short description of the item.

Image(s) representing the item.

IRI pointing to an Annotation Collection for this item.

If created from an existing collection, save its previous id to via.

IRI(s) / ID(s) of holding manifest(s).

Default: https://editions.sub.uni-goettingen.de/context.json

The TextAPI version covered by the implementation. MUST be at least 2.0.0.

Default: 2.0.0

IRI pointing to this item

Default: TextApiItem

The revision of this Item Object.

The time this Item Object was created

The time this Item Object was modified

Create an Item. › Responses

The created Item.

Item output class.

Item

textItemType

TextItemType · enum · required

The type of this item

Enum values:

fragment

section

page

full

languages

string[] · required

Languages present in this item as ISO 639-3 language codes.

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

Content[] · required

Different serializations of the item, e.g. HTML, plain text, XML.

id

string · uri · required

IRI pointing to this item.

required

revision

string · required

The revision of this Item Object

created

string · required

The time this Item Object was created.

modified

string · required

The time this Item Object was modified.

IRI of the previous revision of this item.

The title(s) of the item.

The division label for this item.

Alternative language name or code (when there is no ISO 639-3 code available, e.g. karshuni).

A short description of the item.

Image(s) representing the item.

IRI pointing to an Annotation Collection for this item.

If created from an existing collection, save its previous id to via.

IRI(s) / ID(s) of holding manifest(s).

textapiVersion

string · pattern: ^(0|[1-9]\d*)\.(0|[1…

The TextAPI version covered by the implementation.

Default: 2.0.0

textapiType

string · const

Const value: TextApiItem

Default: TextApiItem

POST/items/

curl --request POST \
  --url https://editions.sub.uni-goettingen.de/textapi/v2/items \
  --header 'Content-Type: application/json' \
  --data '
{
  "textItemType": "section",
  "languages": [
    "eng"
  ],
  "contents": [
    {
      "id": "https://example.com/index.html",
      "contentType": "text/html"
    }
  ]
}
'

Example Request Body

{
  "textItemType": "section",
  "languages": [
    "eng"
  ],
  "contents": [
    {
      "id": "https://example.com/index.html",
      "contentType": "text/html"
    }
  ]
}

json

A minimal example to showcase the additions by the OutputItem.

application/json

Example Responses

{
  "prevRevision": "https://www.example.com/path/to/resource",
  "titles": [
    "string"
  ],
  "textItemType": "fragment",
  "division": "string",
  "languages": [
    "aaa"
  ],
  "langAlt": [
    "string"
  ],
  "contents": [
    {
      "id": "id",
      "contentType": "contentType",
      "integrity": {
        "algorithm": "algorithm",
        "checksum": "checksum",
        "textapiType": "TextApiIntegrity"
      }
    }
  ],
  "description": "string",
  "images": [
    {
      "id": "https://www.example.com/path/to/resource",
      "mimetype": "application/ld+json;profile=\"http://iiif.io/api/image/3/context.json",
      "license": "license",
      "copyright": "string"
    }
  ],
  "annotationCollection": "https://www.example.com/path/to/resource",
  "via": "string",
  "partOf": [
    "https://www.example.com/path/to/resource"
  ],
  "textapiVersion": "2.0.0",
  "id": "https://www.example.com/path/to/resource",
  "@context": "https://www.example.com/path/to/resource",
  "textapiType": "TextApiItem",
  "revision": "revision",
  "created": "created",
  "modified": "modified"
}

text

application/ld+json;profile='https://editions.sub.uni-goettingen.de/context.json'

Retrieve an Item.

GET

https://editions.sub.uni-goettingen.de/textapi/v2

/items/{slug}/revisions/{revslug}/

Retrieve a TextAPI Item.

Retrieve an Item. › path Parameters

slug

string · required

revslug

string · required

Retrieve an Item. › Responses

The requested Item.

Item output class.

Item

textItemType

TextItemType · enum · required

The type of this item

Enum values:

fragment

section

page

full

languages

string[] · required

Languages present in this item as ISO 639-3 language codes.

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

Content[] · required

Different serializations of the item, e.g. HTML, plain text, XML.

id

string · uri · required

IRI pointing to this item.

required

revision

string · required

The revision of this Item Object

created

string · required

The time this Item Object was created.

modified

string · required

The time this Item Object was modified.

IRI of the previous revision of this item.

The title(s) of the item.

The division label for this item.

Alternative language name or code (when there is no ISO 639-3 code available, e.g. karshuni).

A short description of the item.

Image(s) representing the item.

IRI pointing to an Annotation Collection for this item.

If created from an existing collection, save its previous id to via.

IRI(s) / ID(s) of holding manifest(s).

textapiVersion

string · pattern: ^(0|[1-9]\d*)\.(0|[1…

The TextAPI version covered by the implementation.

Default: 2.0.0

textapiType

string · const

Const value: TextApiItem

Default: TextApiItem

GET/items/{slug}/revisions/{revslug}/

curl --request GET \
  --url https://editions.sub.uni-goettingen.de/textapi/v2/items/:slug/revisions/:revslug

Example Responses

{
  "prevRevision": "https://www.example.com/path/to/resource",
  "titles": [
    "string"
  ],
  "textItemType": "fragment",
  "division": "string",
  "languages": [
    "aaa"
  ],
  "langAlt": [
    "string"
  ],
  "contents": [
    {
      "id": "id",
      "contentType": "contentType",
      "integrity": {
        "algorithm": "algorithm",
        "checksum": "checksum",
        "textapiType": "TextApiIntegrity"
      }
    }
  ],
  "description": "string",
  "images": [
    {
      "id": "https://www.example.com/path/to/resource",
      "mimetype": "application/ld+json;profile=\"http://iiif.io/api/image/3/context.json",
      "license": "license",
      "copyright": "string"
    }
  ],
  "annotationCollection": "https://www.example.com/path/to/resource",
  "via": "string",
  "partOf": [
    "https://www.example.com/path/to/resource"
  ],
  "textapiVersion": "2.0.0",
  "id": "https://www.example.com/path/to/resource",
  "@context": "https://www.example.com/path/to/resource",
  "textapiType": "TextApiItem",
  "revision": "revision",
  "created": "created",
  "modified": "modified"
}

text

application/ld+json;profile='https://editions.sub.uni-goettingen.de/context.json'

Retrieve an Item.

GET

https://editions.sub.uni-goettingen.de/textapi/v2

/items/{slug}/

Retrieve a TextAPI Item.

Retrieve an Item. › path Parameters

slug

string · required

Retrieve an Item. › query Parameters

revslug

string

Default:

Retrieve an Item. › Responses

The requested Item.

Item output class.

Item

textItemType

TextItemType · enum · required

The type of this item

Enum values:

fragment

section

page

full

languages

string[] · required

Languages present in this item as ISO 639-3 language codes.

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

Content[] · required

Different serializations of the item, e.g. HTML, plain text, XML.

id

string · uri · required

IRI pointing to this item.

required

revision

string · required

The revision of this Item Object

created

string · required

The time this Item Object was created.

modified

string · required

The time this Item Object was modified.

IRI of the previous revision of this item.

The title(s) of the item.

The division label for this item.

Alternative language name or code (when there is no ISO 639-3 code available, e.g. karshuni).

A short description of the item.

Image(s) representing the item.

IRI pointing to an Annotation Collection for this item.

If created from an existing collection, save its previous id to via.

IRI(s) / ID(s) of holding manifest(s).

textapiVersion

string · pattern: ^(0|[1-9]\d*)\.(0|[1…

The TextAPI version covered by the implementation.

Default: 2.0.0

textapiType

string · const

Const value: TextApiItem

Default: TextApiItem

GET/items/{slug}/

curl --request GET \
  --url https://editions.sub.uni-goettingen.de/textapi/v2/items/:slug

Example Responses

{
  "prevRevision": "https://www.example.com/path/to/resource",
  "titles": [
    "string"
  ],
  "textItemType": "fragment",
  "division": "string",
  "languages": [
    "aaa"
  ],
  "langAlt": [
    "string"
  ],
  "contents": [
    {
      "id": "id",
      "contentType": "contentType",
      "integrity": {
        "algorithm": "algorithm",
        "checksum": "checksum",
        "textapiType": "TextApiIntegrity"
      }
    }
  ],
  "description": "string",
  "images": [
    {
      "id": "https://www.example.com/path/to/resource",
      "mimetype": "application/ld+json;profile=\"http://iiif.io/api/image/3/context.json",
      "license": "license",
      "copyright": "string"
    }
  ],
  "annotationCollection": "https://www.example.com/path/to/resource",
  "via": "string",
  "partOf": [
    "https://www.example.com/path/to/resource"
  ],
  "textapiVersion": "2.0.0",
  "id": "https://www.example.com/path/to/resource",
  "@context": "https://www.example.com/path/to/resource",
  "textapiType": "TextApiItem",
  "revision": "revision",
  "created": "created",
  "modified": "modified"
}

text

application/ld+json;profile='https://editions.sub.uni-goettingen.de/context.json'

Remove an Item.

DELETE

https://editions.sub.uni-goettingen.de/textapi/v2

/items/{slug}/

Remove an Item from the database.

Remove an Item. › path Parameters

slug

string · required

Remove an Item. › query Parameters

revslug

string

Default:

Remove an Item. › Responses

Remove an Item from the database. If no revision is provided, the latest revision will be deleted.

No data returned

Remove an Item.

DELETE

https://editions.sub.uni-goettingen.de/textapi/v2

/items/revisions/{revslug}/

Remove an Item from the database.

Remove an Item. › path Parameters

revslug

string · required

Remove an Item. › query Parameters

slug

string · required

Remove an Item. › Responses

Remove an Item from the database. If no revision is provided, the latest revision will be deleted.

No data returned

manifests

Create an Item.

PUT

https://editions.sub.uni-goettingen.de/textapi/v2

/items/revisions/

Create a TextAPI Item with an optional slug for the Item ID and return it.

Create an Item. › Headers

slug

Create an Item. › Request Body

An Item object as posted by the user on create.

InputItem

textItemType

TextItemType · enum · required

The type of this item

Enum values:

fragment

section

page

full

languages

string[] · required

Languages present in this item as ISO 639-3 language codes.

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

Content[] · required

Different serializations of the item, e.g. HTML, plain text, XML.

IRI of the previous revision of this item.

The title(s) of the item.

The division label for this item.

Alternative language name or code (when there is no ISO 639-3 code available, e.g. karshuni).

A short description of the item.

Image(s) representing the item.

IRI pointing to an Annotation Collection for this item.

If created from an existing collection, save its previous id to via.

IRI(s) / ID(s) of holding manifest(s).

Default: https://editions.sub.uni-goettingen.de/context.json

The TextAPI version covered by the implementation. MUST be at least 2.0.0.

Default: 2.0.0

IRI pointing to this item

Default: TextApiItem

The revision of this Item Object.

The time this Item Object was created

The time this Item Object was modified

Create an Item. › Responses

The created Item.

Item output class.

Item

textItemType

TextItemType · enum · required

The type of this item

Enum values:

fragment

section

page

full

languages

string[] · required

Languages present in this item as ISO 639-3 language codes.

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

Content[] · required

Different serializations of the item, e.g. HTML, plain text, XML.

id

string · uri · required

IRI pointing to this item.

required

revision

string · required

The revision of this Item Object

created

string · required

The time this Item Object was created.

modified

string · required

The time this Item Object was modified.

IRI of the previous revision of this item.

The title(s) of the item.

The division label for this item.

Alternative language name or code (when there is no ISO 639-3 code available, e.g. karshuni).

A short description of the item.

Image(s) representing the item.

IRI pointing to an Annotation Collection for this item.

If created from an existing collection, save its previous id to via.

IRI(s) / ID(s) of holding manifest(s).

textapiVersion

string · pattern: ^(0|[1-9]\d*)\.(0|[1…

The TextAPI version covered by the implementation.

Default: 2.0.0

textapiType

string · const

Const value: TextApiItem

Default: TextApiItem

Create an Item.

POST

https://editions.sub.uni-goettingen.de/textapi/v2

/items/

Create a TextAPI Item with an optional slug for the Item ID and return it.

Create an Item. › Headers

slug

Create an Item. › Request Body

An Item object as posted by the user on create.

InputItem

textItemType

TextItemType · enum · required

The type of this item

Enum values:

fragment

section

page

full

languages

string[] · required

Languages present in this item as ISO 639-3 language codes.

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

Content[] · required

Different serializations of the item, e.g. HTML, plain text, XML.

IRI of the previous revision of this item.

The title(s) of the item.

The division label for this item.

Alternative language name or code (when there is no ISO 639-3 code available, e.g. karshuni).

A short description of the item.

Image(s) representing the item.

IRI pointing to an Annotation Collection for this item.

If created from an existing collection, save its previous id to via.

IRI(s) / ID(s) of holding manifest(s).

Default: https://editions.sub.uni-goettingen.de/context.json

The TextAPI version covered by the implementation. MUST be at least 2.0.0.

Default: 2.0.0

IRI pointing to this item

Default: TextApiItem

The revision of this Item Object.

The time this Item Object was created

The time this Item Object was modified

Create an Item. › Responses

The created Item.

Item output class.

Item

textItemType

TextItemType · enum · required

The type of this item

Enum values:

fragment

section

page

full

languages

string[] · required

Languages present in this item as ISO 639-3 language codes.

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

Content[] · required

Different serializations of the item, e.g. HTML, plain text, XML.

id

string · uri · required

IRI pointing to this item.

required

revision

string · required

The revision of this Item Object

created

string · required

The time this Item Object was created.

modified

string · required

The time this Item Object was modified.

IRI of the previous revision of this item.

The title(s) of the item.

The division label for this item.

Alternative language name or code (when there is no ISO 639-3 code available, e.g. karshuni).

A short description of the item.

Image(s) representing the item.

IRI pointing to an Annotation Collection for this item.

If created from an existing collection, save its previous id to via.

IRI(s) / ID(s) of holding manifest(s).

textapiVersion

string · pattern: ^(0|[1-9]\d*)\.(0|[1…

The TextAPI version covered by the implementation.

Default: 2.0.0

textapiType

string · const

Const value: TextApiItem

Default: TextApiItem

Retrieve an Item.

GET

https://editions.sub.uni-goettingen.de/textapi/v2

/items/{slug}/revisions/{revslug}/

Retrieve a TextAPI Item.

Retrieve an Item. › path Parameters

slug

string · required

revslug

string · required

Retrieve an Item. › Responses

The requested Item.

Item output class.

Item

textItemType

TextItemType · enum · required

The type of this item

Enum values:

fragment

section

page

full

languages

string[] · required

Languages present in this item as ISO 639-3 language codes.

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

Content[] · required

Different serializations of the item, e.g. HTML, plain text, XML.

id

string · uri · required

IRI pointing to this item.

required

revision

string · required

The revision of this Item Object

created

string · required

The time this Item Object was created.

modified

string · required

The time this Item Object was modified.

IRI of the previous revision of this item.

The title(s) of the item.

The division label for this item.

Alternative language name or code (when there is no ISO 639-3 code available, e.g. karshuni).

A short description of the item.

Image(s) representing the item.

IRI pointing to an Annotation Collection for this item.

If created from an existing collection, save its previous id to via.

IRI(s) / ID(s) of holding manifest(s).

textapiVersion

string · pattern: ^(0|[1-9]\d*)\.(0|[1…

The TextAPI version covered by the implementation.

Default: 2.0.0

textapiType

string · const

Const value: TextApiItem

Default: TextApiItem

Retrieve an Item.

GET

https://editions.sub.uni-goettingen.de/textapi/v2

/items/{slug}/

Retrieve a TextAPI Item.

Retrieve an Item. › path Parameters

slug

string · required

Retrieve an Item. › query Parameters

revslug

string

Default:

Retrieve an Item. › Responses

The requested Item.

Item output class.

Item

textItemType

TextItemType · enum · required

The type of this item

Enum values:

fragment

section

page

full

languages

string[] · required

Languages present in this item as ISO 639-3 language codes.

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

Content[] · required

Different serializations of the item, e.g. HTML, plain text, XML.

id

string · uri · required

IRI pointing to this item.

required

revision

string · required

The revision of this Item Object

created

string · required

The time this Item Object was created.

modified

string · required

The time this Item Object was modified.

IRI of the previous revision of this item.

The title(s) of the item.

The division label for this item.

Alternative language name or code (when there is no ISO 639-3 code available, e.g. karshuni).

A short description of the item.

Image(s) representing the item.

IRI pointing to an Annotation Collection for this item.

If created from an existing collection, save its previous id to via.

IRI(s) / ID(s) of holding manifest(s).

textapiVersion

string · pattern: ^(0|[1-9]\d*)\.(0|[1…

The TextAPI version covered by the implementation.

Default: 2.0.0

textapiType

string · const

Const value: TextApiItem

Default: TextApiItem

Remove an Item.

DELETE

https://editions.sub.uni-goettingen.de/textapi/v2

/items/{slug}/

Remove an Item from the database.

Remove an Item. › path Parameters

slug

string · required

Remove an Item. › query Parameters

revslug

string

Default:

Remove an Item. › Responses

Remove an Item from the database. If no revision is provided, the latest revision will be deleted.

No data returned

Remove an Item.

DELETE

https://editions.sub.uni-goettingen.de/textapi/v2

/items/revisions/{revslug}/

Remove an Item from the database.

Remove an Item. › path Parameters

revslug

string · required

Remove an Item. › query Parameters

slug

string · required

Remove an Item. › Responses

Remove an Item from the database. If no revision is provided, the latest revision will be deleted.

No data returned