Api

PreviousMake Bridge API reference

Check Integration Initiation

get

Checks the status of integration initiation.

Path parameters

flowIdstringRequired

Query parameters

teamIdintegerOptional

Responses

200

Integration initialization check.

application/json

get

GET /api/bridge/integrations/check-init/{flowId} HTTP/1.1
Host: 
Accept: */*

200

Integration initialization check.

{
  "flow": {
    "id": "text",
    "statusId": 1,
    "statusMessage": "text",
    "isCompleted": true,
    "result": null
  }
}

Activate Integration using Scenario ID

post

Activates a specific integration which is done by activating a Scenario.

Path parameters

scenarioIdintegerRequired

Query parameters

teamIdintegerOptional

Responses

200

Integration activated successfully.

application/json

post

POST /api/bridge/integrations/{scenarioId}/activate HTTP/1.1
Host: 
Accept: */*

200

Integration activated successfully.

{
  "integration": {
    "scenarioId": 1
  }
}

Deactivate Integration using Scenario ID

post

Deactivates a specific integration which is done by deactivating a Scenario.

Path parameters

scenarioIdintegerRequired

Query parameters

teamIdintegerOptional

Responses

200

Integration deactivated successfully.

application/json

post

POST /api/bridge/integrations/{scenarioId}/deactivate HTTP/1.1
Host: 
Accept: */*

200

Integration deactivated successfully.

{
  "integration": {
    "scenarioId": 1
  }
}

Delete Integration

delete

Deletes a specific integration by calling Web API to delete a Scenario.

Path parameters

scenarioIdintegerRequired

Query parameters

teamIdintegerOptional

Responses

200

Integration deleted successfully.

application/json

delete

DELETE /api/bridge/integrations/{scenarioId} HTTP/1.1
Host: 
Accept: */*

200

Integration deleted successfully.

{
  "message": "text"
}

Run an Integration using Scenario ID

post

Runs a specific Integration.

Path parameters

scenarioIdintegerRequired

Query parameters

teamIdintegerOptional

Responses

200

Integration run successfully.

application/json

post

POST /api/bridge/integrations/{scenarioId}/run HTTP/1.1
Host: 
Accept: */*

200

Integration run successfully.

{
  "executionId": "text",
  "statusUrl": "text"
}

List Scenarios

get

Returns a list of Scenarios that were initialized from any of the integrations.

Responses

200

List of Scenarios returned successfully.

application/json

get

GET /api/bridge/scenarios/ HTTP/1.1
Host: 
Accept: */*

200

List of Scenarios returned successfully.

{
  "scenarios": [
    {
      "id": 1,
      "name": "text",
      "isActive": true,
      "islocked": true,
      "isPaused": true,
      "usedPackages": [
        "text"
      ],
      "scheduling": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "iswaiting": true,
      "nextExec": "text"
    }
  ]
}

Get Scenario by id

get

Returns a Scenario by ID.

Path parameters

scenarioIdintegerRequired

Query parameters

teamIdintegerOptional

Responses

200

Scenario returned successfully.

application/json

get

GET /api/bridge/scenarios/{scenarioId} HTTP/1.1
Host: 
Accept: */*

200

Scenario returned successfully.

{
  "id": 1,
  "name": "text",
  "isActive": true,
  "islocked": true,
  "isPaused": true,
  "usedPackages": [
    "text"
  ],
  "scheduling": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "iswaiting": true,
  "nextExec": "text"
}

Activate a Scenario using Scenario ID

post

Activates a specific Scenario.

Path parameters

scenarioIdintegerRequired

Query parameters

teamIdintegerOptional

Responses

200

Scenario activated successfully.

application/json

post

POST /api/bridge/scenarios/{scenarioId}/activate HTTP/1.1
Host: 
Accept: */*

200

Scenario activated successfully.

{
  "scenarioId": 1
}

Deactivate a Scenario using Scenario ID

post

Deactivates a specific Scenario.

Path parameters

scenarioIdintegerRequired

Query parameters

teamIdintegerOptional

Responses

200

Scenario deactivated successfully.

application/json

post

POST /api/bridge/scenarios/{scenarioId}/deactivate HTTP/1.1
Host: 
Accept: */*

200

Scenario deactivated successfully.

{
  "scenarioId": 1
}

Run a Scenario using Scenario ID

post

Runs a specific Scenario.

Path parameters

scenarioIdintegerRequired

Query parameters

teamIdintegerOptional

Responses

200

Scenario run successfully.

application/json

post

POST /api/bridge/scenarios/{scenarioId}/run HTTP/1.1
Host: 
Accept: */*

200

Scenario run successfully.

{
  "executionId": "text",
  "statusUrl": "text"
}

Get Scenario usage grouped by date

get

Returns the usage of a specific Scenario.

Path parameters

scenarioIdintegerRequired

Query parameters

teamIdintegerOptional

Responses

200

Scenario usage returned successfully.

application/json

get

GET /api/bridge/scenarios/{scenarioId}/usage HTTP/1.1
Host: 
Accept: */*

200

Scenario usage returned successfully.

[
  {
    "date": "text",
    "operations": 1,
    "dataTransfer": 1
  }
]

Get Scenario logs

get

Returns a list of the logs for a specific Scenario.

Path parameters

scenarioIdintegerRequired

Query parameters

teamIdintegerOptional

Responses

200

Scenario logs returned successfully.

application/json

get

GET /api/bridge/scenarios/{scenarioId}/logs HTTP/1.1
Host: 
Accept: */*

200

Scenario logs returned successfully.

[
  {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
]

Get a Scenario execution log by scenario ID and execution ID

get

Returns an execution log by scenario ID and execution ID.

Path parameters

scenarioIdintegerRequired

executionIdstringRequired

Query parameters

teamIdintegerOptional

Responses

200

Scenario execution log returned successfully.

application/json

get

GET /api/bridge/scenarios/{scenarioId}/logs/{executionId} HTTP/1.1
Host: 
Accept: */*

200

Scenario execution log returned successfully.

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get Scenario blueprint

get

Returns the latest version of a blueprint of a specific Scenario.

Path parameters

scenarioIdintegerRequired

Query parameters

teamIdintegerOptional

Responses

200

Scenario blueprint returned successfully.

application/json

get

GET /api/bridge/scenarios/{scenarioId}/blueprint HTTP/1.1
Host: 
Accept: */*

200

Scenario blueprint returned successfully.

{
  "blueprint": null
}

List Scenario blueprint versions

get

Returns the list of blueprint versions for a specific Scenario.

Path parameters

scenarioIdintegerRequired

Query parameters

teamIdintegerOptional

Responses

200

Scenario blueprint versions returned successfully.

application/json

get

GET /api/bridge/scenarios/{scenarioId}/blueprints HTTP/1.1
Host: 
Accept: */*

200

Scenario blueprint versions returned successfully.

{
  "blueprints": []
}

Get Scenario interface

get

Returns the interface of a specific Scenario.

Path parameters

scenarioIdintegerRequired

Query parameters

teamIdintegerOptional

Responses

200

Scenario interface returned successfully.

application/json

get

GET /api/bridge/scenarios/{scenarioId}/interface HTTP/1.1
Host: 
Accept: */*

200

Scenario interface returned successfully.

{
  "input": [],
  "output": []
}

List Integrations

get

Returns a list of Integrations, which is list of templates merged with list of states and list of scenarios.

Responses

200

List of Integrations returned successfully.

application/json

get

GET /api/bridge/integrations/ HTTP/1.1
Host: 
Accept: */*

200

List of Integrations returned successfully.

{
  "integrations": [
    {
      "scenario": {
        "id": 1,
        "name": "text",
        "isActive": true,
        "usedPackages": [
          "text"
        ],
        "scheduling": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "state": {
        "isConnected": true
      },
      "template": {
        "versionUid": 1,
        "instanceableId": 1
      }
    }
  ]
}

Initialize Integration using Template ID

post

Initializes a new integration using a bridge template.

Path parameters

instanceableIdintegerRequired

Query parameters

teamIdintegerOptional

Body

any ofOptional

nullOptional

Responses

200

Integration has started initialization.

application/json

post

POST /api/bridge/integrations/init/{instanceableId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 313

{
  "teamId": 1,
  "templateId": 1,
  "algorithm": "text",
  "prefill": {
    "hard": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "soft": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "allowReusingComponents": true,
  "allowCreatingComponents": true,
  "autoActivate": true,
  "autoFinalize": true,
  "redirectUri": "text",
  "scenario": {
    "name": "text",
    "enable": true
  }
}

200

Integration has started initialization.

{
  "publicUrl": "text",
  "flow": {
    "id": "text"
  }
}