clientapi_atrocore.TranslationApi

All URIs are relative to https://demo.atropim.com/api/v1

Method	HTTP request	Description
add_relation_for_translation	POST /Translation/{link}/relation	Add relation for Translation
create_translation_item	POST /Translation	Create a record of the Translation
delete_translation_item	DELETE /Translation/{id}	Delete a record of the Translation
follow_translation	PUT /Translation/{id}/subscription	Follow the Translation stream
get_linked_items_for_translation_item	GET /Translation/{id}/{link}	Returns linked entities for the Translation
get_list_of_translation_items	GET /Translation	Returns a collection of Translation records
get_translation_item	GET /Translation/{id}	Returns a record of the Translation
link_translation	POST /Translation/{id}/{link}	Link Translation to Entities
mass_delete_translation	POST /Translation/action/massDelete	Mass delete of Translation data
mass_update_translation	PUT /Translation/action/massUpdate	Mass update of Translation data
remove_relation_for_translation	DELETE /Translation/{link}/relation	Remove relation for Translation
unfollow_translation	DELETE /Translation/{id}/subscription	Unfollow the Translation stream
unlink_translation	DELETE /Translation/{id}/{link}	Unlink Translation from Entities
update_translation_item	PUT /Translation/{id}	Update a record of the Translation

add_relation_for_translation

bool add_relation_for_translation(link, ids, foreign_ids)

Add relation for Translation

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.TranslationApi(api_client)
    link = 'link_example' # str | 
    ids = ['ids_example'] # List[str] | 
    foreign_ids = ['foreign_ids_example'] # List[str] | 

    try:
        # Add relation for Translation
        api_response = api_instance.add_relation_for_translation(link, ids, foreign_ids)
        print("The response of TranslationApi->add_relation_for_translation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TranslationApi->add_relation_for_translation: %s\n" % e)

Parameters

Name	Type	Description	Notes
link	str
ids	List[str]
foreign_ids	List[str]

Return type

bool

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

create_translation_item

Translation create_translation_item(create_translation_item_request)

Create a record of the Translation

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_translation_item_request import CreateTranslationItemRequest
from clientapi_atrocore.models.translation import Translation
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.TranslationApi(api_client)
    create_translation_item_request = clientapi_atrocore.CreateTranslationItemRequest() # CreateTranslationItemRequest | 

    try:
        # Create a record of the Translation
        api_response = api_instance.create_translation_item(create_translation_item_request)
        print("The response of TranslationApi->create_translation_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TranslationApi->create_translation_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_translation_item_request	CreateTranslationItemRequest

Return type

Translation

Authorization

Authorization-Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

delete_translation_item

bool delete_translation_item(id)

Delete a record of the Translation

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.TranslationApi(api_client)
    id = 'id_example' # str | 

    try:
        # Delete a record of the Translation
        api_response = api_instance.delete_translation_item(id)
        print("The response of TranslationApi->delete_translation_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TranslationApi->delete_translation_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

bool

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

follow_translation

FollowAccount200Response follow_translation(id)

Follow the Translation stream

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.follow_account200_response import FollowAccount200Response
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.TranslationApi(api_client)
    id = 'id_example' # str | 

    try:
        # Follow the Translation stream
        api_response = api_instance.follow_translation(id)
        print("The response of TranslationApi->follow_translation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TranslationApi->follow_translation: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

FollowAccount200Response

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

get_linked_items_for_translation_item

GetLinkedItemsForAccountItem200Response get_linked_items_for_translation_item(id, link, language=language)

Returns linked entities for the Translation

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_linked_items_for_account_item200_response import GetLinkedItemsForAccountItem200Response
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.TranslationApi(api_client)
    id = 'id_example' # str | 
    link = 'link_example' # str | 
    language = 'language_example' # str | Set this parameter for data to be returned for a specified language (optional)

    try:
        # Returns linked entities for the Translation
        api_response = api_instance.get_linked_items_for_translation_item(id, link, language=language)
        print("The response of TranslationApi->get_linked_items_for_translation_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TranslationApi->get_linked_items_for_translation_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
link	str
language	str	Set this parameter for data to be returned for a specified language	[optional]

Return type

GetLinkedItemsForAccountItem200Response

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

get_list_of_translation_items

GetListOfTranslationItems200Response get_list_of_translation_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)

Returns a collection of Translation records

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_list_of_translation_items200_response import GetListOfTranslationItems200Response
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.TranslationApi(api_client)
    language = 'language_example' # str | Set this parameter for data to be returned for a specified language (optional)
    select = 'name,createdAt' # str | Available fields: afZa, arAe, arBh, arDz, arEg, arIq, arJo, arKw, arLb, arLy, arMa, arOm, arQa, arSa, arSy, arTn, arYe, azAz, beBy, bgBg, bnIn, bsBa, caEs, createdAt, createdBy, createdById, createdByName, csCz, cyGb, daDk, deAt, deCh, deDe, deLi, deLu, deleted, elGr, enAu, enBz, enCa, enGb, enIe, enJm, enNz, enPh, enTt, enUs, enVi, enZa, enZw, esAr, esBo, esCl, esCo, esCr, esDo, esEc, esEs, esGt, esHn, esMx, esNi, esPa, esPe, esPr, esPy, esSv, esUy, esVe, etEe, euEs, faIr, fiFi, filterCreateImportJob, filterUpdateImportJob, foFo, frBe, frCa, frCh, frFr, frLu, frMc, glEs, guIn, heIl, hiIn, hrHr, huHu, hyAm, id, idId, isCustomized, isIs, itCh, itIt, jaJp, kaGe, kkKz, knIn, koKr, kokIn, ltLt, lvLv, mkMk, mlIn, mnMn, modifiedAt, modifiedBy, modifiedById, modifiedByName, module, mrIn, msBn, msMy, mtMt, name, nbNo, nlBe, nlNl, nnNo, paIn, plPl, ptBr, ptPt, roRo, ruRu, seNo, skSk, slSi, sqAl, srBa, srCs, svFi, svSe, swKe, syrSy, taIn, teIn, thTh, tnZa, trTr, ukUa, uzUz, viVn, xhZa, zhCn, zhHk, zhMo, zhSg, zhTw, zuZa (optional)
    where = None # List[object] | There are a lot of filter types supported. You can learn all of them if you trace what's requested by Atro UI in the network tab in your browser console (press F12 key to open the console). (optional)
    offset = 0 # int |  (optional)
    max_size = 50 # int |  (optional)
    sort_by = 'name' # str |  (optional)
    asc = true # bool |  (optional)

    try:
        # Returns a collection of Translation records
        api_response = api_instance.get_list_of_translation_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)
        print("The response of TranslationApi->get_list_of_translation_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TranslationApi->get_list_of_translation_items: %s\n" % e)

Parameters

Name	Type	Description	Notes
language	str	Set this parameter for data to be returned for a specified language	[optional]
select	str	Available fields: afZa, arAe, arBh, arDz, arEg, arIq, arJo, arKw, arLb, arLy, arMa, arOm, arQa, arSa, arSy, arTn, arYe, azAz, beBy, bgBg, bnIn, bsBa, caEs, createdAt, createdBy, createdById, createdByName, csCz, cyGb, daDk, deAt, deCh, deDe, deLi, deLu, deleted, elGr, enAu, enBz, enCa, enGb, enIe, enJm, enNz, enPh, enTt, enUs, enVi, enZa, enZw, esAr, esBo, esCl, esCo, esCr, esDo, esEc, esEs, esGt, esHn, esMx, esNi, esPa, esPe, esPr, esPy, esSv, esUy, esVe, etEe, euEs, faIr, fiFi, filterCreateImportJob, filterUpdateImportJob, foFo, frBe, frCa, frCh, frFr, frLu, frMc, glEs, guIn, heIl, hiIn, hrHr, huHu, hyAm, id, idId, isCustomized, isIs, itCh, itIt, jaJp, kaGe, kkKz, knIn, koKr, kokIn, ltLt, lvLv, mkMk, mlIn, mnMn, modifiedAt, modifiedBy, modifiedById, modifiedByName, module, mrIn, msBn, msMy, mtMt, name, nbNo, nlBe, nlNl, nnNo, paIn, plPl, ptBr, ptPt, roRo, ruRu, seNo, skSk, slSi, sqAl, srBa, srCs, svFi, svSe, swKe, syrSy, taIn, teIn, thTh, tnZa, trTr, ukUa, uzUz, viVn, xhZa, zhCn, zhHk, zhMo, zhSg, zhTw, zuZa	[optional]
where	List[object]	There are a lot of filter types supported. You can learn all of them if you trace what's requested by Atro UI in the network tab in your browser console (press F12 key to open the console).	[optional]
offset	int		[optional]
max_size	int		[optional]
sort_by	str		[optional]
asc	bool		[optional]

Return type

GetListOfTranslationItems200Response

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

get_translation_item

Translation get_translation_item(id, language=language)

Returns a record of the Translation

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.translation import Translation
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.TranslationApi(api_client)
    id = 'id_example' # str | 
    language = 'language_example' # str | Set this parameter for data to be returned for a specified language (optional)

    try:
        # Returns a record of the Translation
        api_response = api_instance.get_translation_item(id, language=language)
        print("The response of TranslationApi->get_translation_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TranslationApi->get_translation_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
language	str	Set this parameter for data to be returned for a specified language	[optional]

Return type

Translation

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

link_translation

bool link_translation(id, link, link_account_request)

Link Translation to Entities

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.link_account_request import LinkAccountRequest
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.TranslationApi(api_client)
    id = 'id_example' # str | 
    link = 'link_example' # str | 
    link_account_request = clientapi_atrocore.LinkAccountRequest() # LinkAccountRequest | 

    try:
        # Link Translation to Entities
        api_response = api_instance.link_translation(id, link, link_account_request)
        print("The response of TranslationApi->link_translation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TranslationApi->link_translation: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
link	str
link_account_request	LinkAccountRequest

Return type

bool

Authorization

Authorization-Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

mass_delete_translation

bool mass_delete_translation(link_account_request)

Mass delete of Translation data

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.link_account_request import LinkAccountRequest
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.TranslationApi(api_client)
    link_account_request = clientapi_atrocore.LinkAccountRequest() # LinkAccountRequest | 

    try:
        # Mass delete of Translation data
        api_response = api_instance.mass_delete_translation(link_account_request)
        print("The response of TranslationApi->mass_delete_translation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TranslationApi->mass_delete_translation: %s\n" % e)

Parameters

Name	Type	Description	Notes
link_account_request	LinkAccountRequest

Return type

bool

Authorization

Authorization-Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

mass_update_translation

bool mass_update_translation(mass_update_account_request)

Mass update of Translation data

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.mass_update_account_request import MassUpdateAccountRequest
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.TranslationApi(api_client)
    mass_update_account_request = clientapi_atrocore.MassUpdateAccountRequest() # MassUpdateAccountRequest | 

    try:
        # Mass update of Translation data
        api_response = api_instance.mass_update_translation(mass_update_account_request)
        print("The response of TranslationApi->mass_update_translation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TranslationApi->mass_update_translation: %s\n" % e)

Parameters

Name	Type	Description	Notes
mass_update_account_request	MassUpdateAccountRequest

Return type

bool

Authorization

Authorization-Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

remove_relation_for_translation

bool remove_relation_for_translation(link, ids, foreign_ids)

Remove relation for Translation

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.TranslationApi(api_client)
    link = 'link_example' # str | 
    ids = ['ids_example'] # List[str] | 
    foreign_ids = ['foreign_ids_example'] # List[str] | 

    try:
        # Remove relation for Translation
        api_response = api_instance.remove_relation_for_translation(link, ids, foreign_ids)
        print("The response of TranslationApi->remove_relation_for_translation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TranslationApi->remove_relation_for_translation: %s\n" % e)

Parameters

Name	Type	Description	Notes
link	str
ids	List[str]
foreign_ids	List[str]

Return type

bool

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

unfollow_translation

bool unfollow_translation(id)

Unfollow the Translation stream

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.TranslationApi(api_client)
    id = 'id_example' # str | 

    try:
        # Unfollow the Translation stream
        api_response = api_instance.unfollow_translation(id)
        print("The response of TranslationApi->unfollow_translation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TranslationApi->unfollow_translation: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

bool

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

unlink_translation

bool unlink_translation(id, link, ids)

Unlink Translation from Entities

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.TranslationApi(api_client)
    id = 'id_example' # str | 
    link = 'link_example' # str | 
    ids = ['ids_example'] # List[str] | 

    try:
        # Unlink Translation from Entities
        api_response = api_instance.unlink_translation(id, link, ids)
        print("The response of TranslationApi->unlink_translation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TranslationApi->unlink_translation: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
link	str
ids	List[str]

Return type

bool

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

update_translation_item

Translation update_translation_item(id, create_translation_item_request)

Update a record of the Translation

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_translation_item_request import CreateTranslationItemRequest
from clientapi_atrocore.models.translation import Translation
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.TranslationApi(api_client)
    id = 'id_example' # str | 
    create_translation_item_request = clientapi_atrocore.CreateTranslationItemRequest() # CreateTranslationItemRequest | 

    try:
        # Update a record of the Translation
        api_response = api_instance.update_translation_item(id, create_translation_item_request)
        print("The response of TranslationApi->update_translation_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TranslationApi->update_translation_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
create_translation_item_request	CreateTranslationItemRequest

Return type

Translation

Authorization

Authorization-Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

FilesExpand file tree

TranslationApi.md

Latest commit

History

TranslationApi.md

File metadata and controls

clientapi_atrocore.TranslationApi

add_relation_for_translation

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_translation_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_translation_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

follow_translation

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_linked_items_for_translation_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_list_of_translation_items

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_translation_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

link_translation

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_delete_translation

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_update_translation

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_relation_for_translation

Example

Parameters