Sign in

v44

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

Http Post Ci Schema V3

POST method that creates a Collection Instrument in CIR. Requires guid and validator_version as parameters with optional ci_version. This endpoint is deprecated.

post/v3/publish_collection_instrument

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