Set workflow

PUT 
/workflows/:workflowId

Set a Workflow details; available as an Add-On Module

Request

Path Parameters

workflowId stringrequired

Workflow Identifier

Query Parameters

siteId string

Site Identifier

application/json

Body

required

name stringrequired

Workflow name

description string

Workflow description

status WorkflowStatus (string)required

Status of the Workflow

Possible values: [ACTIVE, INACTIVE]

steps

object[]

required

Workflow Steps

Array [

stepId string

Workflow Step Identifier

action

object

type DocumentActionType (string)required

Type of the Document Action

Possible values: [ANTIVIRUS, DOCUMENTTAGGING, FULLTEXT, NOTIFICATION, OCR, QUEUE, WEBHOOK, IDP, PUBLISH, PDFEXPORT, EVENTBRIDGE, RESIZE, DATA_CLASSIFICATION, MALWARE_SCAN]

parameters

object

ocrTextractQueries

object[]

Array [

text string

Natural-language question

alias string

Label to identify this query in the result

pages string[]

Page selection

]

ocrParseTypes string

OCR: Parse types - TEXT, FORMS, TABLES, QUERIES (must include ocrTextractQueries)

ocrEngine OcrEngine (string)

Type of OCR Engine to use

Possible values: [TESSERACT, TEXTRACT]

ocrOutputType OcrOutputType (string)

OCR Engine output format (textract table only)

Possible values: [CSV]

ocrNumberOfPages string

Number of pages to OCR (from start) (-1 all)

addPdfDetectedCharactersAsText string

OCR: For the rewriting of the PDF document, converting any image text to searchable text

llmPromptEntityName string

DATA_CLASSIFICATION: Set the LLM Prompt Entity Name

url string

Webhook: Callback URL

characterMax string

Fulltext: Maximum number of characters (-1 unlimited, Typesense defaults to 2048 characters)

engine string

DocumentTagging: Engine to use for document tagging generation

Possible values: [chatgpt]

notificationType string

Notification Type

Possible values: [email]

notificationToCc string

Who to carbon copy on the notification to (comma-delimited list)

notificationToBcc string

Who to blind carbon copy on the notification to (comma-delimited list)

notificationSubject string

Subject of the notification

notificationText string

Text of the notification

notificationHtml string

Html of the notification

tags string

DocumentTagging: Comma-deliminted list of keywords to generate tags for

mappingId string

Id of Mapping

eventBusName string

The name or ARN of the event bus to receive the event

width string

The width of the image to resize (or 'auto')

height string

The height of the image to resize (or 'auto')

path string

The path to use when creating resized document (optional)

outputType string

The output type of the image

queueId string

Id of Queue

queue

object

queueId stringrequired

Queue Identifier

approvalGroups string[]

decisions

object[]

Workflow Decisions

Array [

type WorkflowStepDecisionType (string)required

Type of Workflow Step Decision

Possible values: [APPROVE, REJECT]

nextStepId stringrequired

Workflow Step to move to

]

]

Responses

200

20. OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

message string

Result message

Example (from schema)

{
  "message": "string"
}

400

400 BAD REQUEST

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

errors

object[]

List of errors

Array [

key string

Error Key

error string

Error Message

]

Example (from schema)

{
  "errors": [
    {
      "key": "string",
      "error": "string"
    }
  ]
}

Loading...