clientapi_atrocore.LocaleApi

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

Method	HTTP request	Description
add_relation_for_locale	POST /Locale/{link}/relation	Add relation for Locale
create_locale_item	POST /Locale	Create a record of the Locale
delete_locale_item	DELETE /Locale/{id}	Delete a record of the Locale
follow_locale	PUT /Locale/{id}/subscription	Follow the Locale stream
get_linked_items_for_locale_item	GET /Locale/{id}/{link}	Returns linked entities for the Locale
get_list_of_locale_items	GET /Locale	Returns a collection of Locale records
get_locale_item	GET /Locale/{id}	Returns a record of the Locale
link_locale	POST /Locale/{id}/{link}	Link Locale to Entities
mass_delete_locale	POST /Locale/action/massDelete	Mass delete of Locale data
mass_update_locale	PUT /Locale/action/massUpdate	Mass update of Locale data
remove_relation_for_locale	DELETE /Locale/{link}/relation	Remove relation for Locale
unfollow_locale	DELETE /Locale/{id}/subscription	Unfollow the Locale stream
unlink_locale	DELETE /Locale/{id}/{link}	Unlink Locale from Entities
update_locale_item	PUT /Locale/{id}	Update a record of the Locale

add_relation_for_locale

bool add_relation_for_locale(link, ids, foreign_ids)

Add relation for Locale

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.LocaleApi(api_client)
    link = 'link_example' # str | 
    ids = ['ids_example'] # List[str] | 
    foreign_ids = ['foreign_ids_example'] # List[str] | 

    try:
        # Add relation for Locale
        api_response = api_instance.add_relation_for_locale(link, ids, foreign_ids)
        print("The response of LocaleApi->add_relation_for_locale:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LocaleApi->add_relation_for_locale: %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_locale_item

Locale create_locale_item(create_locale_item_request)

Create a record of the Locale

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_locale_item_request import CreateLocaleItemRequest
from clientapi_atrocore.models.locale import Locale
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.LocaleApi(api_client)
    create_locale_item_request = clientapi_atrocore.CreateLocaleItemRequest() # CreateLocaleItemRequest | 

    try:
        # Create a record of the Locale
        api_response = api_instance.create_locale_item(create_locale_item_request)
        print("The response of LocaleApi->create_locale_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LocaleApi->create_locale_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_locale_item_request	CreateLocaleItemRequest

Return type

Locale

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_locale_item

bool delete_locale_item(id)

Delete a record of the Locale

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.LocaleApi(api_client)
    id = 'id_example' # str | 

    try:
        # Delete a record of the Locale
        api_response = api_instance.delete_locale_item(id)
        print("The response of LocaleApi->delete_locale_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LocaleApi->delete_locale_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_locale

FollowAccount200Response follow_locale(id)

Follow the Locale 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.LocaleApi(api_client)
    id = 'id_example' # str | 

    try:
        # Follow the Locale stream
        api_response = api_instance.follow_locale(id)
        print("The response of LocaleApi->follow_locale:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LocaleApi->follow_locale: %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_locale_item

GetLinkedItemsForAccountItem200Response get_linked_items_for_locale_item(id, link, language=language)

Returns linked entities for the Locale

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.LocaleApi(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 Locale
        api_response = api_instance.get_linked_items_for_locale_item(id, link, language=language)
        print("The response of LocaleApi->get_linked_items_for_locale_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LocaleApi->get_linked_items_for_locale_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_locale_items

GetListOfLocaleItems200Response get_list_of_locale_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)

Returns a collection of Locale records

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_list_of_locale_items200_response import GetListOfLocaleItems200Response
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.LocaleApi(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: createdAt, createdBy, createdById, createdByName, dateFormat, decimalMark, deleted, description, filterCreateImportJob, filterUpdateImportJob, id, language, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, thousandSeparator, timeFormat, timeZone, weekStart (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 Locale records
        api_response = api_instance.get_list_of_locale_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)
        print("The response of LocaleApi->get_list_of_locale_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LocaleApi->get_list_of_locale_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: createdAt, createdBy, createdById, createdByName, dateFormat, decimalMark, deleted, description, filterCreateImportJob, filterUpdateImportJob, id, language, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, thousandSeparator, timeFormat, timeZone, weekStart	[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

GetListOfLocaleItems200Response

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_locale_item

Locale get_locale_item(id, language=language)

Returns a record of the Locale

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.locale import Locale
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.LocaleApi(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 Locale
        api_response = api_instance.get_locale_item(id, language=language)
        print("The response of LocaleApi->get_locale_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LocaleApi->get_locale_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

Locale

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_locale

bool link_locale(id, link, link_account_request)

Link Locale 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.LocaleApi(api_client)
    id = 'id_example' # str | 
    link = 'link_example' # str | 
    link_account_request = clientapi_atrocore.LinkAccountRequest() # LinkAccountRequest | 

    try:
        # Link Locale to Entities
        api_response = api_instance.link_locale(id, link, link_account_request)
        print("The response of LocaleApi->link_locale:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LocaleApi->link_locale: %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_locale

bool mass_delete_locale(link_account_request)

Mass delete of Locale 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.LocaleApi(api_client)
    link_account_request = clientapi_atrocore.LinkAccountRequest() # LinkAccountRequest | 

    try:
        # Mass delete of Locale data
        api_response = api_instance.mass_delete_locale(link_account_request)
        print("The response of LocaleApi->mass_delete_locale:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LocaleApi->mass_delete_locale: %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_locale

bool mass_update_locale(mass_update_account_request)

Mass update of Locale 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.LocaleApi(api_client)
    mass_update_account_request = clientapi_atrocore.MassUpdateAccountRequest() # MassUpdateAccountRequest | 

    try:
        # Mass update of Locale data
        api_response = api_instance.mass_update_locale(mass_update_account_request)
        print("The response of LocaleApi->mass_update_locale:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LocaleApi->mass_update_locale: %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_locale

bool remove_relation_for_locale(link, ids, foreign_ids)

Remove relation for Locale

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.LocaleApi(api_client)
    link = 'link_example' # str | 
    ids = ['ids_example'] # List[str] | 
    foreign_ids = ['foreign_ids_example'] # List[str] | 

    try:
        # Remove relation for Locale
        api_response = api_instance.remove_relation_for_locale(link, ids, foreign_ids)
        print("The response of LocaleApi->remove_relation_for_locale:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LocaleApi->remove_relation_for_locale: %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_locale

bool unfollow_locale(id)

Unfollow the Locale 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.LocaleApi(api_client)
    id = 'id_example' # str | 

    try:
        # Unfollow the Locale stream
        api_response = api_instance.unfollow_locale(id)
        print("The response of LocaleApi->unfollow_locale:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LocaleApi->unfollow_locale: %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_locale

bool unlink_locale(id, link, ids)

Unlink Locale 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.LocaleApi(api_client)
    id = 'id_example' # str | 
    link = 'link_example' # str | 
    ids = ['ids_example'] # List[str] | 

    try:
        # Unlink Locale from Entities
        api_response = api_instance.unlink_locale(id, link, ids)
        print("The response of LocaleApi->unlink_locale:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LocaleApi->unlink_locale: %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_locale_item

Locale update_locale_item(id, create_locale_item_request)

Update a record of the Locale

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_locale_item_request import CreateLocaleItemRequest
from clientapi_atrocore.models.locale import Locale
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.LocaleApi(api_client)
    id = 'id_example' # str | 
    create_locale_item_request = clientapi_atrocore.CreateLocaleItemRequest() # CreateLocaleItemRequest | 

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

Parameters

Name	Type	Description	Notes
id	str
create_locale_item_request	CreateLocaleItemRequest

Return type

Locale

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

LocaleApi.md

Latest commit

History

LocaleApi.md

File metadata and controls

clientapi_atrocore.LocaleApi

add_relation_for_locale

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_locale_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_locale_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

follow_locale

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_linked_items_for_locale_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_list_of_locale_items

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_locale_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

link_locale

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_delete_locale

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_update_locale

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_relation_for_locale

Example

Parameters