bpmn-server / Connector
Interface: Connector#
Table of contents#
Properties#
- id
- name
- description
- openapi
- baseUrl
- operations
- groups
- enabled
- timeout
- retries
- auth
- test
- createdAt
- updatedAt
Properties#
id#
• id: string
Defined in#
packages/bpmn-server/src/connectors/Connectors.ts:46
name#
• name: string
Defined in#
packages/bpmn-server/src/connectors/Connectors.ts:47
description#
• Optional description: string
Defined in#
packages/bpmn-server/src/connectors/Connectors.ts:48
openapi#
• openapi: Object
the document, kept as it was read (packed: see document(id) to read it)
Type declaration#
| Name | Type |
|---|---|
source? |
string |
version |
string |
title? |
string |
fetchedAt |
string |
packed |
string |
bytes |
number |
Defined in#
packages/bpmn-server/src/connectors/Connectors.ts:50
baseUrl#
• baseUrl: string
Defined in#
packages/bpmn-server/src/connectors/Connectors.ts:51
operations#
• operations: Record\<string, boolean>
the operations designers may use, by operationId
Defined in#
packages/bpmn-server/src/connectors/Connectors.ts:53
groups#
• groups: string[]
the groups that may design with it; empty: every designer
Defined in#
packages/bpmn-server/src/connectors/Connectors.ts:55
enabled#
• enabled: boolean
Defined in#
packages/bpmn-server/src/connectors/Connectors.ts:56
timeout#
• Optional timeout: number
Defined in#
packages/bpmn-server/src/connectors/Connectors.ts:57
retries#
• Optional retries: number
Defined in#
packages/bpmn-server/src/connectors/Connectors.ts:58
auth#
• Optional auth: ConnectorAuth
Defined in#
packages/bpmn-server/src/connectors/Connectors.ts:59
test#
• Optional test: Object
Type declaration#
| Name | Type |
|---|---|
at |
string |
operation |
string |
ok |
boolean |
status? |
number |
message? |
string |
Defined in#
packages/bpmn-server/src/connectors/Connectors.ts:60
createdAt#
• createdAt: string
Defined in#
packages/bpmn-server/src/connectors/Connectors.ts:61
updatedAt#
• updatedAt: string
Defined in#
packages/bpmn-server/src/connectors/Connectors.ts:62