HWM-related schemas

HWMResponseV1

HWM response.

Parameters:

• id

  (int) –

  HWM id

• namespace_id

  (int) –

  Namespace id HWM is bound to

• name

  (str) –

  HWM name, unique in the namespace

• description

  (str) –

  HWM description

• type

  (str) –

  HWM type, any non-empty string

• value

  (Any) –

  HWM value, any JSON serializable value

• entity

  (str | None, default: None ) –

  Name of entity associated with the HWM. Can be any string

• expression

  (str | None, default: None ) –

  Expression used to calculate HWM value. Can be any string

• changed_at

  (datetime) –

  Timestamp of last change of the HWM data

• changed_by

  (str | None, default: None ) –

  Latest user who changed the HWM data

HWMListResponseV1

Parameters:

• hwms

  (list[HWMResponseV1]) –

  List of HWMs

HWMPaginateQueryV1

Query params for HWM pagination request.

Parameters:

• page

  (int, default: 1 ) –

  Page number

• page_size

  (int, default: 20 ) –

  Number of items per page

• namespace_id

  (int) –

  Namespace id HWM is bound to

• name

  (str | None, default: None ) –

  Search query

HWMCreateRequestV1

Request body for HWM create request.

Parameters:

• namespace_id

  (int) –

  Namespace id HWM is bound to

• name

  (str) –

  HWM name, unique in the namespace

• description

  (str, default: '' ) –

  HWM description

• type

  (str) –

  HWM type, any non-empty string

• value

  (Any) –

  HWM value, any JSON serializable value

• entity

  (str | None, default: None ) –

  Name of entity associated with the HWM. Can be any string

• expression

  (str | None, default: None ) –

  Expression used to calculate HWM value. Can be any string

HWMUpdateRequestV1

Request body for HWM update request.

If field value is not set, it will not be updated.

Parameters:

• name

  (str, default: Unset() ) –

  New HWM name

• description

  (str, default: Unset() ) –

  New HWM description

• type

  (str, default: Unset() ) –

  New HWM type

• value

  (Any, default: Unset() ) –

  New HWM value

• entity

  (str | None, default: Unset() ) –

  New name of entity associated with the HWM. Can be any string

• expression

  (str | None, default: Unset() ) –

  New expression used to calculate HWM value. Can be any string

HWMBulkCopyRequestV1

Schema for request body of HWM copy operation.

Parameters:

• source_namespace_id

  (int) –

  Source namespace ID from which HWMs are copied

• target_namespace_id

  (int) –

  Target namespace ID to which HWMs are copied

• hwm_ids

  (list[int]) –

  List of HWM IDs to be copied

• with_history

  (bool, default: False ) –

  Whether to copy HWM history

HWMBulkDeleteRequestV1

Schema for request body of bulk delete HWM operation.

Parameters:

• namespace_id

  (int) –

  Namespace ID where the HWMs belong

• hwm_ids

  (list[int]) –

  List of HWM IDs to be copied