# \WorkflowApi All URIs are relative to *https://localhost:49618/v1* Method | HTTP request | Description ------------- | ------------- | ------------- [**WorkflowControllerAddNewObjectToAWorkflow**](WorkflowApi.md#WorkflowControllerAddNewObjectToAWorkflow) | **Post** /workflow/{workflowName}/add | [**WorkflowControllerBookSchedule**](WorkflowApi.md#WorkflowControllerBookSchedule) | **Post** /workflow/{workflowName}/schedule/book | [**WorkflowControllerCheckSchedule**](WorkflowApi.md#WorkflowControllerCheckSchedule) | **Get** /workflow/{workflowName}/schedule/check | [**WorkflowControllerCreateANewWorkflow**](WorkflowApi.md#WorkflowControllerCreateANewWorkflow) | **Post** /workflow/ | [**WorkflowControllerCreateARealtionshipBetweenTwoRobjects**](WorkflowApi.md#WorkflowControllerCreateARealtionshipBetweenTwoRobjects) | **Post** /workflow/{workflowName}/link | [**WorkflowControllerGetMxGraphLastStatus**](WorkflowApi.md#WorkflowControllerGetMxGraphLastStatus) | **Get** /workflow/{workflowName}/mxGraphParser | [**WorkflowControllerGetSchedule**](WorkflowApi.md#WorkflowControllerGetSchedule) | **Get** /workflow/{workflowName}/schedule | [**WorkflowControllerGetWorkflow**](WorkflowApi.md#WorkflowControllerGetWorkflow) | **Get** /workflow/{workflowName} | [**WorkflowControllerListWorkflows**](WorkflowApi.md#WorkflowControllerListWorkflows) | **Get** /workflow/ | [**WorkflowControllerParseMxGraph**](WorkflowApi.md#WorkflowControllerParseMxGraph) | **Post** /workflow/{workflowName}/mxGraphParser | [**WorkflowControllerSetSchedule**](WorkflowApi.md#WorkflowControllerSetSchedule) | **Put** /workflow/{workflowName}/schedule | # **WorkflowControllerAddNewObjectToAWorkflow** > WorkflowControllerAddNewObjectToAWorkflow(ctx, workflowName, rID) Create a Rtype object from already added resources to the workspace ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. **workflowName** | **string**| workflow Name | **rID** | **string**| rID of already existing item in Workspace | ### Return type (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined [[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) # **WorkflowControllerBookSchedule** > []ModelsDCstatus WorkflowControllerBookSchedule(ctx, workflowName) Book a schedule in all DCs of the workflow. Must set a desired schedule first! ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. **workflowName** | **string**| Workflow Name | ### Return type [**[]ModelsDCstatus**](models.DCstatus.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined [[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) # **WorkflowControllerCheckSchedule** > []ModelsDCstatus WorkflowControllerCheckSchedule(ctx, workflowName) Check if we can schedule the project in other DCs. Must set a desired schedule first! ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. **workflowName** | **string**| Workflow Name | ### Return type [**[]ModelsDCstatus**](models.DCstatus.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined [[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) # **WorkflowControllerCreateANewWorkflow** > WorkflowControllerCreateANewWorkflow(ctx, workflowName) Create a name for the new workflow ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. **workflowName** | **string**| Name of the workflow | ### Return type (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined [[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) # **WorkflowControllerCreateARealtionshipBetweenTwoRobjects** > WorkflowControllerCreateARealtionshipBetweenTwoRobjects(ctx, workflowName, rObjIDsource, isInput, rObjIDtarger) Create a Rtype object from already added resources to the workspace ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. **workflowName** | **string**| Workflow Name | **rObjIDsource** | **string**| Robject source. Usually Data | **isInput** | **bool**| If the operation is for input (true) linkage or output (false) | **rObjIDtarger** | **string**| Robject where will be written the association | ### Return type (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined [[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) # **WorkflowControllerGetMxGraphLastStatus** > WorkflowControllerGetMxGraphLastStatus(ctx, workflowName) Obtain the last mxgraph XML status from the workflow ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. **workflowName** | **string**| Workflow Name | ### Return type (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined [[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) # **WorkflowControllerGetSchedule** > ModelsScheduleTime WorkflowControllerGetSchedule(ctx, workflowName) Obtain the desired schedule of this workflow ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. **workflowName** | **string**| Workflow Name | ### Return type [**ModelsScheduleTime**](models.ScheduleTime.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined [[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) # **WorkflowControllerGetWorkflow** > ModelsWorkflow WorkflowControllerGetWorkflow(ctx, workflowName) Get a workflow by name ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. **workflowName** | **string**| Workflow Name | ### Return type [**ModelsWorkflow**](models.Workflow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined [[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) # **WorkflowControllerListWorkflows** > WorkflowControllerListWorkflows(ctx, ) List available workflows ### Required Parameters This endpoint does not need any parameter. ### Return type (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined [[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) # **WorkflowControllerParseMxGraph** > WorkflowControllerParseMxGraph(ctx, workflowName, xmlData) If we use this aproach to transofrm mxgraph representation in our representation, we should not use other API calls for modify the project structure or we'll have inconsistencies. ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. **workflowName** | **string**| Workflow Name | **xmlData** | **string**| Xml representation of the workflow | ### Return type (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined [[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) # **WorkflowControllerSetSchedule** > ModelsScheduleInfo WorkflowControllerSetSchedule(ctx, workflowName, isService, startDate, stopDate, optional) Set desired schedule by the user. No other effects a part of saving the user input ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. **workflowName** | **string**| Workflow Name | **isService** | **bool**| True: Service, False: Task | **startDate** | [**interface{}**](.md)| RFC3339 time for startDate | **stopDate** | [**interface{}**](.md)| RFC3339 time for stopDate | **optional** | ***WorkflowApiWorkflowControllerSetScheduleOpts** | optional parameters | nil if no parameters ### Optional Parameters Optional parameters are passed through a pointer to a WorkflowApiWorkflowControllerSetScheduleOpts struct Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **events** | **optional.String**| List of events separated by comma | **cronString** | **optional.String**| Cron string | **duration** | **optional.Int32**| Duration in seconds | ### Return type [**ModelsScheduleInfo**](models.ScheduleInfo.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined [[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)