TagsApi

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

Method	HTTP request	Description
tagCreate	POST /projects/{project_id}/tags	Create a tag
tagDelete	DELETE /projects/{project_id}/tags/{name}	Delete a tag
tagShow	GET /projects/{project_id}/tags/{name}	Get a single tag
tagsList	GET /projects/{project_id}/tags	List tags

tagCreate

TagWithStats tagCreate(projectId, tagCreateParameters, xPhraseAppOTP)

Create a tag

Create a new tag.

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

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

    TagsApi apiInstance = new TagsApi(defaultClient);
    String projectId = "projectId_example"; // String | Project ID
    TagCreateParameters tagCreateParameters = new TagCreateParameters(); // TagCreateParameters | 
    String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional)
    try {
      TagWithStats result = apiInstance.tagCreate(projectId, tagCreateParameters, xPhraseAppOTP);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TagsApi#tagCreate");
      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
tagCreateParameters	TagCreateParameters
xPhraseAppOTP	String	Two-Factor-Authentication token (optional)	[optional]

Return type

TagWithStats

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	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not Found	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Rate Limiting	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

tagDelete

tagDelete(projectId, name, xPhraseAppOTP, branch)

Delete a tag

Delete an existing tag.

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

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

    TagsApi apiInstance = new TagsApi(defaultClient);
    String projectId = "projectId_example"; // String | Project ID
    String name = "name_example"; // String | name
    String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional)
    String branch = "my-feature-branch"; // String | specify the branch to use
    try {
      apiInstance.tagDelete(projectId, name, xPhraseAppOTP, branch);
    } catch (ApiException e) {
      System.err.println("Exception when calling TagsApi#tagDelete");
      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]
branch	String	specify the branch to use	[optional]

Return type

null (empty response body)

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not Found	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Rate Limiting	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

tagShow

TagWithStats tagShow(projectId, name, xPhraseAppOTP, branch)

Get a single tag

Get details and progress information on a single tag 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.TagsApi;

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

    TagsApi apiInstance = new TagsApi(defaultClient);
    String projectId = "projectId_example"; // String | Project ID
    String name = "name_example"; // String | name
    String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional)
    String branch = "my-feature-branch"; // String | specify the branch to use
    try {
      TagWithStats result = apiInstance.tagShow(projectId, name, xPhraseAppOTP, branch);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TagsApi#tagShow");
      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]
branch	String	specify the branch to use	[optional]

Return type

TagWithStats

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	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not Found	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Rate Limiting	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

tagsList

List<Tag> tagsList(projectId, xPhraseAppOTP, page, perPage, excludeSystemTags, branch)

List tags

List all tags for the 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.TagsApi;

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

    TagsApi apiInstance = new TagsApi(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
    Boolean excludeSystemTags = true; // Boolean | excludes tags generated by the system, e.g. job, upload or figma tags
    String branch = "my-feature-branch"; // String | specify the branch to use
    try {
      List<Tag> result = apiInstance.tagsList(projectId, xPhraseAppOTP, page, perPage, excludeSystemTags, branch);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TagsApi#tagsList");
      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]
excludeSystemTags	Boolean	excludes tags generated by the system, e.g. job, upload or figma tags	[optional]
branch	String	specify the branch to use	[optional]

Return type

List<Tag>

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	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not Found	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Rate Limiting	* 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

TagsApi.md

TagsApi.md

TagsApi

tagCreate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

tagDelete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

tagShow

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

tagsList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Files

TagsApi.md

Latest commit

History

TagsApi.md

File metadata and controls

TagsApi

tagCreate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

tagDelete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

tagShow

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

tagsList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details