clientapi_atrocore.ExportFeedApi

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

Method	HTTP request	Description
add_relation_for_export_feed	POST /ExportFeed/{link}/relation	Add relation for ExportFeed
create_export_feed_item	POST /ExportFeed	Create a record of the ExportFeed
delete_export_feed_item	DELETE /ExportFeed/{id}	Delete a record of the ExportFeed
export_channel	POST /ExportFeed/action/exportChannel	Export channel data to file
export_file	POST /ExportFeed/action/exportFile	Export data to file
follow_export_feed	PUT /ExportFeed/{id}/subscription	Follow the ExportFeed stream
get_export_feed_item	GET /ExportFeed/{id}	Returns a record of the ExportFeed
get_linked_items_for_export_feed_item	GET /ExportFeed/{id}/{link}	Returns linked entities for the ExportFeed
get_list_of_export_feed_items	GET /ExportFeed	Returns a collection of ExportFeed records
link_export_feed	POST /ExportFeed/{id}/{link}	Link ExportFeed to Entities
mass_delete_export_feed	POST /ExportFeed/action/massDelete	Mass delete of ExportFeed data
mass_update_export_feed	PUT /ExportFeed/action/massUpdate	Mass update of ExportFeed data
remove_relation_for_export_feed	DELETE /ExportFeed/{link}/relation	Remove relation for ExportFeed
unfollow_export_feed	DELETE /ExportFeed/{id}/subscription	Unfollow the ExportFeed stream
unlink_export_feed	DELETE /ExportFeed/{id}/{link}	Unlink ExportFeed from Entities
update_export_feed_item	PUT /ExportFeed/{id}	Update a record of the ExportFeed

add_relation_for_export_feed

bool add_relation_for_export_feed(link, ids, foreign_ids)

Add relation for ExportFeed

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

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

ExportFeed create_export_feed_item(create_export_feed_item_request)

Create a record of the ExportFeed

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_export_feed_item_request import CreateExportFeedItemRequest
from clientapi_atrocore.models.export_feed import ExportFeed
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.ExportFeedApi(api_client)
    create_export_feed_item_request = clientapi_atrocore.CreateExportFeedItemRequest() # CreateExportFeedItemRequest | 

    try:
        # Create a record of the ExportFeed
        api_response = api_instance.create_export_feed_item(create_export_feed_item_request)
        print("The response of ExportFeedApi->create_export_feed_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportFeedApi->create_export_feed_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_export_feed_item_request	CreateExportFeedItemRequest

Return type

ExportFeed

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_export_feed_item

bool delete_export_feed_item(id)

Delete a record of the ExportFeed

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

    try:
        # Delete a record of the ExportFeed
        api_response = api_instance.delete_export_feed_item(id)
        print("The response of ExportFeedApi->delete_export_feed_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportFeedApi->delete_export_feed_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]

export_channel

bool export_channel(install_module_request)

Export channel data to file

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.install_module_request import InstallModuleRequest
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.ExportFeedApi(api_client)
    install_module_request = clientapi_atrocore.InstallModuleRequest() # InstallModuleRequest | 

    try:
        # Export channel data to file
        api_response = api_instance.export_channel(install_module_request)
        print("The response of ExportFeedApi->export_channel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportFeedApi->export_channel: %s\n" % e)

Parameters

Name	Type	Description	Notes
install_module_request	InstallModuleRequest

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]

export_file

bool export_file(install_module_request)

Export data to file

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.install_module_request import InstallModuleRequest
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.ExportFeedApi(api_client)
    install_module_request = clientapi_atrocore.InstallModuleRequest() # InstallModuleRequest | 

    try:
        # Export data to file
        api_response = api_instance.export_file(install_module_request)
        print("The response of ExportFeedApi->export_file:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportFeedApi->export_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
install_module_request	InstallModuleRequest

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]

follow_export_feed

FollowAccount200Response follow_export_feed(id)

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

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

ExportFeed get_export_feed_item(id, language=language)

Returns a record of the ExportFeed

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.export_feed import ExportFeed
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.ExportFeedApi(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 ExportFeed
        api_response = api_instance.get_export_feed_item(id, language=language)
        print("The response of ExportFeedApi->get_export_feed_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportFeedApi->get_export_feed_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

ExportFeed

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_export_feed_item

GetLinkedItemsForAccountItem200Response get_linked_items_for_export_feed_item(id, link, language=language)

Returns linked entities for the ExportFeed

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.ExportFeedApi(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 ExportFeed
        api_response = api_instance.get_linked_items_for_export_feed_item(id, link, language=language)
        print("The response of ExportFeedApi->get_linked_items_for_export_feed_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportFeedApi->get_linked_items_for_export_feed_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_export_feed_items

GetListOfExportFeedItems200Response get_list_of_export_feed_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)

Returns a collection of ExportFeed records

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_list_of_export_feed_items200_response import GetListOfExportFeedItems200Response
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.ExportFeedApi(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: assignedAccounts, assignedAccountsIds, assignedAccountsNames, assignedUser, assignedUserId, assignedUserName, code, configuratorItems, configuratorItemsIds, configuratorItemsNames, convertCollectionToString, convertRelationsToString, createdAt, createdBy, createdById, createdByName, csvFieldDelimiter, csvTextQualifier, data, decimalMark, deleted, delimiter, description, emptyValue, entity, exportByMaxDepth, exportJobs, exportJobsIds, exportJobsNames, fieldDelimiterForRelation, fileType, filterCreateImportJob, filterUpdateImportJob, id, isActive, isFileHeaderRow, language, lastStatus, lastTime, limit, markForNoRelation, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, nullValue, ownerUser, ownerUserId, ownerUserName, replaceAttributeValues, scheduledJobs, scheduledJobsIds, scheduledJobsNames, separateJob, sortOrderDirection, sortOrderField, teams, teamsIds, teamsNames, template, thousandSeparator, type (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 ExportFeed records
        api_response = api_instance.get_list_of_export_feed_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)
        print("The response of ExportFeedApi->get_list_of_export_feed_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportFeedApi->get_list_of_export_feed_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: assignedAccounts, assignedAccountsIds, assignedAccountsNames, assignedUser, assignedUserId, assignedUserName, code, configuratorItems, configuratorItemsIds, configuratorItemsNames, convertCollectionToString, convertRelationsToString, createdAt, createdBy, createdById, createdByName, csvFieldDelimiter, csvTextQualifier, data, decimalMark, deleted, delimiter, description, emptyValue, entity, exportByMaxDepth, exportJobs, exportJobsIds, exportJobsNames, fieldDelimiterForRelation, fileType, filterCreateImportJob, filterUpdateImportJob, id, isActive, isFileHeaderRow, language, lastStatus, lastTime, limit, markForNoRelation, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, nullValue, ownerUser, ownerUserId, ownerUserName, replaceAttributeValues, scheduledJobs, scheduledJobsIds, scheduledJobsNames, separateJob, sortOrderDirection, sortOrderField, teams, teamsIds, teamsNames, template, thousandSeparator, type	[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

GetListOfExportFeedItems200Response

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_export_feed

bool link_export_feed(id, link, link_account_request)

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

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

bool mass_delete_export_feed(link_account_request)

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

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

bool mass_update_export_feed(mass_update_account_request)

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

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

bool remove_relation_for_export_feed(link, ids, foreign_ids)

Remove relation for ExportFeed

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

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

bool unfollow_export_feed(id)

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

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

bool unlink_export_feed(id, link, ids)

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

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

ExportFeed update_export_feed_item(id, create_export_feed_item_request)

Update a record of the ExportFeed

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_export_feed_item_request import CreateExportFeedItemRequest
from clientapi_atrocore.models.export_feed import ExportFeed
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.ExportFeedApi(api_client)
    id = 'id_example' # str | 
    create_export_feed_item_request = clientapi_atrocore.CreateExportFeedItemRequest() # CreateExportFeedItemRequest | 

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

Parameters

Name	Type	Description	Notes
id	str
create_export_feed_item_request	CreateExportFeedItemRequest

Return type

ExportFeed

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

ExportFeedApi.md

Latest commit

History

ExportFeedApi.md

File metadata and controls

clientapi_atrocore.ExportFeedApi

add_relation_for_export_feed

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_export_feed_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_export_feed_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

export_channel

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

export_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

follow_export_feed

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_export_feed_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_linked_items_for_export_feed_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_list_of_export_feed_items

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

link_export_feed

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_delete_export_feed

Example

Parameters