Skip to main content
Kinetic Community

Bridge Model Mapping Qualifications

Operation List

GET /models/{modelName}/mappings/{mappingName}/qualifications Retrieve Bridge Model Mapping Qualifications
POST /models/{modelName}/mappings/{mappingName}/qualifications Create Bridge Model Mapping Qualification
GET /models/{modelName}/mappings/{mappingName}/qualifications/{name} Retrieve Bridge Model Mapping Qualification
PUT /models/{modelName}/mappings/{mappingName}/qualifications/{name} Update Bridge Model Mapping Qualification
DELETE /models/{modelName}/mappings/{mappingName}/qualifications/{name} Delete Bridge Model Mapping Qualification

Resource Schema

Available Includes

  • details
  • bridgeMapping

Operations

Retrieve Bridge Model Mapping Qualifications

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

Returns information about all qualifications 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 qualifications belong to.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridgeModelMappingQualifications": [
    {
      "name": "by Email",
      "query": "email = '${parameter[Email]'}"
    }
  ]
}

Create Bridge Model Mapping Qualification

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

Creates a new qualification 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 qualification belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "by Email",
  "query": "email = '${parameter[Email]'}"
}

Response

Body
{
  "bridgeModelMappingQualification": {
    "name": "by Email",
    "query": "email = '${parameter[Email]'}"
  }
}

Retrieve Bridge Model Mapping Qualification

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

Retrieves the bridge model mapping qualification 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 qualification belongs to.

name

The name of the qualification to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridgeModelMappingQualification": {
    "name": "by Email",
    "query": "email = '${parameter[Email]'}"
  }
}

Update Bridge Model Mapping Qualification

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

Updates the qualification 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 qualification belongs to.

name

The name of the qualification to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "by Email",
  "query": "email = '${parameter[Email]'}"
}

Response

Body
{
  "bridgeModelMappingQualification": {
    "name": "by Email",
    "query": "email = '${parameter[Email]'}"
  }
}

Delete Bridge Model Mapping Qualification

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

Deletes the qualification 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 qualification belongs to.

name

The name of the qualification to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridgeModelMappingQualification": {
    "name": "by Email",
    "query": "email = '${parameter[Email]'}"
  }
}

 

Related