clientapi_atrocore.ExtensibleEnumApi

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

Method	HTTP request	Description
add_relation_for_extensible_enum	POST /ExtensibleEnum/{link}/relation	Add relation for ExtensibleEnum
create_extensible_enum_item	POST /ExtensibleEnum	Create a record of the ExtensibleEnum
delete_extensible_enum_item	DELETE /ExtensibleEnum/{id}	Delete a record of the ExtensibleEnum
follow_extensible_enum	PUT /ExtensibleEnum/{id}/subscription	Follow the ExtensibleEnum stream
get_extensible_enum_item	GET /ExtensibleEnum/{id}	Returns a record of the ExtensibleEnum
get_linked_items_for_extensible_enum_item	GET /ExtensibleEnum/{id}/{link}	Returns linked entities for the ExtensibleEnum
get_list_of_extensible_enum_items	GET /ExtensibleEnum	Returns a collection of ExtensibleEnum records
link_extensible_enum	POST /ExtensibleEnum/{id}/{link}	Link ExtensibleEnum to Entities
mass_delete_extensible_enum	POST /ExtensibleEnum/action/massDelete	Mass delete of ExtensibleEnum data
mass_update_extensible_enum	PUT /ExtensibleEnum/action/massUpdate	Mass update of ExtensibleEnum data
remove_relation_for_extensible_enum	DELETE /ExtensibleEnum/{link}/relation	Remove relation for ExtensibleEnum
unfollow_extensible_enum	DELETE /ExtensibleEnum/{id}/subscription	Unfollow the ExtensibleEnum stream
unlink_extensible_enum	DELETE /ExtensibleEnum/{id}/{link}	Unlink ExtensibleEnum from Entities
update_extensible_enum_item	PUT /ExtensibleEnum/{id}	Update a record of the ExtensibleEnum

add_relation_for_extensible_enum

bool add_relation_for_extensible_enum(link, ids, foreign_ids)

Add relation for ExtensibleEnum

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

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

ExtensibleEnum create_extensible_enum_item(create_extensible_enum_item_request)

Create a record of the ExtensibleEnum

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_extensible_enum_item_request import CreateExtensibleEnumItemRequest
from clientapi_atrocore.models.extensible_enum import ExtensibleEnum
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.ExtensibleEnumApi(api_client)
    create_extensible_enum_item_request = clientapi_atrocore.CreateExtensibleEnumItemRequest() # CreateExtensibleEnumItemRequest | 

    try:
        # Create a record of the ExtensibleEnum
        api_response = api_instance.create_extensible_enum_item(create_extensible_enum_item_request)
        print("The response of ExtensibleEnumApi->create_extensible_enum_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExtensibleEnumApi->create_extensible_enum_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_extensible_enum_item_request	CreateExtensibleEnumItemRequest

Return type

ExtensibleEnum

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_extensible_enum_item

bool delete_extensible_enum_item(id)

Delete a record of the ExtensibleEnum

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

    try:
        # Delete a record of the ExtensibleEnum
        api_response = api_instance.delete_extensible_enum_item(id)
        print("The response of ExtensibleEnumApi->delete_extensible_enum_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExtensibleEnumApi->delete_extensible_enum_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_extensible_enum

FollowAccount200Response follow_extensible_enum(id)

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

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

ExtensibleEnum get_extensible_enum_item(id, language=language)

Returns a record of the ExtensibleEnum

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.extensible_enum import ExtensibleEnum
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.ExtensibleEnumApi(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 ExtensibleEnum
        api_response = api_instance.get_extensible_enum_item(id, language=language)
        print("The response of ExtensibleEnumApi->get_extensible_enum_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExtensibleEnumApi->get_extensible_enum_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

ExtensibleEnum

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_extensible_enum_item

GetLinkedItemsForAccountItem200Response get_linked_items_for_extensible_enum_item(id, link, language=language)

Returns linked entities for the ExtensibleEnum

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.ExtensibleEnumApi(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 ExtensibleEnum
        api_response = api_instance.get_linked_items_for_extensible_enum_item(id, link, language=language)
        print("The response of ExtensibleEnumApi->get_linked_items_for_extensible_enum_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExtensibleEnumApi->get_linked_items_for_extensible_enum_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_extensible_enum_items

GetListOfExtensibleEnumItems200Response get_list_of_extensible_enum_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)

Returns a collection of ExtensibleEnum records

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_list_of_extensible_enum_items200_response import GetListOfExtensibleEnumItems200Response
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.ExtensibleEnumApi(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: attributes, attributesIds, attributesNames, code, createdAt, createdBy, createdById, createdByName, deleted, description, extensibleEnumOptions, extensibleEnumOptionsIds, extensibleEnumOptionsNames, filterCreateImportJob, filterUpdateImportJob, id, modifiedAt, modifiedBy, modifiedById, modifiedByName, multilingual, name (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 ExtensibleEnum records
        api_response = api_instance.get_list_of_extensible_enum_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)
        print("The response of ExtensibleEnumApi->get_list_of_extensible_enum_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExtensibleEnumApi->get_list_of_extensible_enum_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: attributes, attributesIds, attributesNames, code, createdAt, createdBy, createdById, createdByName, deleted, description, extensibleEnumOptions, extensibleEnumOptionsIds, extensibleEnumOptionsNames, filterCreateImportJob, filterUpdateImportJob, id, modifiedAt, modifiedBy, modifiedById, modifiedByName, multilingual, name	[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

GetListOfExtensibleEnumItems200Response

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_extensible_enum

bool link_extensible_enum(id, link, link_account_request)

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

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

bool mass_delete_extensible_enum(link_account_request)

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

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

bool mass_update_extensible_enum(mass_update_account_request)

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

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

bool remove_relation_for_extensible_enum(link, ids, foreign_ids)

Remove relation for ExtensibleEnum

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

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

bool unfollow_extensible_enum(id)

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

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

bool unlink_extensible_enum(id, link, ids)

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

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

ExtensibleEnum update_extensible_enum_item(id, create_extensible_enum_item_request)

Update a record of the ExtensibleEnum

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_extensible_enum_item_request import CreateExtensibleEnumItemRequest
from clientapi_atrocore.models.extensible_enum import ExtensibleEnum
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.ExtensibleEnumApi(api_client)
    id = 'id_example' # str | 
    create_extensible_enum_item_request = clientapi_atrocore.CreateExtensibleEnumItemRequest() # CreateExtensibleEnumItemRequest | 

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

Parameters

Name	Type	Description	Notes
id	str
create_extensible_enum_item_request	CreateExtensibleEnumItemRequest

Return type

ExtensibleEnum

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

ExtensibleEnumApi.md

Latest commit

History

ExtensibleEnumApi.md

File metadata and controls

clientapi_atrocore.ExtensibleEnumApi

add_relation_for_extensible_enum

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_extensible_enum_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_extensible_enum_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

follow_extensible_enum

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_extensible_enum_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_linked_items_for_extensible_enum_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_list_of_extensible_enum_items

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

link_extensible_enum

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_delete_extensible_enum

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_update_extensible_enum

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_relation_for_extensible_enum

Example

Parameters