preservica-client-root
API
Generated with
preservica-client-root/uk.gov.nationalarchives.dp.client/WorkflowClient

WorkflowClient

uk.gov.nationalarchives.dp.client.WorkflowClient
See theWorkflowClient companion object
trait WorkflowClient[F[_]]

A client to start a Preservica workflow

Type parameters

F

Type of the effect

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def startWorkflow(startWorkflowRequest: StartWorkflowRequest): F[Int]

Starts a preservica workflow

Starts a preservica workflow

Value parameters

startWorkflowRequest

An instance of WorkflowClient.StartWorkflowRequest It contains details used to start the workflow

Attributes

Returns

The id of the new workflow wrapped in the F effect.

Generated with