mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 04:19:37 +00:00
starting point for adding python sdk docs
This commit is contained in:
@@ -0,0 +1,57 @@
|
||||
---
|
||||
id: v2024-search-schedule
|
||||
title: SearchSchedule
|
||||
pagination_label: SearchSchedule
|
||||
sidebar_label: SearchSchedule
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'SearchSchedule', 'V2024SearchSchedule']
|
||||
slug: /tools/sdk/python/v2024/models/search-schedule
|
||||
tags: ['SDK', 'Software Development Kit', 'SearchSchedule', 'V2024SearchSchedule']
|
||||
---
|
||||
|
||||
# SearchSchedule
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**saved_search_id** | **str** | The ID of the saved search that will be executed. | [required]
|
||||
**created** | **datetime** | The date the scheduled search was initially created. | [optional] [readonly]
|
||||
**modified** | **datetime** | The last date the scheduled search was modified. | [optional] [readonly]
|
||||
**schedule** | [**Schedule2**](schedule2) | | [required]
|
||||
**recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | [required]
|
||||
**enabled** | **bool** | Indicates if the scheduled search is enabled. | [optional] [default to False]
|
||||
**email_empty_results** | **bool** | Indicates if email generation should occur when search returns no results. | [optional] [default to False]
|
||||
**display_query_details** | **bool** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to False]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.search_schedule import SearchSchedule
|
||||
|
||||
search_schedule = SearchSchedule(
|
||||
saved_search_id='554f1511-f0a1-4744-ab14-599514d3e57c',
|
||||
created='2018-06-25T20:22:28.104Z',
|
||||
modified='2018-06-25T20:22:28.104Z',
|
||||
schedule=sailpoint.v2024.models.schedule_2.Schedule_2(
|
||||
type = 'WEEKLY',
|
||||
months = null,
|
||||
days = null,
|
||||
hours = null,
|
||||
expiration = '2018-06-25T20:22:28.104Z',
|
||||
time_zone_id = 'America/Chicago', ),
|
||||
recipients=[
|
||||
sailpoint.v2024.models.search_schedule_recipients_inner.SearchSchedule_recipients_inner(
|
||||
type = 'IDENTITY',
|
||||
id = '2c9180867624cbd7017642d8c8c81f67', )
|
||||
],
|
||||
enabled=False,
|
||||
email_empty_results=False,
|
||||
display_query_details=False
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
Reference in New Issue
Block a user