Sign in

v44

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

Create Collection Instrument

POST method to create a new collection instrument

  • A GUID is required
  • A validator_version is required
  • A ci_version is optional, if not specified, it will increment automatically
post/collection-instruments

Query parameters

guidstring

guid for CI

guid for CI

validator_versionstring

Validator version of CI schema

Validator version of CI schema

ci_versionstring

CI version of CI schema

CI version of CI schema

Request body

data_versionstring required
form_typestring
languagestring required
legal_basisstring
mime_typestring
navigationobject
post_submissionobject
questionnaire_flowobject
sds_schemastring
submissionobject
survey_idstring required
themestring
titlestring required

Response

Successfully created a CI. This is illustrated with the returned response containing the metadata of the CI.

ci_versioninteger required
classifier_typestring required
classifier_valuestring required
data_versionstring required
guidstring required
languagestring required
published_atstring required
sds_schemastring
survey_idstring required
titlestring required
validator_versionstring required