cdes_update_cdeset

Update a CDE set’s metadata

Functions

async pydelfini.delfini_core.api.cde.cdes_update_cdeset.asyncio(cdeset_name, *, client, body)[source]

Update a CDE set’s metadata

Update the description, display name, state and/or default flag of a CDE set. Fields that are omitted are left unchanged. The set’s data elements are not affected; use the dictionary copy-to-cde operation to add elements. Admin access is required.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[Any]

Return type:

Any

async pydelfini.delfini_core.api.cde.cdes_update_cdeset.asyncio_detailed(cdeset_name, *, client, body)[source]

Update a CDE set’s metadata

Update the description, display name, state and/or default flag of a CDE set. Fields that are omitted are left unchanged. The set’s data elements are not affected; use the dictionary copy-to-cde operation to add elements. Admin access is required.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Union[Any, ServerError]]

Return type:

Response[Any | ServerError]

pydelfini.delfini_core.api.cde.cdes_update_cdeset.sync(cdeset_name, *, client, body)[source]

Update a CDE set’s metadata

Update the description, display name, state and/or default flag of a CDE set. Fields that are omitted are left unchanged. The set’s data elements are not affected; use the dictionary copy-to-cde operation to add elements. Admin access is required.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[Any]

Return type:

Any

pydelfini.delfini_core.api.cde.cdes_update_cdeset.sync_detailed(cdeset_name, *, client, body)[source]

Update a CDE set’s metadata

Update the description, display name, state and/or default flag of a CDE set. Fields that are omitted are left unchanged. The set’s data elements are not affected; use the dictionary copy-to-cde operation to add elements. Admin access is required.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Union[Any, ServerError]]

Return type:

Response[Any | ServerError]