Documentation for a newer release is available. View Latest

Connector and Transaction Operations

1. Endpoints

1.1. ConnectorOperationsController

1.1.1. getConnector

GET /connectors/{connectorName}
Description
Parameters
Path Parameters
Name Description Required Default Pattern

connectorName

X

null
Return Type

ConnectorInfo

Content Type

  • application/json

Responses
http response codes
Code Message Datatype

200

OK

ConnectorInfo
Samples

1.1.2. getConnectors

GET /connectors
Description
Parameters
Return Type

-

Responses
http response codes
Code Message Datatype

200

OK

<<>>
Samples

1.1.3. start

POST /connectors/{connectorName}/start
Description
Parameters
Path Parameters
Name Description Required Default Pattern

connectorName

X

null
Return Type

-

Responses
http response codes
Code Message Datatype

200

OK

<<>>
Samples

1.1.4. startReceivingFromAll

POST /connectors/start-receiving
Description
Parameters
Return Type

-

Responses
http response codes
Code Message Datatype

200

OK

<<>>
Samples

1.1.5. stop

POST /connectors/{connectorName}/stop
Description
Parameters
Path Parameters
Name Description Required Default Pattern

connectorName

X

null
Return Type

-

Responses
http response codes
Code Message Datatype

200

OK

<<>>
Samples

1.1.6. stopReceivingFromAll

POST /connectors/stop-receiving
Description
Parameters
Return Type

-

Responses
http response codes
Code Message Datatype

200

OK

<<>>
Samples

1.2. TransactionOperationsController

1.2.1. resumeTransaction

POST /transactions/{transactionId}/resume
Description
Parameters
Path Parameters
Name Description Required Default Pattern

transactionId

X

null
Return Type

-

Responses
http response codes
Code Message Datatype

200

OK

<<>>
Samples

1.2.2. stopTransaction

POST /transactions/{transactionId}/abort
Description
Parameters
Path Parameters
Name Description Required Default Pattern

transactionId

X

null
Body Parameter
Name Description Required Default Pattern

StopInfo

StopInfo

X
Return Type

-

Responses
http response codes
Code Message Datatype

200

OK

<<>>
Samples

2. Models

2.1. ConnectorInfo

Field Name Required Type Description Format

name

String

running

Boolean

2.2. StopInfo

Field Name Required Type Description Format

reason

String