Skip to main content
Kinetic Community

Bridge Model Qualification Parameters

Operation List

GET /models/{modelName}/qualifications/{qualificationName}/parameters Retrieve Bridge Model Qualification Parameters
POST /models/{modelName}/qualifications/{qualificationName}/parameters Create Bridge Model Qualification Parameter
GET /models/{modelName}/qualifications/{qualificationName}/parameters/{name} Retrieve Bridge Model Qualification Parameter
PUT /models/{modelName}/qualifications/{qualificationName}/parameters/{name} Update Bridge Model Qualification Parameter
DELETE /models/{modelName}/qualifications/{qualificationName}/parameters/{name} Delete Bridge Model Qualification Parameter

Resource Schema

Available Includes

  • details
  • bridgeModelQualification

Operations

Retrieve Bridge Model Qualification Parameters

GET /models/{modelName}/qualifications/{qualificationName}/parameters

Returns information about all parameters for a Bridge Model Qualification.

Request

Path Parameters
modelName

The name of the bridge model the qualifications belongs to.

qualificationName

The name of the bridge model qualification the parameters belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridgeModelQualificationParameters": [
    {
      "name": "firstName",
      "notes": "Parameter representing the of the 'First Name' of the User model."
    }
  ]
}

Create Bridge Model Qualification Parameter

POST /models/{modelName}/qualifications/{qualificationName}/parameters

Creates a new parameter for a for a bridge model qualification

Request

Path Parameters
modelName

The name of the bridge model the qualifications belongs to.

qualificationName

The name of the bridge model qualification the parameter belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "firstName",
  "notes": "Parameter representing the of the 'First Name' of the User model."
}

Response

Body
{
  "bridgeModelQualificationParameter": {
    "name": "firstName",
    "notes": "Parameter representing the of the 'First Name' of the User model."
  }
}

Retrieve Bridge Model Qualification Parameter

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

Retrieves the bridge model qualification parameter identified by the {name} parameter.

Request

Path Parameters
modelName

The name of the bridge model the qualification belongs to.

qualificationName

The name of the bridge model qualification the parameter belongs to.

name

The name of the bridge model qualification parameter to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridgeModelQualificationParameter": {
    "name": "firstName",
    "notes": "Parameter representing the of the 'First Name' of the User model."
  }
}

Update Bridge Model Qualification Parameter

PUT/models/{modelName}/qualifications/{qualificationName}/parameters/{name}

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

qualificationName

The name of the bridge model qualification the parameter belongs to.

name

The name of the bridge model qualification parameter to upate.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "firstName",
  "notes": "Parameter representing the of the 'First Name' of the User model."
}

Response

Body
{
  "bridgeModelQualificationParameter": {
    "name": "firstName",
    "notes": "Parameter representing the of the 'First Name' of the User model."
  }
}

Delete Bridge Model Qualification Parameter

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

Deletes the bridge model qualification parameter specified by the {name} parameter.

Request

Path Parameters
modelName

The name of the bridge model the qualification belongs to.

qualificationName

The name of the bridge model qualification the parameter belongs to.

name

The name of the bridge model qualification parameter to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "bridgeModelQualificationParameter": {
    "name": "firstName",
    "notes": "Parameter representing the of the 'First Name' of the User model."
  }
}

 

Related