GridViewApi

All URIs are relative to http://localhost

Method	HTTP request	Description
gridViewAddContext	POST /api/v{version}/GridView/context	Adds new context
gridViewChangeData	POST /api/v{version}/GridView/contexts/{context}/change	Saves grid view row changes and returns change results
gridViewDeleteContext	DELETE /api/v{version}/GridView/context/{name}	Deletes specific context
gridViewEditContext	PUT /api/v{version}/GridView/context/{name}	Edits specific context
gridViewGetData	GET /api/v{version}/GridView/contexts/{context}/data	Returns grid view data for specific context
gridViewGetGridViewContext	GET /api/v{version}/GridView/context/{name}	Returns a single context in full
gridViewGetGridViewContexts	GET /api/v{version}/GridView/contexts	Returns a list of contexts for grid view.
gridViewGetSchema	GET /api/v{version}/GridView/contexts/{context}/schema	Returns grid view schema for specific context

gridViewAddContext

gridViewAddContext(version, addContextRequest)

Adds new context

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.GridViewApi;

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");

    GridViewApi apiInstance = new GridViewApi(defaultClient);
    String version = "version_example"; // String | 
    AddContextRequest addContextRequest = new AddContextRequest(); // AddContextRequest | 
    try {
      apiInstance.gridViewAddContext(version, addContextRequest);
    } catch (ApiException e) {
      System.err.println("Exception when calling GridViewApi#gridViewAddContext");
      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
addContextRequest	AddContextRequest		[optional]

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: 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
201	Returns the newly created context	-
400	If creating context fails	-

gridViewChangeData

gridViewChangeData(context, version, changeDataRequest)

Saves grid view row changes and returns change results

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.GridViewApi;

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");

    GridViewApi apiInstance = new GridViewApi(defaultClient);
    String context = "context_example"; // String | 
    String version = "version_example"; // String | 
    ChangeDataRequest changeDataRequest = new ChangeDataRequest(); // ChangeDataRequest | 
    try {
      apiInstance.gridViewChangeData(context, version, changeDataRequest);
    } catch (ApiException e) {
      System.err.println("Exception when calling GridViewApi#gridViewChangeData");
      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	Notes
context	String
version	String
changeDataRequest	ChangeDataRequest	[optional]

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: 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	If request is successful	-
400	Bad Request	-
404	If saving changes fails	-

gridViewDeleteContext

gridViewDeleteContext(name, version)

Deletes specific context

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.GridViewApi;

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");

    GridViewApi apiInstance = new GridViewApi(defaultClient);
    String name = "name_example"; // String | 
    String version = "version_example"; // String | 
    try {
      apiInstance.gridViewDeleteContext(name, version);
    } catch (ApiException e) {
      System.err.println("Exception when calling GridViewApi#gridViewDeleteContext");
      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
name	String
version	String

Return type

null (empty response body)

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	If request is successful	-
400	If editing the context fails	-

gridViewEditContext

gridViewEditContext(name, version, editContextRequest)

Edits specific context

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.GridViewApi;

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");

    GridViewApi apiInstance = new GridViewApi(defaultClient);
    String name = "name_example"; // String | 
    String version = "version_example"; // String | 
    EditContextRequest editContextRequest = new EditContextRequest(); // EditContextRequest | 
    try {
      apiInstance.gridViewEditContext(name, version, editContextRequest);
    } catch (ApiException e) {
      System.err.println("Exception when calling GridViewApi#gridViewEditContext");
      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	Notes
name	String
version	String
editContextRequest	EditContextRequest	[optional]

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: 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	If request is successful	-
400	If editing the context fails	-

gridViewGetData

gridViewGetData(context, version)

Returns grid view data for specific context

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.GridViewApi;

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");

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

Return type

null (empty response body)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	If request is successful	-
400	If trait is not found	-

gridViewGetGridViewContext

gridViewGetGridViewContext(name, version)

Returns a single context in full

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.GridViewApi;

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");

    GridViewApi apiInstance = new GridViewApi(defaultClient);
    String name = "name_example"; // String | 
    String version = "version_example"; // String | 
    try {
      apiInstance.gridViewGetGridViewContext(name, version);
    } catch (ApiException e) {
      System.err.println("Exception when calling GridViewApi#gridViewGetGridViewContext");
      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
name	String
version	String

Return type

null (empty response body)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-
400	If the name was not found or any other error occurred	-

gridViewGetGridViewContexts

gridViewGetGridViewContexts(version)

Returns a list of contexts for grid view.

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.GridViewApi;

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");

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

null (empty response body)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

gridViewGetSchema

gridViewGetSchema(context, version)

Returns grid view schema for specific context

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.GridViewApi;

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");

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

Return type

null (empty response body)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200		-

FilesExpand file tree

GridViewApi.md

Latest commit

History

GridViewApi.md

File metadata and controls

GridViewApi

gridViewAddContext

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

gridViewChangeData

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

gridViewDeleteContext

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

gridViewEditContext

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

gridViewGetData

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

gridViewGetGridViewContext

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

gridViewGetGridViewContexts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

gridViewGetSchema

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details