Work — JSON-LD

GET

/id/work/{key}.json

const url = 'https://textrefs.org/id/work/example.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/id/work/example.json

Parameters

Path Parameters

key

required

string

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

Flat registry key.

Responses

200

Work record as JSON-LD.

application/json

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: iri

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

alternative_labels

Additional names for the work — abbreviations, translated titles, and established short forms. Search and display only. Identity-neutral, because no label is a UUID seed input, so a label change never moves an identifier. Unique within one work; two different works MAY share an alternative label.

Array<string>

>= 1 items unique items

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

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

404

No registry object found at this identifier. The site is static, so the host cannot build a per-path error body. It serves the site’s own 404 page instead: text/html, with the same navigation as every other page. A client detects the miss from the status code, not from the body.

text/html

The site’s HTML 404 page.

string