configurations

Set Codes Status

Changed on

Sets selected codes to the specified status for the given configuration ID.

If update_beyond_rendered_set is false, we update status for only the specified code_ids within the rendered page.

If update_beyond_rendered_set is true, we skip any codes within code_ids_to_skip and update status for all other codes that don't get clipped away by the passed-in filters

Args: configuration_id (UUID): ID of the configuration to update update_beyond_rendered_set (bool): Whether the action should be only within the rendered codes or include all codes. code_ids (list[UUID]): List of code IDs to specifically action. Used in the "within cursor" flow. code_ids_to_skip (list[UUID]): List of code IDs to skip since they've been manually actioned by the user. filters (FilterInput): Filter input coming from the client to build the "complete" set of codes to bulk select status (Literal['included', 'excluded'): Set codes as 'included' or 'excluded' user (DbUser): The logged-in user db (AsyncDatabaseConnection): Database connection

Raises: HTTPException: 404 if configuration can't be found

Returns: list[UUID]: Code IDs that had their status changed

post/api/v1/configurations/{configuration_id}/set-status

Request

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

Path parameters

configuration_idstring uuid required

Query parameters

update_beyond_rendered_setboolean required
status'included' | 'excluded' required
searchstring nullable
code_systemsstring[]
sourcesstring[]
statusesstring[]

Request body

code_ids_to_skipstring[] required
code_idsstring[] required

Response

Successful Response

string[] required

Changes

    • breaking

      added the new required query request parameter update_beyond_rendered_set

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from array to object

    • info

      added the new optional query request parameter code_systems

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter sources

    • info

      added the new optional query request parameter statuses

    • info

      endpoint added