Skip to content
This repository was archived by the owner on Feb 21, 2025. It is now read-only.

Latest commit

 

History

History
1231 lines (905 loc) · 42.8 KB

File metadata and controls

1231 lines (905 loc) · 42.8 KB

clientapi_atrocore.ImportJobLogApi

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

Method HTTP request Description
add_relation_for_import_job_log POST /ImportJobLog/{link}/relation Add relation for ImportJobLog
create_import_job_log_item POST /ImportJobLog Create a record of the ImportJobLog
delete_import_job_log_item DELETE /ImportJobLog/{id} Delete a record of the ImportJobLog
follow_import_job_log PUT /ImportJobLog/{id}/subscription Follow the ImportJobLog stream
get_import_job_log_item GET /ImportJobLog/{id} Returns a record of the ImportJobLog
get_linked_items_for_import_job_log_item GET /ImportJobLog/{id}/{link} Returns linked entities for the ImportJobLog
get_list_of_import_job_log_items GET /ImportJobLog Returns a collection of ImportJobLog records
link_import_job_log POST /ImportJobLog/{id}/{link} Link ImportJobLog to Entities
mass_delete_import_job_log POST /ImportJobLog/action/massDelete Mass delete of ImportJobLog data
mass_update_import_job_log PUT /ImportJobLog/action/massUpdate Mass update of ImportJobLog data
remove_relation_for_import_job_log DELETE /ImportJobLog/{link}/relation Remove relation for ImportJobLog
unfollow_import_job_log DELETE /ImportJobLog/{id}/subscription Unfollow the ImportJobLog stream
unlink_import_job_log DELETE /ImportJobLog/{id}/{link} Unlink ImportJobLog from Entities
update_import_job_log_item PUT /ImportJobLog/{id} Update a record of the ImportJobLog

add_relation_for_import_job_log

bool add_relation_for_import_job_log(link, ids, foreign_ids)

Add relation for ImportJobLog

Add relation for ImportJobLog

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

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

ImportJobLog create_import_job_log_item(create_import_job_log_item_request)

Create a record of the ImportJobLog

Create a record of the ImportJobLog

Example

  • Api Key Authentication (Authorization-Token):
import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_import_job_log_item_request import CreateImportJobLogItemRequest
from clientapi_atrocore.models.import_job_log import ImportJobLog
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.ImportJobLogApi(api_client)
    create_import_job_log_item_request = clientapi_atrocore.CreateImportJobLogItemRequest() # CreateImportJobLogItemRequest | 

    try:
        # Create a record of the ImportJobLog
        api_response = api_instance.create_import_job_log_item(create_import_job_log_item_request)
        print("The response of ImportJobLogApi->create_import_job_log_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportJobLogApi->create_import_job_log_item: %s\n" % e)

Parameters

Name Type Description Notes
create_import_job_log_item_request CreateImportJobLogItemRequest

Return type

ImportJobLog

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_import_job_log_item

bool delete_import_job_log_item(id)

Delete a record of the ImportJobLog

Delete a record of the ImportJobLog

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

    try:
        # Delete a record of the ImportJobLog
        api_response = api_instance.delete_import_job_log_item(id)
        print("The response of ImportJobLogApi->delete_import_job_log_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportJobLogApi->delete_import_job_log_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_import_job_log

FollowAccount200Response follow_import_job_log(id)

Follow the ImportJobLog stream

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

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

ImportJobLog get_import_job_log_item(id, language=language)

Returns a record of the ImportJobLog

Returns a record of the ImportJobLog

Example

  • Api Key Authentication (Authorization-Token):
import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.import_job_log import ImportJobLog
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.ImportJobLogApi(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 ImportJobLog
        api_response = api_instance.get_import_job_log_item(id, language=language)
        print("The response of ImportJobLogApi->get_import_job_log_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportJobLogApi->get_import_job_log_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

ImportJobLog

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_import_job_log_item

GetLinkedItemsForAccountItem200Response get_linked_items_for_import_job_log_item(id, link, language=language)

Returns linked entities for the ImportJobLog

Returns linked entities for the ImportJobLog

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.ImportJobLogApi(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 ImportJobLog
        api_response = api_instance.get_linked_items_for_import_job_log_item(id, link, language=language)
        print("The response of ImportJobLogApi->get_linked_items_for_import_job_log_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportJobLogApi->get_linked_items_for_import_job_log_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_import_job_log_items

GetListOfImportJobLogItems200Response get_list_of_import_job_log_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)

Returns a collection of ImportJobLog records

Returns a collection of ImportJobLog records

Example

  • Api Key Authentication (Authorization-Token):
import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_list_of_import_job_log_items200_response import GetListOfImportJobLogItems200Response
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.ImportJobLogApi(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: createdAt, createdBy, createdById, createdByName, deleted, entityId, entityName, filterCreateImportJob, filterUpdateImportJob, id, importJob, importJobId, importJobName, message, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, restoreData, rowNumber, type (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 ImportJobLog records
        api_response = api_instance.get_list_of_import_job_log_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)
        print("The response of ImportJobLogApi->get_list_of_import_job_log_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportJobLogApi->get_list_of_import_job_log_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: createdAt, createdBy, createdById, createdByName, deleted, entityId, entityName, filterCreateImportJob, filterUpdateImportJob, id, importJob, importJobId, importJobName, message, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, restoreData, rowNumber, type [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

GetListOfImportJobLogItems200Response

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_import_job_log

bool link_import_job_log(id, link, link_account_request)

Link ImportJobLog to Entities

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

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

bool mass_delete_import_job_log(link_account_request)

Mass delete of ImportJobLog data

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

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

bool mass_update_import_job_log(mass_update_account_request)

Mass update of ImportJobLog data

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

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

bool remove_relation_for_import_job_log(link, ids, foreign_ids)

Remove relation for ImportJobLog

Remove relation for ImportJobLog

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

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

bool unfollow_import_job_log(id)

Unfollow the ImportJobLog stream

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

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

bool unlink_import_job_log(id, link, ids)

Unlink ImportJobLog from Entities

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

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

ImportJobLog update_import_job_log_item(id, create_import_job_log_item_request)

Update a record of the ImportJobLog

Update a record of the ImportJobLog

Example

  • Api Key Authentication (Authorization-Token):
import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_import_job_log_item_request import CreateImportJobLogItemRequest
from clientapi_atrocore.models.import_job_log import ImportJobLog
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.ImportJobLogApi(api_client)
    id = 'id_example' # str | 
    create_import_job_log_item_request = clientapi_atrocore.CreateImportJobLogItemRequest() # CreateImportJobLogItemRequest | 

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

Parameters

Name Type Description Notes
id str
create_import_job_log_item_request CreateImportJobLogItemRequest

Return type

ImportJobLog

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]