---
title: "Digitised object definition"
method: GET
path: "/v1/digitised-objects/{id}"
tags: ["V1", "Digitised Objects"]
---

# Digitised object definition

`GET /v1/digitised-objects/{id}`

## Request

- Base URL: `https://api-dor.ncl.ac.uk`
- URL: `https://api-dor.ncl.ac.uk/v1/digitised-objects/{id}`
- Auth: none declared

Returns all the metadata and signposts to the related resources for the given digitised object.

## Path parameters

- `id` string, required

## Response `200`

The complete definition of the identified digitised object.

- object
  - `id` string, required
  - `refCode` string, nullable, required
  - `title` string, nullable, required
  - `description` string, nullable, required
  - `format` string, nullable, required
  - `language` string, nullable, required
  - `creators` string[], nullable, required
  - `subjects` string[], nullable, required
  - `dates` string[], nullable, required
  - `places` string[], nullable, required
  - `publishers` string[], nullable, required
  - `provenances` string[], nullable, required
  - `contributors` string[], nullable, required
  - `copyright` string, nullable, required
  - `license` string, nullable, required
  - `manifest` string, required
  - `collection` object, required
    - `id` string, required
    - `title` string, nullable, required
    - `_links` object, required
      - `definition` HateoasLink, required
        - `href` string, required
        - `type` 'GET' | 'POST' | 'PUT' | 'DELETE', required
        - `parameters` HateoasParameters: Any relevant parameters that should be appended to the URL (for GET method) or passed as a payload for other HTTP methods.
  - `items` object, required
    - `totalElements` number, required
    - `_links` object, required
      - `search` HateoasLink, required
        - `href` string, required
        - `type` 'GET' | 'POST' | 'PUT' | 'DELETE', required
        - `parameters` HateoasParameters: Any relevant parameters that should be appended to the URL (for GET method) or passed as a payload for other HTTP methods.
  - `transcript` object, nullable, required
    - `_links` object, required
      - `content` HateoasLink, required
        - `href` string, required
        - `type` 'GET' | 'POST' | 'PUT' | 'DELETE', required
        - `parameters` HateoasParameters: Any relevant parameters that should be appended to the URL (for GET method) or passed as a payload for other HTTP methods.
  - `teis` object[], nullable, required
    - `id` string, required
    - `type` 'primary', nullable, required
    - `_links` object, required
      - `content` HateoasLink, required
        - `href` string, required
        - `type` 'GET' | 'POST' | 'PUT' | 'DELETE', required
        - `parameters` HateoasParameters: Any relevant parameters that should be appended to the URL (for GET method) or passed as a payload for other HTTP methods.
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, nullable, required
  - `_links` object, required
    - `index` HateoasLink, required
      - `href` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'DELETE', required
      - `parameters` HateoasParameters: Any relevant parameters that should be appended to the URL (for GET method) or passed as a payload for other HTTP methods.
    - `search` HateoasLink, required
      - `href` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'DELETE', required
      - `parameters` HateoasParameters: Any relevant parameters that should be appended to the URL (for GET method) or passed as a payload for other HTTP methods.

## Other responses

- `400`: The server could not finalise the response due to the malformed, invalid or missing request parameters.
- `404`: A digitised object with the specified ID was not found.
- `5XX`: Indicates that the server encountered an unexpected exception preventing it from fulfilling the request.

---

[API](https://skmtc.dev/ncl/apis/newcastle-university-digitised-objects-repository-search-and.md) - [All operations](https://skmtc.dev/ncl/apis/newcastle-university-digitised-objects-repository-search-and/llms.txt) - [OpenAPI document](https://skmtc.dev/ncl/apis/newcastle-university-digitised-objects-repository-search-and/revisions/fe6a8df13009?raw)