All URIs are relative to https://demo.atropim.com/api/v1
| Method | HTTP request | Description |
|---|---|---|
| add_relation_for_catalog | POST /Catalog/{link}/relation | Add relation for Catalog |
| create_catalog_item | POST /Catalog | Create a record of the Catalog |
| delete_catalog_item | DELETE /Catalog/{id} | Delete a record of the Catalog |
| follow_catalog | PUT /Catalog/{id}/subscription | Follow the Catalog stream |
| get_catalog_item | GET /Catalog/{id} | Returns a record of the Catalog |
| get_linked_items_for_catalog_item | GET /Catalog/{id}/{link} | Returns linked entities for the Catalog |
| get_list_of_catalog_items | GET /Catalog | Returns a collection of Catalog records |
| link_catalog | POST /Catalog/{id}/{link} | Link Catalog to Entities |
| mass_delete_catalog | POST /Catalog/action/massDelete | Mass delete of Catalog data |
| mass_update_catalog | PUT /Catalog/action/massUpdate | Mass update of Catalog data |
| remove_relation_for_catalog | DELETE /Catalog/{link}/relation | Remove relation for Catalog |
| unfollow_catalog | DELETE /Catalog/{id}/subscription | Unfollow the Catalog stream |
| unlink_catalog | DELETE /Catalog/{id}/{link} | Unlink Catalog from Entities |
| update_catalog_item | PUT /Catalog/{id} | Update a record of the Catalog |
bool add_relation_for_catalog(link, ids, foreign_ids)
Add relation for Catalog
Add relation for Catalog
- 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.CatalogApi(api_client)
link = 'link_example' # str |
ids = ['ids_example'] # List[str] |
foreign_ids = ['foreign_ids_example'] # List[str] |
try:
# Add relation for Catalog
api_response = api_instance.add_relation_for_catalog(link, ids, foreign_ids)
print("The response of CatalogApi->add_relation_for_catalog:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CatalogApi->add_relation_for_catalog: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| link | str | ||
| ids | List[str] | ||
| foreign_ids | List[str] |
bool
- Content-Type: Not defined
- Accept: application/json
| 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]
Catalog create_catalog_item(create_catalog_item_request)
Create a record of the Catalog
Create a record of the Catalog
- Api Key Authentication (Authorization-Token):
import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.catalog import Catalog
from clientapi_atrocore.models.create_catalog_item_request import CreateCatalogItemRequest
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.CatalogApi(api_client)
create_catalog_item_request = clientapi_atrocore.CreateCatalogItemRequest() # CreateCatalogItemRequest |
try:
# Create a record of the Catalog
api_response = api_instance.create_catalog_item(create_catalog_item_request)
print("The response of CatalogApi->create_catalog_item:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CatalogApi->create_catalog_item: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| create_catalog_item_request | CreateCatalogItemRequest |
- Content-Type: application/json
- Accept: application/json
| 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]
bool delete_catalog_item(id)
Delete a record of the Catalog
Delete a record of the Catalog
- 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.CatalogApi(api_client)
id = 'id_example' # str |
try:
# Delete a record of the Catalog
api_response = api_instance.delete_catalog_item(id)
print("The response of CatalogApi->delete_catalog_item:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CatalogApi->delete_catalog_item: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str |
bool
- Content-Type: Not defined
- Accept: application/json
| 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]
FollowAccount200Response follow_catalog(id)
Follow the Catalog stream
Follow the Catalog stream
- 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.CatalogApi(api_client)
id = 'id_example' # str |
try:
# Follow the Catalog stream
api_response = api_instance.follow_catalog(id)
print("The response of CatalogApi->follow_catalog:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CatalogApi->follow_catalog: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str |
- Content-Type: Not defined
- Accept: application/json
| 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]
Catalog get_catalog_item(id, language=language)
Returns a record of the Catalog
Returns a record of the Catalog
- Api Key Authentication (Authorization-Token):
import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.catalog import Catalog
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.CatalogApi(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 Catalog
api_response = api_instance.get_catalog_item(id, language=language)
print("The response of CatalogApi->get_catalog_item:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CatalogApi->get_catalog_item: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ||
| language | str | Set this parameter for data to be returned for a specified language | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
GetLinkedItemsForAccountItem200Response get_linked_items_for_catalog_item(id, link, language=language)
Returns linked entities for the Catalog
Returns linked entities for the Catalog
- 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.CatalogApi(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 Catalog
api_response = api_instance.get_linked_items_for_catalog_item(id, link, language=language)
print("The response of CatalogApi->get_linked_items_for_catalog_item:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CatalogApi->get_linked_items_for_catalog_item: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ||
| link | str | ||
| language | str | Set this parameter for data to be returned for a specified language | [optional] |
GetLinkedItemsForAccountItem200Response
- Content-Type: Not defined
- Accept: application/json
| 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]
GetListOfCatalogItems200Response get_list_of_catalog_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)
Returns a collection of Catalog records
Returns a collection of Catalog records
- Api Key Authentication (Authorization-Token):
import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_list_of_catalog_items200_response import GetListOfCatalogItems200Response
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.CatalogApi(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: assignedUser, assignedUserId, assignedUserName, categories, categoriesIds, categoriesNames, code, createdAt, createdBy, createdById, createdByName, deleted, description, descriptionDeDe, filterCreateImportJob, filterUpdateImportJob, id, isActive, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, nameDeDe, products, productsCount, productsIds, productsNames, teams, teamsIds, teamsNames (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 Catalog records
api_response = api_instance.get_list_of_catalog_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)
print("The response of CatalogApi->get_list_of_catalog_items:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CatalogApi->get_list_of_catalog_items: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| language | str | Set this parameter for data to be returned for a specified language | [optional] |
| select | str | Available fields: assignedUser, assignedUserId, assignedUserName, categories, categoriesIds, categoriesNames, code, createdAt, createdBy, createdById, createdByName, deleted, description, descriptionDeDe, filterCreateImportJob, filterUpdateImportJob, id, isActive, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, nameDeDe, products, productsCount, productsIds, productsNames, teams, teamsIds, teamsNames | [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] |
GetListOfCatalogItems200Response
- Content-Type: Not defined
- Accept: application/json
| 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]
bool link_catalog(id, link, link_account_request)
Link Catalog to Entities
Link Catalog to Entities
- 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.CatalogApi(api_client)
id = 'id_example' # str |
link = 'link_example' # str |
link_account_request = clientapi_atrocore.LinkAccountRequest() # LinkAccountRequest |
try:
# Link Catalog to Entities
api_response = api_instance.link_catalog(id, link, link_account_request)
print("The response of CatalogApi->link_catalog:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CatalogApi->link_catalog: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ||
| link | str | ||
| link_account_request | LinkAccountRequest |
bool
- Content-Type: application/json
- Accept: application/json
| 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]
bool mass_delete_catalog(link_account_request)
Mass delete of Catalog data
Mass delete of Catalog data
- 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.CatalogApi(api_client)
link_account_request = clientapi_atrocore.LinkAccountRequest() # LinkAccountRequest |
try:
# Mass delete of Catalog data
api_response = api_instance.mass_delete_catalog(link_account_request)
print("The response of CatalogApi->mass_delete_catalog:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CatalogApi->mass_delete_catalog: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| link_account_request | LinkAccountRequest |
bool
- Content-Type: application/json
- Accept: application/json
| 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]
bool mass_update_catalog(mass_update_account_request)
Mass update of Catalog data
Mass update of Catalog data
- 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.CatalogApi(api_client)
mass_update_account_request = clientapi_atrocore.MassUpdateAccountRequest() # MassUpdateAccountRequest |
try:
# Mass update of Catalog data
api_response = api_instance.mass_update_catalog(mass_update_account_request)
print("The response of CatalogApi->mass_update_catalog:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CatalogApi->mass_update_catalog: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| mass_update_account_request | MassUpdateAccountRequest |
bool
- Content-Type: application/json
- Accept: application/json
| 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]
bool remove_relation_for_catalog(link, ids, foreign_ids)
Remove relation for Catalog
Remove relation for Catalog
- 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.CatalogApi(api_client)
link = 'link_example' # str |
ids = ['ids_example'] # List[str] |
foreign_ids = ['foreign_ids_example'] # List[str] |
try:
# Remove relation for Catalog
api_response = api_instance.remove_relation_for_catalog(link, ids, foreign_ids)
print("The response of CatalogApi->remove_relation_for_catalog:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CatalogApi->remove_relation_for_catalog: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| link | str | ||
| ids | List[str] | ||
| foreign_ids | List[str] |
bool
- Content-Type: Not defined
- Accept: application/json
| 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]
bool unfollow_catalog(id)
Unfollow the Catalog stream
Unfollow the Catalog stream
- 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.CatalogApi(api_client)
id = 'id_example' # str |
try:
# Unfollow the Catalog stream
api_response = api_instance.unfollow_catalog(id)
print("The response of CatalogApi->unfollow_catalog:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CatalogApi->unfollow_catalog: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str |
bool
- Content-Type: Not defined
- Accept: application/json
| 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]
bool unlink_catalog(id, link, ids)
Unlink Catalog from Entities
Unlink Catalog from Entities
- 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.CatalogApi(api_client)
id = 'id_example' # str |
link = 'link_example' # str |
ids = ['ids_example'] # List[str] |
try:
# Unlink Catalog from Entities
api_response = api_instance.unlink_catalog(id, link, ids)
print("The response of CatalogApi->unlink_catalog:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CatalogApi->unlink_catalog: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ||
| link | str | ||
| ids | List[str] |
bool
- Content-Type: Not defined
- Accept: application/json
| 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]
Catalog update_catalog_item(id, create_catalog_item_request)
Update a record of the Catalog
Update a record of the Catalog
- Api Key Authentication (Authorization-Token):
import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.catalog import Catalog
from clientapi_atrocore.models.create_catalog_item_request import CreateCatalogItemRequest
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.CatalogApi(api_client)
id = 'id_example' # str |
create_catalog_item_request = clientapi_atrocore.CreateCatalogItemRequest() # CreateCatalogItemRequest |
try:
# Update a record of the Catalog
api_response = api_instance.update_catalog_item(id, create_catalog_item_request)
print("The response of CatalogApi->update_catalog_item:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CatalogApi->update_catalog_item: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ||
| create_catalog_item_request | CreateCatalogItemRequest |
- Content-Type: application/json
- Accept: application/json
| 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]