View the Project on GitHub elements-storage/elements-sdk-python
Method | HTTP request | Description |
---|---|---|
abort_task | POST /api/2/tasks/{id}/abort |
|
create_job | POST /api/2/jobs |
|
create_job_fs_trigger | POST /api/2/jobs/fs-triggers |
|
create_schedule | POST /api/2/schedules |
|
create_subtask | POST /api/2/subtasks |
|
delete_finished_tasks | DELETE /api/2/tasks/finished |
|
delete_job | DELETE /api/2/jobs/{id} |
|
delete_job_fs_trigger | DELETE /api/2/jobs/fs-triggers/{id} |
|
delete_schedule | DELETE /api/2/schedules/{id} |
|
delete_subtask | DELETE /api/2/subtasks/{id} |
|
delete_task | DELETE /api/2/tasks/{id} |
|
download_all_task_logs | GET /api/2/tasks/logs/download |
|
download_task_log | GET /api/2/tasks/{id}/log/download |
|
export_job | GET /api/2/jobs/{id}/export |
|
get_all_events | GET /api/2/events |
|
get_all_job_fs_triggers | GET /api/2/jobs/fs-triggers |
|
get_all_jobs | GET /api/2/jobs |
|
get_all_schedules | GET /api/2/schedules |
|
get_all_subtasks | GET /api/2/subtasks |
|
get_all_task_queues | GET /api/2/tasks/queues |
|
get_all_task_types | GET /api/2/tasks/types |
|
get_all_tasks | GET /api/2/tasks |
|
get_event | GET /api/2/events/{id} |
|
get_finished_tasks | GET /api/2/tasks/finished |
|
get_job | GET /api/2/jobs/{id} |
|
get_job_fs_trigger | GET /api/2/jobs/fs-triggers/{id} |
|
get_job_variable_options | GET /api/2/jobs/{id}/variables/{name}/options |
|
get_pending_tasks | GET /api/2/tasks/pending |
|
get_python_environments | GET /api/2/python/environments |
|
get_schedule | GET /api/2/schedules/{id} |
|
get_subtask | GET /api/2/subtasks/{id} |
|
get_task | GET /api/2/tasks/{id} |
|
get_task_log | GET /api/2/tasks/{id}/log |
|
get_task_log_v2 | GET /api/2/tasks/{id}/log-v2 |
|
get_task_type | GET /api/2/tasks/types/{type} |
|
get_tasks_summary | GET /api/2/tasks/summary |
|
import_job | POST /api/2/jobs/import |
|
kill_all_pending_tasks | DELETE /api/2/tasks/pending |
|
kill_task | POST /api/2/tasks/{id}/kill |
|
patch_job | PATCH /api/2/jobs/{id} |
|
patch_job_fs_trigger | PATCH /api/2/jobs/fs-triggers/{id} |
|
patch_schedule | PATCH /api/2/schedules/{id} |
|
patch_subtask | PATCH /api/2/subtasks/{id} |
|
restart_task | POST /api/2/tasks/{id}/restart |
|
start_job | POST /api/2/jobs/{id}/start |
|
start_task | POST /api/2/tasks/start |
|
update_job | PUT /api/2/jobs/{id} |
|
update_job_fs_trigger | PUT /api/2/jobs/fs-triggers/{id} |
|
update_schedule | PUT /api/2/schedules/{id} |
|
update_subtask | PUT /api/2/subtasks/{id} |
def abort_task(id)
tasks:manage
import elements_sdk
from elements_sdk.api import automation_api
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = "id_example" # str | A unique value identifying this task info.
# example passing only required values which don't have defaults set
try:
api_instance.abort_task(id)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->abort_task: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | str | A unique value identifying this task info. |
void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def JobDetail create_job(job_detail_update)
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.job_detail_update import JobDetailUpdate
from elements_sdk.model.job_detail import JobDetail
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
job_detail_update = JobDetailUpdate(
schedules=[
ScheduleReference(
id=1,
),
],
variable_definitions=[
{
"key": "key_example",
},
],
subtasks=[
SubtaskReference(
id=1,
),
],
allow_users=[
ElementsUserReference(
id=1,
),
],
allow_groups=[
ElementsGroupReference(
id=1,
),
],
media_roots=[
1,
],
workflow=1,
special_type=2,
name="name_example",
description="description_example",
enabled=True,
allow_others_to_start=True,
allow_client_to_start=True,
show_as_button=True,
input_type="path",
add_to_new_media_roots=True,
hook="hook_example",
webhook_secret="webhook_secret_example",
elements_release="elements_release_example",
security_context=1,
) # JobDetailUpdate |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.create_job(job_detail_update)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->create_job: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job_detail_update | JobDetailUpdate |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def JobFSTrigger create_job_fs_trigger(job_fs_trigger_update)
tasks:manage
import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.job_fs_trigger import JobFSTrigger
from elements_sdk.model.job_fs_trigger_update import JobFSTriggerUpdate
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
job_fs_trigger_update = JobFSTriggerUpdate(
path="path_example",
name_glob="name_glob_example",
recursive=True,
listen_for_created=True,
listen_for_modified=True,
listen_for_renamed=True,
listen_for_deleted=True,
job=1,
) # JobFSTriggerUpdate |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.create_job_fs_trigger(job_fs_trigger_update)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->create_job_fs_trigger: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job_fs_trigger_update | JobFSTriggerUpdate |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def Schedule create_schedule(schedule_update)
tasks:view
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.schedule import Schedule
from elements_sdk.model.schedule_update import ScheduleUpdate
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
schedule_update = ScheduleUpdate(
variables={
"key": "key_example",
},
type=1,
enabled=True,
last_run=dateutil_parser('1970-01-01T00:00:00.00Z'),
every=-2147483648,
period="minutes",
crontab_day_of_month="crontab_day_of_month_example",
crontab_day_of_week="crontab_day_of_week_example",
crontab_hour="crontab_hour_example",
crontab_minute="crontab_minute_example",
crontab_month_of_year="crontab_month_of_year_example",
job=1,
) # ScheduleUpdate |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.create_schedule(schedule_update)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->create_schedule: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
schedule_update | ScheduleUpdate |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def Subtask create_subtask(subtask_update)
tasks:view
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.subtask import Subtask
from elements_sdk.model.subtask_update import SubtaskUpdate
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
subtask_update = SubtaskUpdate(
kwargs={},
graph_layout={
"key": "key_example",
},
trigger="trigger_example",
name="name_example",
noop_dont_save=True,
no_concurrency=True,
timeout=-2147483648,
log_variable=True,
task="task_example",
condition_variable="condition_variable_example",
condition_value="condition_value_example",
sync=True,
queue="queue_example",
enqueue_at_front=True,
parent=1,
relative_to=1,
) # SubtaskUpdate |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.create_subtask(subtask_update)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->create_subtask: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
subtask_update | SubtaskUpdate |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def delete_finished_tasks()
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
# example, this endpoint has no required or optional parameters
try:
api_instance.delete_finished_tasks()
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->delete_finished_tasks: %s\n" % e)
This endpoint does not need any parameter.
void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def delete_job(id)
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this job.
# example passing only required values which don't have defaults set
try:
api_instance.delete_job(id)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->delete_job: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this job. |
void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def delete_job_fs_trigger(id)
tasks:manage
import elements_sdk
from elements_sdk.api import automation_api
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this Job FS trigger.
# example passing only required values which don't have defaults set
try:
api_instance.delete_job_fs_trigger(id)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->delete_job_fs_trigger: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this Job FS trigger. |
void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def delete_schedule(id)
tasks:view
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this schedule.
# example passing only required values which don't have defaults set
try:
api_instance.delete_schedule(id)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->delete_schedule: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this schedule. |
void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def delete_subtask(id)
tasks:view
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this subtask.
# example passing only required values which don't have defaults set
try:
api_instance.delete_subtask(id)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->delete_subtask: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this subtask. |
void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def delete_task(id)
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = "id_example" # str | A unique value identifying this task info.
# example passing only required values which don't have defaults set
try:
api_instance.delete_task(id)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->delete_task: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | str | A unique value identifying this task info. |
void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def download_all_task_logs()
tasks:view
import elements_sdk
from elements_sdk.api import automation_api
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
job_instance = "job_instance_example" # str | Filter the returned list by `job_instance`. (optional)
job_instance__in = "job_instance__in_example" # str | Multiple values may be separated by commas. (optional)
subtask = 1 # int | Filter the returned list by `subtask`. (optional)
state = "state_example" # str | Filter the returned list by `state`. (optional)
state__in = 3.14 # float | Multiple values may be separated by commas. (optional)
id = "id_example" # str | Filter the returned list by `id`. (optional)
id__in = "id__in_example" # str | Multiple values may be separated by commas. (optional)
name = "name_example" # str | Filter the returned list by `name`. (optional)
task_name = "task_name_example" # str | Filter the returned list by `task_name`. (optional)
is_finished = "is_finished_example" # str | Filter the returned list by `is_finished`. (optional)
is_running = "is_running_example" # str | Filter the returned list by `is_running`. (optional)
related_proxy_id = 3.14 # float | Filter the returned list by `related_proxy_id`. (optional)
ordering = "ordering_example" # str | Which field to use when ordering the results. (optional)
limit = 1 # int | Number of results to return per page. (optional)
offset = 1 # int | The initial index from which to return the results. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
api_instance.download_all_task_logs(job_instance=job_instance, job_instance__in=job_instance__in, subtask=subtask, state=state, state__in=state__in, id=id, id__in=id__in, name=name, task_name=task_name, is_finished=is_finished, is_running=is_running, related_proxy_id=related_proxy_id, ordering=ordering, limit=limit, offset=offset)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->download_all_task_logs: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job_instance | str | Filter the returned list by `job_instance`. | [optional] |
job_instance__in | str | Multiple values may be separated by commas. | [optional] |
subtask | int | Filter the returned list by `subtask`. | [optional] |
state | str | Filter the returned list by `state`. | [optional] |
state__in | float | Multiple values may be separated by commas. | [optional] |
id | str | Filter the returned list by `id`. | [optional] |
id__in | str | Multiple values may be separated by commas. | [optional] |
name | str | Filter the returned list by `name`. | [optional] |
task_name | str | Filter the returned list by `task_name`. | [optional] |
is_finished | str | Filter the returned list by `is_finished`. | [optional] |
is_running | str | Filter the returned list by `is_running`. | [optional] |
related_proxy_id | float | Filter the returned list by `related_proxy_id`. | [optional] |
ordering | str | Which field to use when ordering the results. | [optional] |
limit | int | Number of results to return per page. | [optional] |
offset | int | The initial index from which to return the results. | [optional] |
void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def download_task_log(id)
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = "id_example" # str | A unique value identifying this task info.
# example passing only required values which don't have defaults set
try:
api_instance.download_task_log(id)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->download_task_log: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | str | A unique value identifying this task info. |
void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def export_job(id)
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this job.
# example passing only required values which don't have defaults set
try:
api_instance.export_job(id)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->export_job: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this job. |
void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def [Event] get_all_events()
import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.event import Event
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
ordering = "ordering_example" # str | Which field to use when ordering the results. (optional)
limit = 1 # int | Number of results to return per page. (optional)
offset = 1 # int | The initial index from which to return the results. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
api_response = api_instance.get_all_events(ordering=ordering, limit=limit, offset=offset)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_all_events: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
ordering | str | Which field to use when ordering the results. | [optional] |
limit | int | Number of results to return per page. | [optional] |
offset | int | The initial index from which to return the results. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def [JobFSTrigger] get_all_job_fs_triggers()
tasks:manage
import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.job_fs_trigger import JobFSTrigger
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
job = 1 # int | Filter the returned list by `job`. (optional)
ordering = "ordering_example" # str | Which field to use when ordering the results. (optional)
limit = 1 # int | Number of results to return per page. (optional)
offset = 1 # int | The initial index from which to return the results. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
api_response = api_instance.get_all_job_fs_triggers(job=job, ordering=ordering, limit=limit, offset=offset)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_all_job_fs_triggers: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job | int | Filter the returned list by `job`. | [optional] |
ordering | str | Which field to use when ordering the results. | [optional] |
limit | int | Number of results to return per page. | [optional] |
offset | int | The initial index from which to return the results. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def [Job] get_all_jobs()
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.job import Job
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
special_type = "special_type_example" # str | Filter the returned list by `special_type`. (optional)
special_type__isnull = "special_type__isnull_example" # str | Filter the returned list by `special_type__isnull`. (optional)
hook = "hook_example" # str | Filter the returned list by `hook`. (optional)
name = "name_example" # str | Filter the returned list by `name`. (optional)
ordering = "ordering_example" # str | Which field to use when ordering the results. (optional)
limit = 1 # int | Number of results to return per page. (optional)
offset = 1 # int | The initial index from which to return the results. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
api_response = api_instance.get_all_jobs(special_type=special_type, special_type__isnull=special_type__isnull, hook=hook, name=name, ordering=ordering, limit=limit, offset=offset)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_all_jobs: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
special_type | str | Filter the returned list by `special_type`. | [optional] |
special_type__isnull | str | Filter the returned list by `special_type__isnull`. | [optional] |
hook | str | Filter the returned list by `hook`. | [optional] |
name | str | Filter the returned list by `name`. | [optional] |
ordering | str | Which field to use when ordering the results. | [optional] |
limit | int | Number of results to return per page. | [optional] |
offset | int | The initial index from which to return the results. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def [Schedule] get_all_schedules()
tasks:view
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.schedule import Schedule
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
job = 1 # int | Filter the returned list by `job`. (optional)
ordering = "ordering_example" # str | Which field to use when ordering the results. (optional)
limit = 1 # int | Number of results to return per page. (optional)
offset = 1 # int | The initial index from which to return the results. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
api_response = api_instance.get_all_schedules(job=job, ordering=ordering, limit=limit, offset=offset)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_all_schedules: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job | int | Filter the returned list by `job`. | [optional] |
ordering | str | Which field to use when ordering the results. | [optional] |
limit | int | Number of results to return per page. | [optional] |
offset | int | The initial index from which to return the results. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def [Subtask] get_all_subtasks()
tasks:view
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.subtask import Subtask
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
parent = 1 # int | Filter the returned list by `parent`. (optional)
ordering = "ordering_example" # str | Which field to use when ordering the results. (optional)
limit = 1 # int | Number of results to return per page. (optional)
offset = 1 # int | The initial index from which to return the results. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
api_response = api_instance.get_all_subtasks(parent=parent, ordering=ordering, limit=limit, offset=offset)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_all_subtasks: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
parent | int | Filter the returned list by `parent`. | [optional] |
ordering | str | Which field to use when ordering the results. | [optional] |
limit | int | Number of results to return per page. | [optional] |
offset | int | The initial index from which to return the results. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def [Queue] get_all_task_queues()
tasks:view
import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.queue import Queue
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
ordering = "ordering_example" # str | Which field to use when ordering the results. (optional)
limit = 1 # int | Number of results to return per page. (optional)
offset = 1 # int | The initial index from which to return the results. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
api_response = api_instance.get_all_task_queues(ordering=ordering, limit=limit, offset=offset)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_all_task_queues: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
ordering | str | Which field to use when ordering the results. | [optional] |
limit | int | Number of results to return per page. | [optional] |
offset | int | The initial index from which to return the results. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def [TaskType] get_all_task_types()
import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.task_type import TaskType
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
ordering = "ordering_example" # str | Which field to use when ordering the results. (optional)
limit = 1 # int | Number of results to return per page. (optional)
offset = 1 # int | The initial index from which to return the results. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
api_response = api_instance.get_all_task_types(ordering=ordering, limit=limit, offset=offset)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_all_task_types: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
ordering | str | Which field to use when ordering the results. | [optional] |
limit | int | Number of results to return per page. | [optional] |
offset | int | The initial index from which to return the results. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def [TaskInfo] get_all_tasks()
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.task_info import TaskInfo
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
job_instance = "job_instance_example" # str | Filter the returned list by `job_instance`. (optional)
job_instance__in = "job_instance__in_example" # str | Multiple values may be separated by commas. (optional)
subtask = 1 # int | Filter the returned list by `subtask`. (optional)
state = "state_example" # str | Filter the returned list by `state`. (optional)
state__in = 3.14 # float | Multiple values may be separated by commas. (optional)
id = "id_example" # str | Filter the returned list by `id`. (optional)
id__in = "id__in_example" # str | Multiple values may be separated by commas. (optional)
name = "name_example" # str | Filter the returned list by `name`. (optional)
task_name = "task_name_example" # str | Filter the returned list by `task_name`. (optional)
is_finished = "is_finished_example" # str | Filter the returned list by `is_finished`. (optional)
is_running = "is_running_example" # str | Filter the returned list by `is_running`. (optional)
related_proxy_id = 3.14 # float | Filter the returned list by `related_proxy_id`. (optional)
ordering = "ordering_example" # str | Which field to use when ordering the results. (optional)
limit = 1 # int | Number of results to return per page. (optional)
offset = 1 # int | The initial index from which to return the results. (optional)
include_kwargs = True # bool | (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
api_response = api_instance.get_all_tasks(job_instance=job_instance, job_instance__in=job_instance__in, subtask=subtask, state=state, state__in=state__in, id=id, id__in=id__in, name=name, task_name=task_name, is_finished=is_finished, is_running=is_running, related_proxy_id=related_proxy_id, ordering=ordering, limit=limit, offset=offset, include_kwargs=include_kwargs)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_all_tasks: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job_instance | str | Filter the returned list by `job_instance`. | [optional] |
job_instance__in | str | Multiple values may be separated by commas. | [optional] |
subtask | int | Filter the returned list by `subtask`. | [optional] |
state | str | Filter the returned list by `state`. | [optional] |
state__in | float | Multiple values may be separated by commas. | [optional] |
id | str | Filter the returned list by `id`. | [optional] |
id__in | str | Multiple values may be separated by commas. | [optional] |
name | str | Filter the returned list by `name`. | [optional] |
task_name | str | Filter the returned list by `task_name`. | [optional] |
is_finished | str | Filter the returned list by `is_finished`. | [optional] |
is_running | str | Filter the returned list by `is_running`. | [optional] |
related_proxy_id | float | Filter the returned list by `related_proxy_id`. | [optional] |
ordering | str | Which field to use when ordering the results. | [optional] |
limit | int | Number of results to return per page. | [optional] |
offset | int | The initial index from which to return the results. | [optional] |
include_kwargs | bool | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def Event get_event(id)
import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.event import Event
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = "id_example" # str |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.get_event(id)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_event: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | str |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def [TaskInfo] get_finished_tasks()
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.task_info import TaskInfo
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
job_instance = "job_instance_example" # str | Filter the returned list by `job_instance`. (optional)
job_instance__in = "job_instance__in_example" # str | Multiple values may be separated by commas. (optional)
subtask = 1 # int | Filter the returned list by `subtask`. (optional)
state = "state_example" # str | Filter the returned list by `state`. (optional)
state__in = 3.14 # float | Multiple values may be separated by commas. (optional)
id = "id_example" # str | Filter the returned list by `id`. (optional)
id__in = "id__in_example" # str | Multiple values may be separated by commas. (optional)
name = "name_example" # str | Filter the returned list by `name`. (optional)
task_name = "task_name_example" # str | Filter the returned list by `task_name`. (optional)
is_finished = "is_finished_example" # str | Filter the returned list by `is_finished`. (optional)
is_running = "is_running_example" # str | Filter the returned list by `is_running`. (optional)
related_proxy_id = 3.14 # float | Filter the returned list by `related_proxy_id`. (optional)
ordering = "ordering_example" # str | Which field to use when ordering the results. (optional)
limit = 1 # int | Number of results to return per page. (optional)
offset = 1 # int | The initial index from which to return the results. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
api_response = api_instance.get_finished_tasks(job_instance=job_instance, job_instance__in=job_instance__in, subtask=subtask, state=state, state__in=state__in, id=id, id__in=id__in, name=name, task_name=task_name, is_finished=is_finished, is_running=is_running, related_proxy_id=related_proxy_id, ordering=ordering, limit=limit, offset=offset)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_finished_tasks: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job_instance | str | Filter the returned list by `job_instance`. | [optional] |
job_instance__in | str | Multiple values may be separated by commas. | [optional] |
subtask | int | Filter the returned list by `subtask`. | [optional] |
state | str | Filter the returned list by `state`. | [optional] |
state__in | float | Multiple values may be separated by commas. | [optional] |
id | str | Filter the returned list by `id`. | [optional] |
id__in | str | Multiple values may be separated by commas. | [optional] |
name | str | Filter the returned list by `name`. | [optional] |
task_name | str | Filter the returned list by `task_name`. | [optional] |
is_finished | str | Filter the returned list by `is_finished`. | [optional] |
is_running | str | Filter the returned list by `is_running`. | [optional] |
related_proxy_id | float | Filter the returned list by `related_proxy_id`. | [optional] |
ordering | str | Which field to use when ordering the results. | [optional] |
limit | int | Number of results to return per page. | [optional] |
offset | int | The initial index from which to return the results. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def JobDetail get_job(id)
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.job_detail import JobDetail
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this job.
# example passing only required values which don't have defaults set
try:
api_response = api_instance.get_job(id)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_job: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this job. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def JobFSTrigger get_job_fs_trigger(id)
tasks:manage
import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.job_fs_trigger import JobFSTrigger
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this Job FS trigger.
# example passing only required values which don't have defaults set
try:
api_response = api_instance.get_job_fs_trigger(id)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_job_fs_trigger: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this Job FS trigger. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def [FieldOption] get_job_variable_options(id, name)
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.field_option import FieldOption
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this job.
name = "name_example" # str |
q = "q_example" # str | (optional)
# example passing only required values which don't have defaults set
try:
api_response = api_instance.get_job_variable_options(id, name)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_job_variable_options: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
api_response = api_instance.get_job_variable_options(id, name, q=q)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_job_variable_options: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this job. | |
name | str | ||
q | str | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def [TaskInfo] get_pending_tasks()
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.task_info import TaskInfo
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
job_instance = "job_instance_example" # str | Filter the returned list by `job_instance`. (optional)
job_instance__in = "job_instance__in_example" # str | Multiple values may be separated by commas. (optional)
subtask = 1 # int | Filter the returned list by `subtask`. (optional)
state = "state_example" # str | Filter the returned list by `state`. (optional)
state__in = 3.14 # float | Multiple values may be separated by commas. (optional)
id = "id_example" # str | Filter the returned list by `id`. (optional)
id__in = "id__in_example" # str | Multiple values may be separated by commas. (optional)
name = "name_example" # str | Filter the returned list by `name`. (optional)
task_name = "task_name_example" # str | Filter the returned list by `task_name`. (optional)
is_finished = "is_finished_example" # str | Filter the returned list by `is_finished`. (optional)
is_running = "is_running_example" # str | Filter the returned list by `is_running`. (optional)
related_proxy_id = 3.14 # float | Filter the returned list by `related_proxy_id`. (optional)
ordering = "ordering_example" # str | Which field to use when ordering the results. (optional)
limit = 1 # int | Number of results to return per page. (optional)
offset = 1 # int | The initial index from which to return the results. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
api_response = api_instance.get_pending_tasks(job_instance=job_instance, job_instance__in=job_instance__in, subtask=subtask, state=state, state__in=state__in, id=id, id__in=id__in, name=name, task_name=task_name, is_finished=is_finished, is_running=is_running, related_proxy_id=related_proxy_id, ordering=ordering, limit=limit, offset=offset)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_pending_tasks: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job_instance | str | Filter the returned list by `job_instance`. | [optional] |
job_instance__in | str | Multiple values may be separated by commas. | [optional] |
subtask | int | Filter the returned list by `subtask`. | [optional] |
state | str | Filter the returned list by `state`. | [optional] |
state__in | float | Multiple values may be separated by commas. | [optional] |
id | str | Filter the returned list by `id`. | [optional] |
id__in | str | Multiple values may be separated by commas. | [optional] |
name | str | Filter the returned list by `name`. | [optional] |
task_name | str | Filter the returned list by `task_name`. | [optional] |
is_finished | str | Filter the returned list by `is_finished`. | [optional] |
is_running | str | Filter the returned list by `is_running`. | [optional] |
related_proxy_id | float | Filter the returned list by `related_proxy_id`. | [optional] |
ordering | str | Which field to use when ordering the results. | [optional] |
limit | int | Number of results to return per page. | [optional] |
offset | int | The initial index from which to return the results. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def [PythonEnvironment] get_python_environments()
tasks:manage
import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.python_environment import PythonEnvironment
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
# example, this endpoint has no required or optional parameters
try:
api_response = api_instance.get_python_environments()
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_python_environments: %s\n" % e)
This endpoint does not need any parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def Schedule get_schedule(id)
tasks:view
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.schedule import Schedule
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this schedule.
# example passing only required values which don't have defaults set
try:
api_response = api_instance.get_schedule(id)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_schedule: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this schedule. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def Subtask get_subtask(id)
tasks:view
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.subtask import Subtask
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this subtask.
# example passing only required values which don't have defaults set
try:
api_response = api_instance.get_subtask(id)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_subtask: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this subtask. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def TaskInfo get_task(id)
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.task_info import TaskInfo
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = "id_example" # str | A unique value identifying this task info.
include_kwargs = True # bool | (optional)
# example passing only required values which don't have defaults set
try:
api_response = api_instance.get_task(id)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_task: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
api_response = api_instance.get_task(id, include_kwargs=include_kwargs)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_task: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | str | A unique value identifying this task info. | |
include_kwargs | bool | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def TaskLog get_task_log(id)
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.task_log import TaskLog
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = "id_example" # str | A unique value identifying this task info.
# example passing only required values which don't have defaults set
try:
api_response = api_instance.get_task_log(id)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_task_log: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | str | A unique value identifying this task info. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def TaskLogV2 get_task_log_v2(id)
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.task_log_v2 import TaskLogV2
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = "id_example" # str | A unique value identifying this task info.
# example passing only required values which don't have defaults set
try:
api_response = api_instance.get_task_log_v2(id)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_task_log_v2: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | str | A unique value identifying this task info. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def TaskType get_task_type(type)
import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.task_type import TaskType
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
type = "o" # str |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.get_task_type(type)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_task_type: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
type | str |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def TasksSummary get_tasks_summary()
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.tasks_summary import TasksSummary
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
job_instance = "job_instance_example" # str | Filter the returned list by `job_instance`. (optional)
job_instance__in = "job_instance__in_example" # str | Multiple values may be separated by commas. (optional)
subtask = 1 # int | Filter the returned list by `subtask`. (optional)
state = "state_example" # str | Filter the returned list by `state`. (optional)
state__in = 3.14 # float | Multiple values may be separated by commas. (optional)
id = "id_example" # str | Filter the returned list by `id`. (optional)
id__in = "id__in_example" # str | Multiple values may be separated by commas. (optional)
name = "name_example" # str | Filter the returned list by `name`. (optional)
task_name = "task_name_example" # str | Filter the returned list by `task_name`. (optional)
is_finished = "is_finished_example" # str | Filter the returned list by `is_finished`. (optional)
is_running = "is_running_example" # str | Filter the returned list by `is_running`. (optional)
related_proxy_id = 3.14 # float | Filter the returned list by `related_proxy_id`. (optional)
ordering = "ordering_example" # str | Which field to use when ordering the results. (optional)
limit = 1 # int | Number of results to return per page. (optional)
offset = 1 # int | The initial index from which to return the results. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
api_response = api_instance.get_tasks_summary(job_instance=job_instance, job_instance__in=job_instance__in, subtask=subtask, state=state, state__in=state__in, id=id, id__in=id__in, name=name, task_name=task_name, is_finished=is_finished, is_running=is_running, related_proxy_id=related_proxy_id, ordering=ordering, limit=limit, offset=offset)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->get_tasks_summary: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job_instance | str | Filter the returned list by `job_instance`. | [optional] |
job_instance__in | str | Multiple values may be separated by commas. | [optional] |
subtask | int | Filter the returned list by `subtask`. | [optional] |
state | str | Filter the returned list by `state`. | [optional] |
state__in | float | Multiple values may be separated by commas. | [optional] |
id | str | Filter the returned list by `id`. | [optional] |
id__in | str | Multiple values may be separated by commas. | [optional] |
name | str | Filter the returned list by `name`. | [optional] |
task_name | str | Filter the returned list by `task_name`. | [optional] |
is_finished | str | Filter the returned list by `is_finished`. | [optional] |
is_running | str | Filter the returned list by `is_running`. | [optional] |
related_proxy_id | float | Filter the returned list by `related_proxy_id`. | [optional] |
ordering | str | Which field to use when ordering the results. | [optional] |
limit | int | Number of results to return per page. | [optional] |
offset | int | The initial index from which to return the results. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def ImportJobResponse import_job(import_job_request)
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.import_job_request import ImportJobRequest
from elements_sdk.model.import_job_response import ImportJobResponse
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
import_job_request = ImportJobRequest(
content="content_example",
replace=True,
rename="rename_example",
) # ImportJobRequest |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.import_job(import_job_request)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->import_job: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
import_job_request | ImportJobRequest |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def kill_all_pending_tasks()
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
# example, this endpoint has no required or optional parameters
try:
api_instance.kill_all_pending_tasks()
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->kill_all_pending_tasks: %s\n" % e)
This endpoint does not need any parameter.
void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def kill_task(id)
tasks:manage
import elements_sdk
from elements_sdk.api import automation_api
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = "id_example" # str | A unique value identifying this task info.
# example passing only required values which don't have defaults set
try:
api_instance.kill_task(id)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->kill_task: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | str | A unique value identifying this task info. |
void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def JobDetail patch_job(id, job_detail_partial_update)
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.job_detail_partial_update import JobDetailPartialUpdate
from elements_sdk.model.job_detail import JobDetail
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this job.
job_detail_partial_update = JobDetailPartialUpdate(
schedules=[
ScheduleReference(
id=1,
),
],
variable_definitions=[
{
"key": "key_example",
},
],
subtasks=[
SubtaskReference(
id=1,
),
],
allow_users=[
ElementsUserReference(
id=1,
),
],
allow_groups=[
ElementsGroupReference(
id=1,
),
],
media_roots=[
1,
],
workflow=1,
special_type=2,
name="name_example",
description="description_example",
enabled=True,
allow_others_to_start=True,
allow_client_to_start=True,
show_as_button=True,
input_type="path",
add_to_new_media_roots=True,
hook="hook_example",
webhook_secret="webhook_secret_example",
elements_release="elements_release_example",
security_context=1,
) # JobDetailPartialUpdate |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.patch_job(id, job_detail_partial_update)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->patch_job: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this job. | |
job_detail_partial_update | JobDetailPartialUpdate |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def JobFSTrigger patch_job_fs_trigger(id, job_fs_trigger_partial_update)
tasks:manage
import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.job_fs_trigger import JobFSTrigger
from elements_sdk.model.job_fs_trigger_partial_update import JobFSTriggerPartialUpdate
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this Job FS trigger.
job_fs_trigger_partial_update = JobFSTriggerPartialUpdate(
path="path_example",
name_glob="name_glob_example",
recursive=True,
listen_for_created=True,
listen_for_modified=True,
listen_for_renamed=True,
listen_for_deleted=True,
job=1,
) # JobFSTriggerPartialUpdate |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.patch_job_fs_trigger(id, job_fs_trigger_partial_update)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->patch_job_fs_trigger: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this Job FS trigger. | |
job_fs_trigger_partial_update | JobFSTriggerPartialUpdate |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def Schedule patch_schedule(id, schedule_partial_update)
tasks:view
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.schedule import Schedule
from elements_sdk.model.schedule_partial_update import SchedulePartialUpdate
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this schedule.
schedule_partial_update = SchedulePartialUpdate(
variables={
"key": "key_example",
},
type=1,
enabled=True,
last_run=dateutil_parser('1970-01-01T00:00:00.00Z'),
every=-2147483648,
period="minutes",
crontab_day_of_month="crontab_day_of_month_example",
crontab_day_of_week="crontab_day_of_week_example",
crontab_hour="crontab_hour_example",
crontab_minute="crontab_minute_example",
crontab_month_of_year="crontab_month_of_year_example",
job=1,
) # SchedulePartialUpdate |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.patch_schedule(id, schedule_partial_update)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->patch_schedule: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this schedule. | |
schedule_partial_update | SchedulePartialUpdate |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def Subtask patch_subtask(id, subtask_partial_update)
tasks:view
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.subtask import Subtask
from elements_sdk.model.subtask_partial_update import SubtaskPartialUpdate
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this subtask.
subtask_partial_update = SubtaskPartialUpdate(
kwargs={},
graph_layout={
"key": "key_example",
},
trigger="trigger_example",
name="name_example",
noop_dont_save=True,
no_concurrency=True,
timeout=-2147483648,
log_variable=True,
task="task_example",
condition_variable="condition_variable_example",
condition_value="condition_value_example",
sync=True,
queue="queue_example",
enqueue_at_front=True,
parent=1,
relative_to=1,
) # SubtaskPartialUpdate |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.patch_subtask(id, subtask_partial_update)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->patch_subtask: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this subtask. | |
subtask_partial_update | SubtaskPartialUpdate |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def TaskInfo restart_task(id)
tasks:manage
import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.task_info import TaskInfo
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = "id_example" # str | A unique value identifying this task info.
# example passing only required values which don't have defaults set
try:
api_response = api_instance.restart_task(id)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->restart_task: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | str | A unique value identifying this task info. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def [TaskInfo] start_job(id, start_job_request)
import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.task_info import TaskInfo
from elements_sdk.model.start_job_request import StartJobRequest
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this job.
start_job_request = StartJobRequest(
variables={
"key": "key_example",
},
secret="secret_example",
) # StartJobRequest |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.start_job(id, start_job_request)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->start_job: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this job. | |
start_job_request | StartJobRequest |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def TaskInfo start_task(start_task_request)
tasks:manage
import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.task_info import TaskInfo
from elements_sdk.model.start_task_request import StartTaskRequest
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
start_task_request = StartTaskRequest(
task_type="task_type_example",
parameters={
"key": "key_example",
},
sync=False,
) # StartTaskRequest |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.start_task(start_task_request)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->start_task: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
start_task_request | StartTaskRequest |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def JobDetail update_job(id, job_detail_update)
None
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.job_detail_update import JobDetailUpdate
from elements_sdk.model.job_detail import JobDetail
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this job.
job_detail_update = JobDetailUpdate(
schedules=[
ScheduleReference(
id=1,
),
],
variable_definitions=[
{
"key": "key_example",
},
],
subtasks=[
SubtaskReference(
id=1,
),
],
allow_users=[
ElementsUserReference(
id=1,
),
],
allow_groups=[
ElementsGroupReference(
id=1,
),
],
media_roots=[
1,
],
workflow=1,
special_type=2,
name="name_example",
description="description_example",
enabled=True,
allow_others_to_start=True,
allow_client_to_start=True,
show_as_button=True,
input_type="path",
add_to_new_media_roots=True,
hook="hook_example",
webhook_secret="webhook_secret_example",
elements_release="elements_release_example",
security_context=1,
) # JobDetailUpdate |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.update_job(id, job_detail_update)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->update_job: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this job. | |
job_detail_update | JobDetailUpdate |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def JobFSTrigger update_job_fs_trigger(id, job_fs_trigger_update)
tasks:manage
import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.job_fs_trigger import JobFSTrigger
from elements_sdk.model.job_fs_trigger_update import JobFSTriggerUpdate
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this Job FS trigger.
job_fs_trigger_update = JobFSTriggerUpdate(
path="path_example",
name_glob="name_glob_example",
recursive=True,
listen_for_created=True,
listen_for_modified=True,
listen_for_renamed=True,
listen_for_deleted=True,
job=1,
) # JobFSTriggerUpdate |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.update_job_fs_trigger(id, job_fs_trigger_update)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->update_job_fs_trigger: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this Job FS trigger. | |
job_fs_trigger_update | JobFSTriggerUpdate |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def Schedule update_schedule(id, schedule_update)
tasks:view
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.schedule import Schedule
from elements_sdk.model.schedule_update import ScheduleUpdate
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this schedule.
schedule_update = ScheduleUpdate(
variables={
"key": "key_example",
},
type=1,
enabled=True,
last_run=dateutil_parser('1970-01-01T00:00:00.00Z'),
every=-2147483648,
period="minutes",
crontab_day_of_month="crontab_day_of_month_example",
crontab_day_of_week="crontab_day_of_week_example",
crontab_hour="crontab_hour_example",
crontab_minute="crontab_minute_example",
crontab_month_of_year="crontab_month_of_year_example",
job=1,
) # ScheduleUpdate |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.update_schedule(id, schedule_update)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->update_schedule: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this schedule. | |
schedule_update | ScheduleUpdate |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
def Subtask update_subtask(id, subtask_update)
tasks:view
(read) / tasks:manage
(write)import elements_sdk
from elements_sdk.api import automation_api
from elements_sdk.model.subtask import Subtask
from elements_sdk.model.subtask_update import SubtaskUpdate
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = elements_sdk.Configuration(
host="https://elements.local:8080",
discard_unknown_keys=True,
)
configuration.client_side_validation = False
configuration.api_key['Bearer'] = 'Bearer your-api-token-here'
with elements_sdk.ApiClient(configuration) as api_client:
api_instance = automation_api.AutomationApi(api_client)
id = 1 # int | A unique integer value identifying this subtask.
subtask_update = SubtaskUpdate(
kwargs={},
graph_layout={
"key": "key_example",
},
trigger="trigger_example",
name="name_example",
noop_dont_save=True,
no_concurrency=True,
timeout=-2147483648,
log_variable=True,
task="task_example",
condition_variable="condition_variable_example",
condition_value="condition_value_example",
sync=True,
queue="queue_example",
enqueue_at_front=True,
parent=1,
relative_to=1,
) # SubtaskUpdate |
# example passing only required values which don't have defaults set
try:
api_response = api_instance.update_subtask(id, subtask_update)
pprint(api_response)
except elements_sdk.ApiException as e:
print("Exception when calling AutomationApi->update_subtask: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this subtask. | |
subtask_update | SubtaskUpdate |
[Back to top] [Back to API list] [Back to Model list] [Back to README]