Skip to content

Latest commit

 

History

History
225 lines (173 loc) · 7.95 KB

CustomIndexApi.md

File metadata and controls

225 lines (173 loc) · 7.95 KB

CustomIndexApi

All URIs are relative to http://localhost

Method HTTP request Description
deleteIndex DELETE /indices/{indexType}/{indexKey}
indexFolderMove POST /indices/{indexType}/move
indexSearch POST /indices/search

deleteIndex

DeleteIndicesResponse deleteIndex(indexKey, indexType, siteId)

Perform a delete on the Folder Index. When deleting a file from the "folder" index, you can set the indexKey to a URLEncoded path variable.

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.CustomIndexApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    CustomIndexApi apiInstance = new CustomIndexApi(defaultClient);
    String indexKey = "indexKey_example"; // String | Index Key Identifier
    String indexType = "indexType_example"; // String | Index Type
    String siteId = "siteId_example"; // String | Site Identifier
    try {
      DeleteIndicesResponse result = apiInstance.deleteIndex(indexKey, indexType, siteId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CustomIndexApi#deleteIndex");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
indexKey String Index Key Identifier
indexType String Index Type
siteId String Site Identifier [optional]

Return type

DeleteIndicesResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -
400 400 OK -

indexFolderMove

IndexFolderMoveResponse indexFolderMove(indexType, indexFolderMoveRequest, siteId)

Perform an Folder Index Move

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.CustomIndexApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    CustomIndexApi apiInstance = new CustomIndexApi(defaultClient);
    String indexType = "indexType_example"; // String | Index Type
    IndexFolderMoveRequest indexFolderMoveRequest = new IndexFolderMoveRequest(); // IndexFolderMoveRequest | 
    String siteId = "siteId_example"; // String | Site Identifier
    try {
      IndexFolderMoveResponse result = apiInstance.indexFolderMove(indexType, indexFolderMoveRequest, siteId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CustomIndexApi#indexFolderMove");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
indexType String Index Type
indexFolderMoveRequest IndexFolderMoveRequest
siteId String Site Identifier [optional]

Return type

IndexFolderMoveResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -
400 400 OK -

indexSearch

IndexSearchResponse indexSearch(indexSearchRequest, siteId, limit, next, previous)

Perform a search on a index; this is currently available for both folder and tag indices

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.CustomIndexApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    CustomIndexApi apiInstance = new CustomIndexApi(defaultClient);
    IndexSearchRequest indexSearchRequest = new IndexSearchRequest(); // IndexSearchRequest | 
    String siteId = "siteId_example"; // String | Site Identifier
    String limit = "10"; // String | Limit Results
    String next = "next_example"; // String | Next page of results token
    String previous = "previous_example"; // String | Previous page of results token
    try {
      IndexSearchResponse result = apiInstance.indexSearch(indexSearchRequest, siteId, limit, next, previous);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CustomIndexApi#indexSearch");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
indexSearchRequest IndexSearchRequest
siteId String Site Identifier [optional]
limit String Limit Results [optional] [default to 10]
next String Next page of results token [optional]
previous String Previous page of results token [optional]

Return type

IndexSearchResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -
400 400 OK -