camundala.api
package camundala.api
Type members
Classlikes
trait ApiEndpoint[In <: Product, Out <: Product, T <: ApiEndpoint[In, Out, T]](implicit evidence$8: Encoder[In], evidence$9: Decoder[In], evidence$10: Schema[In], evidence$11: Encoder[Out], evidence$12: Decoder[Out], evidence$13: Schema[Out], evidence$14: ClassTag[Out]) extends Product
case
class CamundaAuthError(`type`: String, message: String, userId: String, permissionName: String, resourceName: String, resourceId: String)
case
class CamundaRestApi[In <: Product, Out <: Product](name: String, tag: String, descr: Option[String] | String, requestInput: RequestInput[In], requestOutput: RequestOutput[Out], requestErrorOutputs: List[RequestErrorOutput])(implicit evidence$1: Encoder[In], evidence$2: Decoder[In], evidence$3: Schema[In], evidence$4: Encoder[Out], evidence$5: Decoder[Out], evidence$6: Schema[Out], evidence$7: ClassTag[Out])
- Companion
- object
case
class CompleteTask[In <: Product](restApi: CamundaRestApi[In, NoOutput])(implicit evidence$27: Encoder[In], evidence$28: Decoder[In], evidence$29: Schema[In]) extends ApiEndpoint[In, NoOutput, CompleteTask[In]]
@Schema$$annotations$$description("A JSON object with the following properties: (at least an empty JSON object {} or an empty request body)")
case
class CompleteTaskIn(variables: Map[ExampleName, CamundaVariable], @Schema$$annotations$$description("Set to false will not return the Process Variables and the Result Status is 204.") withVariablesInReturn: Boolean)
case
class CompleteTaskOut(@Schema$$annotations$$description("The Process Variables - Be aware that returns everything stored in the Process.") variables: Map[ExampleName, CamundaVariable])
case
class EvaluateDecision[In <: Product, Out <: Product](decisionDmn: DecisionDmn[In, Out], restApi: CamundaRestApi[In, Out])(implicit evidence$1: Encoder[In], evidence$2: Decoder[In], evidence$3: Schema[In], evidence$4: ClassTag[In], evidence$5: Encoder[Out], evidence$6: Decoder[Out], evidence$7: Schema[Out], evidence$8: ClassTag[Out]) extends ApiEndpoint[In, Out, EvaluateDecision[In, Out]]
case
class GetActiveTask(restApi: CamundaRestApi[NoInput, NoOutput]) extends ApiEndpoint[NoInput, NoOutput, GetActiveTask]
@Schema$$annotations$$description("A JSON object with the following properties")
case
class GetActiveTaskIn(@Schema$$annotations$$description("\n |The id of the process - you want to get the active tasks.\n |> This is the result id of the `StartProcessOut`\n |") processInstanceId: String, @Schema$$annotations$$description("We are only interested in the active Task(s)") active: Boolean)
case
class GetTaskFormVariables[Out <: Product](restApi: CamundaRestApi[NoInput, Out])(implicit evidence$23: Encoder[Out], evidence$24: Decoder[Out], evidence$25: Schema[Out], evidence$26: ClassTag[Out]) extends ApiEndpoint[NoInput, Out, GetTaskFormVariables[Out]]
@Schema$$annotations$$description("A JSON object with the following properties: (at least an empty JSON object {} or an empty request body)")
case
class StartProcessIn(variables: Map[ExampleName, CamundaVariable], @Schema$$annotations$$description("The business key of the process instance.") businessKey: Option[String], @Schema$$annotations$$description("Set to false will not return the Process Variables.") withVariablesInReturn: Boolean)
case
class StartProcessInstance[In <: Product, Out <: Product](processDefinitionKey: String, restApi: CamundaRestApi[In, Out])(implicit evidence$15: Encoder[In], evidence$16: Decoder[In], evidence$17: Schema[In], evidence$18: ClassTag[In], evidence$19: Encoder[Out], evidence$20: Decoder[Out], evidence$21: Schema[Out], evidence$22: ClassTag[Out]) extends ApiEndpoint[In, Out, StartProcessInstance[In, Out]]
- Companion
- object
@Schema$$annotations$$description
case
class StartProcessOut(@Schema$$annotations$$description("The Process Variables - Be aware that returns everything stored in the Process.") variables: Map[ExampleName, CamundaVariable], @Schema$$annotations$$description id: String, @Schema$$annotations$$description("The id of the process definition.") definitionId: String, @Schema$$annotations$$description("The business key of the process instance.") businessKey: Option[String])
case
class UserTaskEndpoint[In <: Product, Out <: Product](restApi: CamundaRestApi[In, Out], getActiveTask: GetActiveTask, getTaskFormVariables: GetTaskFormVariables[In], completeTask: CompleteTask[Out])(implicit evidence$30: Encoder[In], evidence$31: Decoder[In], evidence$32: Schema[In], evidence$33: ClassTag[In], evidence$34: Encoder[Out], evidence$35: Decoder[Out], evidence$36: Schema[Out], evidence$37: ClassTag[Out]) extends ApiEndpoint[In, Out, UserTaskEndpoint[In, Out]]
Types
Value members
Concrete methods
Concrete fields
Extensions
Extensions
extension (request: RequestErrorOutput)