Skip to main content
Kinetic Community

Bridge Model Qualifications

Operation List

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

Resource Schema

Available Includes

  • details
  • bridgeModel

Operations

Retrieve Bridge Model Qualifications

GET /models/{modelName}/qualifications

Returns information about all qualifications for a Bridge Model.

Request

Path Parameters
modelName

The name of the bridge model the qualifications belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridgeModelQualifications": [
    {
      "name": "First Name",
      "resultType": "Single"
    }
  ]
}

Create Bridge Model Qualification

POST /models/{modelName}/qualifications

Creates a new qualification for a bridge model

Request

Path Parameters
modelName

The name of the bridge model the qualifications belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "First Name",
  "resultType": "Single"
}

Response

Body
{
  "bridgeModelQualification": {
    "name": "First Name",
    "resultType": "Single"
  }
}

Retrieve Bridge Model Qualification

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

Retrieves the qualification identified by the {name} parameter.

Request

Path Parameters
modelName

The name of the parent bridge model 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
{
  "bridgeModelQualification": {
    "name": "First Name",
    "resultType": "Single"
  }
}

Update Bridge Model Qualification

PUT /models/{modelName}/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 parent bridge model 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": "First Name",
  "resultType": "Single"
}

Response

Body
{
  "bridgeModelQualification": {
    "name": "First Name",
    "resultType": "Single"
  }
}

Delete Bridge Model Qualification

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

Deletes the qualification specified by the {name} parameter.

Request

Path Parameters
modelName

The name of the parent bridge model 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
{
  "bridgeModelQualification": {
    "name": "First Name",
    "resultType": "Single"
  }
}

 

Related