Skip to content

Latest commit

 

History

History
860 lines (632 loc) · 28.1 KB

ProjectsClassicApi.md

File metadata and controls

860 lines (632 loc) · 28.1 KB

ProjectsClassicApi

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

Method HTTP request Description
create1 POST /projects Creates a new Classic Project.
createLanguageCombination POST /projects/{projectId}/languageCombinations Creates a new language combination for a given project without creating a task.
createTask POST /projects/{projectId}/tasks Creates a new task for a given project.
delete5 DELETE /projects/{projectId} Removes a project.
getAllIds6 GET /projects/ids Returns projects' internal identifiers.
getById7 GET /projects/{projectId} Returns project details.
getContacts GET /projects/{projectId}/contacts Returns contacts of a given project.
getCustomFields5 GET /projects/{projectId}/customFields Returns custom fields of a given project.
getDates1 GET /projects/{projectId}/dates Returns dates of a given project.
getFinance GET /projects/{projectId}/finance Returns finance of a given project.
getInstructions GET /projects/{projectId}/instructions Returns instructions of a given project.
updateContacts PUT /projects/{projectId}/contacts Updates contacts of a given project.
updateCustomFields PUT /projects/{projectId}/customFields Updates custom fields of a given project.
updateDates PUT /projects/{projectId}/dates Updates dates of a given project.
updateInstructions PUT /projects/{projectId}/instructions Updates instructions of a given project.

create1

ProjectDTO create1(body)

Creates a new Classic Project.

Creates a new Classic Project. If the specified service ID refers to Smart Project, 400 Bad Request is returned instead.

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

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

ProjectsClassicApi apiInstance = new ProjectsClassicApi();
ProjectCreateDTO body = new ProjectCreateDTO(); // ProjectCreateDTO | Created a new Classic Project.
try {
    ProjectDTO result = apiInstance.create1(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectsClassicApi#create1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body ProjectCreateDTO Created a new Classic Project.

Return type

ProjectDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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

createLanguageCombination

LanguageCombinationDTO createLanguageCombination(body, projectId)

Creates a new language combination for a given project without creating a task.

Creates a new language combination for a given project without creating a task.

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

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

ProjectsClassicApi apiInstance = new ProjectsClassicApi();
LanguageCombinationDTO body = new LanguageCombinationDTO(); // LanguageCombinationDTO | Created language combination for a given project without creating a task.
String projectId = "projectId_example"; // String | project's internal identifier
try {
    LanguageCombinationDTO result = apiInstance.createLanguageCombination(body, projectId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectsClassicApi#createLanguageCombination");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body LanguageCombinationDTO Created language combination for a given project without creating a task.
projectId String project's internal identifier

Return type

LanguageCombinationDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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

createTask

TaskDTO createTask(body, projectId)

Creates a new task for a given project.

Creates a new task for a given project. Required fields are presented in the example.

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

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

ProjectsClassicApi apiInstance = new ProjectsClassicApi();
TaskDTO body = new TaskDTO(); // TaskDTO | Created new task for a given project.
String projectId = "projectId_example"; // String | project's internal identifier
try {
    TaskDTO result = apiInstance.createTask(body, projectId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectsClassicApi#createTask");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body TaskDTO Created new task for a given project.
projectId String project's internal identifier

Return type

TaskDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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

delete5

delete5(projectId)

Removes a project.

Removes a project.

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

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

ProjectsClassicApi apiInstance = new ProjectsClassicApi();
String projectId = "projectId_example"; // String | project's internal identifier
try {
    apiInstance.delete5(projectId);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectsClassicApi#delete5");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
projectId String project's internal identifier

Return type

null (empty response body)

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getAllIds6

List<Integer> getAllIds6(updatedSince)

Returns projects' internal identifiers.

Returns projects' internal identifiers.

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

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

ProjectsClassicApi apiInstance = new ProjectsClassicApi();
Long updatedSince = 789L; // Long | only projects modified since this timestamp
try {
    List<Integer> result = apiInstance.getAllIds6(updatedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectsClassicApi#getAllIds6");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
updatedSince Long only projects modified since this timestamp [optional]

Return type

List<Integer>

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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

getById7

ProjectDTO getById7(projectId, embed)

Returns project details.

Returns project details. If the specified project ID refers to Smart Project, 400 Bad Request is returned instead.

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

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

ProjectsClassicApi apiInstance = new ProjectsClassicApi();
String projectId = "projectId_example"; // String | project's internal identifier
String embed = "embed_example"; // String | list of adittional fields which should be embedded in the response (ie. tasks)
try {
    ProjectDTO result = apiInstance.getById7(projectId, embed);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectsClassicApi#getById7");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
projectId String project's internal identifier
embed String list of adittional fields which should be embedded in the response (ie. tasks) [optional]

Return type

ProjectDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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

getContacts

ContactsDTO getContacts(projectId)

Returns contacts of a given project.

Returns contacts of a given project.

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

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

ProjectsClassicApi apiInstance = new ProjectsClassicApi();
String projectId = "projectId_example"; // String | project's internal identifier
try {
    ContactsDTO result = apiInstance.getContacts(projectId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectsClassicApi#getContacts");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
projectId String project's internal identifier

Return type

ContactsDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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

getCustomFields5

CustomFieldsDTO getCustomFields5(projectId)

Returns custom fields of a given project.

Returns custom fields of a given project.

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

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

ProjectsClassicApi apiInstance = new ProjectsClassicApi();
String projectId = "projectId_example"; // String | project's internal identifier
try {
    CustomFieldsDTO result = apiInstance.getCustomFields5(projectId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectsClassicApi#getCustomFields5");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
projectId String project's internal identifier

Return type

CustomFieldsDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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

getDates1

ProjectDatesDTO getDates1(projectId)

Returns dates of a given project.

Returns dates of a given project.

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

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

ProjectsClassicApi apiInstance = new ProjectsClassicApi();
String projectId = "projectId_example"; // String | project's internal identifier
try {
    ProjectDatesDTO result = apiInstance.getDates1(projectId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectsClassicApi#getDates1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
projectId String project's internal identifier

Return type

ProjectDatesDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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

getFinance

FinanceDTO getFinance(projectId)

Returns finance of a given project.

Returns finance of a given project.

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

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

ProjectsClassicApi apiInstance = new ProjectsClassicApi();
String projectId = "projectId_example"; // String | project's internal identifier
try {
    FinanceDTO result = apiInstance.getFinance(projectId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectsClassicApi#getFinance");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
projectId String project's internal identifier

Return type

FinanceDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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

getInstructions

InstructionsDTO getInstructions(projectId)

Returns instructions of a given project.

Returns instructions of a given project.

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

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

ProjectsClassicApi apiInstance = new ProjectsClassicApi();
String projectId = "projectId_example"; // String | project's internal identifier
try {
    InstructionsDTO result = apiInstance.getInstructions(projectId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectsClassicApi#getInstructions");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
projectId String project's internal identifier

Return type

InstructionsDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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

updateContacts

ContactsDTO updateContacts(body, projectId)

Updates contacts of a given project.

Updates contacts of a given project.

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

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

ProjectsClassicApi apiInstance = new ProjectsClassicApi();
ContactsDTO body = new ContactsDTO(); // ContactsDTO | Updated contacts of a given project.
String projectId = "projectId_example"; // String | project's internal identifier
try {
    ContactsDTO result = apiInstance.updateContacts(body, projectId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectsClassicApi#updateContacts");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body ContactsDTO Updated contacts of a given project.
projectId String project's internal identifier

Return type

ContactsDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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

updateCustomFields

CustomFieldsDTO updateCustomFields(body, projectId)

Updates custom fields of a given project.

Updates custom fields of a given project.

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

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

ProjectsClassicApi apiInstance = new ProjectsClassicApi();
List<CustomFieldDTO> body = Arrays.asList(new CustomFieldDTO()); // List<CustomFieldDTO> | Updated custom fields of a given project.
String projectId = "projectId_example"; // String | project's internal identifier
try {
    CustomFieldsDTO result = apiInstance.updateCustomFields(body, projectId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectsClassicApi#updateCustomFields");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body List<CustomFieldDTO> Updated custom fields of a given project.
projectId String project's internal identifier

Return type

CustomFieldsDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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

updateDates

ProjectDatesDTO updateDates(body, projectId)

Updates dates of a given project.

Updates dates of a given project.

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

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

ProjectsClassicApi apiInstance = new ProjectsClassicApi();
ProjectDatesDTO body = new ProjectDatesDTO(); // ProjectDatesDTO | Updated dates of a given project..
String projectId = "projectId_example"; // String | project's internal identifier
try {
    ProjectDatesDTO result = apiInstance.updateDates(body, projectId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectsClassicApi#updateDates");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body ProjectDatesDTO Updated dates of a given project..
projectId String project's internal identifier

Return type

ProjectDatesDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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

updateInstructions

InstructionsDTO updateInstructions(body, projectId)

Updates instructions of a given project.

Updates instructions of a given project.

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

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

ProjectsClassicApi apiInstance = new ProjectsClassicApi();
InstructionsDTO body = new InstructionsDTO(); // InstructionsDTO | Updated instructions of a given project.
String projectId = "projectId_example"; // String | project's internal identifier
try {
    InstructionsDTO result = apiInstance.updateInstructions(body, projectId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectsClassicApi#updateInstructions");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body InstructionsDTO Updated instructions of a given project.
projectId String project's internal identifier

Return type

InstructionsDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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