TextAPI

items

List of revisions.

GET

/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[]

GET/items/{slug}/revisions/

curl --request GET \
  --url /items/:slug/revisions/

shell

Example Responses

[
  "string"
]

plain

application/ld+json;profile='https://gitlab.gwdg.de/subugoe/textapi/specs/-/raw/main/jsonld/v2.jsonld'

Create an Item.

PUT

/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.

textItemType

required

languages

string[] · required

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

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

object[] · 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)

IRI pointing to this item

Default: TextApiItem

The revision of this Item Object

Create an Item. › Responses

The created Item.

Item output class.

textItemType

required

languages

string[] · required

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

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

object[] · required

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

id

string · uri · minLength: 1 · maxLength: 2083 · required

IRI pointing to this item

revision

string · required

The revision of this Item Object

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)

type

string

Default: TextApiItem

PUT/items/revisions/

curl --request PUT \
  --url /items/revisions/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "contents": [
    {
      "contentType": "text/html",
      "id": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
    }
  ],
  "languages": [
    "deu"
  ],
  "textItemType": "CRAIG"
}
'

shell

Example Request Body

{
  "contents": [
    {
      "contentType": "text/html",
      "id": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
    }
  ],
  "languages": [
    "deu"
  ],
  "textItemType": "CRAIG"
}

json

Example Responses

{
  "prevRevision": "https://www.example.com/path/to/resource",
  "titles": [
    "string"
  ],
  "textItemType": {},
  "division": "string",
  "languages": [
    "aaa"
  ],
  "langAlt": [
    "string"
  ],
  "contents": [
    {
      "id": "id",
      "contentType": "contentType",
      "integrity": {
        "algorithm": "algorithm",
        "checksum": "checksum"
      }
    }
  ],
  "description": "string",
  "images": [
    {
      "id": "https://www.example.com/path/to/resource",
      "type": "string",
      "manifest": "https://www.example.com/path/to/resource",
      "license": "license",
      "copyright": "string"
    }
  ],
  "annotationCollection": "https://www.example.com/path/to/resource",
  "via": "string",
  "partOf": [
    "https://www.example.com/path/to/resource"
  ],
  "id": "https://www.example.com/path/to/resource",
  "type": "type",
  "revision": "revision"
}

plain

application/ld+json;profile='https://gitlab.gwdg.de/subugoe/textapi/specs/-/raw/main/jsonld/v2.jsonld'

Create an Item.

POST

/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.

textItemType

required

languages

string[] · required

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

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

object[] · 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)

IRI pointing to this item

Default: TextApiItem

The revision of this Item Object

Create an Item. › Responses

The created Item.

Item output class.

textItemType

required

languages

string[] · required

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

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

object[] · required

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

id

string · uri · minLength: 1 · maxLength: 2083 · required

IRI pointing to this item

revision

string · required

The revision of this Item Object

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)

type

string

Default: TextApiItem

POST/items/

curl --request POST \
  --url /items/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "contents": [
    {
      "contentType": "text/html",
      "id": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
    }
  ],
  "languages": [
    "deu"
  ],
  "textItemType": "CRAIG"
}
'

shell

Example Request Body

{
  "contents": [
    {
      "contentType": "text/html",
      "id": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
    }
  ],
  "languages": [
    "deu"
  ],
  "textItemType": "CRAIG"
}

json

Example Responses

{
  "prevRevision": "https://www.example.com/path/to/resource",
  "titles": [
    "string"
  ],
  "textItemType": {},
  "division": "string",
  "languages": [
    "aaa"
  ],
  "langAlt": [
    "string"
  ],
  "contents": [
    {
      "id": "id",
      "contentType": "contentType",
      "integrity": {
        "algorithm": "algorithm",
        "checksum": "checksum"
      }
    }
  ],
  "description": "string",
  "images": [
    {
      "id": "https://www.example.com/path/to/resource",
      "type": "string",
      "manifest": "https://www.example.com/path/to/resource",
      "license": "license",
      "copyright": "string"
    }
  ],
  "annotationCollection": "https://www.example.com/path/to/resource",
  "via": "string",
  "partOf": [
    "https://www.example.com/path/to/resource"
  ],
  "id": "https://www.example.com/path/to/resource",
  "type": "type",
  "revision": "revision"
}

plain

application/ld+json;profile='https://gitlab.gwdg.de/subugoe/textapi/specs/-/raw/main/jsonld/v2.jsonld'

Retrieve an Item.

GET

/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.

textItemType

required

languages

string[] · required

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

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

object[] · required

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

id

string · uri · minLength: 1 · maxLength: 2083 · required

IRI pointing to this item

revision

string · required

The revision of this Item Object

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)

type

string

Default: TextApiItem

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

curl --request GET \
  --url /items/:slug/revisions/:revslug/

shell

Example Responses

{
  "prevRevision": "https://www.example.com/path/to/resource",
  "titles": [
    "string"
  ],
  "textItemType": {},
  "division": "string",
  "languages": [
    "aaa"
  ],
  "langAlt": [
    "string"
  ],
  "contents": [
    {
      "id": "id",
      "contentType": "contentType",
      "integrity": {
        "algorithm": "algorithm",
        "checksum": "checksum"
      }
    }
  ],
  "description": "string",
  "images": [
    {
      "id": "https://www.example.com/path/to/resource",
      "type": "string",
      "manifest": "https://www.example.com/path/to/resource",
      "license": "license",
      "copyright": "string"
    }
  ],
  "annotationCollection": "https://www.example.com/path/to/resource",
  "via": "string",
  "partOf": [
    "https://www.example.com/path/to/resource"
  ],
  "id": "https://www.example.com/path/to/resource",
  "type": "type",
  "revision": "revision"
}

plain

application/ld+json;profile='https://gitlab.gwdg.de/subugoe/textapi/specs/-/raw/main/jsonld/v2.jsonld'

Retrieve an Item.

GET

/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.

textItemType

required

languages

string[] · required

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

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

object[] · required

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

id

string · uri · minLength: 1 · maxLength: 2083 · required

IRI pointing to this item

revision

string · required

The revision of this Item Object

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)

type

string

Default: TextApiItem

GET/items/{slug}/

curl --request GET \
  --url /items/:slug/

shell

Example Responses

{
  "prevRevision": "https://www.example.com/path/to/resource",
  "titles": [
    "string"
  ],
  "textItemType": {},
  "division": "string",
  "languages": [
    "aaa"
  ],
  "langAlt": [
    "string"
  ],
  "contents": [
    {
      "id": "id",
      "contentType": "contentType",
      "integrity": {
        "algorithm": "algorithm",
        "checksum": "checksum"
      }
    }
  ],
  "description": "string",
  "images": [
    {
      "id": "https://www.example.com/path/to/resource",
      "type": "string",
      "manifest": "https://www.example.com/path/to/resource",
      "license": "license",
      "copyright": "string"
    }
  ],
  "annotationCollection": "https://www.example.com/path/to/resource",
  "via": "string",
  "partOf": [
    "https://www.example.com/path/to/resource"
  ],
  "id": "https://www.example.com/path/to/resource",
  "type": "type",
  "revision": "revision"
}

plain

application/ld+json;profile='https://gitlab.gwdg.de/subugoe/textapi/specs/-/raw/main/jsonld/v2.jsonld'

Remove an Item.

DELETE

/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 and item from the database. If no revision is provided, the latest will be deleted.

No data returned

Remove an Item.

DELETE

/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 and item from the database. If no revision is provided, the latest will be deleted.

No data returned

DELETE/items/revisions/{revslug}/

curl --request DELETE \
  --url '/items/revisions/:revslug/?slug=%3Cstring%3E'

shell

Example Responses

No example specified for this content type

manifests

TextAPI

items

List of revisions.

GET

/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[]

GET/items/{slug}/revisions/

curl --request GET \
  --url /items/:slug/revisions/

shell

Example Responses

[
  "string"
]

plain

application/ld+json;profile='https://gitlab.gwdg.de/subugoe/textapi/specs/-/raw/main/jsonld/v2.jsonld'

Create an Item.

PUT

/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.

textItemType

required

languages

string[] · required

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

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

object[] · 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)

IRI pointing to this item

Default: TextApiItem

The revision of this Item Object

Create an Item. › Responses

The created Item.

Item output class.

textItemType

required

languages

string[] · required

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

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

object[] · required

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

id

string · uri · minLength: 1 · maxLength: 2083 · required

IRI pointing to this item

revision

string · required

The revision of this Item Object

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)

type

string

Default: TextApiItem

PUT/items/revisions/

curl --request PUT \
  --url /items/revisions/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "contents": [
    {
      "contentType": "text/html",
      "id": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
    }
  ],
  "languages": [
    "deu"
  ],
  "textItemType": "CRAIG"
}
'

shell

Example Request Body

{
  "contents": [
    {
      "contentType": "text/html",
      "id": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
    }
  ],
  "languages": [
    "deu"
  ],
  "textItemType": "CRAIG"
}

json

Example Responses

{
  "prevRevision": "https://www.example.com/path/to/resource",
  "titles": [
    "string"
  ],
  "textItemType": {},
  "division": "string",
  "languages": [
    "aaa"
  ],
  "langAlt": [
    "string"
  ],
  "contents": [
    {
      "id": "id",
      "contentType": "contentType",
      "integrity": {
        "algorithm": "algorithm",
        "checksum": "checksum"
      }
    }
  ],
  "description": "string",
  "images": [
    {
      "id": "https://www.example.com/path/to/resource",
      "type": "string",
      "manifest": "https://www.example.com/path/to/resource",
      "license": "license",
      "copyright": "string"
    }
  ],
  "annotationCollection": "https://www.example.com/path/to/resource",
  "via": "string",
  "partOf": [
    "https://www.example.com/path/to/resource"
  ],
  "id": "https://www.example.com/path/to/resource",
  "type": "type",
  "revision": "revision"
}

plain

application/ld+json;profile='https://gitlab.gwdg.de/subugoe/textapi/specs/-/raw/main/jsonld/v2.jsonld'

Create an Item.

POST

/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.

textItemType

required

languages

string[] · required

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

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

object[] · 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)

IRI pointing to this item

Default: TextApiItem

The revision of this Item Object

Create an Item. › Responses

The created Item.

Item output class.

textItemType

required

languages

string[] · required

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

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

object[] · required

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

id

string · uri · minLength: 1 · maxLength: 2083 · required

IRI pointing to this item

revision

string · required

The revision of this Item Object

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)

type

string

Default: TextApiItem

POST/items/

curl --request POST \
  --url /items/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "contents": [
    {
      "contentType": "text/html",
      "id": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
    }
  ],
  "languages": [
    "deu"
  ],
  "textItemType": "CRAIG"
}
'

shell

Example Request Body

{
  "contents": [
    {
      "contentType": "text/html",
      "id": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
    }
  ],
  "languages": [
    "deu"
  ],
  "textItemType": "CRAIG"
}

json

Example Responses

{
  "prevRevision": "https://www.example.com/path/to/resource",
  "titles": [
    "string"
  ],
  "textItemType": {},
  "division": "string",
  "languages": [
    "aaa"
  ],
  "langAlt": [
    "string"
  ],
  "contents": [
    {
      "id": "id",
      "contentType": "contentType",
      "integrity": {
        "algorithm": "algorithm",
        "checksum": "checksum"
      }
    }
  ],
  "description": "string",
  "images": [
    {
      "id": "https://www.example.com/path/to/resource",
      "type": "string",
      "manifest": "https://www.example.com/path/to/resource",
      "license": "license",
      "copyright": "string"
    }
  ],
  "annotationCollection": "https://www.example.com/path/to/resource",
  "via": "string",
  "partOf": [
    "https://www.example.com/path/to/resource"
  ],
  "id": "https://www.example.com/path/to/resource",
  "type": "type",
  "revision": "revision"
}

plain

application/ld+json;profile='https://gitlab.gwdg.de/subugoe/textapi/specs/-/raw/main/jsonld/v2.jsonld'

Retrieve an Item.

GET

/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.

textItemType

required

languages

string[] · required

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

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

object[] · required

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

id

string · uri · minLength: 1 · maxLength: 2083 · required

IRI pointing to this item

revision

string · required

The revision of this Item Object

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)

type

string

Default: TextApiItem

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

curl --request GET \
  --url /items/:slug/revisions/:revslug/

shell

Example Responses

{
  "prevRevision": "https://www.example.com/path/to/resource",
  "titles": [
    "string"
  ],
  "textItemType": {},
  "division": "string",
  "languages": [
    "aaa"
  ],
  "langAlt": [
    "string"
  ],
  "contents": [
    {
      "id": "id",
      "contentType": "contentType",
      "integrity": {
        "algorithm": "algorithm",
        "checksum": "checksum"
      }
    }
  ],
  "description": "string",
  "images": [
    {
      "id": "https://www.example.com/path/to/resource",
      "type": "string",
      "manifest": "https://www.example.com/path/to/resource",
      "license": "license",
      "copyright": "string"
    }
  ],
  "annotationCollection": "https://www.example.com/path/to/resource",
  "via": "string",
  "partOf": [
    "https://www.example.com/path/to/resource"
  ],
  "id": "https://www.example.com/path/to/resource",
  "type": "type",
  "revision": "revision"
}

plain

application/ld+json;profile='https://gitlab.gwdg.de/subugoe/textapi/specs/-/raw/main/jsonld/v2.jsonld'

Retrieve an Item.

GET

/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.

textItemType

required

languages

string[] · required

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

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

object[] · required

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

id

string · uri · minLength: 1 · maxLength: 2083 · required

IRI pointing to this item

revision

string · required

The revision of this Item Object

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)

type

string

Default: TextApiItem

GET/items/{slug}/

curl --request GET \
  --url /items/:slug/

shell

Example Responses

{
  "prevRevision": "https://www.example.com/path/to/resource",
  "titles": [
    "string"
  ],
  "textItemType": {},
  "division": "string",
  "languages": [
    "aaa"
  ],
  "langAlt": [
    "string"
  ],
  "contents": [
    {
      "id": "id",
      "contentType": "contentType",
      "integrity": {
        "algorithm": "algorithm",
        "checksum": "checksum"
      }
    }
  ],
  "description": "string",
  "images": [
    {
      "id": "https://www.example.com/path/to/resource",
      "type": "string",
      "manifest": "https://www.example.com/path/to/resource",
      "license": "license",
      "copyright": "string"
    }
  ],
  "annotationCollection": "https://www.example.com/path/to/resource",
  "via": "string",
  "partOf": [
    "https://www.example.com/path/to/resource"
  ],
  "id": "https://www.example.com/path/to/resource",
  "type": "type",
  "revision": "revision"
}

plain

application/ld+json;profile='https://gitlab.gwdg.de/subugoe/textapi/specs/-/raw/main/jsonld/v2.jsonld'

Remove an Item.

DELETE

/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 and item from the database. If no revision is provided, the latest will be deleted.

No data returned

Remove an Item.

DELETE

/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 and item from the database. If no revision is provided, the latest will be deleted.

No data returned

DELETE/items/revisions/{revslug}/

curl --request DELETE \
  --url '/items/revisions/:revslug/?slug=%3Cstring%3E'

shell

Example Responses

No example specified for this content type

manifests