Sign in
Records

Create Keyword Endpoint

Create a new keyword for a record.

post/records/{record_id}/keywords/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Path parameters

record_idstring uuid required

Request body

keywordstring required
vocabulary_uristring nullable

URI of the controlled vocabulary

keyword_typestring

ISO MD_KeywordTypeCode, e.g. theme, place, discipline

Response

Successful Response

idstring uuid required
record_idstring uuid required
keywordstring required
vocabulary_uristring nullable required
keyword_typestring required
inheritedboolean

True when this keyword also exists on the dataset this record was derived from. Derived at read time from derived_from; only ever true for a requester who can access that source dataset, so everyone else sees false — matching the derived_from redaction.

Changes

No recorded changes to this operation across all 50 revisions of this API.