API Docs / Schemas / ConvertFormFileResponse

ConvertFormFileResponse

Result of converting an external form definition file into the Sodium import format

Properties

Name Type Description
formsarray of CreateDataFormRequest

The converted forms in Sodium's CreateDataFormRequest format, ready for import

The converted forms in Sodium's CreateDataFormRequest format, ready for import

warningsarray of ConvertFormFieldWarning

Warnings about fields that could not be automatically mapped (e.g. unrecognised custom fields, unsupported builtin fields)

Warnings about fields that could not be automatically mapped (e.g. unrecognised custom fields, unsupported builtin fields)

JSON Example

{
  "forms": [
    {
      "name": "...",
      "description": "...",
      "introduction": "...",
      "dataFormCategoryCode": "...",
      "status": "..."
    }
  ],
  "warnings": [
    {
      "formName": "...",
      "sectionTitle": "...",
      "questionLabel": "...",
      "originalField": "...",
      "warningType": "..."
    }
  ]
}

Used By Operations