v44

latestOpenAPI 3.0.1raw.githubusercontent.com2026-05-0512828.7 KB

Get Collection Instruments Metadata

GET method that returns any metadata objects from CIR that match the parameters passed. The user has multiple ways of querying the metadata.

  • Provide survey_id, classifiers, language.
  • Provide no parameters. (all ci metadata is returned)
get/collection-instruments/metadata

Query parameters

classifier_type'form_type' | 'default'

classifier_type used by the CI

classifier_valuestring

classifier_value used by the CI

classifier_value used by the CI

languagestring

The language of the CI

The language of the CI

survey_idstring

The survey_id of the CI

The survey_id of the CI

Response

Successful Response

{"stackTrail":"paths:/collection-instruments/metadata:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}