mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-06 20:37:46 +00:00
1.9 KiB
1.9 KiB
id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags
| id | title | pagination_label | sidebar_label | sidebar_class_name | keywords | slug | tags | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| v2024-query | Query | Query | Query | powershellsdk |
|
/tools/sdk/powershell/v2024/models/query |
|
Query
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| Query | String | The query using the Elasticsearch Query String Query syntax from the Query DSL extended by SailPoint to support Nested queries. | [optional] |
| Fields | String | The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of ""a*"" to be applied to ""name"", ""firstName"", and the ""source.name"". The response will include all results matching the ""a*"" query found in those three fields. A field's availability depends on the indices being searched. For example, if you are searching ""identities"", you can apply your search to the ""firstName"" field, but you couldn't use ""firstName"" with a search on ""access profiles"". Refer to the response schema for the respective lists of available fields. | [optional] |
| TimeZone | String | The time zone to be applied to any range query related to dates. | [optional] |
| InnerHit | InnerHit | [optional] |
Examples
- Prepare the resource
$Query = Initialize-V2024Query -Query name:a* `
-Fields [firstName,lastName,email] `
-TimeZone America/Chicago `
-InnerHit null
- Convert the resource to JSON
$Query | ConvertTo-JSON