Skip to main content
Kinetic Community

Bridge Model Mapping Attributes

Operation List

GET /models/{modelName}/mappings/{mappingName}/attributes Retrieve Bridge Model Mapping Attributes
POST /models/{modelName}/mappings/{mappingName}/attributes Create Bridge Model Mapping Attribute
GET /models/{modelName}/mappings/{mappingName}/attributes/{name} Retrieve Bridge Model Mapping Attribute
PUT /models/{modelName}/mappings/{mappingName}/attributes/{name} Update Bridge Model Mapping Attribute
DELETE /models/{modelName}/mappings/{mappingName}/attributes/{name} Delete Bridge Model Mapping Attribute

Resource Schema

Available Includes

  • details
  • bridgeMapping

Operations

Retrieve Bridge Model Mapping Attributes

GET /models/{modelName}/mappings/{mappingName}/attributes

Returns information about all attributes for a Bridge Model Mapping.

Request

Path Parameters
modelName

The name of the bridge model the mapping belongs to.

mappingName

The name of the bridge model mapping the attributes belong to.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridgeModelMappingAttributes": [
    {
      "name": "First Name",
      "structureField": "fName"
    }
  ]
}

Create Bridge Model Mapping Attribute

POST /models/{modelName}/mappings/{mappingName}/attributes

Creates a new attribute for a bridge model mapping

Request

Path Parameters
modelName

The name of the bridge model the mapping belongs to.

mappingName

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

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "First Name",
  "structureField": "fName"
}

Response

Body
{
  "bridgeModelMappingAttribute": {
    "name": "First Name",
    "structureField": "fName"
  }
}

Retrieve Bridge Model Mapping Attribute

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

Retrieves the bridge model mapping attribute identified by the {name} parameter.

Request

Path Parameters
modelName

The name of the bridge model the mapping belongs to.

mappingName

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

name

The name of the attribute to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridgeModelMappingAttribute": {
    "name": "First Name",
    "structureField": "fName"
  }
}

Update Bridge Model Mapping Attribute

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

Updates the attribute 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 bridge model the mapping belongs to.

mappingName

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

name

The name of the attribute to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "First Name",
  "structureField": "fName"
}

Response

Body
{
  "bridgeModelMappingAttribute": {
    "name": "First Name",
    "structureField": "fName"
  }
}

Delete Bridge Model Mapping Attribute

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

Deletes the attribute specified by the {name} parameter.

Request

Path Parameters
modelName

The name of the bridge model the mapping belongs to.

mappingName

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

name

The name of the attribute to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridgeModelMappingAttribute": {
    "name": "First Name",
    "structureField": "fName"
  }
}

 

Related