XTRF Home Portal API
- API version: 2.0
- Build date: 2019-07-02T16:14:58.802Z[GMT]
XTRF Home Portal API enables you to perform operations on Projects, Quotes, Customers, Vendors etc. as a XTRF Home Portal user.
The documentation is generated from OpenAPI specification 3.0 available <a href="/home-api/openapi.json">here
The API client/consumer code may be easily generated in 60+ programming languages using an open source code generator available at the time of writing this documentation at https://editor.swagger.io/ Thank you for using XTRF Application Programming interface (XTRF API). By using the API you agree to the terms below. If you disagree with any of these terms, XTRF does not grant you a license to use the XTRF API. XTRF reserves the right to update and change these terms from time to time without a prior notice of API users. You can always find the most recent version of these terms here:
Automatically generated by the Swagger Codegen
Building the API client library requires:
- Java 1.7+
- Maven/Gradle
To install the API client library to your local Maven repository, simply execute:
mvn clean install
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn clean deploy
Refer to the OSSRH Guide for more information.
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrowserApi;
import java.io.File;
import java.util.*;
public class BrowserApiExample {
public static void main(String[] args) {
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();
}
}
}
All URIs are relative to https://hornet-trunk.dev.xtrf.eu/home-api
Class | Method | HTTP request | Description |
---|---|---|---|
BrowserApi | browseCSV | GET /browser/csv | Searches for data (ie. customer, task, etc) and returns it in a CSV form. |
BrowserApi | browseJSON | GET /browser | Searches for data (ie. customer, task, etc) and returns it in a tabular form. |
BrowserApi | create | POST /browser/views/for/{className} | Creates view for given class. |
BrowserApi | delete | DELETE /browser/views/{viewId} | Removes a view. |
BrowserApi | deleteColumn | DELETE /browser/views/{viewId}/columns/{columnName} | Deletes a single column from view. |
BrowserApi | get | GET /browser/views/{viewId} | Returns all view's information. |
BrowserApi | getColumnSettings | GET /browser/views/{viewId}/columns/{columnName}/settings | Returns column's specific settings. |
BrowserApi | getColumns | GET /browser/views/{viewId}/columns | Returns columns defined in view. |
BrowserApi | getCurrentViewDetails | GET /browser/views/details/for/{className} | Returns current view's detailed information, suitable for browser. |
BrowserApi | getFilter | GET /browser/views/{viewId}/filter | Returns view's filter. |
BrowserApi | getLocalSettings | GET /browser/views/{viewId}/settings/local | Returns view's local settings (for current user). |
BrowserApi | getOrder | GET /browser/views/{viewId}/order | Returns view's order settings. |
BrowserApi | getPermissions | GET /browser/views/{viewId}/permissions | Returns view's permissions. |
BrowserApi | getSettings | GET /browser/views/{viewId}/settings | Returns view's settings. |
BrowserApi | getViewDetails | GET /browser/views/details/for/{className}/{viewId} | Returns view's detailed information, suitable for browser. |
BrowserApi | getViewsBrief | GET /browser/views/for/{className} | Returns views' brief. |
BrowserApi | selectViewAndGetItsDetails | POST /browser/views/details/for/{className}/{viewId} | Selects given view as current and returns its detailed information, suitable for browser. |
BrowserApi | update | PUT /browser/views/{viewId} | Updates all view's information. |
BrowserApi | updateColumnSettings | PUT /browser/views/{viewId}/columns/{columnName}/settings | Updates column's specific settings. |
BrowserApi | updateColumns | PUT /browser/views/{viewId}/columns | Updates columns in view. |
BrowserApi | updateFilter | PUT /browser/views/{viewId}/filter | Updates view's filter. |
BrowserApi | updateFilterProperty | PUT /browser/views/{viewId}/filter/{filterProperty} | Updates view's filter property. |
BrowserApi | updateLocalSettings | PUT /browser/views/{viewId}/settings/local | Updates view's local settings (for current user). |
BrowserApi | updateOrder | PUT /browser/views/{viewId}/order | Updates view's order settings. |
BrowserApi | updatePermissions | PUT /browser/views/{viewId}/permissions | Updates view's permissions. |
BrowserApi | updateSettings | PUT /browser/views/{viewId}/settings | Updates view's settings. |
ClientInvoicesApi | create | POST /accounting/customers/invoices | Creates a new invoice. |
ClientInvoicesApi | createPayment | POST /accounting/customers/invoices/{invoiceId}/payments | Adds a new payment to the client invoice. The invoice payment status (Not Paid, Partially Paid, Fully Paid) is automatically recalculated. |
ClientInvoicesApi | delete | DELETE /accounting/customers/invoices/{invoiceId} | Removes a client invoice. |
ClientInvoicesApi | delete_0 | DELETE /accounting/customers/payments/{paymentId} | Removes a customer payment. |
ClientInvoicesApi | downloadDocuments | POST /accounting/customers/invoices/documents | Generates client invoices' documents. |
ClientInvoicesApi | duplicate | POST /accounting/customers/invoices/{invoiceId}/duplicate | Duplicate client invoice. |
ClientInvoicesApi | duplicateAsProForma | POST /accounting/customers/invoices/{invoiceId}/duplicate/proForma | Duplicate client invoice as pro forma. |
ClientInvoicesApi | getAll | GET /accounting/customers/invoices | Lists all client invoices in all statuses (including not ready and drafts) that have been updated since a specific date. |
ClientInvoicesApi | getAllIds | GET /accounting/customers/invoices/ids | Returns client invoices' internal identifiers. |
ClientInvoicesApi | getById | GET /accounting/customers/invoices/{invoiceId} | Returns client invoice details. |
ClientInvoicesApi | getDates | GET /accounting/customers/invoices/{invoiceId}/dates | Returns dates of a given client invoice. |
ClientInvoicesApi | getDocument | GET /accounting/customers/invoices/{invoiceId}/document | Generates client invoice document (PDF). |
ClientInvoicesApi | getPaymentTerms | GET /accounting/customers/invoices/{invoiceId}/paymentTerms | Returns payment terms of a given client invoice. |
ClientInvoicesApi | getPayments | GET /accounting/customers/invoices/{invoiceId}/payments | Returns all payments for the client invoice. |
ClientInvoicesApi | sendReminder | POST /accounting/customers/invoices/{invoiceId}/sendReminder | Sends reminder. |
ClientInvoicesApi | sendReminders | POST /accounting/customers/invoices/sendReminders | Sends reminders. Returns number of sent e-mails. |
ClientsApi | create | POST /customers/persons | Creates a new person. |
ClientsApi | create1 | POST /customers | Creates a new client. |
ClientsApi | delete1 | DELETE /customers/persons/{personId} | Removes a person. |
ClientsApi | delete1_0 | DELETE /customers/priceLists/{priceListId} | Removes a customer price list. |
ClientsApi | delete2 | DELETE /customers/{customerId} | Removes a client. |
ClientsApi | generateSingleUseSignInToken | POST /customers/persons/accessToken | Generates a single use sign-in token. |
ClientsApi | getAddress | GET /customers/{customerId}/address | Returns address of a given client. |
ClientsApi | getAllIds1 | GET /customers/persons/ids | Returns persons' internal identifiers. |
ClientsApi | getAllIds2 | GET /customers/ids | Returns clients' internal identifiers. |
ClientsApi | getAllNamesWithIds | GET /customers | Returns list of simple clients representations |
ClientsApi | getById1 | GET /customers/persons/{personId} | Returns person details. |
ClientsApi | getById2 | GET /customers/{customerId} | Returns client details. |
ClientsApi | getCategories | GET /customers/{customerId}/categories | Returns categories of a given client. |
ClientsApi | getContact | GET /customers/persons/{personId}/contact | Returns contact of a given person. |
ClientsApi | getContact1 | GET /customers/{customerId}/contact | Returns contact of a given client. |
ClientsApi | getCorrespondenceAddress | GET /customers/{customerId}/correspondenceAddress | Returns correspondence address of a given client. |
ClientsApi | getCustomField | GET /customers/{customerId}/customFields/{customFieldKey} | Returns custom field of a given client. |
ClientsApi | getCustomFields | GET /customers/persons/{personId}/customFields | Returns custom fields of a given person. |
ClientsApi | getCustomFields1 | GET /customers/{customerId}/customFields | Returns custom fields of a given client. |
ClientsApi | getIndustries | GET /customers/{customerId}/industries | Returns industries of a given client. |
ClientsApi | update | PUT /customers/persons/{personId} | Updates an existing person. |
ClientsApi | updateAddress | PUT /customers/{customerId}/address | Updates address of a given client. |
ClientsApi | updateCategories | PUT /customers/{customerId}/categories | Updates categories of a given client. |
ClientsApi | updateContact | PUT /customers/persons/{personId}/contact | Updates contact of a given person. |
ClientsApi | updateContact_0 | PUT /customers/{customerId}/contact | Updates contact of a given client. |
ClientsApi | updateCorrespondenceAddress | PUT /customers/{customerId}/correspondenceAddress | Updates correspondence address of a given client. |
ClientsApi | updateCustomField | PUT /customers/{customerId}/customFields/{customFieldKey} | Updates given custom field of a given client. |
ClientsApi | updateCustomFields | PUT /customers/persons/{personId}/customFields | Updates custom fields of a given person. |
ClientsApi | updateCustomFields_0 | PUT /customers/{customerId}/customFields | Updates custom fields of a given client. |
ClientsApi | updateIndustries | PUT /customers/{customerId}/industries | Updates industries of a given client. |
ClientsApi | update_0 | PUT /customers/{customerId} | Updates an existing client. |
DictionariesApi | getActive | GET /dictionaries/active | Returns active dictionary entities for all types. |
DictionariesApi | getActiveByType | GET /dictionaries/{type}/active | Returns active values from a given dictionary. |
DictionariesApi | getAll1 | GET /dictionaries/all | Returns dictionary entities for all types. Both active and not active ones. |
DictionariesApi | getAll3 | GET /services/all | Returns services list |
DictionariesApi | getAllActive | GET /services/active | Returns active services list |
DictionariesApi | getAllByType | GET /dictionaries/{type}/all | Returns all values (both active and not active) from a given dictionary. |
DictionariesApi | getByTypeAndId | GET /dictionaries/{type}/{id} | Returns specific value from a given dictionary. |
FilesApi | uploadFile | POST /files | Uploads a temporary file (ie. for XML import). Returns token which can be used in other API calls. |
JobsSmartV2Api | addFiles | PUT /v2/jobs/{jobId}/files/delivered/add | Adds files to the project as delivered in the job. |
JobsSmartV2Api | assignVendor | PUT /v2/jobs/{jobId}/vendor | Assigns vendor to a job in a project. |
JobsSmartV2Api | changeStatus | PUT /v2/jobs/{jobId}/status | Changes job status if possible (400 Bad Request is returned otherwise). |
JobsSmartV2Api | getDeliveredFiles | GET /v2/jobs/{jobId}/files/delivered | Returns list of files delivered in the job. |
JobsSmartV2Api | getFileById | GET /v2/jobs/{jobId} | Returns details for a job. |
JobsSmartV2Api | getSharedReferenceFiles | GET /v2/jobs/{jobId}/files/sharedReferenceFiles | Returns list of files shared with the job as Reference Files. |
JobsSmartV2Api | getSharedWorkFiles | GET /v2/jobs/{jobId}/files/sharedWorkFiles | Returns list of files shared with the job as Work Files. |
JobsSmartV2Api | shareAsReferenceFiles | PUT /v2/jobs/{jobId}/files/sharedReferenceFiles/share | Shares selected files as Reference Files with a job in a project. |
JobsSmartV2Api | shareAsWorkFiles | PUT /v2/jobs/{jobId}/files/sharedWorkFiles/share | Shares selected files as Work Files with a job in a project. |
JobsSmartV2Api | stopSharing | PUT /v2/jobs/{jobId}/files/stopSharing | Stops sharing selected files with a job in a project. |
JobsSmartV2Api | updateInstructions | PUT /v2/jobs/{jobId}/instructions | Updates instructions for a job. |
JobsSmartV2Api | uploadFile1 | POST /v2/jobs/{jobId}/files/delivered/upload | Uploads file to the project as a file delivered in the job. |
LicenseApi | getLicense | GET /license | Returns license content. |
LicenseApi | refresh | POST /license/refresh | Refreshes license content. |
MacrosApi | run | POST /macros/{macroId}/run | Executes a macro. |
ProjectsClassicApi | create1 | POST /projects | Creates a new Classic Project. |
ProjectsClassicApi | createLanguageCombination | POST /projects/{projectId}/languageCombinations | Creates a new language combination for a given project without creating a task. |
ProjectsClassicApi | createTask | POST /projects/{projectId}/tasks | Creates a new task for a given project. |
ProjectsClassicApi | delete5 | DELETE /projects/{projectId} | Removes a project. |
ProjectsClassicApi | getAllIds6 | GET /projects/ids | Returns projects' internal identifiers. |
ProjectsClassicApi | getById7 | GET /projects/{projectId} | Returns project details. |
ProjectsClassicApi | getContacts | GET /projects/{projectId}/contacts | Returns contacts of a given project. |
ProjectsClassicApi | getCustomFields5 | GET /projects/{projectId}/customFields | Returns custom fields of a given project. |
ProjectsClassicApi | getDates1 | GET /projects/{projectId}/dates | Returns dates of a given project. |
ProjectsClassicApi | getFinance | GET /projects/{projectId}/finance | Returns finance of a given project. |
ProjectsClassicApi | getInstructions | GET /projects/{projectId}/instructions | Returns instructions of a given project. |
ProjectsClassicApi | updateContacts | PUT /projects/{projectId}/contacts | Updates contacts of a given project. |
ProjectsClassicApi | updateCustomFields | PUT /projects/{projectId}/customFields | Updates custom fields of a given project. |
ProjectsClassicApi | updateDates | PUT /projects/{projectId}/dates | Updates dates of a given project. |
ProjectsClassicApi | updateInstructions | PUT /projects/{projectId}/instructions | Updates instructions of a given project. |
ProjectsSmartV2Api | addFileLinks | POST /v2/projects/{projectId}/files/addLink | Adds file links to the project as added by PM. |
ProjectsSmartV2Api | addFiles1 | PUT /v2/projects/{projectId}/files/add | Adds files to the project as added by PM. |
ProjectsSmartV2Api | archive | POST /v2/projects/files/archive | Prepares a ZIP archive that contains the specified files. |
ProjectsSmartV2Api | changeStatus1 | PUT /v2/projects/{projectId}/status | Changes project status if possible (400 Bad Request is returned otherwise). |
ProjectsSmartV2Api | create2 | POST /v2/projects | Creates a new Smart Project. |
ProjectsSmartV2Api | createPayable | POST /v2/projects/{projectId}/finance/payables | Adds a payable to a project. |
ProjectsSmartV2Api | createReceivable | POST /v2/projects/{projectId}/finance/receivables | Adds a receivable to a project. |
ProjectsSmartV2Api | deletePayable | DELETE /v2/projects/{projectId}/finance/payables/{payableId} | Deletes a payable. |
ProjectsSmartV2Api | deleteReceivable | DELETE /v2/projects/{projectId}/finance/receivables/{receivableId} | Deletes a receivable. |
ProjectsSmartV2Api | getById9 | GET /v2/projects/{projectId} | Returns project details. |
ProjectsSmartV2Api | getCATToolProjectInfo | GET /v2/projects/{projectId}/catToolProject | Returns if cat tool project is created or queued. |
ProjectsSmartV2Api | getContacts2 | GET /v2/projects/{projectId}/clientContacts | Returns Client Contacts information for a project. |
ProjectsSmartV2Api | getCustomFields8 | GET /v2/projects/{projectId}/customFields | Returns a list of custom field keys and values for a project. |
ProjectsSmartV2Api | getDeliverableFiles | GET /v2/projects/{projectId}/files/deliverable | Returns list of files in a project, that are ready to be delivered to client. |
ProjectsSmartV2Api | getFileById1 | GET /v2/projects/files/{fileId} | Returns details of a file. |
ProjectsSmartV2Api | getFileContentById | GET /v2/projects/files/{fileId}/download/{fileName} | Downloads a file content. |
ProjectsSmartV2Api | getFiles | GET /v2/projects/{projectId}/files | Returns list of files in a project. |
ProjectsSmartV2Api | getFinance2 | GET /v2/projects/{projectId}/finance | Returns finance information for a project. |
ProjectsSmartV2Api | getJobs | GET /v2/projects/{projectId}/jobs | Returns list of jobs in a project. |
ProjectsSmartV2Api | updateClientDeadline | PUT /v2/projects/{projectId}/clientDeadline | Updates Client Deadline for a project. |
ProjectsSmartV2Api | updateClientNotes | PUT /v2/projects/{projectId}/clientNotes | Updates Client Notes for a project. |
ProjectsSmartV2Api | updateClientReferenceNumber | PUT /v2/projects/{projectId}/clientReferenceNumber | Updates Client Reference Number for a project. |
ProjectsSmartV2Api | updateContacts | PUT /v2/projects/{projectId}/clientContacts | Updates Client Contacts for a project. |
ProjectsSmartV2Api | updateCustomField | PUT /v2/projects/{projectId}/customFields/{key} | Updates a custom field with a specified key in a project |
ProjectsSmartV2Api | updateInternalNotes | PUT /v2/projects/{projectId}/internalNotes | Updates Internal Notes for a project. |
ProjectsSmartV2Api | updateOrderedOn | PUT /v2/projects/{projectId}/orderDate | Updates Order Date for a project. |
ProjectsSmartV2Api | updatePayable | PUT /v2/projects/{projectId}/finance/payables/{payableId} | Updates a payable. |
ProjectsSmartV2Api | updateReceivable | PUT /v2/projects/{projectId}/finance/receivables/{receivableId} | Updates a receivable. |
ProjectsSmartV2Api | updateSourceLanguage | PUT /v2/projects/{projectId}/sourceLanguage | Updates source language for a project. |
ProjectsSmartV2Api | updateSpecialization | PUT /v2/projects/{projectId}/specialization | Updates specialization for a project. |
ProjectsSmartV2Api | updateTargetLanguages | PUT /v2/projects/{projectId}/targetLanguages | Updates target languages for a project. |
ProjectsSmartV2Api | updateVendorInstructions | PUT /v2/projects/{projectId}/vendorInstructions | Updates instructions for all vendors performing the jobs in a project. |
ProjectsSmartV2Api | updateVolume | PUT /v2/projects/{projectId}/volume | Updates volume for a project. |
ProjectsSmartV2Api | uploadFile2 | POST /v2/projects/{projectId}/files/upload | Uploads file to the project as a file uploaded by PM. |
QuotesClassicApi | createLanguageCombination1 | POST /quotes/{quoteId}/languageCombinations | Creates a new language combination for a given quote without creating a task. |
QuotesClassicApi | createTask1 | POST /quotes/{quoteId}/tasks | Creates a new task for a given quote. |
QuotesClassicApi | delete5 | DELETE /quotes/{quoteId} | Removes a quote. |
QuotesClassicApi | getAllIds7 | GET /quotes/ids | Returns quotes' internal identifiers. |
QuotesClassicApi | getById8 | GET /quotes/{quoteId} | Returns quote details. |
QuotesClassicApi | getCustomFields6 | GET /quotes/{quoteId}/customFields | Returns custom fields of a given quote. |
QuotesClassicApi | getDates2 | GET /quotes/{quoteId}/dates | Returns dates of a given quote. |
QuotesClassicApi | getFinance1 | GET /quotes/{quoteId}/finance | Returns finance of a given quote. |
QuotesClassicApi | send1 | POST /quotes/{quoteId}/confirmation/send | Sends a quote for customer confirmation. |
QuotesClassicApi | start | POST /quotes/{quoteId}/start | Starts a quote. |
QuotesClassicApi | updateCustomFields | PUT /quotes/{quoteId}/customFields | Updates custom fields of a given quote. |
QuotesSmartV2Api | addFiles2 | PUT /v2/quotes/{quoteId}/files/add | Adds files to the quote as added by PM. |
QuotesSmartV2Api | archive1 | POST /v2/quotes/files/archive | Prepares a ZIP archive that contains the specified files. |
QuotesSmartV2Api | changeStatus2 | PUT /v2/quotes/{quoteId}/status | Changes quote status if possible (400 Bad Request is returned otherwise). |
QuotesSmartV2Api | create3 | POST /v2/quotes | Creates a new Smart Quote. |
QuotesSmartV2Api | createPayable1 | POST /v2/quotes/{quoteId}/finance/payables | Adds a payable to a quote. |
QuotesSmartV2Api | createReceivable1 | POST /v2/quotes/{quoteId}/finance/receivables | Adds a receivable to a quote. |
QuotesSmartV2Api | deletePayable | DELETE /v2/quotes/{quoteId}/finance/payables/{payableId} | Deletes a payable. |
QuotesSmartV2Api | deleteReceivable | DELETE /v2/quotes/{quoteId}/finance/receivables/{receivableId} | Deletes a receivable. |
QuotesSmartV2Api | getById10 | GET /v2/quotes/{quoteId} | Returns quote details. |
QuotesSmartV2Api | getContacts3 | GET /v2/quotes/{quoteId}/clientContacts | Returns Client Contacts information for a quote. |
QuotesSmartV2Api | getCustomFields9 | GET /v2/quotes/{quoteId}/customFields | Returns a list of custom field keys and values for a project. |
QuotesSmartV2Api | getFileById2 | GET /v2/quotes/files/{fileId} | Returns details of a file. |
QuotesSmartV2Api | getFileContentById1 | GET /v2/quotes/files/{fileId}/download/{fileName} | Downloads a file content. |
QuotesSmartV2Api | getFiles1 | GET /v2/quotes/{quoteId}/files | Returns list of files in a quote. |
QuotesSmartV2Api | getFinance3 | GET /v2/quotes/{quoteId}/finance | Returns finance information for a quote. |
QuotesSmartV2Api | getJobs1 | GET /v2/quotes/{quoteId}/jobs | Returns list of jobs in a quote. |
QuotesSmartV2Api | updateBusinessDays | PUT /v2/quotes/{quoteId}/businessDays | Updates Business Days for a quote. |
QuotesSmartV2Api | updateClientNotes1 | PUT /v2/quotes/{quoteId}/clientNotes | Updates Client Notes for a quote. |
QuotesSmartV2Api | updateClientReferenceNumber1 | PUT /v2/quotes/{quoteId}/clientReferenceNumber | Updates Client Reference Number for a quote. |
QuotesSmartV2Api | updateContacts | PUT /v2/quotes/{quoteId}/clientContacts | Updates Client Contacts for a quote. |
QuotesSmartV2Api | updateCustomField1 | PUT /v2/quotes/{quoteId}/customFields/{key} | Updates a custom field with a specified key in a quote. |
QuotesSmartV2Api | updateExpectedDeliveryDate | PUT /v2/quotes/{quoteId}/expectedDeliveryDate | Updates Expected Delivery Date for a quote. |
QuotesSmartV2Api | updateInternalNotes1 | PUT /v2/quotes/{quoteId}/internalNotes | Updates Internal Notes for a quote. |
QuotesSmartV2Api | updatePayable1 | PUT /v2/quotes/{quoteId}/finance/payables/{payableId} | Updates a payable. |
QuotesSmartV2Api | updateQuoteExpiry | PUT /v2/quotes/{quoteId}/quoteExpiry | Updates Quote Expiry Date for a quote. |
QuotesSmartV2Api | updateReceivable1 | PUT /v2/quotes/{quoteId}/finance/receivables/{receivableId} | Updates a receivable. |
QuotesSmartV2Api | updateSourceLanguage1 | PUT /v2/quotes/{quoteId}/sourceLanguage | Updates source language for a quote. |
QuotesSmartV2Api | updateSpecialization1 | PUT /v2/quotes/{quoteId}/specialization | Updates specialization for a quote. |
QuotesSmartV2Api | updateTargetLanguages1 | PUT /v2/quotes/{quoteId}/targetLanguages | Updates target languages for a quote. |
QuotesSmartV2Api | updateVendorInstructions1 | PUT /v2/quotes/{quoteId}/vendorInstructions | Updates instructions for all vendors performing the jobs in a quote. |
QuotesSmartV2Api | updateVolume1 | PUT /v2/quotes/{quoteId}/volume | Updates volume for a quote. |
QuotesSmartV2Api | uploadFile3 | POST /v2/quotes/{quoteId}/files/upload | Uploads file to the quote as a file uploaded by PM. |
ReportsApi | delete4 | DELETE /reports/{reportId} | Removes a report. |
ReportsApi | duplicate1 | POST /reports/{reportId}/duplicate | Duplicates a report. |
ReportsApi | exportToXML | POST /reports/export/xml | Exports reports definition to XML. |
ReportsApi | generateCSV | GET /reports/{reportId}/result/csv | Generates CSV content for a report. |
ReportsApi | generatePrinterFriendly | GET /reports/{reportId}/result/printerFriendly | Generates printer friendly content for a report. |
ReportsApi | importFromXML | POST /reports/import/xml | Imports reports definition from XML. |
ReportsApi | setPreferred | PUT /reports/{reportId}/preferred | Marks report as preferred or not. |
SubscriptionApi | areHooksSupported | GET /subscription/supports | This method can be used to determine if hooks are supported. |
SubscriptionApi | getAll4 | GET /subscription | Returns all subscriptions |
SubscriptionApi | subscribe | POST /subscription | Subscribe to event |
SubscriptionApi | unsubscribe | DELETE /subscription/{subscriptionId} | Unsubscribe from event |
TasksClassicApi | addFile | POST /tasks/{taskId}/files/input | Adds files to a given task. |
TasksClassicApi | delete5 | DELETE /tasks/{taskId} | Removes a task. |
TasksClassicApi | getContacts1 | GET /tasks/{taskId}/contacts | Returns contacts of a given task. |
TasksClassicApi | getCustomFields7 | GET /tasks/{taskId}/customFields | Returns custom fields of a given task. |
TasksClassicApi | getDates3 | GET /tasks/{taskId}/dates | Returns dates of a given task. |
TasksClassicApi | getInstructions1 | GET /tasks/{taskId}/instructions | Returns instructions of a given task. |
TasksClassicApi | getProgress | GET /tasks/{taskId}/progress | Returns progress of a given task. |
TasksClassicApi | start1 | POST /tasks/{taskId}/start | Starts a task. |
TasksClassicApi | updateClientTaskPONumber | PUT /tasks/{taskId}/clientTaskPONumber | Updates Client Task PO Number of a given task. |
TasksClassicApi | updateContacts | PUT /tasks/{taskId}/contacts | Updates contacts of a given task. |
TasksClassicApi | updateCustomFields | PUT /tasks/{taskId}/customFields | Updates custom fields of a given task. |
TasksClassicApi | updateDates | PUT /tasks/{taskId}/dates | Updates dates of a given task. |
TasksClassicApi | updateInstructions | PUT /tasks/{taskId}/instructions | Updates instructions of a given task. |
TasksClassicApi | updateName | PUT /tasks/{taskId}/name | Updates name of a given task. |
UsersApi | changePassword | PUT /users/{userId}/password | Sets user's password to a new value. |
UsersApi | getAllNamesWithIds1 | GET /users | Returns list of simple users representations |
UsersApi | getById6 | GET /users/{userId} | Returns user details. |
UsersApi | getCustomField1 | GET /users/{userId}/customFields/{customFieldKey} | Returns custom field of a given user. |
UsersApi | getCustomFields4 | GET /users/{userId}/customFields | Returns custom fields of a given user. |
UsersApi | getMe | GET /users/me | Returns currently signed in user details. |
UsersApi | update | PUT /users/{userId} | Updates an existing user. |
UsersApi | updateCustomField | PUT /users/{userId}/customFields/{customFieldKey} | Updates given custom field of a given user. |
UsersApi | updateCustomFields | PUT /users/{userId}/customFields | Updates custom fields of a given user. |
VendorInvoicesApi | create1 | POST /accounting/providers/invoices | Creates a new invoice. |
VendorInvoicesApi | createPayment | POST /accounting/providers/invoices/{invoiceId}/payments | Creates a new payment on the vendor account and assigns the payment to the invoice. |
VendorInvoicesApi | delete2 | DELETE /accounting/providers/invoices/{invoiceId} | Removes a provider invoice. |
VendorInvoicesApi | delete2_0 | DELETE /accounting/providers/payments/{paymentId} | Removes a provider payment. |
VendorInvoicesApi | getAll2 | GET /accounting/providers/invoices | Lists all vendor invoices in all statuses (including not ready and drafts) that have been updated since a specific date. |
VendorInvoicesApi | getAllIds3 | GET /accounting/providers/invoices/ids | Returns vendor invoices' internal identifiers. |
VendorInvoicesApi | getById3 | GET /accounting/providers/invoices/{invoiceId} | Returns provider invoice details. |
VendorInvoicesApi | getDocument1 | GET /accounting/providers/invoices/{invoiceId}/document | Generates provider invoice document (PDF). |
VendorInvoicesApi | getPayments1 | GET /accounting/providers/invoices/{invoiceId}/payments | Returns all payments for the vendor invoice. |
VendorInvoicesApi | send | POST /accounting/providers/invoices/{invoiceId}/send | Sends a provider invoice. |
VendorInvoicesApi | setStatus | POST /accounting/providers/invoices/{invoiceId}/status | Changes invoice status to given status. |
VendorsApi | delete3 | DELETE /providers/persons/{personId} | Removes a person. |
VendorsApi | delete3_0 | DELETE /providers/priceLists/{priceListId} | Removes a provider price list. |
VendorsApi | delete4 | DELETE /providers/{providerId} | Removes a provider. |
VendorsApi | getAddress1 | GET /providers/{providerId}/address | Returns address of a given provider. |
VendorsApi | getAllIds4 | GET /providers/persons/ids | Returns persons' internal identifiers. |
VendorsApi | getAllIds5 | GET /providers/ids | Returns providers' internal identifiers. |
VendorsApi | getById4 | GET /providers/persons/{personId} | Returns person details. |
VendorsApi | getById5 | GET /providers/{providerId} | Returns provider details. |
VendorsApi | getCompetencies | GET /providers/{providerId}/competencies | Returns competencies of a given provider. |
VendorsApi | getContact2 | GET /providers/persons/{personId}/contact | Returns contact of a given person. |
VendorsApi | getContact3 | GET /providers/{providerId}/contact | Returns contact of a given provider. |
VendorsApi | getCorrespondenceAddress1 | GET /providers/{providerId}/correspondenceAddress | Returns correspondence address of a given provider. |
VendorsApi | getCustomFields2 | GET /providers/persons/{personId}/customFields | Returns custom fields of a given person. |
VendorsApi | getCustomFields3 | GET /providers/{providerId}/customFields | Returns custom fields of a given provider. |
VendorsApi | sendInvitations | POST /providers/persons/{personId}/notification/invitation | Sends invitation to Vendor Portal. |
VendorsApi | sendInvitations1 | POST /providers/{providerId}/notification/invitation | Sends invitations to Vendor Portal. |
- AccessDTO
- AccessTokenDTO
- AccessTokenRequestDTO
- ActionDTO
- ActionStartedDTO
- ActiveSubscriptionDTO
- AddressDTO
- BigDecimalDTO
- Body
- BodyPart
- CATToolProjectDTO
- CalculationUnitDTO
- CategoriesDTO
- CategoryDTO
- ChargeDTO
- ChargeLanguageCombinationDTO
- ColumnDTO
- CompetenciesDTO
- ContactDTO
- ContactsDTO
- ContentDisposition
- CountryDTO
- CurrencyDTO
- CustomFieldDTO
- CustomFieldsDTO
- CustomerAccountingDTO
- CustomerContactEmailsDTO
- CustomerDTO
- CustomerDetailsDTO
- CustomerInvoiceCreateDTO
- CustomerInvoiceCreateResultDTO
- CustomerInvoiceDTO
- CustomerInvoiceDatesDTO
- CustomerPersonDTO
- CustomerResponsiblePersonsDTO
- CustomerTaxNoDTO
- DictionaryEntity
- DocumentsDTO
- DownloadDocumentsRequestDTO
- EntityWithNameDTO
- Event
- EventsQueue
- ExportRequestDTO
- FileCategorizationDto
- FileCategorizationsDto
- FileDTO
- FileDto
- FileLinkCategorizationDto
- FileLinkCategorizationsDto
- FileShareStatusDto
- FilesArchiveDto
- FilesDto
- FilesShareStatusDto
- FilterDTO
- FilterPropertyDTO
- FinanceDTO
- FormDataBodyPart
- FormDataContentDisposition
- FormDataMultiPart
- FormDataMultiPartMediaType
- GetLicenseResult
- Identifier
- ImportRequestDTO
- ImportResultDTO
- IndustriesDTO
- IndustryDTO
- InstructionsDTO
- InvitationStatisticsDTO
- JobCommunicationDto
- JobDatesDto
- JobDocumentsDto
- JobDto
- JobFilesDto
- JobLanguageCombinationDto
- JobStatusDTO
- JobTypeDTO
- JsonNode
- LanguageCombinationDTO
- LanguageCombinationDto
- LanguageDTO
- LanguageRelationDto
- LanguageSpecializationDTO
- LastModificationDTO
- LeadSourceDTO
- LocalSettingsDTO
- LongDTO
- MacroRequestDTO
- ManyValuesPerTypeDTO
- MessageBodyWorkers
- MultiPart
- OrderDTO
- Parameter
- ParameterizedHeader
- PayableCreateDTO
- PayableDTO
- PaymentDTO
- PaymentTermsDTO
- PeopleDTO
- PermissionsDTO
- PersonContactDTO
- PersonContactEmailsDTO
- PersonDepartmentDTO
- PersonPositionDTO
- PreferredRequestDTO
- ProjectCreateDTO
- ProjectDTO
- ProjectDatesDTO
- ProjectFileAddedByDto
- ProjectFileDto
- ProjectLanguagesDTO
- ProjectStatusDTO
- ProviderDTO
- ProviderInvoiceCreateDTO
- ProviderInvoiceCreateResultDTO
- ProviderInvoiceDTO
- ProviderInvoiceDatesDTO
- ProviderPersonDTO
- ProvinceDTO
- QuoteCreateDTO
- QuoteDTO
- QuoteDatesDTO
- ReceivableCreateDTO
- ReceivableDTO
- RemoteCATToolReferencesDto
- ReportResultDTO
- ResponsiblePersonsDTO
- SendRemindersRequestDTO
- SendRemindersResponseDTO
- ServiceDTO
- SettingsDTO
- SmartContactsDTO
- SmartCustomFieldDTO
- SourceLanguageDTO
- SpecializationDTO
- StatusRequestDTO
- StepTypeDto
- StepTypeSemanticsDto
- StringDTO
- SubscriptionDTO
- TargetLanguagesDTO
- TaskCreateDTO
- TaskDTO
- TaskFileDTO
- TaskFinanceDTO
- TaskProgressDTO
- TimeDTO
- UploadedFileInfo
- UrlResultDTO
- UserDTO
- VendorPriceProfileDTO
- ViewBriefDTO
- ViewDTO
- ViewDetailsDTO
- ViewWithIdDTO
- ViewsBriefDTO
- VolumeDTO
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: X-AUTH-ACCESS-TOKEN
- Location: HTTP header
It's recommended to create an instance of ApiClient
per thread in a multithreaded environment to avoid any potential issues.