clientapi_atrocore.ExportJobApi

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

Method	HTTP request	Description
add_relation_for_export_job	POST /ExportJob/{link}/relation	Add relation for ExportJob
create_export_job_item	POST /ExportJob	Create a record of the ExportJob
delete_export_job_item	DELETE /ExportJob/{id}	Delete a record of the ExportJob
follow_export_job	PUT /ExportJob/{id}/subscription	Follow the ExportJob stream
get_export_job_item	GET /ExportJob/{id}	Returns a record of the ExportJob
get_linked_items_for_export_job_item	GET /ExportJob/{id}/{link}	Returns linked entities for the ExportJob
get_list_of_export_job_items	GET /ExportJob	Returns a collection of ExportJob records
link_export_job	POST /ExportJob/{id}/{link}	Link ExportJob to Entities
mass_delete_export_job	POST /ExportJob/action/massDelete	Mass delete of ExportJob data
mass_update_export_job	PUT /ExportJob/action/massUpdate	Mass update of ExportJob data
remove_relation_for_export_job	DELETE /ExportJob/{link}/relation	Remove relation for ExportJob
unfollow_export_job	DELETE /ExportJob/{id}/subscription	Unfollow the ExportJob stream
unlink_export_job	DELETE /ExportJob/{id}/{link}	Unlink ExportJob from Entities
update_export_job_item	PUT /ExportJob/{id}	Update a record of the ExportJob

add_relation_for_export_job

bool add_relation_for_export_job(link, ids, foreign_ids)

Add relation for ExportJob

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

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

ExportJob create_export_job_item(create_export_job_item_request)

Create a record of the ExportJob

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_export_job_item_request import CreateExportJobItemRequest
from clientapi_atrocore.models.export_job import ExportJob
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.ExportJobApi(api_client)
    create_export_job_item_request = clientapi_atrocore.CreateExportJobItemRequest() # CreateExportJobItemRequest | 

    try:
        # Create a record of the ExportJob
        api_response = api_instance.create_export_job_item(create_export_job_item_request)
        print("The response of ExportJobApi->create_export_job_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportJobApi->create_export_job_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_export_job_item_request	CreateExportJobItemRequest

Return type

ExportJob

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_export_job_item

bool delete_export_job_item(id)

Delete a record of the ExportJob

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

    try:
        # Delete a record of the ExportJob
        api_response = api_instance.delete_export_job_item(id)
        print("The response of ExportJobApi->delete_export_job_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportJobApi->delete_export_job_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_export_job

FollowAccount200Response follow_export_job(id)

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

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

ExportJob get_export_job_item(id, language=language)

Returns a record of the ExportJob

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.export_job import ExportJob
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.ExportJobApi(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 ExportJob
        api_response = api_instance.get_export_job_item(id, language=language)
        print("The response of ExportJobApi->get_export_job_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportJobApi->get_export_job_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

ExportJob

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_export_job_item

GetLinkedItemsForAccountItem200Response get_linked_items_for_export_job_item(id, link, language=language)

Returns linked entities for the ExportJob

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.ExportJobApi(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 ExportJob
        api_response = api_instance.get_linked_items_for_export_job_item(id, link, language=language)
        print("The response of ExportJobApi->get_linked_items_for_export_job_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportJobApi->get_linked_items_for_export_job_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_export_job_items

GetListOfExportJobItems200Response get_list_of_export_job_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)

Returns a collection of ExportJob records

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_list_of_export_job_items200_response import GetListOfExportJobItems200Response
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.ExportJobApi(api_client)
    language = 'language_example' # str | Set this parameter for data to be returned for a specified language (optional)
    select = 'name,createdAt' # str | Available fields: assignedUser, assignedUserId, assignedUserName, count, createdAt, createdBy, createdById, createdByName, data, deleted, editable, end, exportFeed, exportFeedId, exportFeedName, fileId, fileName, filePathsData, filterCreateImportJob, filterUpdateImportJob, id, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, ownerUser, ownerUserId, ownerUserName, payload, sortOrder, start, state, stateMessage, teams, teamsIds, teamsNames, trial (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 ExportJob records
        api_response = api_instance.get_list_of_export_job_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)
        print("The response of ExportJobApi->get_list_of_export_job_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportJobApi->get_list_of_export_job_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: assignedUser, assignedUserId, assignedUserName, count, createdAt, createdBy, createdById, createdByName, data, deleted, editable, end, exportFeed, exportFeedId, exportFeedName, fileId, fileName, filePathsData, filterCreateImportJob, filterUpdateImportJob, id, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, ownerUser, ownerUserId, ownerUserName, payload, sortOrder, start, state, stateMessage, teams, teamsIds, teamsNames, trial	[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

GetListOfExportJobItems200Response

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_export_job

bool link_export_job(id, link, link_account_request)

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

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

bool mass_delete_export_job(link_account_request)

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

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

bool mass_update_export_job(mass_update_account_request)

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

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

bool remove_relation_for_export_job(link, ids, foreign_ids)

Remove relation for ExportJob

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

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

bool unfollow_export_job(id)

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

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

bool unlink_export_job(id, link, ids)

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

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

ExportJob update_export_job_item(id, create_export_job_item_request)

Update a record of the ExportJob

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_export_job_item_request import CreateExportJobItemRequest
from clientapi_atrocore.models.export_job import ExportJob
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.ExportJobApi(api_client)
    id = 'id_example' # str | 
    create_export_job_item_request = clientapi_atrocore.CreateExportJobItemRequest() # CreateExportJobItemRequest | 

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

Parameters

Name	Type	Description	Notes
id	str
create_export_job_item_request	CreateExportJobItemRequest

Return type

ExportJob

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

ExportJobApi.md

Latest commit

History

ExportJobApi.md

File metadata and controls

clientapi_atrocore.ExportJobApi

add_relation_for_export_job

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_export_job_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_export_job_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

follow_export_job

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_export_job_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_linked_items_for_export_job_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_list_of_export_job_items

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

link_export_job

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_delete_export_job

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_update_export_job

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_relation_for_export_job

Example

Parameters