clientapi_atrocore.ImportFeedApi

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

Method	HTTP request	Description
add_relation_for_import_feed	POST /ImportFeed/{link}/relation	Add relation for ImportFeed
create_import_feed_item	POST /ImportFeed	Create a record of the ImportFeed
delete_import_feed_item	DELETE /ImportFeed/{id}	Delete a record of the ImportFeed
follow_import_feed	PUT /ImportFeed/{id}/subscription	Follow the ImportFeed stream
get_import_feed_item	GET /ImportFeed/{id}	Returns a record of the ImportFeed
get_linked_items_for_import_feed_item	GET /ImportFeed/{id}/{link}	Returns linked entities for the ImportFeed
get_list_of_import_feed_items	GET /ImportFeed	Returns a collection of ImportFeed records
link_import_feed	POST /ImportFeed/{id}/{link}	Link ImportFeed to Entities
mass_delete_import_feed	POST /ImportFeed/action/massDelete	Mass delete of ImportFeed data
mass_update_import_feed	PUT /ImportFeed/action/massUpdate	Mass update of ImportFeed data
remove_relation_for_import_feed	DELETE /ImportFeed/{link}/relation	Remove relation for ImportFeed
run_import	POST /ImportFeed/action/runImport	Run import
unfollow_import_feed	DELETE /ImportFeed/{id}/subscription	Unfollow the ImportFeed stream
unlink_import_feed	DELETE /ImportFeed/{id}/{link}	Unlink ImportFeed from Entities
update_import_feed_item	PUT /ImportFeed/{id}	Update a record of the ImportFeed

add_relation_for_import_feed

bool add_relation_for_import_feed(link, ids, foreign_ids)

Add relation for ImportFeed

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

    try:
        # Add relation for ImportFeed
        api_response = api_instance.add_relation_for_import_feed(link, ids, foreign_ids)
        print("The response of ImportFeedApi->add_relation_for_import_feed:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportFeedApi->add_relation_for_import_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_import_feed_item

ImportFeed create_import_feed_item(create_import_feed_item_request)

Create a record of the ImportFeed

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_import_feed_item_request import CreateImportFeedItemRequest
from clientapi_atrocore.models.import_feed import ImportFeed
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.ImportFeedApi(api_client)
    create_import_feed_item_request = clientapi_atrocore.CreateImportFeedItemRequest() # CreateImportFeedItemRequest | 

    try:
        # Create a record of the ImportFeed
        api_response = api_instance.create_import_feed_item(create_import_feed_item_request)
        print("The response of ImportFeedApi->create_import_feed_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportFeedApi->create_import_feed_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_import_feed_item_request	CreateImportFeedItemRequest

Return type

ImportFeed

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_import_feed_item

bool delete_import_feed_item(id)

Delete a record of the ImportFeed

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

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

follow_import_feed

FollowAccount200Response follow_import_feed(id)

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

    try:
        # Follow the ImportFeed stream
        api_response = api_instance.follow_import_feed(id)
        print("The response of ImportFeedApi->follow_import_feed:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportFeedApi->follow_import_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_import_feed_item

ImportFeed get_import_feed_item(id, language=language)

Returns a record of the ImportFeed

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.import_feed import ImportFeed
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.ImportFeedApi(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 ImportFeed
        api_response = api_instance.get_import_feed_item(id, language=language)
        print("The response of ImportFeedApi->get_import_feed_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportFeedApi->get_import_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

ImportFeed

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_import_feed_item

GetLinkedItemsForAccountItem200Response get_linked_items_for_import_feed_item(id, link, language=language)

Returns linked entities for the ImportFeed

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.ImportFeedApi(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 ImportFeed
        api_response = api_instance.get_linked_items_for_import_feed_item(id, link, language=language)
        print("The response of ImportFeedApi->get_linked_items_for_import_feed_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportFeedApi->get_linked_items_for_import_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_import_feed_items

GetListOfImportFeedItems200Response get_list_of_import_feed_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)

Returns a collection of ImportFeed records

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_list_of_import_feed_items200_response import GetListOfImportFeedItems200Response
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.ImportFeedApi(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: adapter, assignedAccounts, assignedAccountsIds, assignedAccountsNames, assignedUser, assignedUserId, assignedUserName, code, configuratorItems, configuratorItemsIds, configuratorItemsNames, connection, connectionId, connectionName, createdAt, createdBy, createdById, createdByName, data, decimalMark, deleted, delimiter, description, emptyValue, entity, excludedNodes, fieldDelimiterForRelation, fileDataAction, fileFieldDelimiter, fileId, fileName, filePathsData, fileTextQualifier, filterCreateImportJob, filterUpdateImportJob, format, id, importFileId, importFileName, importFilePathsData, importJobs, importJobsIds, importJobsNames, isActive, isFileHeaderRow, keptStringNodes, lastStatus, lastTime, markForNoRelation, maxPerJob, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, nullValue, ownerUser, ownerUserId, ownerUserName, repeatProcessing, scheduledJobs, scheduledJobsIds, scheduledJobsNames, sheet, sheetOptions, sourceFields, teams, teamsIds, teamsNames, 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 ImportFeed records
        api_response = api_instance.get_list_of_import_feed_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)
        print("The response of ImportFeedApi->get_list_of_import_feed_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportFeedApi->get_list_of_import_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: adapter, assignedAccounts, assignedAccountsIds, assignedAccountsNames, assignedUser, assignedUserId, assignedUserName, code, configuratorItems, configuratorItemsIds, configuratorItemsNames, connection, connectionId, connectionName, createdAt, createdBy, createdById, createdByName, data, decimalMark, deleted, delimiter, description, emptyValue, entity, excludedNodes, fieldDelimiterForRelation, fileDataAction, fileFieldDelimiter, fileId, fileName, filePathsData, fileTextQualifier, filterCreateImportJob, filterUpdateImportJob, format, id, importFileId, importFileName, importFilePathsData, importJobs, importJobsIds, importJobsNames, isActive, isFileHeaderRow, keptStringNodes, lastStatus, lastTime, markForNoRelation, maxPerJob, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, nullValue, ownerUser, ownerUserId, ownerUserName, repeatProcessing, scheduledJobs, scheduledJobsIds, scheduledJobsNames, sheet, sheetOptions, sourceFields, teams, teamsIds, teamsNames, 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

GetListOfImportFeedItems200Response

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_import_feed

bool link_import_feed(id, link, link_account_request)

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

    try:
        # Link ImportFeed to Entities
        api_response = api_instance.link_import_feed(id, link, link_account_request)
        print("The response of ImportFeedApi->link_import_feed:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportFeedApi->link_import_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_import_feed

bool mass_delete_import_feed(link_account_request)

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

    try:
        # Mass delete of ImportFeed data
        api_response = api_instance.mass_delete_import_feed(link_account_request)
        print("The response of ImportFeedApi->mass_delete_import_feed:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportFeedApi->mass_delete_import_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_import_feed

bool mass_update_import_feed(mass_update_account_request)

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

    try:
        # Mass update of ImportFeed data
        api_response = api_instance.mass_update_import_feed(mass_update_account_request)
        print("The response of ImportFeedApi->mass_update_import_feed:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportFeedApi->mass_update_import_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_import_feed

bool remove_relation_for_import_feed(link, ids, foreign_ids)

Remove relation for ImportFeed

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

    try:
        # Remove relation for ImportFeed
        api_response = api_instance.remove_relation_for_import_feed(link, ids, foreign_ids)
        print("The response of ImportFeedApi->remove_relation_for_import_feed:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportFeedApi->remove_relation_for_import_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]

run_import

bool run_import(run_import_request)

Run import

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.run_import_request import RunImportRequest
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.ImportFeedApi(api_client)
    run_import_request = clientapi_atrocore.RunImportRequest() # RunImportRequest | 

    try:
        # Run import
        api_response = api_instance.run_import(run_import_request)
        print("The response of ImportFeedApi->run_import:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportFeedApi->run_import: %s\n" % e)

Parameters

Name	Type	Description	Notes
run_import_request	RunImportRequest

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]

unfollow_import_feed

bool unfollow_import_feed(id)

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

    try:
        # Unfollow the ImportFeed stream
        api_response = api_instance.unfollow_import_feed(id)
        print("The response of ImportFeedApi->unfollow_import_feed:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportFeedApi->unfollow_import_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_import_feed

bool unlink_import_feed(id, link, ids)

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

    try:
        # Unlink ImportFeed from Entities
        api_response = api_instance.unlink_import_feed(id, link, ids)
        print("The response of ImportFeedApi->unlink_import_feed:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportFeedApi->unlink_import_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_import_feed_item

ImportFeed update_import_feed_item(id, create_import_feed_item_request)

Update a record of the ImportFeed

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_import_feed_item_request import CreateImportFeedItemRequest
from clientapi_atrocore.models.import_feed import ImportFeed
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.ImportFeedApi(api_client)
    id = 'id_example' # str | 
    create_import_feed_item_request = clientapi_atrocore.CreateImportFeedItemRequest() # CreateImportFeedItemRequest | 

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

Parameters

Name	Type	Description	Notes
id	str
create_import_feed_item_request	CreateImportFeedItemRequest

Return type

ImportFeed

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

ImportFeedApi.md

Latest commit

History

ImportFeedApi.md

File metadata and controls

clientapi_atrocore.ImportFeedApi

add_relation_for_import_feed

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_import_feed_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_import_feed_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

follow_import_feed

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_import_feed_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_linked_items_for_import_feed_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_list_of_import_feed_items

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

link_import_feed

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_delete_import_feed

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_update_import_feed

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_relation_for_import_feed

Example

Parameters