Skip to content

Update specs and clients for 4.4.0 #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ViacheslavKlimov merged 1 commit into from
Oct 13, 2026
Merged

Update specs and clients for 4.4.0 #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
10 changes: 6 additions & 4 deletions ce/docs/AlarmCountQuery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ A JSON value representing the alarm count query.
|------------ | ------------- | ------------- | -------------|
| **entity_filter** | [**EntityFilter**](EntityFilter.md) | | [optional] |
| **key_filters** | [**List[KeyFilter]**](KeyFilter.md) | | [optional] |
| **key_filters_operation** | [**AlarmRuleComplexOperation**](AlarmRuleComplexOperation.md) | | [optional] |
| **start_ts** | **int** | | [optional] |
| **end_ts** | **int** | | [optional] |
| **time_window** | **int** | | [optional] |
Expand All @@ -19,6 +20,7 @@ A JSON value representing the alarm count query.
| **severity_list** | [**List[AlarmSeverity]**](AlarmSeverity.md) | | [optional] |
| **search_propagated_alarms** | **bool** | | [optional] |
| **assignee_id** | [**UserId**](UserId.md) | | [optional] |
| **key_filters_operation_or_default** | [**AlarmRuleComplexOperation**](AlarmRuleComplexOperation.md) | | [optional] |



Expand Down Expand Up @@ -156,6 +158,9 @@ A JSON value representing the alarm count query.
| value_type | EntityKeyValueType | | [optional] |
| predicate | KeyFilterPredicate | | [optional] |

#### AlarmRuleComplexOperation (enum)
`AND` | `OR`

#### AlarmSearchStatus (enum)
`ANY` | `ACTIVE` | `CLEARED` | `ACK` | `UNACK`

Expand Down Expand Up @@ -185,7 +190,7 @@ A JSON value representing the alarm count query.
#### ComplexFilterPredicate *(extends KeyFilterPredicate, type=`COMPLEX`)*
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| operation | ComplexOperation | | [optional] |
| operation | AlarmRuleComplexOperation | | [optional] |
| predicates | List[KeyFilterPredicate] | | [optional] |

#### NumericFilterPredicate *(extends KeyFilterPredicate, type=`NUMERIC`)*
Expand Down Expand Up @@ -257,9 +262,6 @@ A JSON value representing the alarm count query.
| user_value | bool | | [optional] |
| dynamic_value | DynamicValueBoolean | | [optional] |

#### ComplexOperation (enum)
`AND` | `OR`

#### DynamicValueString
| Name | Type | Description | Notes |
|------|------|-------------|-------|
Expand Down
10 changes: 6 additions & 4 deletions ce/docs/AlarmDataQuery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ A JSON value representing the alarm data query. See API call notes above for mor
|------------ | ------------- | ------------- | -------------|
| **entity_filter** | [**EntityFilter**](EntityFilter.md) | | [optional] |
| **key_filters** | [**List[KeyFilter]**](KeyFilter.md) | | [optional] |
| **key_filters_operation** | [**AlarmRuleComplexOperation**](AlarmRuleComplexOperation.md) | | [optional] |
| **page_link** | [**AlarmDataPageLink**](AlarmDataPageLink.md) | | [optional] |
| **entity_fields** | [**List[EntityKey]**](EntityKey.md) | | [optional] |
| **latest_values** | [**List[EntityKey]**](EntityKey.md) | | [optional] |
| **alarm_fields** | [**List[EntityKey]**](EntityKey.md) | | [optional] |
| **key_filters_operation_or_default** | [**AlarmRuleComplexOperation**](AlarmRuleComplexOperation.md) | | [optional] |



Expand Down Expand Up @@ -152,6 +154,9 @@ A JSON value representing the alarm data query. See API call notes above for mor
| value_type | EntityKeyValueType | | [optional] |
| predicate | KeyFilterPredicate | | [optional] |

#### AlarmRuleComplexOperation (enum)
`AND` | `OR`

#### AlarmDataPageLink
| Name | Type | Description | Notes |
|------|------|-------------|-------|
Expand Down Expand Up @@ -192,7 +197,7 @@ A JSON value representing the alarm data query. See API call notes above for mor
#### ComplexFilterPredicate *(extends KeyFilterPredicate, type=`COMPLEX`)*
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| operation | ComplexOperation | | [optional] |
| operation | AlarmRuleComplexOperation | | [optional] |
| predicates | List[KeyFilterPredicate] | | [optional] |

#### NumericFilterPredicate *(extends KeyFilterPredicate, type=`NUMERIC`)*
Expand Down Expand Up @@ -279,9 +284,6 @@ A JSON value representing the alarm data query. See API call notes above for mor
| user_value | bool | | [optional] |
| dynamic_value | DynamicValueBoolean | | [optional] |

#### ComplexOperation (enum)
`AND` | `OR`

#### DynamicValueString
| Name | Type | Description | Notes |
|------|------|-------------|-------|
Expand Down
8 changes: 4 additions & 4 deletions ce/docs/AssetControllerApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ PageDataAsset client.get_edge_assets(edge_id: str, page_size: int, page: int, ty
Asset client.get_tenant_asset_by_name(asset_name: str) # Get Tenant Asset (getTenantAssetByName)
PageDataAssetInfo client.get_tenant_asset_infos(page_size: int, page: int, type: Optional[str] = None, asset_profile_id: Optional[str] = None, text_search: Optional[str] = None, sort_property: Optional[str] = None, sort_order: Optional[str] = None) # Get Tenant Asset Infos (getTenantAssetInfos)
PageDataAsset client.get_tenant_assets(page_size: int, page: int, type: Optional[str] = None, text_search: Optional[str] = None, sort_property: Optional[str] = None, sort_order: Optional[str] = None) # Get Tenant Assets (getTenantAssets)
BulkImportResultAsset client.process_assets_bulk_import(bulk_import_request: BulkImportRequest) # Import the bulk of assets (processAssetsBulkImport)
BulkImportResultAsset client.process_asset_bulk_import(bulk_import_request: BulkImportRequest) # Import the bulk of assets (processAssetBulkImport)
Asset client.save_asset(asset: Asset, name_conflict_policy: Optional[NameConflictPolicy] = None, uniquify_separator: Optional[str] = None, uniquify_strategy: Optional[UniquifyStrategy] = None) # Create Or Update Asset (saveAsset)
Asset client.unassign_asset_from_customer(asset_id: str) # Unassign asset from customer (unassignAssetFromCustomer)
Asset client.unassign_asset_from_edge(edge_id: str, asset_id: str) # Unassign asset from edge (unassignAssetFromEdge)
Expand Down Expand Up @@ -412,15 +412,15 @@ Returns a page of assets owned by tenant. You can specify parameters to filter t
**PageDataAsset**


## process_assets_bulk_import
## process_asset_bulk_import

```python
BulkImportResultAsset client.process_assets_bulk_import(bulk_import_request: BulkImportRequest)
BulkImportResultAsset client.process_asset_bulk_import(bulk_import_request: BulkImportRequest)
```

**POST** `/api/asset/bulk_import`

Import the bulk of assets (processAssetsBulkImport)
Import the bulk of assets (processAssetBulkImport)

There's an ability to import the bulk of assets using the only .csv file.

Expand Down
4 changes: 2 additions & 2 deletions ce/docs/AvailableEntityKeys.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Contains unique time series and attribute key names discovered from entities mat
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **entity_types** | [**List[EntityType]**](EntityType.md) | Set of entity types found among the matched entities. | |
| **timeseries** | **List[str]** | | |
| **attribute** | **List[str]** | | |
| **timeseries** | **List[str]** | List of unique time series key names available on the matched entities. | |
| **attribute** | **List[str]** | List of unique attribute key names available on the matched entities. | |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/AvailableEntityKeysV2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Contains unique time series and attribute key names discovered from entities mat
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **entity_types** | [**List[EntityType]**](EntityType.md) | Set of entity types found among the matched entities. | |
| **timeseries** | [**List[KeyInfo]**](KeyInfo.md) | | [optional] |
| **timeseries** | [**List[KeyInfo]**](KeyInfo.md) | List of unique time series keys available on the matched entities, sorted alphabetically. Omitted when timeseries keys were not requested. | [optional] |
| **attributes** | **Dict[str, List[KeyInfo]]** | Map of attribute scope to the list of unique attribute keys available on the matched entities. Only scopes supported by the matched entity types are included. Omitted when attribute keys were not requested or when none of the requested scopes apply to the matched entity types. | [optional] |


Expand Down
4 changes: 2 additions & 2 deletions ce/docs/ComplexFilterPredicate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **operation** | [**ComplexOperation**](ComplexOperation.md) | | [optional] |
| **operation** | [**AlarmRuleComplexOperation**](AlarmRuleComplexOperation.md) | | [optional] |
| **predicates** | [**List[KeyFilterPredicate]**](KeyFilterPredicate.md) | | [optional] |


Expand All @@ -21,7 +21,7 @@
|------|------|-------------|-------|
| type | str | | |

#### ComplexOperation (enum)
#### AlarmRuleComplexOperation (enum)
`AND` | `OR`

---
Expand Down
24 changes: 0 additions & 24 deletions ce/docs/ComplexOperation.md
View file
Open in desktop

This file was deleted.

Loading
Loading