Skip to content

Create WorkflowTypeTaskOption

Request

Creates a new WorkflowTypeTaskOption

Security
apiKeyAuth and bearerAuth
Path
workflowTypestringrequired

Workflow Type

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
workflow_Typestring, [ 1 .. 32 ] charactersrequired

Identifies the workflow type that options are displayed for.

workflowTask_Optionstring, [ 1 .. 32 ] charactersrequired

Identifies the available task option for the identified workflow type.

descriptionstring or null, <= 512 characters

Description of the task option.

displaystring or null, <= 256 characters

Name of the task option.

entry_Datestring, (date-time)

Date record was first added to the system

entry_Userstring or null, <= 20 characters

User that first added the record to the system

system_Process_Optionbooleanrequired

If this option is set to 1, the system will automatically process claims assigned to this workflow task. Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Datestring, (date-time)

Date the record was last updated in the system

update_Userstring or null, <= 20 characters

User that last updated the record in the system

curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/workflow-types/{workflowType}/task-options' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "workflow_Type": "string",
    "workflowTask_Option": "string",
    "description": "string",
    "display": "string",
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "system_Process_Option": true,
    "update_Date": "2019-08-24T14:15:22Z",
    "update_User": "string"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}