Customizable Field Metadata Controller

Changed on
put/customizablefieldmetadata/{uuid}

Request

  • Base URL
    /sormas-rest (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /sormas-rest/customizablefieldmetadata/{uuid}
  • Auth
    none declared

Path parameters

uuidstring required

Request body

activeboolean
changeDatestring date-time
contextClass'CASE' | 'EPIDATA' | 'EXPOSURE' required
creationDatestring date-time
defaultValuestring
descriptionstring
fieldType'TEXT' | 'TEXTAREA' | 'NUMBER' | 'DECIMAL' | 'DATE' | 'DATE_TIME' | 'COMBOBOX' | 'CHECKBOX' | 'YES_NO_UNKNOWN' | 'CHECKBOX_LIST' | 'RADIO_BUTTON_LIST' required
mandatoryboolean
namestring required
readOnlyboolean
translationsobject
uiGroup'CASE_DATA_GENERAL' | 'CASE_DATA_CLASSIFICATION' | 'CASE_DATA_INVESTIGATION' | 'CASE_DATA_IDENTIFIERS' | 'CASE_DATA_DISEASE' | 'CASE_DATA_REINFECTION' | 'CASE_DATA_OUTCOME' | 'CASE_DATA_SEQUELAE' | 'CASE_DATA_JURISDICTION' | 'CASE_DATA_PLACE_OF_STAY' | 'CASE_DATA_QUARANTINE' | 'CASE_DATA_REPORT_GEO' | 'CASE_DATA_HEALTH_CONDITIONS' | 'CASE_DATA_DIAGNOSTIC' | 'CASE_DATA_MEDICAL_INFORMATION' | 'CASE_DATA_VACCINATION' | 'CASE_DATA_CLINICIAN_NOTIFICATION' | 'CASE_DATA_CONTACT_TRACING' | 'EPIDATA_EXPOSURE_INVESTIGATION' | 'EPIDATA_ACTIVITY_AS_CASE' | 'EPIDATA_CONTACT_WITH_SOURCE_CASE' | 'EXPOSURE_DETAILS' | 'EXPOSURES_GENERAL' | 'LOCATION_GENERAL'
uiLinePositioninteger
uiLineWeightnumber float
uuidstring

Response

default response

Changes

  • a4ef960fde19Revision changes
    • breaking

      removed the enum value DIPHTERIA of the request property //

    • warning

      added the new DIPHTHERIA enum value to the // response property for the response status

    • info

      added the new DIPHTHERIA enum value to the request property //

    • info

      removed the DIPHTERIA enum value from the // response property for the response status

  • de78e37bb222Revision changes
    • warning

      added the new GONOCOCCAL_INFECTION enum value to the // response property for the response status

    • info

      added the new GONOCOCCAL_INFECTION enum value to the request property //