Skip to main content

Introduction

APIs and Models to handle your automation processes

API

Here is the list of APIs existing under the processes category.

APIDescription
DeleteProcessAsyncThe API deletes an existing Process from the connected Control Room.
DownloadAsyncThe API downloads an existing Process with a specified ProcessId from the connected Control Room.
GetEditPermittedProcessesAsyncGets the list of all edit permitted ProcessInfo from the connected Control Room.
GetProcessByIdAsyncGets the ProcessInfo from the connected Control Room.
GetProcessByNameAsyncGets the ProcessInfo with specified process name from the connected Control Room.
GetProcessVersionThe API gets the latest version details of the specified process name from the connected Control Room.
GetProcessDefVersionByGuidThis API retrieves the specified process's most recent or active version from the connected Control Room.
GetProcessesAsyncGets the list of all ProcessInfo from the connected Control Room.
GetVersionsGets the list of all the release versions in the form of ProcessInfo of specified process ID from the connected Control Room.
UploadAsyncThe API uploads the process into the connected Control Room from the specified path.

Models

Here is the list of Models used in Processes APIs.

ModelsDescription
ProcessInfoThe structure represents an instance of the Process entity.
ProcessVersionThe structure represents an instance of the Process Version entity.