Skip to main content
Kinetic Community

Bridge Model Mappings

A bridge model mapping is where the bridge data source is mapped to the bridge model properties. This tells Kinetic Request CE how to get the raw data from the data source, and how to present it to the page when rendering the submission form.

Operation List

GET /models/{modelName}/mappings Retrieve Bridge Model Mappings
POST /models/{modelName}/mappings Create Bridge Model Mapping
GET /models/{modelName}/mappings/{name} Retrieve Bridge Model Mapping
PUT /models/{modelName}/mappings/{name} Update Bridge Model Mapping
DELETE /models/{modelName}/mappings/{name} Delete Bridge Model Mapping

Resource Schema

Available Includes

  • details
  • bridgeModel
  • attributes
  • qualifications

Operations

Retrieve Bridge Model Mappings

GET /models/{modelName}/mappings

Returns information about all mappings for a Bridge Model.

Request

Path Parameters
modelName

The name of the bridge model the mappings belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridgeModelMappings": [
    {
      "bridgeName": "JDBC Bridge",
      "name": "Users from Database",
      "status": "Active",
      "structure": "Users",
      "attributes": [],
      "qualifications": []
    }
  ]
}

Create Bridge Model Mapping

POST /models/{modelName}/mappings

Creates a new mapping for a bridge model

Request

Path Parameters
modelName

The name of the bridge model the mapping belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "bridgeName": "JDBC Bridge",
  "name": "Users from Database",
  "status": "Active",
  "structure": "Users",
  "attributes": [],
  "qualifications": []
}

Response

Body
{
  "bridgeModelMapping": {
    "bridgeName": "JDBC Bridge",
    "name": "Users from Database",
    "status": "Active",
    "structure": "Users",
    "attributes": [],
    "qualifications": []
  }
}

Retrieve Bridge Model Mapping

GET /models/{modelName}/mappings/{name}

Retrieves the mapping identified by the {name} parameter.

Request

Path Parameters
modelName

The name of the parent bridge model the mapping belongs to.

name

The name of the mapping to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridgeModelMapping": {
    "bridgeName": "JDBC Bridge",
    "name": "Users from Database",
    "status": "Active",
    "structure": "Users",
    "attributes": [],
    "qualifications": []
  }
}

Update Bridge Model Mapping

PUT /models/{modelName}/mappings/{name}

Updates the mapping 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
modelName

The name of the parent bridge model the mapping belongs to.

name

The name of the mapping to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "bridgeName": "JDBC Bridge",
  "name": "Users from Database",
  "status": "Active",
  "structure": "Users",
  "attributes": [],
  "qualifications": []
}

Response

Body
{
  "bridgeModelMapping": {
    "bridgeName": "JDBC Bridge",
    "name": "Users from Database",
    "status": "Active",
    "structure": "Users",
    "attributes": [],
    "qualifications": []
  }
}

Delete Bridge Model Mapping

DELETE /models/{modelName}/mappings/{name}

Deletes the mapping specified by the {name} parameter.

Request

Path Parameters
modelName

The name of the parent bridge model the mapping belongs to.

name

The name of the mapping to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridgeModelMapping": {
    "bridgeName": "JDBC Bridge",
    "name": "Users from Database",
    "status": "Active",
    "structure": "Users",
    "attributes": [],
    "qualifications": []
  }
}

 

Related