Work collection — JSON-LD

GET

/reg/works.json

const url = 'https://textrefs.org/reg/works.json';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://textrefs.org/reg/works.json

Each item in @graph is the same record that /id/work/{key}.json serves, without its own @context. The collection carries one @context for the whole graph.

Responses

200

Every Work record in the registry, in every status, sorted by key.

application/json

The /reg/works.json registry-wide collection of Work records.

object

@context

required

string format: uri

@graph

required

Array

object

status

required

string

Allowed values: draft active deprecated withdrawn blocked

created

required

string

/^\d{4}-\d{2}-\d{2}$/

modified

required

string

/^\d{4}-\d{2}-\d{2}$/

superseded_by

Successor IRI. Only present when status is deprecated, withdrawn, or blocked.

string format: uri

required

string

/^https://textrefs\.org/id/work/[^/]+$/

key

required

Flat registry key: lowercase, starts with [a-z0-9], allows . _ -

string

/^[a-z0-9][a-z0-9._-]*$/

type

required

string

Allowed values: Work

preferred_label

required

string

>= 1 characters

preferred_citation_system_key

required

Key of the CitationSystem this work is cited under by default. Governs the bare /cite/{work_key}/{locator} alias and default presentation only; it is identity-neutral and never affects how a fully qualified reference validates or resolves.

string

/^[a-z0-9][a-z0-9._-]*$/

creators

Array

One of:

object
object

object

kind

required

string

Allowed values: person

family

required

string

>= 1 characters

given

string

>= 1 characters

alternateOf

Compiler-derived from the work’s alternateOf MappingAssertions that are not deprecated, withdrawn or blocked. The array enriches the work and makes no review claim. Read the MappingAssertion for status. Read-only, never authored.

Array<string>

isReferencedBy

Compiler-derived from the work’s isReferencedBy MappingAssertions that are not deprecated, withdrawn or blocked. The array enriches the work and makes no review claim. Read the MappingAssertion for status. Read-only, never authored.

Array<string>

Example

{
  "@graph": [
    {
      "status": "draft",
      "type": "Work",
      "creators": [
        {
          "kind": "person"
        }
      ]
    }
  ]
}