Resources

name path methods description
AgentResource
  • /agent
  • /agent/_scroll
  • /agent/{id}
  • /agent/{id}/related
  • GET
  • POST
  • GET
  • GET

Agent (Physical Entity)

A thing that 'does stuff'

  • Person: A human being (foaf:Person)
  • Organisation: An organised group of people (foaf:Organization)
  • Collaboration: (tp:Collaboration)
Associations from other resources that agents might be the target of (these are accessible via the /related sub-resource):
  • identification.identifiedBy: Identifier of a Specimen
  • production.contributor: Maker of an Object
  • associatedParties: Associated with another agent
  • authors: Author of a Topic or Publication
  • evidenceFor.atEvent.recordedBy: Recorder of the field collection of a Specimen
  • scientificNameAuthorship: Author of the scientific name of a Specimen
  • associatedWith: Associated with another agent, Category, or Place
  • depicts: Depicted in an Object
  • formerOwner: Former owner of an Object
  • refersTo: Referred to by an Object, Specimen, Topic, or Publication
  • influencedBy: Influenced the making of an Object
  • publisher: Publisher of a Publication
  • editor: Editor of a Publication
  • illustrator: Illustrator of a Publication
  • aggregatedAgents: Part of an aggregation of agents
  • unknownAssociation: Associated in an unspecified way with an Object or Specimen
CategoryResource
  • /category
  • /category/_scroll
  • /category/{id}
  • /category/{id}/related
  • GET
  • POST
  • GET
  • GET

Concept (from a controlled vocabulary)

A concept

  • Category: (skos:Concept)

The concepts include (these may be specified as distinctive types in future API releases):

  • PeriodStyle: A named set of distinctive characteristics, often associated with a specific location or time interval - AAT, Taonga Māori Development Periods
  • EthnicGroup: A community of people who share a common cultural background - MCH Iwi, Statistics NZ ethnicity
  • Subject: A topic that a thing is 'about' - AAT, TGM
  • ObjectType: A category that a thing is an example of, eg. cars - AAT, Mātauranga Māori Thesaurus
  • Material: A substance used to make something - AAT
  • Technique: A method of making something - AAT
Associations from other resources that categories might be the target of (these are accessible via the /related sub-resource):
  • associatedWith: Associated with another category, Place, Person, Organisation, or Collaboration
  • depicts: Concept depicted in an Object
  • refersTo: Style/group/etc. referred to by an Object, Specimen, Topic, or Publication
  • isAbout: Subject of an Object
  • influencedBy: Style/group/etc. that influenced the making of an Object
  • intendedFor: Subject that an Object is intended for
  • productionUsedTechnique: Technique used in the making of an Object
  • isTypeOf: Object type of an Object
  • isMadeOf: Material that an Object is made of
  • unknownAssociation: Associated in an unspecified way with an Object or Specimen
  • relatedTerms: Child category underneath a parent Category
DocumentResource
  • /document
  • /document/_scroll
  • /document/{id}
  • /document/{id}/related
  • GET
  • POST
  • GET
  • GET

Document (Physical Entity)

A visual or text-based object (not a collection object)

  • Publication: A formally published document (tp:Publication)
Associations from other resources that documents might be the target of (these are accessible via the /related sub-resource):
  • isReferencedBy: Referred to by an Object or Specimen
  • relatedTopics: Associated with a Topic
  • isPartOf: Parent of one or more other child Publications
  • hasPart: Child publication underneath a parent Publication
FieldCollectionResource
  • /fieldcollection
  • /fieldcollection/_scroll
  • /fieldcollection/{id}
  • /fieldcollection/{id}/related
  • GET
  • POST
  • GET
  • GET

Field Collection (Te Papa Resource)

The event when a specimen was collected in the field

  • FieldCollection: (tp:FieldCollection)
Associations from other resources that field collection events might be the target of (these are accessible via the /related sub-resource):
  • evidenceFor.atEvent: Field collection event for a Specimen
GroupResource
  • /group
  • /group/_scroll
  • /group/{id}
  • /group/{id}/related
  • GET
  • POST
  • GET
  • GET

Group (Te Papa Resource)

A set of things (object, people, etc.)

  • Group: (tp:Group)
Associations from other resources that groups might be the target of (these are accessible via the /related sub-resource):
  • aggregatedGroups: Part of an aggregation of Groups
MediaResource
  • /media
  • /media/_scroll
  • /media/{id}
  • /media/{id}/related
  • GET
  • POST
  • GET
  • GET

Media (Te Papa Resource)

A media file containing a representation of a collection object

  • ImageObject: An image file (schema:ImageObject)
  • VideoObject: A video file (schema:VideoObject)
  • AudioObject: An audio file (schema:AudioObject)
  • MediaObject: An media file of an unspecified type (schema:MediaObject)
  • WebPage: An individual representation of a media object retrievable via a URL (schema:WebPage)
  • Dataset: (schema:Dataset)
  • TextDigitalDocument: (schema:TextDigitalDocument)
  • SpreadsheetDigitalDocument: (schema:SpreadsheetDigitalDocument)
  • PresentationDigitalDocument: (schema:PresentationDigitalDocument)
Associations from other resources that media might be the target of (these are accessible via the /related sub-resource):
  • hasRepresentation: Representation of an Object or Specimen
ObjectResource
  • /object
  • /object/_scroll
  • /object/{id}
  • /object/{id}/related
  • GET
  • POST
  • GET
  • GET

Te Papa Resource

A thing selected and added to a collection

  • Object: An object of cultural value, may be physical, digital, or biological (crm:E19_Physical_Object)
  • Specimen: A biological object (crm:E20_Biological_Object)
Associations from other resources that objects and specimens might be the target of (these are accessible via the /related sub-resource):
  • relation: Associated with another Object or Specimen
  • relatedObjects: Related to a Topic or Publication
  • isPartOf: Parent of one or more other children Objects or Specimens
  • hasPart: Child object or specimen underneath a parent Object or Specimen
  • aggregatedObjects: Part of an aggregation of Objects or Specimens
PlaceResource
  • /place
  • /place/_scroll
  • /place/{id}
  • /place/{id}/related
  • GET
  • POST
  • GET
  • GET

Place (Physical Entity)

A location in space

  • Place: (crm:E53_Place - using TGN names)
Associations from other resources that places might be the target of (these are accessible via the /related sub-resource):
  • production.spatial: Place related to where an Object was made
  • associatedWith: Associated with another place, Category, Person, Organisation, or Collaboration
  • depicts: Concept depicted in an Object
  • refersTo: Place referred to by an Object, Specimen, Topic, or Publication
  • isAbout: Subject of an Object
  • influencedBy: Place that influenced the making of an Object
  • relatedTerms: Child place within a parent Place
ScrollResource
  • /scroll/{id}
  • GET

Scroll

A temporary resource for retrieving scroll pages.
SearchResource
  • /search
  • /search/_scroll
  • GET POST
  • POST

Search

A resource for querying of the collections.
TaxonResource
  • /taxon
  • /taxon/_scroll
  • /taxon/{id}
  • /taxon/{id}/related
  • GET
  • POST
  • GET
  • GET

Taxonomy (from a controlled vocabulary)

A biological classification of related organisms

  • Taxon: A biological classification of related organisms - Linnaean Taxonomy
Associations from other resources that taxons might be the target of (these are accessible via the /related sub-resource):
  • associatedWith: Associated with a Publication or Topic
  • depicts: Taxon depicted in an Object
  • refersTo: Taxon referred to by an Object, Specimen, Topic, or Publication
  • isAbout: Subject of an Object
  • influencedBy: Taxon that influenced the making of an Object
  • intendedFor: Subject that an Object is intended for
  • unknownAssociation: Associated in an unspecified way with an Object or Specimen
TopicResource
  • /topic
  • /topic/_scroll
  • /topic/{id}
  • /topic/{id}/related
  • GET
  • POST
  • GET
  • GET

Topic (Te Papa Resource)

A narrative or description about a topic

  • Topic: (tp:Topic)
Associations from other resources that topics might be the target of (these are accessible via the /related sub-resource):
  • isReferencedBy: Referred to by an Object or Specimen
  • relatedTopics: Associated with a Topic
  • isPartOf: Parent of one or more other child Topics
  • hasPart: Child topic underneath a parent Topic
  • aggregatedTopics: Part of an aggregation of Topics

Data Types

JSON

type description
ApiSearchRequest A search request allows an API consumer to specify a search query, including a number of facets, and a sort order.

If using the advanced search endpoint, the pagination parameters must be passed through this object (the request body).

ApiSearchResult A search result. Contains metadata about a search, such as result set size, and the actual search results.
ErrorResponse An error response contains details about an error that occurred.
Facet Requests a facet with the search result.
Filter Requests the search results to be filtered by field and keyword.
Operator
ResponseMetadata Information about a search query and the result set.
ResultSetMetadata Information about a result set of a search query.
Sort Requests the search results to be sorted in this order.
SourceField Requests the search results to include/exclude specific fields from each result source record.