# mycoreapi.api.AutomationApi ## Load the API package ```dart import 'package:mycoreapi/api.dart'; ``` All URIs are relative to *http://localhost:25049* Method | HTTP request | Description ------------- | ------------- | ------------- [**automationCreate**](AutomationApi.md#automationcreate) | **POST** /api/automation | Create an automation [**automationDelete**](AutomationApi.md#automationdelete) | **DELETE** /api/automation/{automationId} | Delete an automation [**automationDeleteAllForUser**](AutomationApi.md#automationdeleteallforuser) | **DELETE** /api/automation/user/{userId} | Delete all automation for a specified [**automationGetAll**](AutomationApi.md#automationgetall) | **GET** /api/automation/{userId} | Get all automations for the specified user [**automationGetDetail**](AutomationApi.md#automationgetdetail) | **GET** /api/automation/detail/{automationId} | Get detail info of a specified automation [**automationUpdate**](AutomationApi.md#automationupdate) | **PUT** /api/automation | Update an automation # **automationCreate** > AutomationDTO automationCreate(automationCreateOrUpdateDetailDTO) Create an automation ### Example ```dart import 'package:mycoreapi/api.dart'; // TODO Configure OAuth2 access token for authorization: bearer //defaultApiClient.getAuthentication('bearer').accessToken = 'YOUR_ACCESS_TOKEN'; final api_instance = AutomationApi(); final automationCreateOrUpdateDetailDTO = AutomationCreateOrUpdateDetailDTO(); // AutomationCreateOrUpdateDetailDTO | Automation to create try { final result = api_instance.automationCreate(automationCreateOrUpdateDetailDTO); print(result); } catch (e) { print('Exception when calling AutomationApi->automationCreate: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **automationCreateOrUpdateDetailDTO** | [**AutomationCreateOrUpdateDetailDTO**](AutomationCreateOrUpdateDetailDTO.md)| Automation to create | ### Return type [**AutomationDTO**](AutomationDTO.md) ### Authorization [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **automationDelete** > String automationDelete(automationId) Delete an automation ### Example ```dart import 'package:mycoreapi/api.dart'; // TODO Configure OAuth2 access token for authorization: bearer //defaultApiClient.getAuthentication('bearer').accessToken = 'YOUR_ACCESS_TOKEN'; final api_instance = AutomationApi(); final automationId = automationId_example; // String | Id of automation to delete try { final result = api_instance.automationDelete(automationId); print(result); } catch (e) { print('Exception when calling AutomationApi->automationDelete: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **automationId** | **String**| Id of automation to delete | ### Return type **String** ### Authorization [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **automationDeleteAllForUser** > String automationDeleteAllForUser(userId) Delete all automation for a specified ### Example ```dart import 'package:mycoreapi/api.dart'; // TODO Configure OAuth2 access token for authorization: bearer //defaultApiClient.getAuthentication('bearer').accessToken = 'YOUR_ACCESS_TOKEN'; final api_instance = AutomationApi(); final userId = userId_example; // String | Id of user try { final result = api_instance.automationDeleteAllForUser(userId); print(result); } catch (e) { print('Exception when calling AutomationApi->automationDeleteAllForUser: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **userId** | **String**| Id of user | ### Return type **String** ### Authorization [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **automationGetAll** > List automationGetAll(userId) Get all automations for the specified user ### Example ```dart import 'package:mycoreapi/api.dart'; // TODO Configure OAuth2 access token for authorization: bearer //defaultApiClient.getAuthentication('bearer').accessToken = 'YOUR_ACCESS_TOKEN'; final api_instance = AutomationApi(); final userId = userId_example; // String | Id of user try { final result = api_instance.automationGetAll(userId); print(result); } catch (e) { print('Exception when calling AutomationApi->automationGetAll: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **userId** | **String**| Id of user | ### Return type [**List**](RoomSummaryDTO.md) ### Authorization [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **automationGetDetail** > AutomationDetailDTO automationGetDetail(automationId) Get detail info of a specified automation ### Example ```dart import 'package:mycoreapi/api.dart'; // TODO Configure OAuth2 access token for authorization: bearer //defaultApiClient.getAuthentication('bearer').accessToken = 'YOUR_ACCESS_TOKEN'; final api_instance = AutomationApi(); final automationId = automationId_example; // String | automation id try { final result = api_instance.automationGetDetail(automationId); print(result); } catch (e) { print('Exception when calling AutomationApi->automationGetDetail: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **automationId** | **String**| automation id | ### Return type [**AutomationDetailDTO**](AutomationDetailDTO.md) ### Authorization [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **automationUpdate** > AutomationCreateOrUpdateDetailDTO automationUpdate(automationCreateOrUpdateDetailDTO) Update an automation ### Example ```dart import 'package:mycoreapi/api.dart'; // TODO Configure OAuth2 access token for authorization: bearer //defaultApiClient.getAuthentication('bearer').accessToken = 'YOUR_ACCESS_TOKEN'; final api_instance = AutomationApi(); final automationCreateOrUpdateDetailDTO = AutomationCreateOrUpdateDetailDTO(); // AutomationCreateOrUpdateDetailDTO | automation to update try { final result = api_instance.automationUpdate(automationCreateOrUpdateDetailDTO); print(result); } catch (e) { print('Exception when calling AutomationApi->automationUpdate: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **automationCreateOrUpdateDetailDTO** | [**AutomationCreateOrUpdateDetailDTO**](AutomationCreateOrUpdateDetailDTO.md)| automation to update | ### Return type [**AutomationCreateOrUpdateDetailDTO**](AutomationCreateOrUpdateDetailDTO.md) ### Authorization [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)