Sign in
configurations

Update Section

Changed on

Update a section entry for a configuration.

Args: configuration_id (UUID): ID of the configuration to update section_input (SectionUpdateInput): Updated section info user (DbUser): The logged-in user db (AsyncDatabaseConnection): Database connection

Raises: HTTPException: 400 if the code is not valid, code is in use, name is in use, the section is system-skipped (DisabledSection) and therefore not configurable, the narrative/action combination is unsupported (e.g. narrative="reconstruct" or "keep_on_match" with action="retain"), narrative "reconstruct" targets a section without a registered reconstructor, or the section can carry a trigger code and was sent with include=False HTTPException: 404 if configuration isn't found HTTPException: 409 if configuration is not a draft and therefore not editable HTTPException: 500 if section processing can't be updated

Returns: UpdateSectionProcessingResponse: The message to show the user

patch/api/v1/configurations/{configuration_id}/sections

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

configuration_idstring uuid required

Request body

includeboolean nullable
narrative'retain' | 'remove' | 'reconstruct' | 'keep_on_match'
action'retain' | 'refine'
namestring nullable
current_codestring required
new_codestring nullable

Response

Successful Response

section_updated_codestring required
disabled_sectionDisabledSection[] required
narrative_only_sectionNarrativeOnlySection[] required
reconstructable_sectionReconstructableSection[] required
trigger_code_sectionTriggerCodeSection[] required

Changes

  • d26ad846cb1dRevision changes
    • info

      added the required property to the response with the status

  • 0f1ef0edbb36Revision changes
    • warning

      added the new 18776-5 enum value to the / response property for the response status