clientapi_atrocore.ScheduledJobApi

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

Method	HTTP request	Description
add_relation_for_scheduled_job	POST /ScheduledJob/{link}/relation	Add relation for ScheduledJob
create_scheduled_job_item	POST /ScheduledJob	Create a record of the ScheduledJob
delete_scheduled_job_item	DELETE /ScheduledJob/{id}	Delete a record of the ScheduledJob
follow_scheduled_job	PUT /ScheduledJob/{id}/subscription	Follow the ScheduledJob stream
get_linked_items_for_scheduled_job_item	GET /ScheduledJob/{id}/{link}	Returns linked entities for the ScheduledJob
get_list_of_scheduled_job_items	GET /ScheduledJob	Returns a collection of ScheduledJob records
get_scheduled_job_item	GET /ScheduledJob/{id}	Returns a record of the ScheduledJob
link_scheduled_job	POST /ScheduledJob/{id}/{link}	Link ScheduledJob to Entities
mass_delete_scheduled_job	POST /ScheduledJob/action/massDelete	Mass delete of ScheduledJob data
mass_update_scheduled_job	PUT /ScheduledJob/action/massUpdate	Mass update of ScheduledJob data
remove_relation_for_scheduled_job	DELETE /ScheduledJob/{link}/relation	Remove relation for ScheduledJob
unfollow_scheduled_job	DELETE /ScheduledJob/{id}/subscription	Unfollow the ScheduledJob stream
unlink_scheduled_job	DELETE /ScheduledJob/{id}/{link}	Unlink ScheduledJob from Entities
update_scheduled_job_item	PUT /ScheduledJob/{id}	Update a record of the ScheduledJob

add_relation_for_scheduled_job

bool add_relation_for_scheduled_job(link, ids, foreign_ids)

Add relation for ScheduledJob

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

    try:
        # Add relation for ScheduledJob
        api_response = api_instance.add_relation_for_scheduled_job(link, ids, foreign_ids)
        print("The response of ScheduledJobApi->add_relation_for_scheduled_job:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledJobApi->add_relation_for_scheduled_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_scheduled_job_item

ScheduledJob create_scheduled_job_item(create_scheduled_job_item_request)

Create a record of the ScheduledJob

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_scheduled_job_item_request import CreateScheduledJobItemRequest
from clientapi_atrocore.models.scheduled_job import ScheduledJob
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.ScheduledJobApi(api_client)
    create_scheduled_job_item_request = clientapi_atrocore.CreateScheduledJobItemRequest() # CreateScheduledJobItemRequest | 

    try:
        # Create a record of the ScheduledJob
        api_response = api_instance.create_scheduled_job_item(create_scheduled_job_item_request)
        print("The response of ScheduledJobApi->create_scheduled_job_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledJobApi->create_scheduled_job_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_scheduled_job_item_request	CreateScheduledJobItemRequest

Return type

ScheduledJob

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_scheduled_job_item

bool delete_scheduled_job_item(id)

Delete a record of the ScheduledJob

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

    try:
        # Delete a record of the ScheduledJob
        api_response = api_instance.delete_scheduled_job_item(id)
        print("The response of ScheduledJobApi->delete_scheduled_job_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledJobApi->delete_scheduled_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_scheduled_job

FollowAccount200Response follow_scheduled_job(id)

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

    try:
        # Follow the ScheduledJob stream
        api_response = api_instance.follow_scheduled_job(id)
        print("The response of ScheduledJobApi->follow_scheduled_job:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledJobApi->follow_scheduled_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_linked_items_for_scheduled_job_item

GetLinkedItemsForAccountItem200Response get_linked_items_for_scheduled_job_item(id, link, language=language)

Returns linked entities for the ScheduledJob

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.ScheduledJobApi(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 ScheduledJob
        api_response = api_instance.get_linked_items_for_scheduled_job_item(id, link, language=language)
        print("The response of ScheduledJobApi->get_linked_items_for_scheduled_job_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledJobApi->get_linked_items_for_scheduled_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_scheduled_job_items

GetListOfScheduledJobItems200Response get_list_of_scheduled_job_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)

Returns a collection of ScheduledJob records

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_list_of_scheduled_job_items200_response import GetListOfScheduledJobItems200Response
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.ScheduledJobApi(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, exportFeed, exportFeedId, exportFeedName, exportFeeds, exportFeedsIds, exportFeedsNames, filterCreateImportJob, filterUpdateImportJob, id, importFeed, importFeedId, importFeedName, importFeeds, importFeedsIds, importFeedsNames, isInternal, job, lastRun, logIds, logNames, maximumHoursToLookBack, minimum_age, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, scheduling, status (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 ScheduledJob records
        api_response = api_instance.get_list_of_scheduled_job_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)
        print("The response of ScheduledJobApi->get_list_of_scheduled_job_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledJobApi->get_list_of_scheduled_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: createdAt, createdBy, createdById, createdByName, deleted, exportFeed, exportFeedId, exportFeedName, exportFeeds, exportFeedsIds, exportFeedsNames, filterCreateImportJob, filterUpdateImportJob, id, importFeed, importFeedId, importFeedName, importFeeds, importFeedsIds, importFeedsNames, isInternal, job, lastRun, logIds, logNames, maximumHoursToLookBack, minimum_age, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, scheduling, status	[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

GetListOfScheduledJobItems200Response

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_scheduled_job_item

ScheduledJob get_scheduled_job_item(id, language=language)

Returns a record of the ScheduledJob

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.scheduled_job import ScheduledJob
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.ScheduledJobApi(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 ScheduledJob
        api_response = api_instance.get_scheduled_job_item(id, language=language)
        print("The response of ScheduledJobApi->get_scheduled_job_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledJobApi->get_scheduled_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

ScheduledJob

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_scheduled_job

bool link_scheduled_job(id, link, link_account_request)

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

    try:
        # Link ScheduledJob to Entities
        api_response = api_instance.link_scheduled_job(id, link, link_account_request)
        print("The response of ScheduledJobApi->link_scheduled_job:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledJobApi->link_scheduled_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_scheduled_job

bool mass_delete_scheduled_job(link_account_request)

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

    try:
        # Mass delete of ScheduledJob data
        api_response = api_instance.mass_delete_scheduled_job(link_account_request)
        print("The response of ScheduledJobApi->mass_delete_scheduled_job:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledJobApi->mass_delete_scheduled_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_scheduled_job

bool mass_update_scheduled_job(mass_update_account_request)

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

    try:
        # Mass update of ScheduledJob data
        api_response = api_instance.mass_update_scheduled_job(mass_update_account_request)
        print("The response of ScheduledJobApi->mass_update_scheduled_job:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledJobApi->mass_update_scheduled_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_scheduled_job

bool remove_relation_for_scheduled_job(link, ids, foreign_ids)

Remove relation for ScheduledJob

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

    try:
        # Remove relation for ScheduledJob
        api_response = api_instance.remove_relation_for_scheduled_job(link, ids, foreign_ids)
        print("The response of ScheduledJobApi->remove_relation_for_scheduled_job:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledJobApi->remove_relation_for_scheduled_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_scheduled_job

bool unfollow_scheduled_job(id)

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

    try:
        # Unfollow the ScheduledJob stream
        api_response = api_instance.unfollow_scheduled_job(id)
        print("The response of ScheduledJobApi->unfollow_scheduled_job:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledJobApi->unfollow_scheduled_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_scheduled_job

bool unlink_scheduled_job(id, link, ids)

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

    try:
        # Unlink ScheduledJob from Entities
        api_response = api_instance.unlink_scheduled_job(id, link, ids)
        print("The response of ScheduledJobApi->unlink_scheduled_job:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledJobApi->unlink_scheduled_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_scheduled_job_item

ScheduledJob update_scheduled_job_item(id, create_scheduled_job_item_request)

Update a record of the ScheduledJob

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_scheduled_job_item_request import CreateScheduledJobItemRequest
from clientapi_atrocore.models.scheduled_job import ScheduledJob
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.ScheduledJobApi(api_client)
    id = 'id_example' # str | 
    create_scheduled_job_item_request = clientapi_atrocore.CreateScheduledJobItemRequest() # CreateScheduledJobItemRequest | 

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

Parameters

Name	Type	Description	Notes
id	str
create_scheduled_job_item_request	CreateScheduledJobItemRequest

Return type

ScheduledJob

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

ScheduledJobApi.md

Latest commit

History

ScheduledJobApi.md

File metadata and controls

clientapi_atrocore.ScheduledJobApi

add_relation_for_scheduled_job

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_scheduled_job_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_scheduled_job_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

follow_scheduled_job

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_linked_items_for_scheduled_job_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_list_of_scheduled_job_items

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_scheduled_job_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

link_scheduled_job

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_delete_scheduled_job

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_update_scheduled_job

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_relation_for_scheduled_job

Example

Parameters