Skip to content

Latest commit

 

History

History
77 lines (54 loc) · 3.08 KB

SearchApi.md

File metadata and controls

77 lines (54 loc) · 3.08 KB
Raw

phrase_api.SearchApi

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

Method HTTP request Description
search_in_account POST /accounts/{account_id}/search Search across projects

search_in_account

AccountSearchResult search_in_account(account_id, search_in_account_parameters, x_phrase_app_otp=x_phrase_app_otp)

Search across projects

Search for keys and translations in all account projects

Note: Search is limited to 10000 results and may not include recently updated data depending on the project sizes.

Example

from __future__ import print_function
import time
import phrase_api
from phrase_api.rest import ApiException
from pprint import pprint

configuration = phrase_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'token'

# Enter a context with an instance of the API client
with phrase_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrase_api.SearchApi(api_client)
    account_id = 'account_id_example' # str | Account ID (required)
    search_in_account_parameters = phrase_api.SearchInAccountParameters() # SearchInAccountParameters |  (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)

    try:
        # Search across projects
        api_response = api_instance.search_in_account(account_id, search_in_account_parameters, x_phrase_app_otp=x_phrase_app_otp)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SearchApi->search_in_account: %s\n" % e)

Parameters

Name Type Description Notes
account_id str Account ID
search_in_account_parameters SearchInAccountParameters
x_phrase_app_otp str Two-Factor-Authentication token (optional) [optional]

Return type

AccountSearchResult

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 -
* 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 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]