All URIs are relative to http://localhost:7072/api
| Method | HTTP request | Description |
|---|---|---|
| HttpGetSearchFacetteByName | GET /search/facette | |
| HttpGlobalSearch | GET /search | |
| HttpSearchAdminGetStatus | GET /searchadmin/status |
SearchFacet HttpGetSearchFacetteByName (string name, string s, string collectiontypeid = null, string collectionid = null, string mode = null, string filter = null, string scopefilter = null, string ids = null, string portalId = null)
This endpoint returns one facette based on the search parameters.
using System.Collections.Generic;
using System.Diagnostics;
using Agravity.Public.Api;
using Agravity.Public.Client;
using Agravity.Public.Model;
namespace Example
{
public class HttpGetSearchFacetteByNameExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "http://localhost:7072/api";
// Configure API key authorization: function_key
config.AddApiKey("x-functions-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-functions-key", "Bearer");
var apiInstance = new PublicSearchManagementApi(config);
var name = "name_example"; // string | The name of the facette.
var s = "s_example"; // string | The search string which should be found.
var collectiontypeid = "collectiontypeid_example"; // string | Limits the result on all collections from the given collectiontypeid parameter. (optional)
var collectionid = "collectionid_example"; // string | Limits the result on collection id (and siblings). Will be overwritten by collectiontypeid parameter. (optional)
var mode = "mode_example"; // string | Two modes supported: \"any\" or \"all\" search terms should be applied. (Only if Azure Search is enabled) (optional)
var filter = "filter_example"; // string | Key value filter for filterable strings and string collections separated by special ',,,'. For date or numbers \"<\", \"=\" and \">\" are possible. Mode influences AND (all) and OR (any) of all filters. Multiple filters are separated by semicolons. (Only if Azure Search is enabled) (optional)
var scopefilter = "scopefilter_example"; // string | Colon separated key value filter for additional scopes. It applies the same conventions as for filter parameter. (optional)
var ids = "ids_example"; // string | Comma separated values list with all ids which should be returned. (optional)
var portalId = "portalId_example"; // string | If the search should be redirected to a specific portal. (optional)
try
{
SearchFacet result = apiInstance.HttpGetSearchFacetteByName(name, s, collectiontypeid, collectionid, mode, filter, scopefilter, ids, portalId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PublicSearchManagementApi.HttpGetSearchFacetteByName: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
ApiResponse<SearchFacet> response = apiInstance.HttpGetSearchFacetteByNameWithHttpInfo(name, s, collectiontypeid, collectionid, mode, filter, scopefilter, ids, portalId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PublicSearchManagementApi.HttpGetSearchFacetteByNameWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|---|---|---|
| name | string | The name of the facette. | |
| s | string | The search string which should be found. | |
| collectiontypeid | string | Limits the result on all collections from the given collectiontypeid parameter. | [optional] |
| collectionid | string | Limits the result on collection id (and siblings). Will be overwritten by collectiontypeid parameter. | [optional] |
| mode | string | Two modes supported: "any" or "all" search terms should be applied. (Only if Azure Search is enabled) | [optional] |
| filter | string | Key value filter for filterable strings and string collections separated by special ',,,'. For date or numbers "<", "=" and ">" are possible. Mode influences AND (all) and OR (any) of all filters. Multiple filters are separated by semicolons. (Only if Azure Search is enabled) | [optional] |
| scopefilter | string | Colon separated key value filter for additional scopes. It applies the same conventions as for filter parameter. | [optional] |
| ids | string | Comma separated values list with all ids which should be returned. | [optional] |
| portalId | string | If the search should be redirected to a specific portal. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns the search result | - |
| 400 | A required parameter is null. (Code: 870f62fe-827a-4ef3-98e7-7f309244ee00)<br>or provide at least parameter "s=" with search string (url encoded) (Code: 180db53c-9789-4588-ac4b-23d0c1eb1c06)<br>or limit is not a valid number! Can use 0 for defined limit. (Code: 7115dc96-99e3-47a4-827a-8cc63cc1ab68<br>or skip is not a valid number! Can use 0 for defined skip. (Code: ad8237e0-236c-4404-8eaa-d81a9fa4e41c<br>Parameter "portal_id=" is not valid.(Code: 2ef46a2f-07a5-4ee3-acef-5b421c3f493a)<br>Parameter "portal_id=" is not found in system. (Code: d0ed0426-9c08-4490-b43c-660093f63db9)<br>Azure Search is not enabled! (Code: ddeb49b9-9574-4682-a7bd-b2946033983f)<br>or parameter "collectiontypeid=" is not valid (not in correct format or not found in system). (Code: 330e6abb-e77e-4193-9aa0-9dfce168c674)<br>or parameter "collectionid=" is not valid (not in correct format or not found in system). (Code: c20f1dfb-0d19-419e-96eb-f5dee44576fe) | - |
| 401 | Unauthorized. API Key not provided. | - |
| 500 | Internal server error. Please contact administrator. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SearchResult HttpGlobalSearch (string s, int? limit = null, int? skip = null, string collectiontypeid = null, string collectionid = null, string mode = null, bool? expose = null, string filter = null, string scopefilter = null, string orderby = null, string ids = null, string portalId = null, bool? translations = null, string acceptLanguage = null)
This endpoint returns a configured max amount of results for search terms.
using System.Collections.Generic;
using System.Diagnostics;
using Agravity.Public.Api;
using Agravity.Public.Client;
using Agravity.Public.Model;
namespace Example
{
public class HttpGlobalSearchExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "http://localhost:7072/api";
// Configure API key authorization: function_key
config.AddApiKey("x-functions-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-functions-key", "Bearer");
var apiInstance = new PublicSearchManagementApi(config);
var s = "s_example"; // string | The search string which should be found.
var limit = 56; // int? | How many results should be returend. 0 is backend configuration limit. (optional)
var skip = 56; // int? | (default: 0) - Used for paging - how many items should be skipped before next limit results will be fetched. (optional)
var collectiontypeid = "collectiontypeid_example"; // string | Limits the result on all collections from the given collectiontypeid parameter. (optional)
var collectionid = "collectionid_example"; // string | Limits the result on collection id (and siblings). Will be overwritten by collectiontypeid parameter. (optional)
var mode = "mode_example"; // string | Two modes supported: \"any\" or \"all\" search terms should be applied. (Only if Azure Search is enabled) (optional)
var expose = true; // bool? | This will expose the thumbnail asset blob incl. URL with SAS Token. (optional)
var filter = "filter_example"; // string | Colon separated key value filter for filterable strings and string collections. For date or numbers \"<\", \"=\" and \">\" are possible. Mode influences AND (all) and OR (any) of all filters. Multiple filters are separated by semicolons. (Only if Azure Search is enabled) (optional)
var scopefilter = "scopefilter_example"; // string | Colon separated key value filter for additional scopes. It applies the same conventions as for filter parameter. (optional)
var orderby = "orderby_example"; // string | Sortable fields can be used. For descendant sorting use leading \"!\". (Only if Azure Search is enabled) (optional)
var ids = "ids_example"; // string | Comma separated values list with all ids which should be returned. (optional)
var portalId = "portalId_example"; // string | If the search should be redirected to a specific portal. (optional)
var translations = true; // bool? | When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header) (optional)
var acceptLanguage = "acceptLanguage_example"; // string | The requested language of the response. If not matching it falls back to default language. (optional)
try
{
SearchResult result = apiInstance.HttpGlobalSearch(s, limit, skip, collectiontypeid, collectionid, mode, expose, filter, scopefilter, orderby, ids, portalId, translations, acceptLanguage);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PublicSearchManagementApi.HttpGlobalSearch: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
ApiResponse<SearchResult> response = apiInstance.HttpGlobalSearchWithHttpInfo(s, limit, skip, collectiontypeid, collectionid, mode, expose, filter, scopefilter, orderby, ids, portalId, translations, acceptLanguage);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PublicSearchManagementApi.HttpGlobalSearchWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|---|---|---|
| s | string | The search string which should be found. | |
| limit | int? | How many results should be returend. 0 is backend configuration limit. | [optional] |
| skip | int? | (default: 0) - Used for paging - how many items should be skipped before next limit results will be fetched. | [optional] |
| collectiontypeid | string | Limits the result on all collections from the given collectiontypeid parameter. | [optional] |
| collectionid | string | Limits the result on collection id (and siblings). Will be overwritten by collectiontypeid parameter. | [optional] |
| mode | string | Two modes supported: "any" or "all" search terms should be applied. (Only if Azure Search is enabled) | [optional] |
| expose | bool? | This will expose the thumbnail asset blob incl. URL with SAS Token. | [optional] |
| filter | string | Colon separated key value filter for filterable strings and string collections. For date or numbers "<", "=" and ">" are possible. Mode influences AND (all) and OR (any) of all filters. Multiple filters are separated by semicolons. (Only if Azure Search is enabled) | [optional] |
| scopefilter | string | Colon separated key value filter for additional scopes. It applies the same conventions as for filter parameter. | [optional] |
| orderby | string | Sortable fields can be used. For descendant sorting use leading "!". (Only if Azure Search is enabled) | [optional] |
| ids | string | Comma separated values list with all ids which should be returned. | [optional] |
| portalId | string | If the search should be redirected to a specific portal. | [optional] |
| translations | bool? | When default language should be returned and the translation dictionary is delivered. (Ignores the "Accept-Language" header) | [optional] |
| acceptLanguage | string | The requested language of the response. If not matching it falls back to default language. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns the search result | - |
| 400 | A required parameter is null. (Code: 870f62fe-827a-4ef3-98e7-7f309244ee00)<br>or provide at least parameter "s=" with search string (url encoded) (Code: de39bfb1-42e3-4edf-9651-5c4952524e69)<br>or limit is not a valid number! Can use 0 for defined limit. (Code: 7115dc96-99e3-47a4-827a-8cc63cc1ab68 or skip is not a valid number! Can use 0 for defined skip. (Code: ad8237e0-236c-4404-8eaa-d81a9fa4e41c or parameter "collectiontypeid=" is not valid (not in correct format or not found in system). (Code: 330e6abb-e77e-4193-9aa0-9dfce168c674)<br>or parameter "collectionid=" is not valid (not in correct format or not found in system). (Code: c20f1dfb-0d19-419e-96eb-f5dee44576fe) | - |
| 401 | Unauthorized. API Key not provided. | - |
| 500 | Internal server error. Please contact administrator. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SearchAdminStatus HttpSearchAdminGetStatus (string portalId = null)
This endpoint gives the status about the index and indexer.
using System.Collections.Generic;
using System.Diagnostics;
using Agravity.Public.Api;
using Agravity.Public.Client;
using Agravity.Public.Model;
namespace Example
{
public class HttpSearchAdminGetStatusExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "http://localhost:7072/api";
// Configure API key authorization: function_key
config.AddApiKey("x-functions-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-functions-key", "Bearer");
var apiInstance = new PublicSearchManagementApi(config);
var portalId = "portalId_example"; // string | If the search should be redirected to a specific portal. (optional)
try
{
SearchAdminStatus result = apiInstance.HttpSearchAdminGetStatus(portalId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PublicSearchManagementApi.HttpSearchAdminGetStatus: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
ApiResponse<SearchAdminStatus> response = apiInstance.HttpSearchAdminGetStatusWithHttpInfo(portalId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PublicSearchManagementApi.HttpSearchAdminGetStatusWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|---|---|---|
| portalId | string | If the search should be redirected to a specific portal. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | This gives status about the search. | - |
| 401 | Unauthorized. API Key not provided. | - |
| 500 | Internal server error. Please contact administrator. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]