Dataplane Transfers

Create a dataplane transfer

Changed on
post/transfers/dataplane/dataplane-processes

Request

  • Base URL: http://localhost:8080/api
  • URL: http://localhost:8080/api/transfers/dataplane/dataplane-processes
  • Auth: none declared

Request body

idstring urn nullable
transferProcessIdstring urn required
role'PROVIDER' | 'CONSUMER' required
interactionMode'PULL' | 'PUSH' required
state'INIT' | 'CONFIGURING' | 'AUTH' | 'READY' | 'SUBSCRIBING' | 'STARTED' | 'UNSUBSCRIBING' | 'STOPPED' | 'TERMINATED' | 'ERROR' required
connectorInstanceIdstring urn nullable
ingressConfigobject required
egressConfigobject required

Response

Created

idstring urn
transferProcessIdstring urn
role'PROVIDER' | 'CONSUMER'
interactionMode'PULL' | 'PUSH'
state'INIT' | 'CONFIGURING' | 'AUTH' | 'READY' | 'SUBSCRIBING' | 'STARTED' | 'UNSUBSCRIBING' | 'STOPPED' | 'TERMINATED' | 'ERROR'
connectorInstanceIdstring urn nullable
ingressConfigobject
egressConfigobject
flowControlobject nullable
createdAtstring date-time
updatedAtstring date-time
fieldsobject

Changes

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      endpoint added