clientapi_atrocore.AttributeApi

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

Method	HTTP request	Description
add_relation_for_attribute	POST /Attribute/{link}/relation	Add relation for Attribute
create_attribute_item	POST /Attribute	Create a record of the Attribute
delete_attribute_item	DELETE /Attribute/{id}	Delete a record of the Attribute
follow_attribute	PUT /Attribute/{id}/subscription	Follow the Attribute stream
get_attribute_item	GET /Attribute/{id}	Returns a record of the Attribute
get_linked_items_for_attribute_item	GET /Attribute/{id}/{link}	Returns linked entities for the Attribute
get_list_of_attribute_items	GET /Attribute	Returns a collection of Attribute records
link_attribute	POST /Attribute/{id}/{link}	Link Attribute to Entities
mass_delete_attribute	POST /Attribute/action/massDelete	Mass delete of Attribute data
mass_update_attribute	PUT /Attribute/action/massUpdate	Mass update of Attribute data
remove_relation_for_attribute	DELETE /Attribute/{link}/relation	Remove relation for Attribute
unfollow_attribute	DELETE /Attribute/{id}/subscription	Unfollow the Attribute stream
unlink_attribute	DELETE /Attribute/{id}/{link}	Unlink Attribute from Entities
update_attribute_item	PUT /Attribute/{id}	Update a record of the Attribute

add_relation_for_attribute

bool add_relation_for_attribute(link, ids, foreign_ids)

Add relation for Attribute

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

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

Attribute create_attribute_item(create_attribute_item_request)

Create a record of the Attribute

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.attribute import Attribute
from clientapi_atrocore.models.create_attribute_item_request import CreateAttributeItemRequest
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.AttributeApi(api_client)
    create_attribute_item_request = clientapi_atrocore.CreateAttributeItemRequest() # CreateAttributeItemRequest | 

    try:
        # Create a record of the Attribute
        api_response = api_instance.create_attribute_item(create_attribute_item_request)
        print("The response of AttributeApi->create_attribute_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AttributeApi->create_attribute_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_attribute_item_request	CreateAttributeItemRequest

Return type

Attribute

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_attribute_item

bool delete_attribute_item(id)

Delete a record of the Attribute

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

    try:
        # Delete a record of the Attribute
        api_response = api_instance.delete_attribute_item(id)
        print("The response of AttributeApi->delete_attribute_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AttributeApi->delete_attribute_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_attribute

FollowAccount200Response follow_attribute(id)

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

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

Attribute get_attribute_item(id, language=language)

Returns a record of the Attribute

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.attribute import Attribute
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.AttributeApi(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 Attribute
        api_response = api_instance.get_attribute_item(id, language=language)
        print("The response of AttributeApi->get_attribute_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AttributeApi->get_attribute_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

Attribute

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_attribute_item

GetLinkedItemsForAccountItem200Response get_linked_items_for_attribute_item(id, link, language=language)

Returns linked entities for the Attribute

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.AttributeApi(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 Attribute
        api_response = api_instance.get_linked_items_for_attribute_item(id, link, language=language)
        print("The response of AttributeApi->get_linked_items_for_attribute_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AttributeApi->get_linked_items_for_attribute_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_attribute_items

GetListOfAttributeItems200Response get_list_of_attribute_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)

Returns a collection of Attribute records

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_list_of_attribute_items200_response import GetListOfAttributeItems200Response
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.AttributeApi(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: amountOfDigitsAfterComma, assetType, assignedUser, assignedUserId, assignedUserName, attributeGroup, attributeGroupId, attributeGroupName, attributeTab, attributeTabId, attributeTabName, children, childrenIds, childrenNames, classificationAttributes, classificationAttributesIds, classificationAttributes_classification, classificationAttributes_classificationIds, classificationAttributes_classificationNames, code, countBytesInsteadOfCharacters, createdAt, createdBy, createdById, createdByName, data, defaultChannel, defaultChannelId, defaultChannelName, defaultScope, defaultUnit, deleted, description, descriptionDeDe, extensibleEnum, extensibleEnumId, extensibleEnumName, filterCreateImportJob, filterUpdateImportJob, hasChildren, hierarchyRoute, hierarchySortOrder, id, inheritedFields, isMultilang, isRequired, isRoot, max, maxLength, measure, measureId, measureName, min, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, nameDeDe, ownerUser, ownerUserId, ownerUserName, parents, parentsIds, parentsNames, pattern, productAttributeValues, productAttributeValuesIds, productAttributeValues_product, productAttributeValues_productIds, productAttributeValues_productNames, prohibitedEmptyValue, sortOrder, sortOrderInAttributeGroup, sortOrderInProduct, teams, teamsIds, teamsNames, tooltip, tooltipDeDe, type, unique, useDisabledTextareaInViewMode, virtualProductField (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 Attribute records
        api_response = api_instance.get_list_of_attribute_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)
        print("The response of AttributeApi->get_list_of_attribute_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AttributeApi->get_list_of_attribute_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: amountOfDigitsAfterComma, assetType, assignedUser, assignedUserId, assignedUserName, attributeGroup, attributeGroupId, attributeGroupName, attributeTab, attributeTabId, attributeTabName, children, childrenIds, childrenNames, classificationAttributes, classificationAttributesIds, classificationAttributes_classification, classificationAttributes_classificationIds, classificationAttributes_classificationNames, code, countBytesInsteadOfCharacters, createdAt, createdBy, createdById, createdByName, data, defaultChannel, defaultChannelId, defaultChannelName, defaultScope, defaultUnit, deleted, description, descriptionDeDe, extensibleEnum, extensibleEnumId, extensibleEnumName, filterCreateImportJob, filterUpdateImportJob, hasChildren, hierarchyRoute, hierarchySortOrder, id, inheritedFields, isMultilang, isRequired, isRoot, max, maxLength, measure, measureId, measureName, min, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, nameDeDe, ownerUser, ownerUserId, ownerUserName, parents, parentsIds, parentsNames, pattern, productAttributeValues, productAttributeValuesIds, productAttributeValues_product, productAttributeValues_productIds, productAttributeValues_productNames, prohibitedEmptyValue, sortOrder, sortOrderInAttributeGroup, sortOrderInProduct, teams, teamsIds, teamsNames, tooltip, tooltipDeDe, type, unique, useDisabledTextareaInViewMode, virtualProductField	[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

GetListOfAttributeItems200Response

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_attribute

bool link_attribute(id, link, link_account_request)

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

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

bool mass_delete_attribute(link_account_request)

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

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

bool mass_update_attribute(mass_update_account_request)

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

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

bool remove_relation_for_attribute(link, ids, foreign_ids)

Remove relation for Attribute

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

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

bool unfollow_attribute(id)

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

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

bool unlink_attribute(id, link, ids)

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

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

Attribute update_attribute_item(id, create_attribute_item_request)

Update a record of the Attribute

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.attribute import Attribute
from clientapi_atrocore.models.create_attribute_item_request import CreateAttributeItemRequest
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.AttributeApi(api_client)
    id = 'id_example' # str | 
    create_attribute_item_request = clientapi_atrocore.CreateAttributeItemRequest() # CreateAttributeItemRequest | 

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

Parameters

Name	Type	Description	Notes
id	str
create_attribute_item_request	CreateAttributeItemRequest

Return type

Attribute

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

AttributeApi.md

Latest commit

History

AttributeApi.md

File metadata and controls

clientapi_atrocore.AttributeApi

add_relation_for_attribute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_attribute_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_attribute_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

follow_attribute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_attribute_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_linked_items_for_attribute_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_list_of_attribute_items

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

link_attribute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_delete_attribute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_update_attribute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_relation_for_attribute

Example

Parameters