TextAPI

manifests

Retrieve a list of Manifest ids.

GET

/manifests/

Retrieve a list of IDs of all TextAPI Manifest that are not part of a collection.

Retrieve a list of Manifest ids. › Responses

200

A list of Manifest ids.

string[]

Create a Manifest.

POST

/manifests/

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

Create a Manifest. › Headers

slug

Create a Manifest. › Request Body

A Manifest object as posted by the user on create.

label

string · required

Human-readable name or title

license

string · required

The license applied to the manifest as SPDX license expression.

Personal entities involved in or related to this manifest.

IRI pointing to an Annotation Collection for the complete manifest.

Additional files necessary for rendering the manifest correctly in some client.

A short description of the object

An image representing the resources (e.g. thumbnail or logo)

IRI(s) / ID(s) of holding collection(s)

IRI of the preceding revision of this manifest

Information about the holding repository

the origin of the manuscript. MAY also comprise full provenence information.

the identifier of the manuscript, e.g. a shelfmark

a term classifying the text’s genre(s) or category/categories, preferably taken from a controlled vocabulary

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

IRI pointing to this manifest

Default: TextApiManifest

The revision of this Item Object

Total number of items in items

Default: 0

Items belonging to this manifest

Create a Manifest. › Responses

The created Manifest.

This is the main object in the schema to represent a single text, its derivatives (e.g. HTML) and therefore contains the text's metadata.

label

string · required

Human-readable name or title

license

string · required

The license applied to the manifest as SPDX license expression.

id

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

IRI pointing to this manifest

revision

string · required

The current revision of this manifest, e.g. a hash, date, etc.

total

integer · min: 0 · required

Total number of items in items

Personal entities involved in or related to this manifest.

IRI pointing to an Annotation Collection for the complete manifest.

Additional files necessary for rendering the manifest correctly in some client.

A short description of the object

An image representing the resources (e.g. thumbnail or logo)

IRI(s) / ID(s) of holding collection(s)

IRI of the preceding revision of this manifest

Information about the holding repository

the origin of the manuscript. MAY also comprise full provenence information.

the identifier of the manuscript, e.g. a shelfmark

a term classifying the text’s genre(s) or category/categories, preferably taken from a controlled vocabulary

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

type

string

Default: TextApiManifest

Items belonging to this manifest

POST/manifests/

curl --request POST \
  --url /manifests/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "copyright": "All rights reserved.",
  "label": "My manifest",
  "license": "EUPL-1.2"
}
'

shell

Example Request Body

{
  "copyright": "All rights reserved.",
  "label": "My manifest",
  "license": "EUPL-1.2"
}

json

Example Responses

{
  "copyright": "all rights reserved by disney",
  "id": "http://test.com/idfcx",
  "items": [
    {
      "contents": [
        {
          "contentType": "application/vnd.ms-powerpoint.presentation.macroEnabled.12",
          "id": "http://uri.com/content1"
        }
      ],
      "id": "http://uri.com/item1",
      "languages": [
        "deu"
      ],
      "revision": "1",
      "textItemType": "fragment"
    },
    {
      "contents": [
        {
          "contentType": "application/vnd.openxmlformats-officedocument.presentationml.commentAuthors+xml",
          "id": "http://uri.com/content1"
        }
      ],
      "id": "http://uri.com/item2",
      "languages": [
        "deu"
      ],
      "revision": "r0",
      "textItemType": "fragment"
    }
  ],
  "label": "mein manifest",
  "license": "MIT and EUPL-1.2",
  "revision": "abcd12234"
}

plain

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

Retrieve a Manifest.

GET

/manifests/{slug}/

Retrieve a TextAPI Manifest.

Retrieve a Manifest. › path Parameters

slug

string · required

Retrieve a Manifest. › Responses

The requested Manifest.

This is the main object in the schema to represent a single text, its derivatives (e.g. HTML) and therefore contains the text's metadata.

label

string · required

Human-readable name or title

license

string · required

The license applied to the manifest as SPDX license expression.

id

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

IRI pointing to this manifest

revision

string · required

The current revision of this manifest, e.g. a hash, date, etc.

total

integer · min: 0 · required

Total number of items in items

Personal entities involved in or related to this manifest.

IRI pointing to an Annotation Collection for the complete manifest.

Additional files necessary for rendering the manifest correctly in some client.

A short description of the object

An image representing the resources (e.g. thumbnail or logo)

IRI(s) / ID(s) of holding collection(s)

IRI of the preceding revision of this manifest

Information about the holding repository

the origin of the manuscript. MAY also comprise full provenence information.

the identifier of the manuscript, e.g. a shelfmark

a term classifying the text’s genre(s) or category/categories, preferably taken from a controlled vocabulary

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

type

string

Default: TextApiManifest

Items belonging to this manifest

GET/manifests/{slug}/

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

shell

Example Responses

{
  "copyright": "all rights reserved by disney",
  "id": "http://test.com/idfcx",
  "items": [
    {
      "contents": [
        {
          "contentType": "application/vnd.ms-powerpoint.presentation.macroEnabled.12",
          "id": "http://uri.com/content1"
        }
      ],
      "id": "http://uri.com/item1",
      "languages": [
        "deu"
      ],
      "revision": "1",
      "textItemType": "fragment"
    },
    {
      "contents": [
        {
          "contentType": "application/vnd.openxmlformats-officedocument.presentationml.commentAuthors+xml",
          "id": "http://uri.com/content1"
        }
      ],
      "id": "http://uri.com/item2",
      "languages": [
        "deu"
      ],
      "revision": "r0",
      "textItemType": "fragment"
    }
  ],
  "label": "mein manifest",
  "license": "MIT and EUPL-1.2",
  "revision": "abcd12234"
}

plain

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

Replace a Manifest.

PUT

/manifests/{slug}/

Replace the latest revision of a TextAPI Manifest.

Replace a Manifest. › path Parameters

slug

string · required

Replace a Manifest. › Request Body

A Manifest object as posted by the user on create.

label

string · required

Human-readable name or title

license

string · required

The license applied to the manifest as SPDX license expression.

Personal entities involved in or related to this manifest.

IRI pointing to an Annotation Collection for the complete manifest.

Additional files necessary for rendering the manifest correctly in some client.

A short description of the object

An image representing the resources (e.g. thumbnail or logo)

IRI(s) / ID(s) of holding collection(s)

IRI of the preceding revision of this manifest

Information about the holding repository

the origin of the manuscript. MAY also comprise full provenence information.

the identifier of the manuscript, e.g. a shelfmark

a term classifying the text’s genre(s) or category/categories, preferably taken from a controlled vocabulary

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

IRI pointing to this manifest

Default: TextApiManifest

The revision of this Item Object

Total number of items in items

Default: 0

Items belonging to this manifest

Replace a Manifest. › Responses

The updated Manifest.

This is the main object in the schema to represent a single text, its derivatives (e.g. HTML) and therefore contains the text's metadata.

label

string · required

Human-readable name or title

license

string · required

The license applied to the manifest as SPDX license expression.

id

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

IRI pointing to this manifest

revision

string · required

The current revision of this manifest, e.g. a hash, date, etc.

total

integer · min: 0 · required

Total number of items in items

Personal entities involved in or related to this manifest.

IRI pointing to an Annotation Collection for the complete manifest.

Additional files necessary for rendering the manifest correctly in some client.

A short description of the object

An image representing the resources (e.g. thumbnail or logo)

IRI(s) / ID(s) of holding collection(s)

IRI of the preceding revision of this manifest

Information about the holding repository

the origin of the manuscript. MAY also comprise full provenence information.

the identifier of the manuscript, e.g. a shelfmark

a term classifying the text’s genre(s) or category/categories, preferably taken from a controlled vocabulary

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

type

string

Default: TextApiManifest

Items belonging to this manifest

PUT/manifests/{slug}/

curl --request PUT \
  --url /manifests/:slug/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "copyright": "All rights reserved.",
  "label": "My manifest",
  "license": "EUPL-1.2"
}
'

shell

Example Request Body

{
  "copyright": "All rights reserved.",
  "label": "My manifest",
  "license": "EUPL-1.2"
}

json

Example Responses

{
  "copyright": "all rights reserved by disney",
  "id": "http://test.com/idfcx",
  "items": [
    {
      "contents": [
        {
          "contentType": "application/vnd.ms-powerpoint.presentation.macroEnabled.12",
          "id": "http://uri.com/content1"
        }
      ],
      "id": "http://uri.com/item1",
      "languages": [
        "deu"
      ],
      "revision": "1",
      "textItemType": "fragment"
    },
    {
      "contents": [
        {
          "contentType": "application/vnd.openxmlformats-officedocument.presentationml.commentAuthors+xml",
          "id": "http://uri.com/content1"
        }
      ],
      "id": "http://uri.com/item2",
      "languages": [
        "deu"
      ],
      "revision": "r0",
      "textItemType": "fragment"
    }
  ],
  "label": "mein manifest",
  "license": "MIT and EUPL-1.2",
  "revision": "abcd12234"
}

plain

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

Delete the latest revision of a Manifest.

DELETE

/manifests/{slug}/

Delete the latest revision of a TextAPI Manifest.

Delete the latest revision of a Manifest. › path Parameters

slug

string · required

Delete the latest revision of a Manifest. › Responses

Empty response.

No data returned

DELETE/manifests/{slug}/

curl --request DELETE \
  --url /manifests/:slug/

shell

Example Responses

No example specified for this content type

Delete the ALL revisions of a Manifest. Do not use.

DELETE

/manifests/{slug}/revisions/

Do not use this function, it will destroy all your revisions.

Delete the ALL revisions of a Manifest. Do not use. › path Parameters

slug

string · required

Delete the ALL revisions of a Manifest. Do not use. › Responses

Empty response.

No data returned

DELETE/manifests/{slug}/revisions/

curl --request DELETE \
  --url /manifests/:slug/revisions/

shell

Example Responses

No example specified for this content type

Create a new manifest revision.

PUT

/manifests/{manifest_slug}/revisions/

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

Create a new manifest revision. › path Parameters

manifest_slug

string · required

Create a new manifest revision. › Headers

slug

Create a new manifest revision. › Request Body

A Manifest object as posted by the user on create.

label

string · required

Human-readable name or title

license

string · required

The license applied to the manifest as SPDX license expression.

Personal entities involved in or related to this manifest.

IRI pointing to an Annotation Collection for the complete manifest.

Additional files necessary for rendering the manifest correctly in some client.

A short description of the object

An image representing the resources (e.g. thumbnail or logo)

IRI(s) / ID(s) of holding collection(s)

IRI of the preceding revision of this manifest

Information about the holding repository

the origin of the manuscript. MAY also comprise full provenence information.

the identifier of the manuscript, e.g. a shelfmark

a term classifying the text’s genre(s) or category/categories, preferably taken from a controlled vocabulary

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

IRI pointing to this manifest

Default: TextApiManifest

The revision of this Item Object

Total number of items in items

Default: 0

Items belonging to this manifest

Create a new manifest revision. › Responses

The created manifest revision.

This is the main object in the schema to represent a single text, its derivatives (e.g. HTML) and therefore contains the text's metadata.

label

string · required

Human-readable name or title

license

string · required

The license applied to the manifest as SPDX license expression.

id

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

IRI pointing to this manifest

revision

string · required

The current revision of this manifest, e.g. a hash, date, etc.

total

integer · min: 0 · required

Total number of items in items

Personal entities involved in or related to this manifest.

IRI pointing to an Annotation Collection for the complete manifest.

Additional files necessary for rendering the manifest correctly in some client.

A short description of the object

An image representing the resources (e.g. thumbnail or logo)

IRI(s) / ID(s) of holding collection(s)

IRI of the preceding revision of this manifest

Information about the holding repository

the origin of the manuscript. MAY also comprise full provenence information.

the identifier of the manuscript, e.g. a shelfmark

a term classifying the text’s genre(s) or category/categories, preferably taken from a controlled vocabulary

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

type

string

Default: TextApiManifest

Items belonging to this manifest

PUT/manifests/{manifest_slug}/revisions/

curl --request PUT \
  --url /manifests/:manifest_slug/revisions/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "copyright": "All rights reserved.",
  "label": "My manifest",
  "license": "EUPL-1.2"
}
'

shell

Example Request Body

{
  "copyright": "All rights reserved.",
  "label": "My manifest",
  "license": "EUPL-1.2"
}

json

Example Responses

{
  "copyright": "all rights reserved by disney",
  "id": "http://test.com/idfcx",
  "items": [
    {
      "contents": [
        {
          "contentType": "application/vnd.ms-powerpoint.presentation.macroEnabled.12",
          "id": "http://uri.com/content1"
        }
      ],
      "id": "http://uri.com/item1",
      "languages": [
        "deu"
      ],
      "revision": "1",
      "textItemType": "fragment"
    },
    {
      "contents": [
        {
          "contentType": "application/vnd.openxmlformats-officedocument.presentationml.commentAuthors+xml",
          "id": "http://uri.com/content1"
        }
      ],
      "id": "http://uri.com/item2",
      "languages": [
        "deu"
      ],
      "revision": "r0",
      "textItemType": "fragment"
    }
  ],
  "label": "mein manifest",
  "license": "MIT and EUPL-1.2",
  "revision": "abcd12234"
}

plain

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

Retrieve a manifest revision.

GET

/manifests/{man_slug}/revisions/{rev_slug}/

Retrieve a TextAPI Manifest revision.

Retrieve a manifest revision. › path Parameters

man_slug

string · required

rev_slug

string · required

Retrieve a manifest revision. › Responses

The requested Manifest revision.

This is the main object in the schema to represent a single text, its derivatives (e.g. HTML) and therefore contains the text's metadata.

label

string · required

Human-readable name or title

license

string · required

The license applied to the manifest as SPDX license expression.

id

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

IRI pointing to this manifest

revision

string · required

The current revision of this manifest, e.g. a hash, date, etc.

total

integer · min: 0 · required

Total number of items in items

Personal entities involved in or related to this manifest.

IRI pointing to an Annotation Collection for the complete manifest.

Additional files necessary for rendering the manifest correctly in some client.

A short description of the object

An image representing the resources (e.g. thumbnail or logo)

IRI(s) / ID(s) of holding collection(s)

IRI of the preceding revision of this manifest

Information about the holding repository

the origin of the manuscript. MAY also comprise full provenence information.

the identifier of the manuscript, e.g. a shelfmark

a term classifying the text’s genre(s) or category/categories, preferably taken from a controlled vocabulary

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

type

string

Default: TextApiManifest

Items belonging to this manifest

GET/manifests/{man_slug}/revisions/{rev_slug}/

curl --request GET \
  --url /manifests/:man_slug/revisions/:rev_slug/

shell

Example Responses

{
  "copyright": "all rights reserved by disney",
  "id": "http://test.com/idfcx",
  "items": [
    {
      "contents": [
        {
          "contentType": "application/vnd.ms-powerpoint.presentation.macroEnabled.12",
          "id": "http://uri.com/content1"
        }
      ],
      "id": "http://uri.com/item1",
      "languages": [
        "deu"
      ],
      "revision": "1",
      "textItemType": "fragment"
    },
    {
      "contents": [
        {
          "contentType": "application/vnd.openxmlformats-officedocument.presentationml.commentAuthors+xml",
          "id": "http://uri.com/content1"
        }
      ],
      "id": "http://uri.com/item2",
      "languages": [
        "deu"
      ],
      "revision": "r0",
      "textItemType": "fragment"
    }
  ],
  "label": "mein manifest",
  "license": "MIT and EUPL-1.2",
  "revision": "abcd12234"
}

plain

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

Replace a Manifest revision.

PUT

/manifests/{man_slug}/revisions/{rev_slug}/

Replace a TextAPI Manifest revision.

Replace a Manifest revision. › path Parameters

man_slug

string · required

rev_slug

string · required

Replace a Manifest revision. › Request Body

A Manifest object as posted by the user on create.

label

string · required

Human-readable name or title

license

string · required

The license applied to the manifest as SPDX license expression.

Personal entities involved in or related to this manifest.

IRI pointing to an Annotation Collection for the complete manifest.

Additional files necessary for rendering the manifest correctly in some client.

A short description of the object

An image representing the resources (e.g. thumbnail or logo)

IRI(s) / ID(s) of holding collection(s)

IRI of the preceding revision of this manifest

Information about the holding repository

the origin of the manuscript. MAY also comprise full provenence information.

the identifier of the manuscript, e.g. a shelfmark

a term classifying the text’s genre(s) or category/categories, preferably taken from a controlled vocabulary

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

IRI pointing to this manifest

Default: TextApiManifest

The revision of this Item Object

Total number of items in items

Default: 0

Items belonging to this manifest

Replace a Manifest revision. › Responses

The Manifest revision after replacement.

This is the main object in the schema to represent a single text, its derivatives (e.g. HTML) and therefore contains the text's metadata.

label

string · required

Human-readable name or title

license

string · required

The license applied to the manifest as SPDX license expression.

id

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

IRI pointing to this manifest

revision

string · required

The current revision of this manifest, e.g. a hash, date, etc.

total

integer · min: 0 · required

Total number of items in items

Personal entities involved in or related to this manifest.

IRI pointing to an Annotation Collection for the complete manifest.

Additional files necessary for rendering the manifest correctly in some client.

A short description of the object

An image representing the resources (e.g. thumbnail or logo)

IRI(s) / ID(s) of holding collection(s)

IRI of the preceding revision of this manifest

Information about the holding repository

the origin of the manuscript. MAY also comprise full provenence information.

the identifier of the manuscript, e.g. a shelfmark

a term classifying the text’s genre(s) or category/categories, preferably taken from a controlled vocabulary

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

type

string

Default: TextApiManifest

Items belonging to this manifest

PUT/manifests/{man_slug}/revisions/{rev_slug}/

curl --request PUT \
  --url /manifests/:man_slug/revisions/:rev_slug/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "copyright": "All rights reserved.",
  "label": "My manifest",
  "license": "EUPL-1.2"
}
'

shell

Example Request Body

{
  "copyright": "All rights reserved.",
  "label": "My manifest",
  "license": "EUPL-1.2"
}

json

Example Responses

{
  "copyright": "all rights reserved by disney",
  "id": "http://test.com/idfcx",
  "items": [
    {
      "contents": [
        {
          "contentType": "application/vnd.ms-powerpoint.presentation.macroEnabled.12",
          "id": "http://uri.com/content1"
        }
      ],
      "id": "http://uri.com/item1",
      "languages": [
        "deu"
      ],
      "revision": "1",
      "textItemType": "fragment"
    },
    {
      "contents": [
        {
          "contentType": "application/vnd.openxmlformats-officedocument.presentationml.commentAuthors+xml",
          "id": "http://uri.com/content1"
        }
      ],
      "id": "http://uri.com/item2",
      "languages": [
        "deu"
      ],
      "revision": "r0",
      "textItemType": "fragment"
    }
  ],
  "label": "mein manifest",
  "license": "MIT and EUPL-1.2",
  "revision": "abcd12234"
}

plain

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

Replace a Manifest revision.

DELETE

/manifests/{man_slug}/revisions/{rev_slug}/

Delete a TextAPI Manifest revision.

Replace a Manifest revision. › path Parameters

man_slug

string · required

rev_slug

string · required

Replace a Manifest revision. › Responses

Empty response.

No data returned

DELETE/manifests/{man_slug}/revisions/{rev_slug}/

curl --request DELETE \
  --url /manifests/:man_slug/revisions/:rev_slug/

shell

Example Responses

No example specified for this content type

collections items