BrowserApi

All URIs are relative to https://hornet-trunk.dev.xtrf.eu/home-api

Method	HTTP request	Description
browseCSV	GET /browser/csv	Searches for data (ie. customer, task, etc) and returns it in a CSV form.
browseJSON	GET /browser	Searches for data (ie. customer, task, etc) and returns it in a tabular form.
create	POST /browser/views/for/{className}	Creates view for given class.
delete	DELETE /browser/views/{viewId}	Removes a view.
deleteColumn	DELETE /browser/views/{viewId}/columns/{columnName}	Deletes a single column from view.
get	GET /browser/views/{viewId}	Returns all view's information.
getColumnSettings	GET /browser/views/{viewId}/columns/{columnName}/settings	Returns column's specific settings.
getColumns	GET /browser/views/{viewId}/columns	Returns columns defined in view.
getCurrentViewDetails	GET /browser/views/details/for/{className}	Returns current view's detailed information, suitable for browser.
getFilter	GET /browser/views/{viewId}/filter	Returns view's filter.
getLocalSettings	GET /browser/views/{viewId}/settings/local	Returns view's local settings (for current user).
getOrder	GET /browser/views/{viewId}/order	Returns view's order settings.
getPermissions	GET /browser/views/{viewId}/permissions	Returns view's permissions.
getSettings	GET /browser/views/{viewId}/settings	Returns view's settings.
getViewDetails	GET /browser/views/details/for/{className}/{viewId}	Returns view's detailed information, suitable for browser.
getViewsBrief	GET /browser/views/for/{className}	Returns views' brief.
selectViewAndGetItsDetails	POST /browser/views/details/for/{className}/{viewId}	Selects given view as current and returns its detailed information, suitable for browser.
update	PUT /browser/views/{viewId}	Updates all view's information.
updateColumnSettings	PUT /browser/views/{viewId}/columns/{columnName}/settings	Updates column's specific settings.
updateColumns	PUT /browser/views/{viewId}/columns	Updates columns in view.
updateFilter	PUT /browser/views/{viewId}/filter	Updates view's filter.
updateFilterProperty	PUT /browser/views/{viewId}/filter/{filterProperty}	Updates view's filter property.
updateLocalSettings	PUT /browser/views/{viewId}/settings/local	Updates view's local settings (for current user).
updateOrder	PUT /browser/views/{viewId}/order	Updates view's order settings.
updatePermissions	PUT /browser/views/{viewId}/permissions	Updates view's permissions.
updateSettings	PUT /browser/views/{viewId}/settings	Updates view's settings.

browseCSV

Object browseCSV(viewId, separator, additionalOrder)

Searches for data (ie. customer, task, etc) and returns it in a CSV form.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
Long viewId = 789L; // Long | view's identifier
String separator = "separator_example"; // String | csv field separator
String additionalOrder = "additionalOrder_example"; // String | 
try {
    Object result = apiInstance.browseCSV(viewId, separator, additionalOrder);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#browseCSV");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
viewId	Long	view's identifier	[optional]
separator	String	csv field separator	[optional]
additionalOrder	String		[optional]

Return type

Object

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

browseJSON

Object browseJSON(viewId, page, additionalOrder, useDeferredColumns, maxRows)

Searches for data (ie. customer, task, etc) and returns it in a tabular form.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
Long viewId = 789L; // Long | view's identifier
Integer page = 56; // Integer | 
String additionalOrder = "additionalOrder_example"; // String | 
String useDeferredColumns = "useDeferredColumns_example"; // String | 
Integer maxRows = 56; // Integer | overrides view's default rows limit, supported values 10 to 1000
try {
    Object result = apiInstance.browseJSON(viewId, page, additionalOrder, useDeferredColumns, maxRows);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#browseJSON");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
viewId	Long	view's identifier	[optional]
page	Integer		[optional]
additionalOrder	String		[optional]
useDeferredColumns	String		[optional]
maxRows	Integer	overrides view's default rows limit, supported values 10 to 1000	[optional]

Return type

Object

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

create

ViewWithIdDTO create(body, className)

Creates view for given class.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
ViewDTO body = new ViewDTO(); // ViewDTO | Created view for given class.
String className = "className_example"; // String | view's class name
try {
    ViewWithIdDTO result = apiInstance.create(body, className);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#create");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	ViewDTO	Created view for given class.
className	String	view's class name

Return type

ViewWithIdDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: application/json;charset=UTF-8
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

delete

delete(viewId)

Removes a view.

Removes a view. No content is returned upon success (204).

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
Long viewId = 789L; // Long | view's internal identifier
try {
    apiInstance.delete(viewId);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#delete");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
viewId	Long	view's internal identifier

Return type

null (empty response body)

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: Not defined
Accept: Not defined

deleteColumn

List<ColumnDTO> deleteColumn(viewId, columnName)

Deletes a single column from view.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
Long viewId = 789L; // Long | view's identifier
String columnName = "columnName_example"; // String | column's name
try {
    List<ColumnDTO> result = apiInstance.deleteColumn(viewId, columnName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#deleteColumn");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
viewId	Long	view's identifier
columnName	String	column's name

Return type

List<ColumnDTO>

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

get

ViewDTO get(viewId)

Returns all view's information.

Returns all view's information (ie. name, columns, filters, etc).

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
Long viewId = 789L; // Long | view's identifier
try {
    ViewDTO result = apiInstance.get(viewId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#get");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
viewId	Long	view's identifier

Return type

ViewDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getColumnSettings

Object getColumnSettings(viewId, columnName)

Returns column's specific settings.

Returns column's specific settings. For example when column describes money amount we can decide whether it should display currency or not.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
Long viewId = 789L; // Long | view's identifier
String columnName = "columnName_example"; // String | column's name
try {
    Object result = apiInstance.getColumnSettings(viewId, columnName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#getColumnSettings");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
viewId	Long	view's identifier
columnName	String	column's name

Return type

Object

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getColumns

List<ColumnDTO> getColumns(viewId)

Returns columns defined in view.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
Long viewId = 789L; // Long | view's identifier
try {
    List<ColumnDTO> result = apiInstance.getColumns(viewId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#getColumns");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
viewId	Long	view's identifier

Return type

List<ColumnDTO>

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getCurrentViewDetails

ViewDetailsDTO getCurrentViewDetails(className, placeName)

Returns current view's detailed information, suitable for browser.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
String className = "className_example"; // String | views' class name
String placeName = "placeName_example"; // String | place name (denotes specific place in system with the table)
try {
    ViewDetailsDTO result = apiInstance.getCurrentViewDetails(className, placeName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#getCurrentViewDetails");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
className	String	views' class name
placeName	String	place name (denotes specific place in system with the table)	[optional]

Return type

ViewDetailsDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getFilter

FilterDTO getFilter(viewId)

Returns view's filter.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
Long viewId = 789L; // Long | view's identifier
try {
    FilterDTO result = apiInstance.getFilter(viewId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#getFilter");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
viewId	Long	view's identifier

Return type

FilterDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getLocalSettings

LocalSettingsDTO getLocalSettings(viewId)

Returns view's local settings (for current user).

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
Long viewId = 789L; // Long | view's identifier
try {
    LocalSettingsDTO result = apiInstance.getLocalSettings(viewId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#getLocalSettings");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
viewId	Long	view's identifier

Return type

LocalSettingsDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getOrder

OrderDTO getOrder(viewId)

Returns view's order settings.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
Long viewId = 789L; // Long | view's identifier
try {
    OrderDTO result = apiInstance.getOrder(viewId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#getOrder");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
viewId	Long	view's identifier

Return type

OrderDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getPermissions

PermissionsDTO getPermissions(viewId)

Returns view's permissions.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
Long viewId = 789L; // Long | view's identifier
try {
    PermissionsDTO result = apiInstance.getPermissions(viewId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#getPermissions");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
viewId	Long	view's identifier

Return type

PermissionsDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getSettings

SettingsDTO getSettings(viewId)

Returns view's settings.

Returns view's settings (ie. name).

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
Long viewId = 789L; // Long | view's identifier
try {
    SettingsDTO result = apiInstance.getSettings(viewId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#getSettings");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
viewId	Long	view's identifier

Return type

SettingsDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getViewDetails

ViewDetailsDTO getViewDetails(className, viewId, placeName)

Returns view's detailed information, suitable for browser.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
String className = "className_example"; // String | views' class name
Long viewId = 789L; // Long | 
String placeName = "placeName_example"; // String | place name (denotes specific place in system with the table)
try {
    ViewDetailsDTO result = apiInstance.getViewDetails(className, viewId, placeName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#getViewDetails");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
className	String	views' class name
viewId	Long
placeName	String	place name (denotes specific place in system with the table)	[optional]

Return type

ViewDetailsDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getViewsBrief

ViewsBriefDTO getViewsBrief(className, placeName)

Returns views' brief.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
String className = "className_example"; // String | views' class name
String placeName = "placeName_example"; // String | place name (denotes specific place in system with the table)
try {
    ViewsBriefDTO result = apiInstance.getViewsBrief(className, placeName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#getViewsBrief");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
className	String	views' class name
placeName	String	place name (denotes specific place in system with the table)	[optional]

Return type

ViewsBriefDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

selectViewAndGetItsDetails

ViewDetailsDTO selectViewAndGetItsDetails(className, viewId, placeNameDenotesSpecificPlaceInSystemWithTheTable)

Selects given view as current and returns its detailed information, suitable for browser.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
String className = "className_example"; // String | views' class name
Long viewId = 789L; // Long | 
String placeNameDenotesSpecificPlaceInSystemWithTheTable = "placeNameDenotesSpecificPlaceInSystemWithTheTable_example"; // String | 
try {
    ViewDetailsDTO result = apiInstance.selectViewAndGetItsDetails(className, viewId, placeNameDenotesSpecificPlaceInSystemWithTheTable);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#selectViewAndGetItsDetails");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
className	String	views' class name
viewId	Long
placeNameDenotesSpecificPlaceInSystemWithTheTable	String		[optional]

Return type

ViewDetailsDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

update

ViewDTO update(body, viewId)

Updates all view's information.

Updates all view's information (ie. name, columns, filters, etc).

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
ViewDTO body = new ViewDTO(); // ViewDTO | Updated all view's information.
Long viewId = 789L; // Long | view's identifier
try {
    ViewDTO result = apiInstance.update(body, viewId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#update");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	ViewDTO	Updated all view's information.
viewId	Long	view's identifier

Return type

ViewDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: application/json;charset=UTF-8
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

updateColumnSettings

Object updateColumnSettings(body, viewId, columnName)

Updates column's specific settings.

Updates column's specific settings. For example when column describes money amount we can decide whether it should display currency or not.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
Object body = {
  "description" : "ref",
  "value" : "/home-api/assets/examples/browsers/views/updateColumnSettings.json#requestBody"
}; // Object | Updated column's specific settings.
Long viewId = 789L; // Long | view's identifier
String columnName = "columnName_example"; // String | column's name
try {
    Object result = apiInstance.updateColumnSettings(body, viewId, columnName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#updateColumnSettings");
    e.printStackTrace();
}

Parameters

Name	Type	Description
body	Object	Updated column's specific settings.
viewId	Long	view's identifier
columnName	String	column's name

Return type

Object

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: application/json
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

updateColumns

List<ColumnDTO> updateColumns(body, viewId)

Updates columns in view.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
List<ColumnDTO> body = Arrays.asList(new ColumnDTO()); // List<ColumnDTO> | Updated columns in view.
Long viewId = 789L; // Long | view's identifier
try {
    List<ColumnDTO> result = apiInstance.updateColumns(body, viewId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#updateColumns");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	List<ColumnDTO>	Updated columns in view.
viewId	Long	view's identifier

Return type

List<ColumnDTO>

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: application/json;charset=UTF-8
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

updateFilter

FilterDTO updateFilter(body, viewId)

Updates view's filter.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
List<FilterPropertyDTO> body = Arrays.asList(new FilterPropertyDTO()); // List<FilterPropertyDTO> | Updated view's filter.
Long viewId = 789L; // Long | view's identifier
try {
    FilterDTO result = apiInstance.updateFilter(body, viewId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#updateFilter");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	List<FilterPropertyDTO>	Updated view's filter.
viewId	Long	view's identifier

Return type

FilterDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: application/json;charset=UTF-8
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

updateFilterProperty

Object updateFilterProperty(body, viewId, filterProperty)

Updates view's filter property.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
FilterPropertyDTO body = new FilterPropertyDTO(); // FilterPropertyDTO | Updated view's filter property.
Long viewId = 789L; // Long | view's identifier
String filterProperty = "filterProperty_example"; // String | view's filter property name
try {
    Object result = apiInstance.updateFilterProperty(body, viewId, filterProperty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#updateFilterProperty");
    e.printStackTrace();
}

Parameters

Name	Type	Description
body	FilterPropertyDTO	Updated view's filter property.
viewId	Long	view's identifier
filterProperty	String	view's filter property name

Return type

Object

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: application/json
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

updateLocalSettings

LocalSettingsDTO updateLocalSettings(body, viewId)

Updates view's local settings (for current user).

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
LocalSettingsDTO body = new LocalSettingsDTO(); // LocalSettingsDTO | Updated view's local settings (for current user).
Long viewId = 789L; // Long | view's identifier
try {
    LocalSettingsDTO result = apiInstance.updateLocalSettings(body, viewId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#updateLocalSettings");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	LocalSettingsDTO	Updated view's local settings (for current user).
viewId	Long	view's identifier

Return type

LocalSettingsDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: application/json
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

updateOrder

OrderDTO updateOrder(body, viewId)

Updates view's order settings.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
OrderDTO body = new OrderDTO(); // OrderDTO | Updated view's order settings.
Long viewId = 789L; // Long | view's identifier
try {
    OrderDTO result = apiInstance.updateOrder(body, viewId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#updateOrder");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	OrderDTO	Updated view's order settings.
viewId	Long	view's identifier

Return type

OrderDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: application/json;charset=UTF-8
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

updatePermissions

PermissionsDTO updatePermissions(body, viewId)

Updates view's permissions.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
PermissionsDTO body = new PermissionsDTO(); // PermissionsDTO | Updated view's permissions.
Long viewId = 789L; // Long | view's identifier
try {
    PermissionsDTO result = apiInstance.updatePermissions(body, viewId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#updatePermissions");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	PermissionsDTO	Updated view's permissions.
viewId	Long	view's identifier

Return type

PermissionsDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: application/json
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

updateSettings

SettingsDTO updateSettings(body, viewId)

Updates view's settings.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.BrowserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

BrowserApi apiInstance = new BrowserApi();
SettingsDTO body = new SettingsDTO(); // SettingsDTO | Updated view's settings.
Long viewId = 789L; // Long | view's identifier
try {
    SettingsDTO result = apiInstance.updateSettings(body, viewId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BrowserApi#updateSettings");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	SettingsDTO	Updated view's settings.
viewId	Long	view's identifier

Return type

SettingsDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: application/json
Accept: application/vnd.xtrf-v1+json;charset=UTF-8

Files

BrowserApi.md

Latest commit

History

BrowserApi.md

File metadata and controls

BrowserApi

browseCSV

Example

Parameters

Return type

Authorization

HTTP request headers

browseJSON

Example

Parameters

Return type

Authorization

HTTP request headers

create

Example

Parameters

Return type

Authorization

HTTP request headers

delete

Example

Parameters

Return type

Authorization

HTTP request headers

deleteColumn

Example

Parameters

Return type

Authorization

HTTP request headers

get

Example

Parameters

Return type

Authorization

HTTP request headers

getColumnSettings

Example

Parameters

Return type

Authorization

HTTP request headers

getColumns

Example

Parameters

Return type

Authorization

HTTP request headers

getCurrentViewDetails

Example

Parameters

Return type

Authorization

HTTP request headers

getFilter

Example

Parameters

Return type

Authorization

HTTP request headers

getLocalSettings

Example

Parameters

Return type

Authorization

HTTP request headers

getOrder

Example

Parameters

Return type

Authorization

HTTP request headers

getPermissions