deprecated-oc-catalog/selfapi/docs/WorkflowApi.md
2023-03-03 14:43:11 +01:00

11 KiB

\WorkflowApi

All URIs are relative to https://localhost:49618/v1

Method HTTP request Description
WorkflowControllerAddNewObjectToAWorkflow Post /workflow/{workflowName}/add
WorkflowControllerBookSchedule Post /workflow/{workflowName}/schedule/book
WorkflowControllerCheckSchedule Get /workflow/{workflowName}/schedule/check
WorkflowControllerCreateANewWorkflow Post /workflow/
WorkflowControllerCreateARealtionshipBetweenTwoRobjects Post /workflow/{workflowName}/link
WorkflowControllerGetMxGraphLastStatus Get /workflow/{workflowName}/mxGraphParser
WorkflowControllerGetSchedule Get /workflow/{workflowName}/schedule
WorkflowControllerGetWorkflow Get /workflow/{workflowName}
WorkflowControllerListWorkflows Get /workflow/
WorkflowControllerParseMxGraph Post /workflow/{workflowName}/mxGraphParser
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] [Back to Model list] [Back to README]

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**

Authorization

No authorization required

HTTP request headers

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

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

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**

Authorization

No authorization required

HTTP request headers

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

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

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] [Back to Model list] [Back to README]

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] [Back to Model list] [Back to README]

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] [Back to Model list] [Back to README]

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

Authorization

No authorization required

HTTP request headers

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

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

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

Authorization

No authorization required

HTTP request headers

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

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

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] [Back to Model list] [Back to README]

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] [Back to Model list] [Back to README]

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{} RFC3339 time for startDate
stopDate interface{} 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

Authorization

No authorization required

HTTP request headers

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

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