Introduction
The Textual Work API is a method of getting access to descriptions of texts, such as the linguistic content carried in printed or digital books, linguistic content incorporated as part of artworks, or other noteworthy linguistic content. The Textual Work model is of average complexity with many familiar properties and patterns, plus several additions to describe the text's relationship to other entities.
For more information about the usage of Textual Work data, please see the Document model description.
Property Definitions
Dereferencing an entity via the Textual Work endpoint would result in a JSON-LD document containing a single JSON object with the following properties.
Properties of Textual Works
Property Name | Datatype | Requirement | Description |
---|---|---|---|
@context |
string, array | Required | The value MUST be the URI of the Linked Art context as a string, "https://linked.art/ns/v1/linked-art.json" or an array in which the URI is the last entry to allow for extensions |
id |
string | Required | The value MUST be the HTTP(S) URI at which the text's representation can be dereferenced |
type |
string | Required | The class for the text, which MUST be the value "LinguisticObject" |
_label |
string | Recommended | A human readable label for the text, intended for developers |
classified_as |
array | Recommended | An array of json objects, each of which is a classification of the text and MUST follow the requirements for Type |
identified_by |
array | Recommended | An array of json objects, each of which is a name/title of the text and MUST follow the requirements for Name, or an identifier for the text and MUST follow the requirements for Identifier |
referred_to_by |
array | Optional | An array of json objects, each of which is a human readable statement about the text and MUST follow the requirements for Statement |
equivalent |
array | Optional | An array of json objects, each of which is a reference to an external identity and description of the current text |
representation |
array | Optional | An array of json objects, each of which is a reference to a Visual Work that represents the current text, and MUST follow the requirements for a reference |
member_of |
array | Optional | An array of json objects, each of which is a Set that the current text is a member of and MUST follow the requirements for a reference to a Set |
subject_of |
array | Optional | An array of json objects, each of which is a reference to another Textual Work, the content of which focuses on the current text, and MUST follow the requirements for a reference |
attributed_by |
array | Optional | An array of json objects, each of which is a Relationship Assignment that relates the current text to another entity |
language |
array | Optional | An array of json objects, each of which is a language the text is expressed in, and MUST follow the requirements for Language |
dimension |
array | Optional | An array of json objects, each of which is a Dimension, such as total number of words, of the current text |
part_of |
array | Optional | An array of json objects, each of which is a reference to another Textual Work that the current text is a part of. |
content |
string | Optional | The string representation of the textual content of the work |
format |
string | Optional | The media type of the encoding of the string representation given in the content property |
digitally_carried_by |
array | Optional | An array of json objects, each of which is a reference to a Digital Object, such as a PDF, that digitally carries the text of this work |
carried_by |
array | Optional | An array of json objects, each of which is a reference to a Physical Object, such as a book, that physically carries the text of this work |
about |
array | Optional | An array of json objects, each of which is a reference to another entity of any type, that this text is primarily about |
refers_to |
array | Optional | An array of json objects, each of which is a reference to another entity of any type, that this text references in some way, but is not necessarily the primary topic of the work |
created_by |
json object | Optional | A json object representing the creation of the text, which follows the requirements for Creations described below |
used_for |
array | Optional | An array of json objects, each of which is a Publication Activity, which follows the requirements for Publications described below |
Properties of Creations, Publication Activities
Property Name | Datatype | Requirement | Description |
---|---|---|---|
id |
string | Optional | If present, the value MUST be a URI identifying the creation or publication |
type |
string | Required | The class for the creation, which MUST be the value "Creation" or "Activity" |
_label |
string | Recommended | A human readable label for the creation or publication, intended for developers |
identified_by |
array | Recommended | An array of json objects, each of which is a name for the creation or publication and MUST follow the requirements for Name, or an identifier for the creation or publication and MUST follow the requirements for Identifier |
classified_as |
array | Recommended | An array of json objects, each of which is a further classification of the creation or publication and MUST follow the requirements for Type |
timespan |
json object | Recommended | A json object recording when the creation or publication occured, which MUST follow the requirements for timespans |
referred_to_by |
array | Optional | An array of json objects, each of which is an embedded statement about the creation or publication |
took_place_at |
array | Optional | An array of json objects, each of which is a reference to a Place where the creation or publication occured |
caused_by |
array | Optional | An array of json objects, each of which is a reference to an Event that caused the creation or publication to occur |
influenced_by |
array | Optional | An array of json objects, each of which is a reference to an entity that influenced the creation or publication in some noticable fashion |
carried_out_by |
array | Optional | An array of json objects, each of which is a reference to a Person or Group that carried out the creation or publication |
Property Diagram
JSON Schema
See the schema documentation and the schema itself
Incoming Properties
Textual Work instances are typically found as the object of the following properties, other than the self-referential properties above. This list is not exhaustive, but is intended to cover the likely cases where other endpoints refer to texts.
Property Name | Source Endpoint | Description |
---|---|---|
subject_of |
All | Any entity can be the subject of textual content |
carries |
Physical Object | A physical object can carry a text, such as a manuscript and the text written on its pages |
digitally_carries |
Digital Object | A digital object can also digitally carry a text, such as a word document and the text encoded in it |
Example
The JSON for a Textual Work entry for a text of a book about Gainsborough's works could be as below.
- It has the Linked Art context document reference in
@context
- It self-documents its URI in
id
- It has a
type
of "LinguisticObject" - It has a
_label
with the value "Gainsborough by Hayes" for people reading the JSON - It is
classified_as
a "Monograph", which has anid
of "aat:300060417" - It is
identified_by
...- ... a
Name
, with the content "Gainsborough: Paintings and Drawings" - ... an
Identifier
with the content "0714816396", which isclassified_as
an ISBN ("aat:300417443")
- ... a
- It is
referred_to_by
a statement which ...- ... has
content
of "A thorough analysis of the artist's life and work" - ... is
classified_as
an Abstract ("aat:")
- ... has
- It has a
language
of English ("aat:300388277") - It is
about
Gainsborough, a Person withid
"ulan:500115200" - It was
created_by
a Creation which ...- ... was
carried_out_by
John Hayes, a Person
- ... was
- It was
used_for
an Activity ...- ... which is
classified_as
Publishing ("aat:300054686") - ...
took_place_at
New York - ... and was
carried_out_by
Phaidon, a Group
- ... which is
{
"@context": "https://linked.art/ns/v1/linked-art.json",
"id": "https://linked.art/example/text/0",
"type": "LinguisticObject",
"_label": "Gainsborough by Hayes",
"classified_as": [
{
"id": "http://vocab.getty.edu/aat/300060417",
"type": "Type",
"_label": "Monograph"
}
],
"identified_by": [
{
"type": "Name",
"classified_as": [
{
"id": "http://vocab.getty.edu/aat/300404670",
"type": "Type",
"_label": "Primary Name"
}
],
"content": "Gainsborough: Paintings and Drawings"
},
{
"type": "Identifier",
"classified_as": [
{
"id": "http://vocab.getty.edu/aat/300417443",
"type": "Type",
"_label": "ISBN Identifier"
}
],
"content": "0714816396"
}
],
"referred_to_by": [
{
"type": "LinguisticObject",
"classified_as": [
{
"id": "http://vocab.getty.edu/aat/300026032",
"type": "Type",
"_label": "Abstract",
"classified_as": [
{
"id": "http://vocab.getty.edu/aat/300418049",
"type": "Type",
"_label": "Brief Text"
}
]
}
],
"content": "A thorough analysis of the artist's life and work"
}
],
"about": [
{
"id": "http://vocab.getty.edu/ulan/500115200",
"type": "Person",
"_label": "Gainsborough, Thomas"
}
],
"language": [
{
"id": "http://vocab.getty.edu/aat/300388277",
"type": "Language",
"_label": "English"
}
],
"used_for": [
{
"type": "Activity",
"classified_as": [
{
"id": "http://vocab.getty.edu/aat/300054686",
"type": "Type",
"_label": "Publishing"
}
],
"timespan": {
"type": "TimeSpan",
"_label": "1975",
"begin_of_the_begin": "1975-01-01T00:00:00Z",
"end_of_the_end": "1975-12-31T23:59:59Z"
},
"took_place_at": [
{
"type": "Place",
"_label": "New York"
}
],
"carried_out_by": [
{
"type": "Group",
"_label": "Phaidon"
}
]
}
],
"created_by": {
"type": "Creation",
"carried_out_by": [
{
"type": "Person",
"_label": "Hayes, John"
}
]
}
}