Sets
Introduction
The Set API is a method of getting access to descriptions of sets or collections of any sort of entity, including especially objects, texts and images. The Set model is relatively simple with the common properties and patterns, and very few additions. It must be noted that, like the Group API, the Set API does not list its members, to avoid the potential for very long lists. Instead the individual entities are members of the set, and discovering others is left to APIs to be determined.
For more information about the usage of Set data, please see the Collection model description.
Property Definitions
Dereferencing an entity via the Set endpoint would result in a JSON-LD document containing a single JSON object with the following properties.
Properties of Sets
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 set's representation can be dereferenced |
type |
string | Required | The class for the set, which MUST be the value "Set" |
_label |
string | Recommended | A human readable label for the set, intended for developers |
classified_as |
array | Recommended | An array of json objects, each of which is a classification of the set and MUST follow the requirements for Type |
identified_by |
array | Recommended | An array of json objects, each of which is a name of the set and MUST follow the requirements for Name, or an identifier for the set 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 set 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 set |
representation |
array | Optional | An array of json objects, each of which is a reference to a Visual Work that represents the current set, 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 set 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 a Textual Work, the content of which focuses on the current set, 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 set to another entity |
dimension |
array | Optional | An array of json objects, each of which is a Dimension, such as total number of members, of the current set |
members_exemplified_by |
array | Optional | An array of json objects, each of which is either an embedded structure that follows the patterns of one of the Linked Art API endpoints, or a reference to any Linked Art resource |
members_contained_by |
array | Optional | An array of json objects, each of which is a reference to a Physical Object that holds or contains (physical) members of the current set |
created_by |
json object | Optional | A json object representing the creation of the set, which follows the requirements for a Creation |
used_for |
array | Optional | An array of json objects, each of which is a Publication (or similar activity) which follows the requirements for an Activity |
Property Diagram
JSON Schema
See the schema documentation and the schema itself
Note that the members_exemplified_by
property can only be minimally validated.
Incoming Properties
Set 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 sets.
Property Name | Source Endpoint | Description |
---|---|---|
member_of |
All | Entities other than People or Groups can be members of sets. (People and Groups are members of Groups instead) |
used_specific_object |
Event | Events can use sets of things, for example the set of objects in an exhibition or auction lot |
Example
The JSON for a Set entry for the Met's Collection 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 "Set" - It has a
_label
with the value "Collection of the Met" for people reading the JSON - It is
classified_as
a "Collection", which has anid
of "aat:300025976" - It is
identified_by
aName
, with the content "Art Collection of the Metropolitan Museum of Art" - It is
referred_to_by
a statement which ...- ... has
content
of "Over 2 million works ..." - ... is
classified_as
a Description ("aat:300435416")
- ... has
- It was
created_by
a Creation which ...- ... has a
timespan
between "1870-04-13T00:00:00Z" and "1870-04-13T23:59:59Z"
- ... has a
{
"@context": "https://linked.art/ns/v1/linked-art.json",
"id": "https://linked.art/example/set/1",
"type": "Set",
"_label": "Collection of the Met",
"classified_as": [
{
"id": "http://vocab.getty.edu/aat/300025976",
"type": "Type",
"_label": "Collection"
}
],
"identified_by": [
{
"type": "Name",
"content": "Art Collection of the Metropolitan Museum of Art"
}
],
"referred_to_by": [
{
"type": "LinguisticObject",
"classified_as": [
{
"id": "http://vocab.getty.edu/aat/300435416",
"type": "Type",
"_label": "Description",
"classified_as": [
{
"id": "http://vocab.getty.edu/aat/300418049",
"type": "Type",
"_label": "Brief Text"
}
]
}
],
"content": "Over 2 million works, divided into 17 curatorial departments"
}
],
"created_by": {
"type": "Creation",
"timespan": {
"type": "TimeSpan",
"_label": "April 13th, 1870",
"begin_of_the_begin": "1870-04-13T00:00:00Z",
"end_of_the_end": "1870-04-13T23:59:59Z"
}
}
}