openapi: 3.2.0
info:
  title: Folio Workflow Controller API
  version: v0
  description: 'Operations tagged workflow-controller across 4 of this provider''s published API definitions: folio-mod-camunda-openapi-openapi.json, folio-mod-workflow-openapi-openapi.json, folio-mod-camunda-openapi-openapi.yml, folio-mod-workflow-openapi-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:9000
  description: Generated server url
tags:
- name: work flow controller
paths:
  /workflow-engine/workflows/deactivate:
    post:
      tags:
      - work flow controller
      operationId: deactivateWorkflow
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Workflow'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
        '204':
          description: No Content
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '400':
          description: Bad Request
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '500':
          description: Internal Server Error
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
      summary: Deactivate workflow
      x-summary-source: derived
    servers:
    - url: http://localhost:9000
      description: Generated server url
  /workflow-engine/workflows/activate:
    post:
      tags:
      - work flow controller
      operationId: activateWorkflow
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                workflow:
                  $ref: '#/components/schemas/Workflow'
                tenant:
                  type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
        '204':
          description: No Content
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '400':
          description: Bad Request
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '500':
          description: Internal Server Error
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
      summary: Activate workflow
      x-summary-source: derived
    servers:
    - url: http://localhost:9000
      description: Generated server url
  /workflows/{id}/deactivate:
    put:
      tags:
      - work flow controller
      operationId: putWorkflowsByIdDeactivate
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: tenant
        in: query
        required: true
        schema:
          type: string
      - name: token
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
        '204':
          description: No Content
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '400':
          description: Bad Request
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '500':
          description: Internal Server Error
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
      summary: Deactivate workflow
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: deactivateWorkflow
    servers:
    - url: http://localhost:9000
      description: Generated server url
  /workflows/{id}/activate:
    put:
      tags:
      - work flow controller
      operationId: putWorkflowsByIdActivate
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: tenant
        in: query
        required: true
        schema:
          type: string
      - name: token
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
        '204':
          description: No Content
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '400':
          description: Bad Request
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '500':
          description: Internal Server Error
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
      summary: Activate workflow
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: activateWorkflow
    servers:
    - url: http://localhost:9000
      description: Generated server url
  /workflows/{id}/start:
    post:
      tags:
      - work flow controller
      operationId: startWorkflow
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: tenant
        in: query
        required: true
        schema:
          type: string
      - name: token
        in: query
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonNode_2'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonNode_2'
        '204':
          description: No Content
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '400':
          description: Bad Request
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '500':
          description: Internal Server Error
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
      summary: Start workflow
      x-summary-source: derived
    servers:
    - url: http://localhost:9000
      description: Generated server url
  /workflows/import:
    post:
      tags:
      - work flow controller
      operationId: importWorkflow
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                tenant:
                  type: string
                token:
                  type: string
              required:
              - file
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        '204':
          description: No Content
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '400':
          description: Bad Request
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '500':
          description: Internal Server Error
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
      summary: Import workflow
      x-summary-source: derived
    servers:
    - url: http://localhost:9000
      description: Generated server url
  /workflows/{id}/history:
    get:
      tags:
      - work flow controller
      operationId: workflowHistory
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: tenant
        in: query
        required: true
        schema:
          type: string
      - name: token
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonNode_2'
        '204':
          description: No Content
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '400':
          description: Bad Request
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '500':
          description: Internal Server Error
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
      summary: Workflow history
      x-summary-source: derived
    servers:
    - url: http://localhost:9000
      description: Generated server url
  /workflows/search:
    get:
      tags:
      - work flow controller
      operationId: searchWorkflows
      parameters:
      - name: query
        in: query
        required: true
        schema:
          type: string
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          format: int64
          default: 0
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 20
      - name: tenant
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonNode_2'
        '204':
          description: No Content
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '400':
          description: Bad Request
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '500':
          description: Internal Server Error
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
      summary: Search workflows
      x-summary-source: derived
    servers:
    - url: http://localhost:9000
      description: Generated server url
  /workflows/{id}/delete:
    delete:
      tags:
      - work flow controller
      operationId: deleteWorkflow
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: tenant
        in: query
        required: true
        schema:
          type: string
      - name: token
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                type: object
        '204':
          description: No Content
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '400':
          description: Bad Request
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '500':
          description: Internal Server Error
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
      summary: Delete workflow
      x-summary-source: derived
    servers:
    - url: http://localhost:9000
      description: Generated server url
components:
  schemas:
    Error:
      required:
      - message
      type: object
      properties:
        message:
          type: string
        type:
          type: string
        code:
          type: string
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
    Workflow:
      required:
      - name
      - versionTag
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        deploymentId:
          type: string
        description:
          maxLength: 512
          minLength: 0
          type: string
        historyTimeToLive:
          minimum: 0
          type: integer
          format: int32
        initialContext:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/JsonNode'
        name:
          maxLength: 64
          minLength: 4
          type: string
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/Node'
        setup:
          $ref: '#/components/schemas/Setup'
        versionTag:
          maxLength: 64
          minLength: 1
          type: string
    ResponseErrors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        total_records:
          type: integer
          format: int32
    Setup:
      type: object
      properties:
        asyncAfter:
          type: boolean
        asyncBefore:
          type: boolean
    Node:
      required:
      - name
      type: object
      properties:
        id:
          type: string
        name:
          maxLength: 64
          minLength: 3
          type: string
        description:
          maxLength: 512
          minLength: 0
          type: string
        deserializeAs:
          type: string
          readOnly: true
        identifier:
          type: string
    Parameter:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
    JsonNode:
      type: object
    JsonNode_2: {}
    JsonNode_3: {}
x-refined-from:
- folio-mod-camunda-openapi-openapi.json
- folio-mod-workflow-openapi-openapi.json
- folio-mod-camunda-openapi-openapi.yml
- folio-mod-workflow-openapi-openapi.yml