OkPluginGenericJsonIngestApi

All URIs are relative to http://localhost

Method	HTTP request	Description
manageContextGetAllContexts	GET /api/v{version}/ingest/genericJSON/manage/context
manageContextGetContext	GET /api/v{version}/ingest/genericJSON/manage/context/{id}
manageContextRemoveContext	DELETE /api/v{version}/ingest/genericJSON/manage/context/{id}
manageContextUpsertContext	POST /api/v{version}/ingest/genericJSON/manage/context
passiveDataIngest	POST /api/v{version}/ingest/genericJSON/data
passiveFilesIngest	POST /api/v{version}/ingest/genericJSON/files

manageContextGetAllContexts

List<Object> manageContextGetAllContexts(version)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.OkPluginGenericJsonIngestApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    OkPluginGenericJsonIngestApi apiInstance = new OkPluginGenericJsonIngestApi(defaultClient);
    String version = "version_example"; // String | 
    try {
      List<Object> result = apiInstance.manageContextGetAllContexts(version);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OkPluginGenericJsonIngestApi#manageContextGetAllContexts");
      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
version	String

Return type

List<Object>

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml, application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

manageContextGetContext

Object manageContextGetContext(id, version)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.OkPluginGenericJsonIngestApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    OkPluginGenericJsonIngestApi apiInstance = new OkPluginGenericJsonIngestApi(defaultClient);
    String id = "id_example"; // String | 
    String version = "version_example"; // String | 
    try {
      Object result = apiInstance.manageContextGetContext(id, version);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OkPluginGenericJsonIngestApi#manageContextGetContext");
      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
id	String
version	String

Return type

Object

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml, application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

manageContextRemoveContext

Boolean manageContextRemoveContext(id, version)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.OkPluginGenericJsonIngestApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    OkPluginGenericJsonIngestApi apiInstance = new OkPluginGenericJsonIngestApi(defaultClient);
    String id = "id_example"; // String | 
    String version = "version_example"; // String | 
    try {
      Boolean result = apiInstance.manageContextRemoveContext(id, version);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OkPluginGenericJsonIngestApi#manageContextRemoveContext");
      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
id	String
version	String

Return type

Boolean

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml, application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

manageContextUpsertContext

Object manageContextUpsertContext(version, body)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.OkPluginGenericJsonIngestApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    OkPluginGenericJsonIngestApi apiInstance = new OkPluginGenericJsonIngestApi(defaultClient);
    String version = "version_example"; // String | 
    Object body = null; // Object | 
    try {
      Object result = apiInstance.manageContextUpsertContext(version, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OkPluginGenericJsonIngestApi#manageContextUpsertContext");
      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
version	String
body	Object

Return type

Object

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: application/json, application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/xml, text/plain, text/json, application/*+json
Accept: application/json, application/xml, application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

passiveDataIngest

passiveDataIngest(readLayerIDs, writeLayerID, version, genericInboundData)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.OkPluginGenericJsonIngestApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    OkPluginGenericJsonIngestApi apiInstance = new OkPluginGenericJsonIngestApi(defaultClient);
    List<String> readLayerIDs = Arrays.asList(); // List<String> | 
    String writeLayerID = "writeLayerID_example"; // String | 
    String version = "version_example"; // String | 
    GenericInboundData genericInboundData = new GenericInboundData(); // GenericInboundData | 
    try {
      apiInstance.passiveDataIngest(readLayerIDs, writeLayerID, version, genericInboundData);
    } catch (ApiException e) {
      System.err.println("Exception when calling OkPluginGenericJsonIngestApi#passiveDataIngest");
      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
readLayerIDs	List<String>
writeLayerID	String
version	String
genericInboundData	GenericInboundData

Return type

null (empty response body)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: application/json, application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/xml, text/plain, text/json, application/*+json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

passiveFilesIngest

passiveFilesIngest(context, version, files)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.OkPluginGenericJsonIngestApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    OkPluginGenericJsonIngestApi apiInstance = new OkPluginGenericJsonIngestApi(defaultClient);
    String context = "context_example"; // String | 
    String version = "version_example"; // String | 
    List<File> files = Arrays.asList(); // List<File> | 
    try {
      apiInstance.passiveFilesIngest(context, version, files);
    } catch (ApiException e) {
      System.err.println("Exception when calling OkPluginGenericJsonIngestApi#passiveFilesIngest");
      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
context	String
version	String
files	List<File>

Return type

null (empty response body)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: multipart/form-data
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

FilesExpand file tree

OkPluginGenericJsonIngestApi.md

Latest commit

History

OkPluginGenericJsonIngestApi.md

File metadata and controls

OkPluginGenericJsonIngestApi

manageContextGetAllContexts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

manageContextGetContext

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

manageContextRemoveContext

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

manageContextUpsertContext

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

passiveDataIngest

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

passiveFilesIngest

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details