Abstract
The Syndesis REST API connects to back-end services on the Syndesis and provides a single entry point for the Syndesis UI.

1. Endpoints

1.1. Actions

1.1.2. get4

GET /connectors/{connectorId}/actions/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

connectorId

X

null

Return Type
Content Type
  • application/json

Responses
Table 2. http response codes
Code Message Datatype

0

default response

ConnectorAction

Samples

1.1.3. list2

GET /connectors/{connectorId}/actions

Description
Parameters
Path Parameters
Name Description Required Default Pattern

connectorId

X

null

Query Parameters
Name Description Required Default Pattern

sort

Sort the result list according to the given field value

-

null

direction

Sorting direction when a 'sort' field is provided. Can be 'asc' (ascending) or 'desc' (descending)

-

null

page

Page number to return

-

1

per_page

Number of records per page

-

20

query

The search query to filter results on

-

null

Content Type
  • application/json

Responses
Table 3. http response codes
Code Message Datatype

0

default response

ListResultConnectorAction

Samples

1.2. Connections

1.2.1. create

POST /connections

Description
Parameters
Body Parameter
Name Description Required Default Pattern

Connection

Connection

X

Return Type
Content Type
  • application/json

Responses
Table 4. http response codes
Code Message Datatype

0

default response

Connection

Samples

1.2.2. delete

DELETE /connections/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type

-

Content Type
  • /

Responses
Table 5. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.2.4. get

GET /connections/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 7. http response codes
Code Message Datatype

0

default response

ConnectionOverview

Samples

1.2.5. getBulletins

GET /connections/{id}/bulletins

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Content Type
  • application/json

Responses
Table 8. http response codes
Code Message Datatype

0

default response

ConnectionBulletinBoard

Samples

1.2.6. list

GET /connections

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sort

Sort the result list according to the given field value

-

null

direction

Sorting direction when a 'sort' field is provided. Can be 'asc' (ascending) or 'desc' (descending)

-

null

page

Page number to return

-

1

per_page

Number of records per page

-

20

query

The search query to filter results on

-

null

Content Type
  • application/json

Responses
Table 9. http response codes
Code Message Datatype

0

default response

ListResultConnectionOverview

Samples

1.2.7. patch

PATCH /connections/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Body Parameter
Name Description Required Default Pattern

body

[object]

X

Return Type

-

Content Type
  • /

Responses
Table 10. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.2.8. update

PUT /connections/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Body Parameter
Name Description Required Default Pattern

Connection

Connection

X

Return Type

-

Content Type
  • /

Responses
Table 11. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.2.9. validate

POST /connections/validation

Description
Parameters
Body Parameter
Name Description Required Default Pattern

Connection

Connection

X

Return Type

-

Content Type
  • application/json

Responses
Table 12. http response codes
Code Message Datatype

204

All validations pass

<<>>

400

Found violations in validation

List[[object]]

Samples

1.3. Connector

1.3.1. create3

POST /connectors/{id}/icon

Description

Updates the connector icon for the specified connector and returns the updated connector

Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Form Parameters
Name Description Required Default Pattern

parts

[InputPart]

-

null

preamble

[string]

-

null

Return Type

-

Responses
Table 13. http response codes
Code Message Datatype

200

Updated Connector icon

<<>>

Samples

1.3.2. get5

GET /connectors/{id}/icon

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type

-

Content Type
  • /

Responses
Table 14. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.4. ConnectorIcon

1.4.1. create3

POST /connectors/{id}/icon

Description

Updates the connector icon for the specified connector and returns the updated connector

Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Form Parameters
Name Description Required Default Pattern

parts

[InputPart]

-

null

preamble

[string]

-

null

Return Type

-

Responses
Table 15. http response codes
Code Message Datatype

200

Updated Connector icon

<<>>

Samples

1.4.2. get5

GET /connectors/{id}/icon

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type

-

Content Type
  • /

Responses
Table 16. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.5. ConnectorTemplate

1.5.1. create2

POST /connectors/custom

Description

Creates a new Connector based on the ConnectorTemplate identified by the provided id and the data given in connectorSettings multipart part, plus optional icon file

Parameters
Form Parameters
Name Description Required Default Pattern

connectorSettings

[ConnectorSettings]

-

null

iconInputStream

[object]

-

null

specification

[object]

-

null

Return Type

-

Responses
Table 17. http response codes
Code Message Datatype

200

Newly created Connector

<<>>

Samples

1.5.2. get6

GET /connector-templates/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 18. http response codes
Code Message Datatype

0

default response

ConnectorTemplate

Samples

1.5.3. info

POST /connectors/custom/info

Description

Provides a summary of the connector as it would be built using a ConnectorTemplate identified by the provided connector-template-id and the data given in connectorSettings

Parameters
Form Parameters
Name Description Required Default Pattern

connectorSettings

[ConnectorSettings]

-

null

iconInputStream

[object]

-

null

specification

[object]

-

null

Return Type
Content Type
  • application/json

Responses
Table 19. http response codes
Code Message Datatype

0

default response

APISummary

Samples

1.5.4. list4

GET /connector-templates

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sort

Sort the result list according to the given field value

-

null

direction

Sorting direction when a 'sort' field is provided. Can be 'asc' (ascending) or 'desc' (descending)

-

null

page

Page number to return

-

1

per_page

Number of records per page

-

20

query

The search query to filter results on

-

null

Content Type
  • application/json

Responses
Table 20. http response codes
Code Message Datatype

0

default response

ListResultConnectorTemplate

Samples

1.6. Connectorgroups

1.6.1. get1

GET /connectorgroups/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 21. http response codes
Code Message Datatype

0

default response

ConnectorGroup

Samples

1.6.2. list1

GET /connectorgroups

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sort

Sort the result list according to the given field value

-

null

direction

Sorting direction when a 'sort' field is provided. Can be 'asc' (ascending) or 'desc' (descending)

-

null

page

Page number to return

-

1

per_page

Number of records per page

-

20

query

The search query to filter results on

-

null

Content Type
  • application/json

Responses
Table 22. http response codes
Code Message Datatype

0

default response

ListResultConnectorGroup

Samples

1.7. Connectors

1.7.1. create1

POST /connectors/{id}/credentials

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Body Parameter
Name Description Required Default Pattern

AcquisitionRequest

AcquisitionRequest

X

Return Type

-

Content Type
  • application/json

Responses
Table 23. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.7.2. create2

POST /connectors/custom

Description

Creates a new Connector based on the ConnectorTemplate identified by the provided id and the data given in connectorSettings multipart part, plus optional icon file

Parameters
Form Parameters
Name Description Required Default Pattern

connectorSettings

[ConnectorSettings]

-

null

iconInputStream

[object]

-

null

specification

[object]

-

null

Return Type

-

Responses
Table 24. http response codes
Code Message Datatype

200

Newly created Connector

<<>>

Samples

1.7.3. create3

POST /connectors/{id}/icon

Description

Updates the connector icon for the specified connector and returns the updated connector

Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Form Parameters
Name Description Required Default Pattern

parts

[InputPart]

-

null

preamble

[string]

-

null

Return Type

-

Responses
Table 25. http response codes
Code Message Datatype

200

Updated Connector icon

<<>>

Samples

1.7.4. delete1

DELETE /connectors/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type

-

Content Type
  • /

Responses
Table 26. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.7.5. dynamicConnectionProperties

POST /connectors/{connectorId}/properties

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

connectorId

X

null

Return Type
Content Type
  • application/json

Responses
Table 27. http response codes
Code Message Datatype

0

default response

[Object]

Samples

1.7.6. get2

GET /connectors/{id}/credentials

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 28. http response codes
Code Message Datatype

0

default response

AcquisitionMethod

Samples

1.7.7. get3

GET /connectors/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 29. http response codes
Code Message Datatype

0

default response

Connector

Samples

1.7.8. get4

GET /connectors/{connectorId}/actions/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

connectorId

X

null

Return Type
Content Type
  • application/json

Responses
Table 30. http response codes
Code Message Datatype

0

default response

ConnectorAction

Samples

1.7.9. get5

GET /connectors/{id}/icon

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type

-

Content Type
  • /

Responses
Table 31. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.7.10. getFilterOptions

GET /connectors/{connectorId}/actions/{actionId}/filters/options

Description
Parameters
Path Parameters
Name Description Required Default Pattern

connectorId

X

null

actionId

X

null

Return Type
Content Type
  • application/json

Responses
Table 32. http response codes
Code Message Datatype

0

default response

FilterOptions

Samples

1.7.11. info

POST /connectors/custom/info

Description

Provides a summary of the connector as it would be built using a ConnectorTemplate identified by the provided connector-template-id and the data given in connectorSettings

Parameters
Form Parameters
Name Description Required Default Pattern

connectorSettings

[ConnectorSettings]

-

null

iconInputStream

[object]

-

null

specification

[object]

-

null

Return Type
Content Type
  • application/json

Responses
Table 33. http response codes
Code Message Datatype

0

default response

APISummary

Samples

1.7.12. list2

GET /connectors/{connectorId}/actions

Description
Parameters
Path Parameters
Name Description Required Default Pattern

connectorId

X

null

Query Parameters
Name Description Required Default Pattern

sort

Sort the result list according to the given field value

-

null

direction

Sorting direction when a 'sort' field is provided. Can be 'asc' (ascending) or 'desc' (descending)

-

null

page

Page number to return

-

1

per_page

Number of records per page

-

20

query

The search query to filter results on

-

null

Content Type
  • application/json

Responses
Table 34. http response codes
Code Message Datatype

0

default response

ListResultConnectorAction

Samples

1.7.13. list3

GET /connectors

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sort

Sort the result list according to the given field value

-

null

direction

Sorting direction when a 'sort' field is provided. Can be 'asc' (ascending) or 'desc' (descending)

-

null

page

Page number to return

-

1

per_page

Number of records per page

-

20

query

The search query to filter results on

-

null

Return Type
Content Type
  • application/json

Responses
Table 35. http response codes
Code Message Datatype

0

default response

ListResultConnector

Samples

1.7.14. listApiConnectors

GET /connectors/apiConnectors

Description
Parameters
Query Parameters
Name Description Required Default Pattern

connectorGroupIdList

Filter by matching connector group ids [String]

X

null

page

Page number to return

-

1

per_page

Number of records per page

-

20

Return Type
Content Type
  • application/json

Responses
Table 36. http response codes
Code Message Datatype

0

default response

ListResultConnector

Samples

1.7.15. patch1

PATCH /connectors/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Body Parameter
Name Description Required Default Pattern

body

[object]

X

Return Type

-

Content Type
  • /

Responses
Table 37. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.7.16. update2

PUT /connectors/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Form Parameters
Name Description Required Default Pattern

connector

Connector

-

null

iconInputStream

[object]

-

null

Return Type

-

Content Type
  • /

Responses
Table 38. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.7.17. verifyConnectionParameters

POST /connectors/{id}/verifier

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Body Parameter
Name Description Required Default Pattern

request_body

[string]

-

Return Type

array[Result]

Content Type
  • application/json

Responses
Table 39. http response codes
Code Message Datatype

0

default response

List[Result]

Samples

1.8. Credentials

1.8.1. callback

GET /credentials/callback

Description
Parameters
Return Type

-

Content Type
  • /

Responses
Table 40. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.8.2. create1

POST /connectors/{id}/credentials

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Body Parameter
Name Description Required Default Pattern

AcquisitionRequest

AcquisitionRequest

X

Return Type

-

Content Type
  • application/json

Responses
Table 41. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.8.3. get2

GET /connectors/{id}/credentials

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 42. http response codes
Code Message Datatype

0

default response

AcquisitionMethod

Samples

1.9. CustomConnector

1.9.1. create2

POST /connectors/custom

Description

Creates a new Connector based on the ConnectorTemplate identified by the provided id and the data given in connectorSettings multipart part, plus optional icon file

Parameters
Form Parameters
Name Description Required Default Pattern

connectorSettings

[ConnectorSettings]

-

null

iconInputStream

[object]

-

null

specification

[object]

-

null

Return Type

-

Responses
Table 43. http response codes
Code Message Datatype

200

Newly created Connector

<<>>

Samples

1.9.2. info

POST /connectors/custom/info

Description

Provides a summary of the connector as it would be built using a ConnectorTemplate identified by the provided connector-template-id and the data given in connectorSettings

Parameters
Form Parameters
Name Description Required Default Pattern

connectorSettings

[ConnectorSettings]

-

null

iconInputStream

[object]

-

null

specification

[object]

-

null

Return Type
Content Type
  • application/json

Responses
Table 44. http response codes
Code Message Datatype

0

default response

APISummary

Samples

1.10. Default

1.10.1. addNewEnvironment

POST /environments/{env}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

env

X

null

Return Type

-

Content Type
  • /

Responses
Table 45. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.10.2. deleteDeployments

GET /test-support/delete-deployments

Description
Parameters
Return Type

-

Content Type
  • /

Responses
Table 46. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.10.3. deleteEnvironment

DELETE /environments/{env}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

env

X

null

Return Type

-

Content Type
  • /

Responses
Table 47. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.10.4. deleteReleaseTag

DELETE /environments/integrations/{id}/{env}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

env

X

null

Return Type

-

Content Type
  • /

Responses
Table 48. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.10.5. get7

GET /organizations/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 49. http response codes
Code Message Datatype

0

default response

Organization

Samples

1.10.6. getReleaseEnvironments

GET /environments

Description
Parameters
Query Parameters
Name Description Required Default Pattern

withUses

-

null

Return Type

-

Content Type
  • application/json

Responses
Table 50. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.10.7. getReleaseTags

GET /environments/integrations/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Content Type
  • application/json

Responses
Table 51. http response codes
Code Message Datatype

0

default response

Map[ContinuousDeliveryEnvironment]

Samples

1.10.8. list5

GET /organizations

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sort

Sort the result list according to the given field value

-

null

direction

Sorting direction when a 'sort' field is provided. Can be 'asc' (ascending) or 'desc' (descending)

-

null

page

Page number to return

-

1

per_page

Number of records per page

-

20

query

The search query to filter results on

-

null

Content Type
  • application/json

Responses
Table 52. http response codes
Code Message Datatype

0

default response

ListResultOrganization

Samples

1.10.9. patchTagsForRelease

PATCH /environments/integrations/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Body Parameter
Name Description Required Default Pattern

string

[string]

X

Content Type
  • application/json

Responses
Table 53. http response codes
Code Message Datatype

0

default response

Map[ContinuousDeliveryEnvironment]

Samples

1.10.10. putTagsForRelease

PUT /environments/integrations/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Body Parameter
Name Description Required Default Pattern

string

[string]

X

Content Type
  • application/json

Responses
Table 54. http response codes
Code Message Datatype

0

default response

Map[ContinuousDeliveryEnvironment]

Samples

1.10.11. renameEnvironment

PUT /environments/{env}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

env

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

X

Return Type

-

Content Type
  • /

Responses
Table 55. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.10.12. resetDBToDefault

GET /test-support/reset-db

Description
Parameters
Return Type

-

Content Type
  • /

Responses
Table 56. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.10.13. restoreDB

POST /test-support/restore-db

Description
Parameters
Body Parameter
Name Description Required Default Pattern

ModelDataObject

ModelDataObject

-

Return Type

-

Content Type
  • /

Responses
Table 57. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.10.14. snapshotDB

GET /test-support/snapshot-db

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 58. http response codes
Code Message Datatype

0

default response

List[ModelDataWithIdObject]

Samples

1.11. Events

1.11.1. reserveEventStream

POST /event/reservations

Description
Parameters
Return Type
Content Type
  • /

Responses
Table 59. http response codes
Code Message Datatype

0

default response

EventMessage

Samples

1.12. Extensions

1.12.1. delete2

DELETE /extensions/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type

-

Content Type
  • /

Responses
Table 60. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.12.2. get8

GET /extensions/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 61. http response codes
Code Message Datatype

0

default response

Extension

Samples

1.12.3. getStepIcon

GET /extensions/{id}/stepIcon

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type

-

Content Type
  • /

Responses
Table 62. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.12.4. install

POST /extensions/{id}/install

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • /

Responses
Table 63. http response codes
Code Message Datatype

200

Installed

List[[object]]

400

Found violations in validation

List[[object]]

Samples

1.12.5. integrations

GET /extensions/{id}/integrations

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • /

Responses
Table 64. http response codes
Code Message Datatype

0

default response

Set[ResourceIdentifier]

Samples

1.12.6. list6

GET /extensions

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sort

Sort the result list according to the given field value

-

null

direction

Sorting direction when a 'sort' field is provided. Can be 'asc' (ascending) or 'desc' (descending)

-

null

page

Page number to return

-

1

per_page

Number of records per page

-

20

query

The search query to filter results on

-

null

extensionType

-

null

Return Type
Content Type
  • application/json

Responses
Table 65. http response codes
Code Message Datatype

0

default response

ListResultExtension

Samples

1.12.7. upload

POST /extensions

Description
Parameters
Form Parameters
Name Description Required Default Pattern

parts

[InputPart]

-

null

preamble

[string]

-

null

Query Parameters
Name Description Required Default Pattern

updatedId

-

null

Return Type
Content Type
  • application/json

Responses
Table 66. http response codes
Code Message Datatype

0

default response

Extension

Samples

1.12.8. validate1

POST /extensions/validation

Description
Parameters
Body Parameter
Name Description Required Default Pattern

Extension

Extension

X

Return Type
Content Type
  • application/json

Responses
Table 67. http response codes
Code Message Datatype

200

All blocking validations pass

List[[object]]

400

Found violations in validation

List[[object]]

Samples

1.12.9. validate2

POST /extensions/{id}/validation

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 68. http response codes
Code Message Datatype

200

All blocking validations pass

List[[object]]

400

Found violations in validation

List[[object]]

Samples

1.13. IntegrationDeployments

1.13.1. get9

GET /integrations/{id}/deployments/{version}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

version

X

null

Return Type
Content Type
  • application/json

Responses
Table 69. http response codes
Code Message Datatype

0

default response

IntegrationDeployment

Samples

1.13.2. list7

GET /integrations/{id}/deployments

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Content Type
  • application/json

Responses
Table 70. http response codes
Code Message Datatype

0

default response

ListResultIntegrationDeployment

Samples

1.13.3. update1

PUT /integrations/{id}/deployments

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 71. http response codes
Code Message Datatype

0

default response

IntegrationDeployment

Samples

1.13.4. updateTargetState

POST /integrations/{id}/deployments/{version}/targetState

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

version

X

null

Body Parameter
Name Description Required Default Pattern

TargetStateRequest

TargetStateRequest

X

Return Type

-

Content Type
  • application/json

Responses
Table 72. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.14. IntegrationMetrics

1.14.1. get11

GET /metrics/integrations

Description

Retrieves a rolled up metrics summary for all integrations over their lifetime

Parameters
Content Type
  • application/json

Responses
Table 73. http response codes
Code Message Datatype

0

default response

IntegrationMetricsSummary

Samples

1.14.2. get12

GET /metrics/integrations/{integrationId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

integrationId

X

null

Content Type
  • application/json

Responses
Table 74. http response codes
Code Message Datatype

0

default response

IntegrationMetricsSummary

Samples

1.15. IntegrationSupport

1.15.1. export

GET /integration-support/export.zip

Description
Parameters
Query Parameters
Name Description Required Default Pattern

id

[String]

X

null

Return Type

-

Content Type
  • application/octet-stream

Responses
Table 75. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.15.2. getOverviews

GET /integration-support/overviews

Description
Parameters
Content Type
  • application/json

Responses
Table 76. http response codes
Code Message Datatype

0

default response

ListResultIntegrationOverview

Samples

1.15.3. importIntegration

POST /integration-support/import

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[object]

-

Return Type
Content Type
  • application/json

Responses
Table 77. http response codes
Code Message Datatype

0

default response

Map[WithResourceId]

Samples

1.15.4. projectPom

POST /integration-support/generate/pom.xml

Description
Parameters
Body Parameter
Name Description Required Default Pattern

Integration

Integration

-

Return Type
Content Type
  • application/octet-stream

Responses
Table 78. http response codes
Code Message Datatype

0

default response

List[[ByteArray]]

Samples

1.16. Integrations

1.16.1. create4

POST /integrations

Description
Parameters
Body Parameter
Name Description Required Default Pattern

Integration

Integration

X

Return Type
Content Type
  • application/json

Responses
Table 79. http response codes
Code Message Datatype

0

default response

Integration

Samples

1.16.2. delete3

DELETE /integrations/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type

-

Content Type
  • /

Responses
Table 80. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.16.3. fetch

GET /integrations/{id}/specification

Description

Responds with specification that defines this integration

Parameters
Path Parameters
Name Description Required Default Pattern

id

The ID of the integration

X

null

Return Type

-

Responses
Table 81. http response codes
Code Message Datatype

200

Specification resource follows

<<>>

204

Empty specification provided when definining this integration

<<>>

404

No specification resource defines this integration

<<>>

Samples

1.16.4. get10

GET /integrations/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 82. http response codes
Code Message Datatype

0

default response

IntegrationOverview

Samples

1.16.5. getFilterOptions1

POST /integrations/filters/options

Description
Parameters
Body Parameter
Name Description Required Default Pattern

DataShape

DataShape

-

Return Type
Content Type
  • application/json

Responses
Table 83. http response codes
Code Message Datatype

0

default response

FilterOptions

Samples

1.16.6. getGlobalFilterOptions

GET /integrations/filters/options

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 84. http response codes
Code Message Datatype

0

default response

FilterOptions

Samples

1.16.7. getOverview

GET /integrations/{id}/overview

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 85. http response codes
Code Message Datatype

0

default response

IntegrationOverview

Samples

1.16.8. list8

GET /integrations

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sort

Sort the result list according to the given field value

-

null

direction

Sorting direction when a 'sort' field is provided. Can be 'asc' (ascending) or 'desc' (descending)

-

null

page

Page number to return

-

1

per_page

Number of records per page

-

20

query

The search query to filter results on

-

null

Content Type
  • application/json

Responses
Table 86. http response codes
Code Message Datatype

0

default response

ListResultIntegrationOverview

Samples

1.16.9. patch2

PATCH /integrations/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Body Parameter
Name Description Required Default Pattern

body

[object]

X

Return Type

-

Content Type
  • /

Responses
Table 87. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.16.10. update3

PUT /integrations/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Body Parameter
Name Description Required Default Pattern

Integration

Integration

X

Return Type

-

Content Type
  • /

Responses
Table 88. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.16.11. update4

PUT /integrations/{id}/specification

Description

For an integration that is generated from a specification updates it so it conforms to the updated specification

Parameters
Path Parameters
Name Description Required Default Pattern

id

The ID of the integration

X

null

Form Parameters
Name Description Required Default Pattern

specification

[object]

-

null

Return Type

-

Content Type
  • /

Responses
Table 89. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.16.12. validate3

POST /integrations/validation

Description
Parameters
Body Parameter
Name Description Required Default Pattern

Integration

Integration

X

Return Type

-

Content Type
  • application/json

Responses
Table 90. http response codes
Code Message Datatype

204

All validations pass

<<>>

400

Found violations in validation

List[[object]]

Samples

1.17. OauthApps

1.17.1. delete4

DELETE /setup/oauth-apps/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type

-

Content Type
  • /

Responses
Table 91. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.17.2. get14

GET /setup/oauth-apps/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 92. http response codes
Code Message Datatype

0

default response

OAuthApp

Samples

1.17.3. list9

GET /setup/oauth-apps

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sort

Sort the result list according to the given field value

-

null

direction

Sorting direction when a 'sort' field is provided. Can be 'asc' (ascending) or 'desc' (descending)

-

null

page

Page number to return

-

1

per_page

Number of records per page

-

20

query

The search query to filter results on

-

null

Return Type
Content Type
  • application/json

Responses
Table 93. http response codes
Code Message Datatype

0

default response

ListResultOAuthApp

Samples

1.17.4. update5

PUT /setup/oauth-apps/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Body Parameter
Name Description Required Default Pattern

OAuthApp

OAuthApp

X

Return Type

-

Content Type
  • /

Responses
Table 94. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.18. Permissions

1.18.1. get15

GET /permissions/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 95. http response codes
Code Message Datatype

0

default response

Permission

Samples

1.18.2. list10

GET /permissions

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sort

Sort the result list according to the given field value

-

null

direction

Sorting direction when a 'sort' field is provided. Can be 'asc' (ascending) or 'desc' (descending)

-

null

page

Page number to return

-

1

per_page

Number of records per page

-

20

query

The search query to filter results on

-

null

Return Type
Content Type
  • application/json

Responses
Table 96. http response codes
Code Message Datatype

0

default response

ListResultPermission

Samples

1.19. Properties

1.19.1. dynamicConnectionProperties

POST /connectors/{connectorId}/properties

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

connectorId

X

null

Return Type
Content Type
  • application/json

Responses
Table 97. http response codes
Code Message Datatype

0

default response

[Object]

Samples

1.20. Resources

1.20.1. get13

GET /resources/{kind}/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

kind

X

null

id

X

null

Return Type

-

Content Type
  • /

Responses
Table 98. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.21. Roles

1.21.1. get16

GET /roles/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 99. http response codes
Code Message Datatype

0

default response

Role

Samples

1.21.2. list11

GET /roles

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sort

Sort the result list according to the given field value

-

null

direction

Sorting direction when a 'sort' field is provided. Can be 'asc' (ascending) or 'desc' (descending)

-

null

page

Page number to return

-

1

per_page

Number of records per page

-

20

query

The search query to filter results on

-

null

Return Type
Content Type
  • application/json

Responses
Table 100. http response codes
Code Message Datatype

0

default response

ListResultRole

Samples

1.22. Tags

1.22.1. listTags

GET /tags

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 101. http response codes
Code Message Datatype

0

default response

ListResultString

Samples

1.23. Users

1.23.1. get17

GET /users/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 102. http response codes
Code Message Datatype

0

default response

User

Samples

1.23.2. list12

GET /users

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sort

Sort the result list according to the given field value

-

null

direction

Sorting direction when a 'sort' field is provided. Can be 'asc' (ascending) or 'desc' (descending)

-

null

page

Page number to return

-

1

per_page

Number of records per page

-

20

query

The search query to filter results on

-

null

Return Type
Content Type
  • application/json

Responses
Table 103. http response codes
Code Message Datatype

0

default response

ListResultUser

Samples

1.23.3. quota

GET /users/~/quota

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 104. http response codes
Code Message Datatype

0

default response

Quota

Samples

1.23.4. whoAmI

GET /users/~

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 105. http response codes
Code Message Datatype

0

default response

User

Samples

2. Models

2.1. APISummary

Field Name Required Type Description Format

actionsSummary

List of ActionsSummary

configuredProperties

Map of [string]

description

String

errors

List of [object]

icon

String

name

X

String

properties

Map of ConfigurationProperty

warnings

List of [object]

2.2. AcquisitionMethod

Field Name Required Type Description Format

configured

Boolean

description

String

icon

String

label

String

type

String

Enum: OAUTH1, OAUTH2,

2.3. AcquisitionRequest

Field Name Required Type Description Format

returnUrl

URI

uri

2.4. Action

Field Name Required Type Description Format

actionType

String

description

String

descriptor

ActionDescriptor

id

String

metadata

Map of [string]

name

X

String

pattern

String

Enum: From, Pipe, To, PollEnrich,

tags

Set of [string]

2.5. ActionDescriptor

Field Name Required Type Description Format

inputDataShape

DataShape

outputDataShape

DataShape

propertyDefinitionSteps

List of ActionDescriptorStep

2.6. ActionDescriptorStep

Field Name Required Type Description Format

configuredProperties

Map of [string]

description

String

name

X

String

properties

Map of ConfigurationProperty

2.7. ActionsSummary

Field Name Required Type Description Format

actionCountByTags

Map of [integer]

int32

totalActions

Integer

int32

2.8. ArrayDefinition

Field Name Required Type Description Format

key

ArrayDefinitionElement

value

ArrayDefinitionElement

2.9. ArrayDefinitionElement

Field Name Required Type Description Format

displayName

String

type

String

2.10. ArrayDefinitionOptions

Field Name Required Type Description Format

i18nAddElementText

String

minElements

Integer

int32

2.11. ConfigurationProperty

Field Name Required Type Description Format

arrayDefinition

ArrayDefinition

arrayDefinitionOptions

ArrayDefinitionOptions

componentProperty

Boolean

connectorValue

String

controlHint

String

dataList

List of [string]

defaultValue

String

deprecated

Boolean

description

String

displayName

String

enum

List of PropertyValue

extendedProperties

String

generator

String

group

String

javaType

String

kind

String

label

String

labelHint

String

multiple

Boolean

order

ConfigurationProperty_order

placeholder

String

raw

Boolean

relation

List of PropertyRelation

required

Boolean

secret

Boolean

tags

Set of [string]

type

String

2.12. ConfigurationPropertyOrder

Field Name Required Type Description Format

asInt

Integer

int32

present

Boolean

2.13. Connection

Field Name Required Type Description Format

configuredProperties

Map of [string]

connector

Connector

connectorId

String

createdDate

Date

date-time

derived

Boolean

description

String

icon

String

id

String

lastUpdated

Date

date-time

metadata

Map of [string]

name

X

String

options

Map of [string]

organization

Organization

organizationId

String

tags

Set of [string]

userId

String

uses

Integer

int32

2.14. ConnectionBulletinBoard

Field Name Required Type Description Format

createdAt

Long

int64

errors

ConfigurationProperty_order

id

String

messages

List of LeveledMessage

metadata

Map of [string]

notices

ConfigurationProperty_order

targetResourceId

String

updatedAt

Long

int64

warnings

ConfigurationProperty_order

2.15. ConnectionOverview

Field Name Required Type Description Format

board

ConnectionBulletinBoard

configuredProperties

Map of [string]

connector

Connector

connectorId

String

createdDate

Date

date-time

derived

Boolean

description

String

icon

String

id

String

lastUpdated

Date

date-time

metadata

Map of [string]

name

X

String

options

Map of [string]

organization

Organization

organizationId

String

tags

Set of [string]

userId

String

uses

Integer

int32

2.16. Connector

Field Name Required Type Description Format

actions

X

List of ConnectorAction

actionsSummary

ActionsSummary

componentScheme

String

configuredProperties

Map of [string]

connectorCustomizers

List of [string]

connectorFactory

String

connectorGroup

ConnectorGroup

connectorGroupId

String

dependencies

List of Dependency

description

String

exceptionHandler

String

icon

String

id

String

metadata

Map of [string]

name

X

String

properties

Map of ConfigurationProperty

tags

Set of [string]

uses

Connector_uses

version

Integer

int32

2.17. ConnectorAction

Field Name Required Type Description Format

actionType

String

dependencies

List of Dependency

description

String

descriptor

ConnectorDescriptor

id

String

metadata

Map of [string]

name

X

String

pattern

String

Enum: From, Pipe, To, PollEnrich,

tags

Set of [string]

2.18. ConnectorDescriptor

Field Name Required Type Description Format

camelConnectorGAV

String

camelConnectorPrefix

String

componentScheme

String

configuredProperties

Map of [string]

connectorCustomizers

List of [string]

connectorFactory

String

connectorId

String

exceptionHandler

String

inputDataShape

DataShape

outputDataShape

DataShape

propertyDefinitionSteps

List of ActionDescriptorStep

standardizedErrors

List of [object]

2.19. ConnectorGroup

Field Name Required Type Description Format

id

String

name

X

String

2.20. ConnectorTemplate

Field Name Required Type Description Format

componentScheme

String

configuredProperties

Map of [string]

connectorGroup

ConnectorGroup

connectorProperties

Map of ConfigurationProperty

description

String

icon

String

id

String

name

X

String

properties

Map of ConfigurationProperty

2.21. ConnectorUses

Field Name Required Type Description Format

asInt

Integer

int32

present

Boolean

2.22. ContinuousDeliveryEnvironment

Field Name Required Type Description Format

environmentId

String

lastExportedAt

Date

date-time

lastImportedAt

Date

date-time

lastTaggedAt

Date

date-time

releaseTag

String

2.23. DataShape

Field Name Required Type Description Format

collectionClassName

String

collectionType

String

description

String

exemplar

List of [ByteArray]

byte

kind

String

Enum: any, java, json-schema, json-instance, xml-schema, xml-schema-inspected, xml-instance, csv-instance, none,

metadata

Map of [string]

name

X

String

parameters

Map of [string]

specification

String

type

String

variants

List of DataShape

2.24. Dependency

Field Name Required Type Description Format

id

String

type

String

Enum: MAVEN, EXTENSION, EXTENSION_TAG, ICON,

2.25. Environment

Field Name Required Type Description Format

id

String

name

X

String

2.26. EventMessage

Field Name Required Type Description Format

data

Object

event

String

2.27. Extension

Field Name Required Type Description Format

actions

X

List of Action

configuredProperties

Map of [string]

createdDate

Date

date-time

dependencies

List of Dependency

description

String

extensionId

String

extensionType

X

String

Enum: Steps, Connectors, Libraries,

icon

String

id

String

lastUpdated

Date

date-time

metadata

Map of [string]

name

X

String

properties

Map of ConfigurationProperty

schemaVersion

X

String

status

String

Enum: Draft, Installed, Deleted,

tags

Set of [string]

userId

String

uses

Integer

int32

version

String

2.28. FilterOptions

Field Name Required Type Description Format

ops

List of Op

paths

List of [string]

2.29. Flow

Field Name Required Type Description Format

connections

List of Connection

dependencies

List of Dependency

description

String

id

String

metadata

Map of [string]

name

X

String

scheduler

Scheduler

steps

List of Step

tags

Set of [string]

type

String

Enum: PRIMARY, API_PROVIDER, ALTERNATE,

2.30. ImmutableConnectorAction

Field Name Required Type Description Format

actionType

String

description

String

descriptor

ConnectorDescriptor

id

String

metadata

Map of [string]

name

X

String

pattern

String

Enum: From, Pipe, To, PollEnrich,

tags

Set of [string]

dependencies

List of Dependency

2.31. ImmutableConnectorActionAllOf

Field Name Required Type Description Format

dependencies

List of Dependency

descriptor

ConnectorDescriptor

2.32. ImmutableStepAction

Field Name Required Type Description Format

actionType

String

description

String

descriptor

StepDescriptor

id

String

metadata

Map of [string]

name

X

String

pattern

String

Enum: From, Pipe, To, PollEnrich,

tags

Set of [string]

2.33. ImmutableStepActionAllOf

Field Name Required Type Description Format

descriptor

StepDescriptor

2.34. Integration

Field Name Required Type Description Format

configuredProperties

Map of [string]

connections

List of Connection

continuousDeliveryState

Map of ContinuousDeliveryEnvironment

createdAt

Long

int64

dependencies

List of Dependency

description

String

environment

Map of [string]

exposure

String

flows

List of Flow

id

String

labels

Map of [string]

name

X

String

properties

Map of ConfigurationProperty

resources

List of ResourceIdentifier

steps

List of Step

tags

Set of [string]

updatedAt

Long

int64

version

Integer

int32

2.35. IntegrationBulletinBoard

Field Name Required Type Description Format

createdAt

Long

int64

errors

ConfigurationProperty_order

id

String

messages

List of LeveledMessage

metadata

Map of [string]

notices

ConfigurationProperty_order

targetResourceId

String

updatedAt

Long

int64

warnings

ConfigurationProperty_order

2.36. IntegrationDeployment

Field Name Required Type Description Format

createdAt

Long

int64

currentState

String

Enum: Published, Unpublished, Error, Pending,

error

IntegrationDeploymentError

id

String

integrationId

String

spec

Integration

statusMessage

String

stepsDone

Map of [string]

targetState

String

Enum: Published, Unpublished, Error, Pending,

updatedAt

Long

int64

userId

String

version

Integer

int32

2.37. IntegrationDeploymentError

Field Name Required Type Description Format

message

String

type

String

2.38. IntegrationDeploymentMetrics

Field Name Required Type Description Format

errors

Long

int64

lastProcessed

Long

int64

messages

Long

int64

start

Long

int64

uptimeDuration

Long

int64

version

String

2.39. IntegrationDeploymentOverview

Field Name Required Type Description Format

createdAt

Long

int64

currentState

String

Enum: Published, Unpublished, Error, Pending,

error

IntegrationDeploymentError

id

String

statusMessage

String

stepsDone

Map of [string]

targetState

String

Enum: Published, Unpublished, Error, Pending,

updatedAt

Long

int64

userId

String

version

Integer

int32

2.40. IntegrationMetricsSummary

Field Name Required Type Description Format

errors

Long

int64

id

String

integrationDeploymentMetrics

List of IntegrationDeploymentMetrics

lastProcessed

Long

int64

messages

Long

int64

metricsProvider

String

start

Long

int64

topIntegrations

Map of [long]

int64

uptimeDuration

Long

int64

2.41. IntegrationOverview

Field Name Required Type Description Format

board

IntegrationBulletinBoard

configuredProperties

Map of [string]

connections

List of Connection

continuousDeliveryState

Map of ContinuousDeliveryEnvironment

createdAt

Long

int64

currentState

String

Enum: Published, Unpublished, Error, Pending,

dependencies

List of Dependency

deploymentVersion

Integer

int32

deployments

List of IntegrationDeploymentOverview

description

String

draft

Boolean

environment

Map of [string]

exposure

String

exposureMeans

Set of [string]

flows

List of Flow

id

String

labels

Map of [string]

managementUrl

String

name

X

String

properties

Map of ConfigurationProperty

resources

List of ResourceIdentifier

steps

List of Step

tags

Set of [string]

targetState

String

Enum: Published, Unpublished, Error, Pending,

updatedAt

Long

int64

url

String

version

Integer

int32

2.42. LeveledMessage

Field Name Required Type Description Format

code

String

Enum: SYNDESIS000, SYNDESIS001, SYNDESIS002, SYNDESIS003, SYNDESIS004, SYNDESIS005, SYNDESIS006, SYNDESIS007, SYNDESIS008, SYNDESIS009, SYNDESIS010, SYNDESIS011, SYNDESIS012,

detail

String

level

String

Enum: INFO, WARN, ERROR,

message

String

metadata

Map of [string]

2.43. ListResultConnectionOverview

Field Name Required Type Description Format

items

List of ConnectionOverview

totalCount

Integer

int32

2.44. ListResultConnector

Field Name Required Type Description Format

items

List of Connector

totalCount

Integer

int32

2.45. ListResultConnectorAction

Field Name Required Type Description Format

items

List of ConnectorAction

totalCount

Integer

int32

2.46. ListResultConnectorGroup

Field Name Required Type Description Format

items

List of ConnectorGroup

totalCount

Integer

int32

2.47. ListResultConnectorTemplate

Field Name Required Type Description Format

items

List of ConnectorTemplate

totalCount

Integer

int32

2.48. ListResultExtension

Field Name Required Type Description Format

items

List of Extension

totalCount

Integer

int32

2.49. ListResultIntegrationDeployment

Field Name Required Type Description Format

items

List of IntegrationDeployment

totalCount

Integer

int32

2.50. ListResultIntegrationOverview

Field Name Required Type Description Format

items

List of IntegrationOverview

totalCount

Integer

int32

2.51. ListResultOAuthApp

Field Name Required Type Description Format

items

List of OAuthApp

totalCount

Integer

int32

2.52. ListResultOrganization

Field Name Required Type Description Format

items

List of Organization

totalCount

Integer

int32

2.53. ListResultPermission

Field Name Required Type Description Format

items

List of Permission

totalCount

Integer

int32

2.54. ListResultRole

Field Name Required Type Description Format

items

List of Role

totalCount

Integer

int32

2.55. ListResultString

Field Name Required Type Description Format

items

List of [string]

totalCount

Integer

int32

2.56. ListResultUser

Field Name Required Type Description Format

items

List of User

totalCount

Integer

int32

2.57. ModelDataObject

Field Name Required Type Description Format

condition

String

data

String

kind

String

Enum: action, connection, connection-overview, connector, connector-action, connector-group, connector-template, icon, environment, environment-type, extension, step-action, organization, integration, integration-overview, integration-deployment, integration-deployment-state-details, integration-metrics-summary, integration-runtime, integration-endpoint, step, permission, role, user, connection-bulletin-board, integration-bulletin-board, open-api, specification,

2.58. ModelDataWithIdObject

Field Name Required Type Description Format

condition

String

data

String

kind

String

Enum: action, connection, connection-overview, connector, connector-action, connector-group, connector-template, icon, environment, environment-type, extension, step-action, organization, integration, integration-overview, integration-deployment, integration-deployment-state-details, integration-metrics-summary, integration-runtime, integration-endpoint, step, permission, role, user, connection-bulletin-board, integration-bulletin-board, open-api, specification,

2.59. OAuthApp

Field Name Required Type Description Format

configuredProperties

Map of [string]

derived

Boolean

icon

String

id

String

name

X

String

properties

Map of ConfigurationProperty

2.60. Op

Field Name Required Type Description Format

label

String

operator

String

2.61. Organization

Field Name Required Type Description Format

environments

List of Environment

id

String

name

X

String

users

List of User

2.62. Permission

Field Name Required Type Description Format

description

String

id

String

name

X

String

2.63. PropertyRelation

Field Name Required Type Description Format

action

String

when

List of When

2.64. PropertyValue

Field Name Required Type Description Format

label

String

value

String

2.65. Quota

Field Name Required Type Description Format

maxDeploymentsPerUser

Integer

int32

maxIntegrationsPerUser

Integer

int32

usedDeploymentsPerUser

Integer

int32

usedIntegrationsPerUser

Integer

int32

2.66. ResourceIdentifier

Field Name Required Type Description Format

id

String

kind

String

Enum: action, connection, connection-overview, connector, connector-action, connector-group, connector-template, icon, environment, environment-type, extension, step-action, organization, integration, integration-overview, integration-deployment, integration-deployment-state-details, integration-metrics-summary, integration-runtime, integration-endpoint, step, permission, role, user, connection-bulletin-board, integration-bulletin-board, open-api, specification,

version

Integer

int32

2.67. Result

Field Name Required Type Description Format

errors

List of VerifierError

scope

String

Enum: PARAMETERS, CONNECTIVITY,

status

String

Enum: OK, ERROR, UNSUPPORTED,

2.68. Role

Field Name Required Type Description Format

id

String

name

X

String

permissions

List of Permission

2.69. Scheduler

Field Name Required Type Description Format

expression

String

type

String

Enum: timer, cron,

2.70. Step

Field Name Required Type Description Format

action

Action

configuredProperties

Map of [string]

connection

Connection

dependencies

List of Dependency

extension

Extension

id

String

metadata

Map of [string]

name

String

stepKind

String

Enum: endpoint, connector, expressionFilter, ruleFilter, extension, mapper, choice, split, aggregate, log, headers, template,

2.71. StepDescriptor

Field Name Required Type Description Format

entrypoint

String

inputDataShape

DataShape

kind

String

Enum: STEP, BEAN, ENDPOINT,

outputDataShape

DataShape

propertyDefinitionSteps

List of ActionDescriptorStep

resource

String

2.72. TargetStateRequest

Field Name Required Type Description Format

targetState

String

Enum: Published, Unpublished, Error, Pending,

2.73. User

Field Name Required Type Description Format

firstName

String

fullName

String

id

String

integrations

List of Integration

lastName

String

name

String

organizationId

String

roleId

String

username

String

2.74. VerifierError

Field Name Required Type Description Format

attributes

Map of [object]

code

String

description

String

parameters

List of [string]

2.75. When

Field Name Required Type Description Format

id

String

value

String

2.76. WithResourceId

Field Name Required Type Description Format

id

String