Skip to main content
Kinetic Community

Bridges

A bridge is a configuration of a simple web application that connects to a data source to read information that can be used to populate data in submissions. The data source may be an external database or web application, or it may be for a specific Form or Kapp in Kinetic Request CE.

Operation List

GET /bridges Retrieve Bridges
POST /bridges Create Bridge
GET /bridges/{name} Retrieve Bridge
PUT /bridges/{name} Update Bridge
DELETE /bridges/{name} Delete Bridge

Resource Schema

Available Includes

  • details
  • space

Operations

Retrieve Bridges

GET /bridges

Returns information about all Bridge objects for the specified Space.

Request

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridges": [
    {
      "name": "Task Bridge",
      "status": "Active",
      "url": "http://server.com/kinetic-task/app/api/v1"
    }
  ]
}

Create Bridge

POST /bridges

Creates a new bridge for the parent Space.

Request

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "Task Bridge",
  "status": "Active",
  "url": "http://server.com/kinetic-task/app/api/v1"
}

Response

Body
{
  "bridge": {
    "name": "Task Bridge",
    "status": "Active",
    "url": "http://server.com/kinetic-task/app/api/v1"
  }
}

Retrieve Bridge

GET /bridges/{name}

Retrieves the Bridge identified by the {name} parameter.

Request

Path Parameters
name

The name of the bridge to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridge": {
    "name": "Task Bridge",
    "status": "Active",
    "url": "http://server.com/kinetic-task/app/api/v1"
  }
}

Update Bridge

PUT /bridges/{name}

Updates the Bridge specified by the {name} parameter with the property values sent in the request body.

NOTE All properties in the request body are optional, and only the properties supplied will be updated.

Request

Path Parameters
name

The name of the bridge to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "Task Bridge",
  "status": "Active",
  "url": "http://server.com/kinetic-task/app/api/v1"
}

Response

Body
{
  "bridge": {
    "name": "Task Bridge",
    "status": "Active",
    "url": "http://server.com/kinetic-task/app/api/v1"
  }
}

Delete Bridge

DELETE /bridges/{name}

Deletes the Bridge specified by the {name} parameter.

Request

Path Parameters
name

The name of the bridge to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridge": {
    "name": "Task Bridge",
    "status": "Active",
    "url": "http://server.com/kinetic-task/app/api/v1"
  }
}

 

Related