Sign in

v6

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2020-12-096613.9 KB
dispatches

Adds a dispatch configuration

Necessary flows are automatically created.

post/dispatches

Request body

applicationNamestring

Human-Readable name of the application

applicationUidstring

Unique identifier of the application

adapterComponentIdstring

ComponentId of the application's adapter

transformerComponentIdstring

ComponentId of the application's transformer

secretIdstring

ID of the secret containing credentials for this application

Example request

[
  {
    "applicationName": "SnazzyContacts",
    "applicationUid": "32bsf84hzsf8a",
    "adapterComponentId": "46u08ejsf",
    "transformerComponentId": "twg9huh46",
    "secretId": "548z9jvsda",
    "outbound": {
      "active": true,
      "flows": [
        {
          "adapterAction": "getPersons",
          "transformerAction": "transformToOih",
          "schemaUri": "http://metadata.openintegrationhub.com/api/v1/domains/testDomainId/schemas/person"
        }
      ]
    },
    "inbound": {
      "active": true,
      "flows": [
        {
          "adapterAction": "createPerson",
          "transformerAction": "transformFromOih",
          "schemaUri": "http://metadata.openintegrationhub.com/api/v1/domains/testDomainId/schemas/person",
          "operation": "CREATE"
        }
      ]
    }
  }
]

Response

The created configuration.

metaobject

Example response

{
  "data": {
    "id": "adgeth2huo31r59",
    "tenant": "aeg0ihq3w328",
    "applications": [
      {
        "applicationName": "SnazzyContacts",
        "applicationUid": "32bsf84hzsf8a",
        "adapterComponentId": "46u08ejsf",
        "transformerComponentId": "twg9huh46",
        "secretId": "548z9jvsda",
        "outbound": {
          "active": true,
          "flows": [
            {
              "adapterAction": "getPersons",
              "transformerAction": "transformToOih",
              "schemaUri": "http://metadata.openintegrationhub.com/api/v1/domains/testDomainId/schemas/person"
            }
          ]
        },
        "inbound": {
          "active": true,
          "flows": [
            {
              "adapterAction": "createPerson",
              "transformerAction": "transformFromOih",
              "schemaUri": "http://metadata.openintegrationhub.com/api/v1/domains/testDomainId/schemas/person",
              "operation": "CREATE"
            }
          ]
        }
      }
    ]
  }
}