clientapi_atrocore.LibraryApi

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

Method	HTTP request	Description
add_relation_for_library	POST /Library/{link}/relation	Add relation for Library
create_library_item	POST /Library	Create a record of the Library
delete_library_item	DELETE /Library/{id}	Delete a record of the Library
follow_library	PUT /Library/{id}/subscription	Follow the Library stream
get_library_item	GET /Library/{id}	Returns a record of the Library
get_linked_items_for_library_item	GET /Library/{id}/{link}	Returns linked entities for the Library
get_list_of_library_items	GET /Library	Returns a collection of Library records
link_library	POST /Library/{id}/{link}	Link Library to Entities
mass_delete_library	POST /Library/action/massDelete	Mass delete of Library data
mass_update_library	PUT /Library/action/massUpdate	Mass update of Library data
remove_relation_for_library	DELETE /Library/{link}/relation	Remove relation for Library
unfollow_library	DELETE /Library/{id}/subscription	Unfollow the Library stream
unlink_library	DELETE /Library/{id}/{link}	Unlink Library from Entities
update_library_item	PUT /Library/{id}	Update a record of the Library

add_relation_for_library

bool add_relation_for_library(link, ids, foreign_ids)

Add relation for Library

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

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

Library create_library_item(create_library_item_request)

Create a record of the Library

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_library_item_request import CreateLibraryItemRequest
from clientapi_atrocore.models.library import Library
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.LibraryApi(api_client)
    create_library_item_request = clientapi_atrocore.CreateLibraryItemRequest() # CreateLibraryItemRequest | 

    try:
        # Create a record of the Library
        api_response = api_instance.create_library_item(create_library_item_request)
        print("The response of LibraryApi->create_library_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->create_library_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_library_item_request	CreateLibraryItemRequest

Return type

Library

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_library_item

bool delete_library_item(id)

Delete a record of the Library

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

    try:
        # Delete a record of the Library
        api_response = api_instance.delete_library_item(id)
        print("The response of LibraryApi->delete_library_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->delete_library_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_library

FollowAccount200Response follow_library(id)

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

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

Library get_library_item(id, language=language)

Returns a record of the Library

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.library import Library
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.LibraryApi(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 Library
        api_response = api_instance.get_library_item(id, language=language)
        print("The response of LibraryApi->get_library_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_library_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

Library

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_library_item

GetLinkedItemsForAccountItem200Response get_linked_items_for_library_item(id, link, language=language)

Returns linked entities for the Library

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.LibraryApi(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 Library
        api_response = api_instance.get_linked_items_for_library_item(id, link, language=language)
        print("The response of LibraryApi->get_linked_items_for_library_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_linked_items_for_library_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_library_items

GetListOfLibraryItems200Response get_list_of_library_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)

Returns a collection of Library records

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_list_of_library_items200_response import GetListOfLibraryItems200Response
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.LibraryApi(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: assetCategories, assetCategoriesIds, assetCategoriesNames, assets, assetsIds, assetsNames, assignedUser, assignedUserId, assignedUserName, code, createdAt, createdBy, createdById, createdByName, deleted, description, filterCreateImportJob, filterUpdateImportJob, id, isActive, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, ownerUser, ownerUserId, ownerUserName, 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 Library records
        api_response = api_instance.get_list_of_library_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)
        print("The response of LibraryApi->get_list_of_library_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_list_of_library_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: assetCategories, assetCategoriesIds, assetCategoriesNames, assets, assetsIds, assetsNames, assignedUser, assignedUserId, assignedUserName, code, createdAt, createdBy, createdById, createdByName, deleted, description, filterCreateImportJob, filterUpdateImportJob, id, isActive, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, ownerUser, ownerUserId, ownerUserName, 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]

Return type

GetListOfLibraryItems200Response

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_library

bool link_library(id, link, link_account_request)

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

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

bool mass_delete_library(link_account_request)

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

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

bool mass_update_library(mass_update_account_request)

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

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

bool remove_relation_for_library(link, ids, foreign_ids)

Remove relation for Library

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

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

bool unfollow_library(id)

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

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

bool unlink_library(id, link, ids)

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

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

Library update_library_item(id, create_library_item_request)

Update a record of the Library

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_library_item_request import CreateLibraryItemRequest
from clientapi_atrocore.models.library import Library
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.LibraryApi(api_client)
    id = 'id_example' # str | 
    create_library_item_request = clientapi_atrocore.CreateLibraryItemRequest() # CreateLibraryItemRequest | 

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

Parameters

Name	Type	Description	Notes
id	str
create_library_item_request	CreateLibraryItemRequest

Return type

Library

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

LibraryApi.md

Latest commit

History

LibraryApi.md

File metadata and controls

clientapi_atrocore.LibraryApi

add_relation_for_library

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_library_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_library_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

follow_library

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_library_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_linked_items_for_library_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_list_of_library_items

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

link_library

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_delete_library

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_update_library

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_relation_for_library

Example

Parameters