SchemaApi

All URIs are relative to https://api.search.io

Method	HTTP request	Description
batchCreateSchemaFields	POST /v4/collections/{collection_id}/schemaFields:batchCreate	Batch create schema fields
createSchemaField	POST /v4/collections/{collection_id}/schemaFields	Create schema field
deleteSchemaField	DELETE /v4/collections/{collection_id}/schemaFields/{schema_field_name}	Delete schema field
listSchemaFields	GET /v4/collections/{collection_id}/schemaFields	List schema fields
updateSchemaField	PATCH /v4/collections/{collection_id}/schemaFields/{schema_field_name}	Update schema field

batchCreateSchemaFields

BatchCreateSchemaFieldsResponse batchCreateSchemaFields(collectionId, batchCreateSchemaFieldsRequest)

Batch create schema fields

The batch version of the CreateSchemaField call.

Example

// Import classes:
import com.sajari.client.ApiClient;
import com.sajari.client.ApiException;
import com.sajari.client.Configuration;
import com.sajari.client.auth.*;
import com.sajari.client.models.*;
import com.sajari.client.api.SchemaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.search.io");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    SchemaApi apiInstance = new SchemaApi(defaultClient);
    String collectionId = "collectionId_example"; // String | The collection to create the schema fields in, e.g. `my-collection`.
    BatchCreateSchemaFieldsRequest batchCreateSchemaFieldsRequest = new BatchCreateSchemaFieldsRequest(); // BatchCreateSchemaFieldsRequest | 
    try {
      BatchCreateSchemaFieldsResponse result = apiInstance.batchCreateSchemaFields(collectionId, batchCreateSchemaFieldsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SchemaApi#batchCreateSchemaFields");
      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
collectionId	String	The collection to create the schema fields in, e.g. `my-collection`.
batchCreateSchemaFieldsRequest	BatchCreateSchemaFieldsRequest

Return type

BatchCreateSchemaFieldsResponse

Authorization

BasicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
401	Returned when the request does not have valid authentication credentials.	-
403	Returned when the user does not have permission to access the resource.	-
404	Returned when the resource does not exist.	-
500	Returned when the API encounters an internal error.	-
0	An unexpected error response.	-

createSchemaField

SchemaField createSchemaField(collectionId, schemaField)

Create schema field

Create a new field in a collection's schema.

Example

// Import classes:
import com.sajari.client.ApiClient;
import com.sajari.client.ApiException;
import com.sajari.client.Configuration;
import com.sajari.client.auth.*;
import com.sajari.client.models.*;
import com.sajari.client.api.SchemaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.search.io");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    SchemaApi apiInstance = new SchemaApi(defaultClient);
    String collectionId = "collectionId_example"; // String | The collection to create a schema field in, e.g. `my-collection`.
    SchemaField schemaField = new SchemaField(); // SchemaField | The schema field to create.
    try {
      SchemaField result = apiInstance.createSchemaField(collectionId, schemaField);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SchemaApi#createSchemaField");
      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
collectionId	String	The collection to create a schema field in, e.g. `my-collection`.
schemaField	SchemaField	The schema field to create.

Return type

SchemaField

Authorization

BasicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
401	Returned when the request does not have valid authentication credentials.	-
403	Returned when the user does not have permission to access the resource.	-
404	Returned when the resource does not exist.	-
500	Returned when the API encounters an internal error.	-
0	An unexpected error response.	-

deleteSchemaField

Object deleteSchemaField(collectionId, schemaFieldName)

Delete schema field

Deleting a schema field removes it from all records within the collection, however, references to the schema field in pipelines are not removed. > Note: This operation cannot be reversed.

Example

// Import classes:
import com.sajari.client.ApiClient;
import com.sajari.client.ApiException;
import com.sajari.client.Configuration;
import com.sajari.client.auth.*;
import com.sajari.client.models.*;
import com.sajari.client.api.SchemaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.search.io");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    SchemaApi apiInstance = new SchemaApi(defaultClient);
    String collectionId = "collectionId_example"; // String | The collection the schema field belongs to, e.g. `my-collection`.
    String schemaFieldName = "schemaFieldName_example"; // String | The name of the schema field to delete.
    try {
      Object result = apiInstance.deleteSchemaField(collectionId, schemaFieldName);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SchemaApi#deleteSchemaField");
      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
collectionId	String	The collection the schema field belongs to, e.g. `my-collection`.
schemaFieldName	String	The name of the schema field to delete.

Return type

Object

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
401	Returned when the request does not have valid authentication credentials.	-
403	Returned when the user does not have permission to access the resource.	-
404	Returned when the resource does not exist.	-
500	Returned when the API encounters an internal error.	-
0	An unexpected error response.	-

listSchemaFields

ListSchemaFieldsResponse listSchemaFields(collectionId, pageSize, pageToken)

List schema fields

Retrieve a list of schema fields in a collection.

Example

// Import classes:
import com.sajari.client.ApiClient;
import com.sajari.client.ApiException;
import com.sajari.client.Configuration;
import com.sajari.client.auth.*;
import com.sajari.client.models.*;
import com.sajari.client.api.SchemaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.search.io");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    SchemaApi apiInstance = new SchemaApi(defaultClient);
    String collectionId = "collectionId_example"; // String | The collection that owns this set of schema fields, e.g. `my-collection`.
    Integer pageSize = 56; // Integer | The maximum number of schema fields to return. The service may return fewer than this value.  If unspecified, at most 50 schema fields are returned.  The maximum value is 1000; values above 1000 are coerced to 1000.
    String pageToken = "pageToken_example"; // String | A page token, received from a previous [ListSchemaFields](/docs/api#operation/ListSchemaFields) call.  Provide this to retrieve the subsequent page.  When paginating, all other parameters provided to [ListSchemaFields](/docs/api#operation/ListSchemaFields) must match the call that provided the page token.
    try {
      ListSchemaFieldsResponse result = apiInstance.listSchemaFields(collectionId, pageSize, pageToken);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SchemaApi#listSchemaFields");
      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
collectionId	String	The collection that owns this set of schema fields, e.g. `my-collection`.
pageSize	Integer	The maximum number of schema fields to return. The service may return fewer than this value. If unspecified, at most 50 schema fields are returned. The maximum value is 1000; values above 1000 are coerced to 1000.	[optional]
pageToken	String	A page token, received from a previous ListSchemaFields call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSchemaFields must match the call that provided the page token.	[optional]

Return type

ListSchemaFieldsResponse

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
401	Returned when the request does not have valid authentication credentials.	-
403	Returned when the user does not have permission to access the resource.	-
404	Returned when the resource does not exist.	-
500	Returned when the API encounters an internal error.	-
0	An unexpected error response.	-

updateSchemaField

SchemaField updateSchemaField(collectionId, schemaFieldName, schemaField, updateMask)

Update schema field

Update the details of a schema field. Only `name` and `description` can be updated.

Example

// Import classes:
import com.sajari.client.ApiClient;
import com.sajari.client.ApiException;
import com.sajari.client.Configuration;
import com.sajari.client.auth.*;
import com.sajari.client.models.*;
import com.sajari.client.api.SchemaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.search.io");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    SchemaApi apiInstance = new SchemaApi(defaultClient);
    String collectionId = "collectionId_example"; // String | The collection the schema field belongs to, e.g. `my-collection`.
    String schemaFieldName = "schemaFieldName_example"; // String | The name of the schema field to update.
    SchemaField schemaField = new SchemaField(); // SchemaField | The schema field details to update.
    String updateMask = "updateMask_example"; // String | The list of fields to update, separated by a comma, e.g. `name,description`.  Each field should be in snake case.  For each field that you want to update, provide a corresponding value in the schema field object containing the new value.
    try {
      SchemaField result = apiInstance.updateSchemaField(collectionId, schemaFieldName, schemaField, updateMask);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SchemaApi#updateSchemaField");
      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
collectionId	String	The collection the schema field belongs to, e.g. `my-collection`.
schemaFieldName	String	The name of the schema field to update.
schemaField	SchemaField	The schema field details to update.
updateMask	String	The list of fields to update, separated by a comma, e.g. `name,description`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the schema field object containing the new value.	[optional]

Return type

SchemaField

Authorization

BasicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
401	Returned when the request does not have valid authentication credentials.	-
403	Returned when the user does not have permission to access the resource.	-
404	Returned when the resource does not exist.	-
500	Returned when the API encounters an internal error.	-
0	An unexpected error response.	-

Files

SchemaApi.md

Latest commit

History

SchemaApi.md

File metadata and controls

SchemaApi

batchCreateSchemaFields

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createSchemaField

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteSchemaField

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listSchemaFields

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateSchemaField

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details