LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update PowerShell SDK docs: 15141274669

Browse Source
This commit is contained in:
developer-relations-sp
2025-05-20 15:12:17 +00:00
parent c4f4d72fc8
commit 8df9b19e41
308 changed files with 6591 additions and 5586 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchApi.md
View File

@@ -40,10 +40,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Search-V2024Aggregate**](#search-aggregate) | **POST** `/search/aggregate` | Perform a Search Query Aggregation
[**Search-V2024Count**](#search-count) | **POST** `/search/count` | Count Documents Satisfying a Query
[**Search-V2024Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a Document by ID
[**Search-V2024Post**](#search-post) | **POST** `/search` | Perform Search
[**Search-V2024Aggregate**](#search-aggregate) | **POST** `/search/aggregate` | Perform a search query aggregation
[**Search-V2024Count**](#search-count) | **POST** `/search/count` | Count documents satisfying a query
[**Search-V2024Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a document by id
[**Search-V2024Post**](#search-post) | **POST** `/search` | Perform search
## search-aggregate
@@ -199,7 +199,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Perform a Search Query Aggregation
# Perform a search query aggregation
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
@@ -361,7 +361,7 @@ $Search = @"{
}
}"@
# Count Documents Satisfying a Query
# Count documents satisfying a query
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
@@ -410,7 +410,7 @@ Code | Description | Data Type
$Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*.
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
# Get a Document by ID
# Get a document by id
try {
Search-V2024Get -Index $Index -Id $Id
@@ -577,7 +577,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Perform Search
# Perform search
try {
$Result = ConvertFrom-JsonToSearch -Json $Search