thousandeyes-sdk-python/thousandeyes-sdk-tests/docs/BaseRequest.md
Jack Browne 92b9a0126c
CP-2126 Refactor HTTP client into shared package (#5)
* CP-2126 Refactor HTTP client into shared package

* CP-2126 Regenerate Python SDK
2024-05-23 11:57:23 +01:00

32 lines
1.5 KiB
Markdown

# BaseRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**labels** | **List[str]** | Contains list of test label IDs (get `labelId` from `/labels` endpoint) | [optional]
**shared_with_accounts** | **List[str]** | Contains list of account group IDs. Test is shared with the listed account groups (get `aid` from `/account-groups` endpoint) | [optional]
**alert_rules** | **List[str]** | List of alert rules IDs to apply to the test (get `ruleId` from `/alerts/rules` endpoint. If `alertsEnabled` is set to `true` and `alertRules` is not included on test creation or update, applicable user default alert rules will be used) | [optional]
## Example
```python
from thousandeyes_sdk.tests.models.base_request import BaseRequest
# TODO update the JSON string below
json = "{}"
# create an instance of BaseRequest from a JSON string
base_request_instance = BaseRequest.from_json(json)
# print the JSON string representation of the object
print(BaseRequest.to_json())
# convert the object into a dict
base_request_dict = base_request_instance.to_dict()
# create an instance of BaseRequest from a dict
base_request_from_dict = BaseRequest.from_dict(base_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)