AutomationApi.md

ElementsSDK.Api.AutomationApi

All URIs are relative to https://elements.local

Method	HTTP request	Description
AbortTask	POST /api/2/tasks/{id}/abort
CreateJob	POST /api/2/jobs
CreateSchedule	POST /api/2/schedules
CreateSubtask	POST /api/2/subtasks
DeleteFinishedTasks	DELETE /api/2/tasks/finished
DeleteJob	DELETE /api/2/jobs/{id}
DeleteSchedule	DELETE /api/2/schedules/{id}
DeleteSubtask	DELETE /api/2/subtasks/{id}
DeleteTask	DELETE /api/2/tasks/{id}
DownloadAllTaskLogs	GET /api/2/tasks/logs/download
DownloadTaskLog	GET /api/2/tasks/{id}/log/download
ExportJob	GET /api/2/jobs/{id}/export
GetAllEvents	GET /api/2/events
GetAllJobs	GET /api/2/jobs
GetAllSchedules	GET /api/2/schedules
GetAllSubtasks	GET /api/2/subtasks
GetAllTaskQueues	GET /api/2/tasks/queues
GetAllTaskTypes	GET /api/2/tasks/types
GetAllTasks	GET /api/2/tasks
GetEvent	GET /api/2/events/{id}
GetFinishedTasks	GET /api/2/tasks/finished
GetJob	GET /api/2/jobs/{id}
GetPendingTasks	GET /api/2/tasks/pending
GetPythonEnvironments	GET /api/2/python/environments
GetSchedule	GET /api/2/schedules/{id}
GetSubtask	GET /api/2/subtasks/{id}
GetTask	GET /api/2/tasks/{id}
GetTaskLog	GET /api/2/tasks/{id}/log
GetTaskType	GET /api/2/tasks/types/{type}
GetTasksSummary	GET /api/2/tasks/summary
ImportJob	POST /api/2/jobs/import
KillAllPendingTasks	DELETE /api/2/tasks/pending
KillTask	POST /api/2/tasks/{id}/kill
PatchJob	PATCH /api/2/jobs/{id}
PatchSchedule	PATCH /api/2/schedules/{id}
PatchSubtask	PATCH /api/2/subtasks/{id}
RestartTask	POST /api/2/tasks/{id}/restart
StartJob	POST /api/2/jobs/{id}/start
StartTask	POST /api/2/tasks/start
UpdateJob	PUT /api/2/jobs/{id}
UpdateSchedule	PUT /api/2/schedules/{id}
UpdateSubtask	PUT /api/2/subtasks/{id}

AbortTask

void AbortTask (string id)

Required permissions * User account permission: tasks:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class AbortTaskExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = id_example;  // string | A unique value identifying this task info.

            try
            {
                apiInstance.AbortTask(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.AbortTask: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	A unique value identifying this task info.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateJob

Job CreateJob (Job job)

Required permissions * User account permission: None (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateJobExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var job = new Job(); // Job | 

            try
            {
                Job result = apiInstance.CreateJob(job);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.CreateJob: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
job	Job

Return type

Job

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateSchedule

Schedule CreateSchedule (Schedule schedule)

Required permissions * User account permission: tasks:view (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateScheduleExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var schedule = new Schedule(); // Schedule | 

            try
            {
                Schedule result = apiInstance.CreateSchedule(schedule);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.CreateSchedule: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
schedule	Schedule

Return type

Schedule

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateSubtask

Subtask CreateSubtask (Subtask subtask)

Required permissions * User account permission: tasks:view (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateSubtaskExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var subtask = new Subtask(); // Subtask | 

            try
            {
                Subtask result = apiInstance.CreateSubtask(subtask);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.CreateSubtask: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
subtask	Subtask

Return type

Subtask

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteFinishedTasks

void DeleteFinishedTasks ()

Required permissions * User account permission: None (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteFinishedTasksExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);

            try
            {
                apiInstance.DeleteFinishedTasks();
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.DeleteFinishedTasks: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteJob

void DeleteJob (int id)

Required permissions * User account permission: None (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteJobExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = 56;  // int | A unique integer value identifying this job.

            try
            {
                apiInstance.DeleteJob(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.DeleteJob: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteSchedule

void DeleteSchedule (int id)

Required permissions * User account permission: tasks:view (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteScheduleExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = 56;  // int | A unique integer value identifying this schedule.

            try
            {
                apiInstance.DeleteSchedule(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.DeleteSchedule: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this schedule.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteSubtask

void DeleteSubtask (int id)

Required permissions * User account permission: tasks:view (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteSubtaskExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = 56;  // int | A unique integer value identifying this subtask.

            try
            {
                apiInstance.DeleteSubtask(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.DeleteSubtask: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this subtask.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteTask

void DeleteTask (string id)

Required permissions * User account permission: None (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteTaskExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = id_example;  // string | A unique value identifying this task info.

            try
            {
                apiInstance.DeleteTask(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.DeleteTask: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	A unique value identifying this task info.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadAllTaskLogs

void DownloadAllTaskLogs (string jobInstance = null, string jobInstanceIn = null, string subtask = null, string state = null, decimal? stateIn = null, string id = null, string idIn = null, string name = null, string taskName = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: tasks:view

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DownloadAllTaskLogsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var jobInstance = jobInstance_example;  // string | Filter the returned list by `job_instance`. (optional) 
            var jobInstanceIn = jobInstanceIn_example;  // string | Multiple values may be separated by commas. (optional) 
            var subtask = subtask_example;  // string | Filter the returned list by `subtask`. (optional) 
            var state = state_example;  // string | Filter the returned list by `state`. (optional) 
            var stateIn = 8.14;  // decimal? | Multiple values may be separated by commas. (optional) 
            var id = id_example;  // string | Filter the returned list by `id`. (optional) 
            var idIn = idIn_example;  // string | Multiple values may be separated by commas. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var taskName = taskName_example;  // string | Filter the returned list by `task_name`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                apiInstance.DownloadAllTaskLogs(jobInstance, jobInstanceIn, subtask, state, stateIn, id, idIn, name, taskName, ordering, limit, offset);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.DownloadAllTaskLogs: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
jobInstance	string	Filter the returned list by `job_instance`.	[optional]
jobInstanceIn	string	Multiple values may be separated by commas.	[optional]
subtask	string	Filter the returned list by `subtask`.	[optional]
state	string	Filter the returned list by `state`.	[optional]
stateIn	decimal?	Multiple values may be separated by commas.	[optional]
id	string	Filter the returned list by `id`.	[optional]
idIn	string	Multiple values may be separated by commas.	[optional]
name	string	Filter the returned list by `name`.	[optional]
taskName	string	Filter the returned list by `task_name`.	[optional]
ordering	string	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]

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadTaskLog

void DownloadTaskLog (string id)

Required permissions * User account permission: tasks:view

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DownloadTaskLogExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = id_example;  // string | A unique value identifying this task info.

            try
            {
                apiInstance.DownloadTaskLog(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.DownloadTaskLog: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	A unique value identifying this task info.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ExportJob

void ExportJob (int id)

Required permissions * User account permission: None (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class ExportJobExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = 56;  // int | A unique integer value identifying this job.

            try
            {
                apiInstance.ExportJob(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.ExportJob: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllEvents

InlineResponse2002 GetAllEvents (string ordering = null, int? limit = null, int? offset = null)

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllEventsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                InlineResponse2002 result = apiInstance.GetAllEvents(ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetAllEvents: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
ordering	string	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]

Return type

InlineResponse2002

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllJobs

List<Job> GetAllJobs (string specialType = null, string specialTypeIsnull = null, string hook = null, string name = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: None (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllJobsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var specialType = specialType_example;  // string | Filter the returned list by `special_type`. (optional) 
            var specialTypeIsnull = specialTypeIsnull_example;  // string | Filter the returned list by `special_type__isnull`. (optional) 
            var hook = hook_example;  // string | Filter the returned list by `hook`. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<Job> result = apiInstance.GetAllJobs(specialType, specialTypeIsnull, hook, name, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetAllJobs: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
specialType	string	Filter the returned list by `special_type`.	[optional]
specialTypeIsnull	string	Filter the returned list by `special_type__isnull`.	[optional]
hook	string	Filter the returned list by `hook`.	[optional]
name	string	Filter the returned list by `name`.	[optional]
ordering	string	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]

Return type

List<Job>

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllSchedules

List<Schedule> GetAllSchedules (string job = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: tasks:view (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllSchedulesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var job = job_example;  // string | Filter the returned list by `job`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<Schedule> result = apiInstance.GetAllSchedules(job, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetAllSchedules: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
job	string	Filter the returned list by `job`.	[optional]
ordering	string	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]

Return type

List<Schedule>

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllSubtasks

List<Subtask> GetAllSubtasks (string parent = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: tasks:view (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllSubtasksExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var parent = parent_example;  // string | Filter the returned list by `parent`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<Subtask> result = apiInstance.GetAllSubtasks(parent, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetAllSubtasks: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
parent	string	Filter the returned list by `parent`.	[optional]
ordering	string	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]

Return type

List<Subtask>

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllTaskQueues

InlineResponse2003 GetAllTaskQueues (string ordering = null, int? limit = null, int? offset = null)

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllTaskQueuesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                InlineResponse2003 result = apiInstance.GetAllTaskQueues(ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetAllTaskQueues: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
ordering	string	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]

Return type

InlineResponse2003

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllTaskTypes

InlineResponse2004 GetAllTaskTypes (string ordering = null, int? limit = null, int? offset = null)

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllTaskTypesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                InlineResponse2004 result = apiInstance.GetAllTaskTypes(ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetAllTaskTypes: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
ordering	string	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]

Return type

InlineResponse2004

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllTasks

List<TaskInfo> GetAllTasks (string jobInstance = null, string jobInstanceIn = null, string subtask = null, string state = null, decimal? stateIn = null, string id = null, string idIn = null, string name = null, string taskName = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: None (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllTasksExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var jobInstance = jobInstance_example;  // string | Filter the returned list by `job_instance`. (optional) 
            var jobInstanceIn = jobInstanceIn_example;  // string | Multiple values may be separated by commas. (optional) 
            var subtask = subtask_example;  // string | Filter the returned list by `subtask`. (optional) 
            var state = state_example;  // string | Filter the returned list by `state`. (optional) 
            var stateIn = 8.14;  // decimal? | Multiple values may be separated by commas. (optional) 
            var id = id_example;  // string | Filter the returned list by `id`. (optional) 
            var idIn = idIn_example;  // string | Multiple values may be separated by commas. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var taskName = taskName_example;  // string | Filter the returned list by `task_name`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<TaskInfo> result = apiInstance.GetAllTasks(jobInstance, jobInstanceIn, subtask, state, stateIn, id, idIn, name, taskName, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetAllTasks: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
jobInstance	string	Filter the returned list by `job_instance`.	[optional]
jobInstanceIn	string	Multiple values may be separated by commas.	[optional]
subtask	string	Filter the returned list by `subtask`.	[optional]
state	string	Filter the returned list by `state`.	[optional]
stateIn	decimal?	Multiple values may be separated by commas.	[optional]
id	string	Filter the returned list by `id`.	[optional]
idIn	string	Multiple values may be separated by commas.	[optional]
name	string	Filter the returned list by `name`.	[optional]
taskName	string	Filter the returned list by `task_name`.	[optional]
ordering	string	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]

Return type

List<TaskInfo>

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEvent

Event GetEvent (string id)

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetEventExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = id_example;  // string | 

            try
            {
                Event result = apiInstance.GetEvent(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetEvent: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string

Return type

Event

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetFinishedTasks

List<TaskInfo> GetFinishedTasks (string jobInstance = null, string jobInstanceIn = null, string subtask = null, string state = null, decimal? stateIn = null, string id = null, string idIn = null, string name = null, string taskName = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: None (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetFinishedTasksExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var jobInstance = jobInstance_example;  // string | Filter the returned list by `job_instance`. (optional) 
            var jobInstanceIn = jobInstanceIn_example;  // string | Multiple values may be separated by commas. (optional) 
            var subtask = subtask_example;  // string | Filter the returned list by `subtask`. (optional) 
            var state = state_example;  // string | Filter the returned list by `state`. (optional) 
            var stateIn = 8.14;  // decimal? | Multiple values may be separated by commas. (optional) 
            var id = id_example;  // string | Filter the returned list by `id`. (optional) 
            var idIn = idIn_example;  // string | Multiple values may be separated by commas. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var taskName = taskName_example;  // string | Filter the returned list by `task_name`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<TaskInfo> result = apiInstance.GetFinishedTasks(jobInstance, jobInstanceIn, subtask, state, stateIn, id, idIn, name, taskName, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetFinishedTasks: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
jobInstance	string	Filter the returned list by `job_instance`.	[optional]
jobInstanceIn	string	Multiple values may be separated by commas.	[optional]
subtask	string	Filter the returned list by `subtask`.	[optional]
state	string	Filter the returned list by `state`.	[optional]
stateIn	decimal?	Multiple values may be separated by commas.	[optional]
id	string	Filter the returned list by `id`.	[optional]
idIn	string	Multiple values may be separated by commas.	[optional]
name	string	Filter the returned list by `name`.	[optional]
taskName	string	Filter the returned list by `task_name`.	[optional]
ordering	string	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]

Return type

List<TaskInfo>

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetJob

Job GetJob (int id)

Required permissions * User account permission: None (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetJobExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = 56;  // int | A unique integer value identifying this job.

            try
            {
                Job result = apiInstance.GetJob(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetJob: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.

Return type

Job

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPendingTasks

List<TaskInfo> GetPendingTasks (string jobInstance = null, string jobInstanceIn = null, string subtask = null, string state = null, decimal? stateIn = null, string id = null, string idIn = null, string name = null, string taskName = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: None (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetPendingTasksExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var jobInstance = jobInstance_example;  // string | Filter the returned list by `job_instance`. (optional) 
            var jobInstanceIn = jobInstanceIn_example;  // string | Multiple values may be separated by commas. (optional) 
            var subtask = subtask_example;  // string | Filter the returned list by `subtask`. (optional) 
            var state = state_example;  // string | Filter the returned list by `state`. (optional) 
            var stateIn = 8.14;  // decimal? | Multiple values may be separated by commas. (optional) 
            var id = id_example;  // string | Filter the returned list by `id`. (optional) 
            var idIn = idIn_example;  // string | Multiple values may be separated by commas. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var taskName = taskName_example;  // string | Filter the returned list by `task_name`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<TaskInfo> result = apiInstance.GetPendingTasks(jobInstance, jobInstanceIn, subtask, state, stateIn, id, idIn, name, taskName, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetPendingTasks: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
jobInstance	string	Filter the returned list by `job_instance`.	[optional]
jobInstanceIn	string	Multiple values may be separated by commas.	[optional]
subtask	string	Filter the returned list by `subtask`.	[optional]
state	string	Filter the returned list by `state`.	[optional]
stateIn	decimal?	Multiple values may be separated by commas.	[optional]
id	string	Filter the returned list by `id`.	[optional]
idIn	string	Multiple values may be separated by commas.	[optional]
name	string	Filter the returned list by `name`.	[optional]
taskName	string	Filter the returned list by `task_name`.	[optional]
ordering	string	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]

Return type

List<TaskInfo>

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPythonEnvironments

List<PythonEnvironment> GetPythonEnvironments ()

Required permissions * User account permission: tasks:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetPythonEnvironmentsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);

            try
            {
                List<PythonEnvironment> result = apiInstance.GetPythonEnvironments();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetPythonEnvironments: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List<PythonEnvironment>

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSchedule

Schedule GetSchedule (int id)

Required permissions * User account permission: tasks:view (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetScheduleExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = 56;  // int | A unique integer value identifying this schedule.

            try
            {
                Schedule result = apiInstance.GetSchedule(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetSchedule: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this schedule.

Return type

Schedule

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSubtask

Subtask GetSubtask (int id)

Required permissions * User account permission: tasks:view (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetSubtaskExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = 56;  // int | A unique integer value identifying this subtask.

            try
            {
                Subtask result = apiInstance.GetSubtask(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetSubtask: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this subtask.

Return type

Subtask

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTask

TaskInfo GetTask (string id)

Required permissions * User account permission: None (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetTaskExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = id_example;  // string | A unique value identifying this task info.

            try
            {
                TaskInfo result = apiInstance.GetTask(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetTask: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	A unique value identifying this task info.

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTaskLog

TaskLog GetTaskLog (string id)

Required permissions * User account permission: tasks:view

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetTaskLogExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = id_example;  // string | A unique value identifying this task info.

            try
            {
                TaskLog result = apiInstance.GetTaskLog(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetTaskLog: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	A unique value identifying this task info.

Return type

TaskLog

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTaskType

TaskType GetTaskType (string type)

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetTaskTypeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var type = type_example;  // string | 

            try
            {
                TaskType result = apiInstance.GetTaskType(type);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetTaskType: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
type	string

Return type

TaskType

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTasksSummary

TasksSummary GetTasksSummary (string jobInstance = null, string jobInstanceIn = null, string subtask = null, string state = null, decimal? stateIn = null, string id = null, string idIn = null, string name = null, string taskName = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: None (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetTasksSummaryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var jobInstance = jobInstance_example;  // string | Filter the returned list by `job_instance`. (optional) 
            var jobInstanceIn = jobInstanceIn_example;  // string | Multiple values may be separated by commas. (optional) 
            var subtask = subtask_example;  // string | Filter the returned list by `subtask`. (optional) 
            var state = state_example;  // string | Filter the returned list by `state`. (optional) 
            var stateIn = 8.14;  // decimal? | Multiple values may be separated by commas. (optional) 
            var id = id_example;  // string | Filter the returned list by `id`. (optional) 
            var idIn = idIn_example;  // string | Multiple values may be separated by commas. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var taskName = taskName_example;  // string | Filter the returned list by `task_name`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                TasksSummary result = apiInstance.GetTasksSummary(jobInstance, jobInstanceIn, subtask, state, stateIn, id, idIn, name, taskName, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.GetTasksSummary: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
jobInstance	string	Filter the returned list by `job_instance`.	[optional]
jobInstanceIn	string	Multiple values may be separated by commas.	[optional]
subtask	string	Filter the returned list by `subtask`.	[optional]
state	string	Filter the returned list by `state`.	[optional]
stateIn	decimal?	Multiple values may be separated by commas.	[optional]
id	string	Filter the returned list by `id`.	[optional]
idIn	string	Multiple values may be separated by commas.	[optional]
name	string	Filter the returned list by `name`.	[optional]
taskName	string	Filter the returned list by `task_name`.	[optional]
ordering	string	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]

Return type

TasksSummary

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ImportJob

ImportJobResponse ImportJob (ImportJobRequest importJobRequest)

Required permissions * User account permission: None (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class ImportJobExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var importJobRequest = new ImportJobRequest(); // ImportJobRequest | 

            try
            {
                ImportJobResponse result = apiInstance.ImportJob(importJobRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.ImportJob: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
importJobRequest	ImportJobRequest

Return type

ImportJobResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

KillAllPendingTasks

void KillAllPendingTasks ()

Required permissions * User account permission: None (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class KillAllPendingTasksExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);

            try
            {
                apiInstance.KillAllPendingTasks();
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.KillAllPendingTasks: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

KillTask

void KillTask (string id)

Required permissions * User account permission: tasks:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class KillTaskExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = id_example;  // string | A unique value identifying this task info.

            try
            {
                apiInstance.KillTask(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.KillTask: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	A unique value identifying this task info.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchJob

Job PatchJob (int id, JobPartialUpdate jobPartialUpdate)

Required permissions * User account permission: None (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchJobExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = 56;  // int | A unique integer value identifying this job.
            var jobPartialUpdate = new JobPartialUpdate(); // JobPartialUpdate | 

            try
            {
                Job result = apiInstance.PatchJob(id, jobPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.PatchJob: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.
jobPartialUpdate	JobPartialUpdate

Return type

Job

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchSchedule

Schedule PatchSchedule (int id, SchedulePartialUpdate schedulePartialUpdate)

Required permissions * User account permission: tasks:view (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchScheduleExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = 56;  // int | A unique integer value identifying this schedule.
            var schedulePartialUpdate = new SchedulePartialUpdate(); // SchedulePartialUpdate | 

            try
            {
                Schedule result = apiInstance.PatchSchedule(id, schedulePartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.PatchSchedule: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this schedule.
schedulePartialUpdate	SchedulePartialUpdate

Return type

Schedule

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchSubtask

Subtask PatchSubtask (int id, SubtaskPartialUpdate subtaskPartialUpdate)

Required permissions * User account permission: tasks:view (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchSubtaskExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = 56;  // int | A unique integer value identifying this subtask.
            var subtaskPartialUpdate = new SubtaskPartialUpdate(); // SubtaskPartialUpdate | 

            try
            {
                Subtask result = apiInstance.PatchSubtask(id, subtaskPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.PatchSubtask: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this subtask.
subtaskPartialUpdate	SubtaskPartialUpdate

Return type

Subtask

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RestartTask

TaskInfo RestartTask (string id)

Required permissions * User account permission: tasks:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class RestartTaskExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = id_example;  // string | A unique value identifying this task info.

            try
            {
                TaskInfo result = apiInstance.RestartTask(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.RestartTask: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	A unique value identifying this task info.

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StartJob

List<TaskInfo> StartJob (int id, StartJobRequest startJobRequest)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class StartJobExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = 56;  // int | A unique integer value identifying this job.
            var startJobRequest = new StartJobRequest(); // StartJobRequest | 

            try
            {
                List<TaskInfo> result = apiInstance.StartJob(id, startJobRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.StartJob: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.
startJobRequest	StartJobRequest

Return type

List<TaskInfo>

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StartTask

TaskInfo StartTask (StartTaskRequest startTaskRequest)

Required permissions * User account permission: tasks:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class StartTaskExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var startTaskRequest = new StartTaskRequest(); // StartTaskRequest | 

            try
            {
                TaskInfo result = apiInstance.StartTask(startTaskRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.StartTask: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
startTaskRequest	StartTaskRequest

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateJob

Job UpdateJob (int id, Job job)

Required permissions * User account permission: None (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateJobExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = 56;  // int | A unique integer value identifying this job.
            var job = new Job(); // Job | 

            try
            {
                Job result = apiInstance.UpdateJob(id, job);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.UpdateJob: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.
job	Job

Return type

Job

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateSchedule

Schedule UpdateSchedule (int id, Schedule schedule)

Required permissions * User account permission: tasks:view (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateScheduleExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = 56;  // int | A unique integer value identifying this schedule.
            var schedule = new Schedule(); // Schedule | 

            try
            {
                Schedule result = apiInstance.UpdateSchedule(id, schedule);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.UpdateSchedule: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this schedule.
schedule	Schedule

Return type

Schedule

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateSubtask

Subtask UpdateSubtask (int id, Subtask subtask)

Required permissions * User account permission: tasks:view (read) / tasks:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateSubtaskExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AutomationApi(config);
            var id = 56;  // int | A unique integer value identifying this subtask.
            var subtask = new Subtask(); // Subtask | 

            try
            {
                Subtask result = apiInstance.UpdateSubtask(id, subtask);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AutomationApi.UpdateSubtask: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this subtask.
subtask	Subtask

Return type

Subtask

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]