action digitalnz_get_records_record_id_format {
  label: "View metadata associated with a single record."
  description: "If you know its `record_id` you can use this endpoint to view all metadata associated with that specific record.\n"
  provider: digitalnz
  method: GET
  path: "/records/{record_id}.{format}"
  encoding: json
  input: {
    type: "object"
    properties: {
      record_id: {
        type: "integer"
      }
    }
    required: ["record_id"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "*NOTE:* There are a lot of fields that are very rarely used in DigitalNZ. For instance there are custom built fields that are only relevant, and only found on specific collections. The schema below focuses on the most common / well populated fields and does not show every possible field available for a single record. \n"
    properties: {
      category: {
        type: "array"
        description: "There will always be at least 1 human-readable category label in this field."
        items: {
          type: "string"
          enum: ["Newspapers", "Images", "Books", "Articles", "Journals", "Archives", "Audio", "Other", "Manuscripts", "Reference sources", "Research papers", "Videos", "Music Score", "Groups", "Data", "Websites", "Sets"]
        }
      }
      collection: {
        type: "array"
        description: "In addition to the top level *\"display_collection\"* above, this field can also contain sub-collections or groupings within the main collection. \n"
        items: {
          type: "string"
        }
      }
      collection_title: {
        type: "array"
        description: "For historic reasons this is a duplicate of the previous field (\"collection\")."
        items: {
          type: "string"
        }
      }
      content_partner: {
        type: "array"
        description: "Name of the organisation(s), institution(s), or individual(s) making content available through DigitalNZ. This metadata will be present on all records and is usually the name of the organisation that has agreed to the DigitalNZ Metadata Contribution Terms."
        items: {
          type: "string"
        }
      }
      copyright: {
        type: "array"
        description: "A copyright statement applying to the object referenced by this record. This field may be empty."
        items: {
          type: "string"
          enum: ["All rights reserved", "Some rights reserved", "No known copyright restrictions", "Unknown"]
        }
      }
      created_at: {
        type: "string"
        format: "date-time"
        description: "The date the record was initially harvested into DigitalNZ."
      }
      creator: {
        type: "array"
        description: "The name's of the people, organisations, institutions, services etc. who created the content (eg. the photographer, artist, writer or author)."
        items: {
          type: "string"
        }
      }
      date: {
        type: "array"
        description: "Date information associated with this record (e.g. 1996-01-01T00:00:00.000Z). This field may be empty."
        items: {
          type: "string"
        }
      }
      dc_identifier: {
        type: "array"
        description: "Identifiers relating to the content from the content partner's system."
        items: {
          type: "string"
        }
      }
      description: {
        type: "string"
        description: "Description of the record. Most records have a description."
      }
      display_collection: {
        type: "string"
        description: "The single main collection or website that the item belongs to. This metadata will be present on all records."
      }
      display_content_partner: {
        type: "string"
        description: "The main Content Partner, for cases when there are more than one. This metadata will be present on all records."
      }
      display_date: {
        type: "string"
        description: "Where provided, this field contains a human readable version of the date information."
      }
      id: {
        type: "integer"
        description: "All records have a unique identifier used within the DigitalNZ system."
      }
      landing_url: {
        type: "string"
        description: "This field will always contain a URL of the item on the content partner's website.  \n*Note:* Please use the source_url when providing HTML links.\n"
      }
      large_thumbnail_url: {
        type: "string"
        description: "URL for a larger thumbnail image with a width of up to 800px. NOTE - the API Terms do not extend rights to the use of images accessable throught the *large_thumbnail_url* field."
      }
      locations: {
        type: "array"
        description: "Geographical location information including latitude and longitude co-ordinates, text based location information, and details about where the location information comes from (eg. \"Location provided by Museum of New Zealand Te Papa Tongarewa\")\n"
        items: {
          type: "object"
          properties: {
            comment: {
              type: "string"
              description: "Describes who provided this location metadata."
            }
            lat: {
              type: "number"
            }
            lng: {
              type: "number"
            }
            placename: {
              type: "string"
            }
          }
        }
      }
      primary_collection: {
        type: "array"
        description: "In most cases this is the same as *display_collection*, but will occasionally a second value."
        items: {
          type: "string"
        }
      }
      rights: {
        type: "string"
        description: "Rights information. Can be a rights statement explaining the rights of the record or a link to a webpage with more detailed rights information."
      }
      rights_url: {
        type: "array"
        description: "An array of HTTP URLs resolving to a rights statement or terms of use information for the resource."
        items: {
          type: "string"
        }
      }
      source_url: {
        type: "string"
        description: "This URL will always be present and provides a redirect to the landing_url. This link should be used as the main click-through to the content. Passing users through this link allows DNZ to count the number of click-throughs, as well as trigger link-checking activities that help clean up stale links in DigitalNZ."
      }
      subject: {
        type: "array"
        description: "Keywords about the content."
        items: {
          type: "string"
        }
      }
      thumbnail_url: {
        type: "string"
        description: "URL for a thumbnail image of the content. The size varies depending on what is available but we aim for a width of 250px. This field is mostly populated on records with a 'category' of 'Images', but is also sometimes found on others (eg. \"Videos\").\n"
      }
      title: {
        type: "string"
        description: "Title of the record. All records should have a title."
      }
      updated_at: {
        type: "string"
        format: "date-time"
        description: "The date the record was last updated/re-harvested into DigitalNZ."
      }
      usage: {
        type: "array"
        description: "This field is always present and contains human-understandable information about how the item may be used based on its copyright/license."
        items: {
          type: "string"
          enum: ["All rights reserved", "Share", "Modify", "Use commercially", "Unknown"]
        }
      }
    }
  }
}