Skip to main content
Kinetic Community

Bridge Models

A bridge model is simply a type of object that is used in Kinetic Request CE forms that is populated from a data source using a bridge to read from that data source. The bridge model allows the object to be assigned properties with normalized names rather than using cryptic database column names, or some other naming convention known only to the developers of the data source application.

Some examples of bridge models include:

  • People
  • Companies
  • Locations
  • Departments
  • Tickets

After the bridge model is created, the properties for the bridge model can be mapped to the bridge where the data comes from.

Operation List

GET /models Retrieve Bridge Models
POST /models Create Bridge Model
GET /models/{name} Retrieve Bridge Model
PUT /models/{name} Update Bridge Model
DELETE /models/{name} Delete Bridge Model

Resource Schema

Available Includes

  • details
  • space
  • attributes
  • mappings
  • qualifications

Operations

Retrieve Bridge Models

GET /models

Returns information about all Bridge Model objects for the specified Space.

Request

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridgeModels": [
    {
      "name": "Tasks",
      "status": "Active",
      "activeMappingName": "",
      "attributes": [],
      "mappings": [],
      "qualifications": []
    }
  ]
}

Create Bridge Model

POST /models

Creates a new bridge model for the parent Space.

Request

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "Tasks",
  "status": "Active",
  "activeMappingName": "",
  "attributes": [],
  "mappings": [],
  "qualifications": []
}

Response

Body
{
  "bridgeModel": {
    "name": "Tasks",
    "status": "Active",
    "activeMappingName": "",
    "attributes": [],
    "mappings": [],
    "qualifications": []
  }
}

Retrieve Bridge Model

GET /models/{name}

Retrieves the Bridge Model identified by the {name} parameter.

Request

Path Parameters
name

The name of the bridge model to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridgeModel": {
    "name": "Tasks",
    "status": "Active",
    "activeMappingName": "",
    "attributes": [],
    "mappings": [],
    "qualifications": []
  }
}

Update Bridge Model

PUT /models/{name}

Updates the Bridge Model 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 model to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "Tasks",
  "status": "Active",
  "activeMappingName": "",
  "attributes": [],
  "mappings": [],
  "qualifications": []
}

Response

Body
{
  "bridgeModel": {
    "name": "Tasks",
    "status": "Active",
    "activeMappingName": "",
    "attributes": [],
    "mappings": [],
    "qualifications": []
  }
}

Delete Bridge Model

DELETE /models/{name}

Deletes the Bridge Model specified by the {name} parameter.

Request

Path Parameters
name

The name of the bridge model to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridgeModel": {
    "name": "Tasks",
    "status": "Active",
    "activeMappingName": "",
    "attributes": [],
    "mappings": [],
    "qualifications": []
  }
}

 

Related