VariablesApi

All URIs are relative to https://api.phrase.com/v2

Method	HTTP request	Description
variableCreate	POST /projects/{project_id}/variables	Create a variable
variableDelete	DELETE /projects/{project_id}/variables/{name}	Delete a variable
variableShow	GET /projects/{project_id}/variables/{name}	Get a single variable
variableUpdate	PATCH /projects/{project_id}/variables/{name}	Update a variable
variablesList	GET /projects/{project_id}/variables	List variables

variableCreate

Variable variableCreate(projectId, variableCreateParameters, xPhraseAppOTP)

Create a variable

Create a new variable.

Example

// Import classes:
import com.phrase.client.ApiClient;
import com.phrase.client.ApiException;
import com.phrase.client.Configuration;
import com.phrase.client.auth.*;
import com.phrase.client.models.*;
import com.phrase.client.api.VariablesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.phrase.com/v2");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    // Configure API key authorization: Token
    ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token");
    Token.setApiKey("YOUR API KEY");
    Token.setApiKeyPrefix("token");

    VariablesApi apiInstance = new VariablesApi(defaultClient);
    String projectId = "projectId_example"; // String | Project ID
    VariableCreateParameters variableCreateParameters = new VariableCreateParameters(); // VariableCreateParameters | 
    String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional)
    try {
      Variable result = apiInstance.variableCreate(projectId, variableCreateParameters, xPhraseAppOTP);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VariablesApi#variableCreate");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
projectId	String	Project ID
variableCreateParameters	VariableCreateParameters
xPhraseAppOTP	String	Two-Factor-Authentication token (optional)	[optional]

Return type

Variable

Authorization

Basic, Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
400	Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
401	Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry.	-
403	Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not found. The requested resource does not exist or is not visible to the authenticated user. Verify the identifiers in the request path and that the token has access to them, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
422	Unprocessable entity. The request was well-formed but failed validation. The response body lists each offending field in the `errors` array, with its resource, field, and a human-readable message. Correct the listed fields and retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Too many requests. The rate limit has been exceeded. Wait until the time indicated by the `X-Rate-Limit-Reset` response header before retrying.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

variableDelete

variableDelete(projectId, name, xPhraseAppOTP)

Delete a variable

Delete an existing variable.

Example

// Import classes:
import com.phrase.client.ApiClient;
import com.phrase.client.ApiException;
import com.phrase.client.Configuration;
import com.phrase.client.auth.*;
import com.phrase.client.models.*;
import com.phrase.client.api.VariablesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.phrase.com/v2");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    // Configure API key authorization: Token
    ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token");
    Token.setApiKey("YOUR API KEY");
    Token.setApiKeyPrefix("token");

    VariablesApi apiInstance = new VariablesApi(defaultClient);
    String projectId = "projectId_example"; // String | Project ID
    String name = "name_example"; // String | name
    String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional)
    try {
      apiInstance.variableDelete(projectId, name, xPhraseAppOTP);
    } catch (ApiException e) {
      System.err.println("Exception when calling VariablesApi#variableDelete");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
projectId	String	Project ID
name	String	name
xPhraseAppOTP	String	Two-Factor-Authentication token (optional)	[optional]

Return type

null (empty response body)

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	The resource was deleted successfully.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
400	Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
401	Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry.	-
403	Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not found. The requested resource does not exist or is not visible to the authenticated user. Verify the identifiers in the request path and that the token has access to them, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
422	Unprocessable entity. The request was well-formed but failed validation. The response body lists each offending field in the `errors` array, with its resource, field, and a human-readable message. Correct the listed fields and retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Too many requests. The rate limit has been exceeded. Wait until the time indicated by the `X-Rate-Limit-Reset` response header before retrying.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

variableShow

Variable variableShow(projectId, name, xPhraseAppOTP)

Get a single variable

Get details on a single variable for a given project.

Example

// Import classes:
import com.phrase.client.ApiClient;
import com.phrase.client.ApiException;
import com.phrase.client.Configuration;
import com.phrase.client.auth.*;
import com.phrase.client.models.*;
import com.phrase.client.api.VariablesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.phrase.com/v2");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    // Configure API key authorization: Token
    ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token");
    Token.setApiKey("YOUR API KEY");
    Token.setApiKeyPrefix("token");

    VariablesApi apiInstance = new VariablesApi(defaultClient);
    String projectId = "projectId_example"; // String | Project ID
    String name = "name_example"; // String | name
    String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional)
    try {
      Variable result = apiInstance.variableShow(projectId, name, xPhraseAppOTP);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VariablesApi#variableShow");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
projectId	String	Project ID
name	String	name
xPhraseAppOTP	String	Two-Factor-Authentication token (optional)	[optional]

Return type

Variable

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
400	Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
401	Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry.	-
403	Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not found. The requested resource does not exist or is not visible to the authenticated user. Verify the identifiers in the request path and that the token has access to them, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Too many requests. The rate limit has been exceeded. Wait until the time indicated by the `X-Rate-Limit-Reset` response header before retrying.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

variableUpdate

Variable variableUpdate(projectId, name, variableUpdateParameters, xPhraseAppOTP)

Update a variable

Update an existing variable.

Example

// Import classes:
import com.phrase.client.ApiClient;
import com.phrase.client.ApiException;
import com.phrase.client.Configuration;
import com.phrase.client.auth.*;
import com.phrase.client.models.*;
import com.phrase.client.api.VariablesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.phrase.com/v2");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    // Configure API key authorization: Token
    ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token");
    Token.setApiKey("YOUR API KEY");
    Token.setApiKeyPrefix("token");

    VariablesApi apiInstance = new VariablesApi(defaultClient);
    String projectId = "projectId_example"; // String | Project ID
    String name = "name_example"; // String | name
    VariableUpdateParameters variableUpdateParameters = new VariableUpdateParameters(); // VariableUpdateParameters | 
    String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional)
    try {
      Variable result = apiInstance.variableUpdate(projectId, name, variableUpdateParameters, xPhraseAppOTP);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VariablesApi#variableUpdate");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
projectId	String	Project ID
name	String	name
variableUpdateParameters	VariableUpdateParameters
xPhraseAppOTP	String	Two-Factor-Authentication token (optional)	[optional]

Return type

Variable

Authorization

Basic, Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
400	Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
401	Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry.	-
403	Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not found. The requested resource does not exist or is not visible to the authenticated user. Verify the identifiers in the request path and that the token has access to them, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
422	Unprocessable entity. The request was well-formed but failed validation. The response body lists each offending field in the `errors` array, with its resource, field, and a human-readable message. Correct the listed fields and retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Too many requests. The rate limit has been exceeded. Wait until the time indicated by the `X-Rate-Limit-Reset` response header before retrying.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

variablesList

List<Variable> variablesList(projectId, xPhraseAppOTP, page, perPage)

List variables

List all variables for the current project.

Example

// Import classes:
import com.phrase.client.ApiClient;
import com.phrase.client.ApiException;
import com.phrase.client.Configuration;
import com.phrase.client.auth.*;
import com.phrase.client.models.*;
import com.phrase.client.api.VariablesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.phrase.com/v2");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    // Configure API key authorization: Token
    ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token");
    Token.setApiKey("YOUR API KEY");
    Token.setApiKeyPrefix("token");

    VariablesApi apiInstance = new VariablesApi(defaultClient);
    String projectId = "projectId_example"; // String | Project ID
    String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional)
    Integer page = 1; // Integer | Page number
    Integer perPage = 25; // Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
    try {
      List<Variable> result = apiInstance.variablesList(projectId, xPhraseAppOTP, page, perPage);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VariablesApi#variablesList");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
projectId	String	Project ID
xPhraseAppOTP	String	Two-Factor-Authentication token (optional)	[optional]
page	Integer	Page number	[optional]
perPage	Integer	Limit on the number of objects to be returned, between 1 and 100. 25 by default	[optional]

Return type

List<Variable>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset - * Link - * Pagination -
400	Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
401	Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry.	-
403	Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not found. The requested resource does not exist or is not visible to the authenticated user. Verify the identifiers in the request path and that the token has access to them, then retry.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Too many requests. The rate limit has been exceeded. Wait until the time indicated by the `X-Rate-Limit-Reset` response header before retrying.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

VariablesApi

variableCreate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

variableDelete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

variableShow

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

variableUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

variablesList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Uh oh!

FilesExpand file tree

VariablesApi.md

Latest commit

History

VariablesApi.md

File metadata and controls

VariablesApi

variableCreate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

variableDelete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

variableShow

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

variableUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

variablesList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details