Jump to

• Request
• Response

Update prediction model by model docstore ID

put

/s1-recipe-svc/rest/v1.0/predictionmodel/{predictionModelId}

Updates the existing prediction model based on the specific model docstore ID. Use PredictionModelRequest to update. Restricted to the Intake Designer role.

Request

Path Parameters

• predictionModelId(required): string(uuid)

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request Object to create prediction model

Show Source

• attributeModelJson: object AttributeModelJson
  Attribute Model JSON
• extractionModels: array extractionModels
• modelDmsId: number
  Model DMS ID

  Example: 14532
• modelName: string
  Model Name

  Example: Social Media
• modelVersion: number
  Model version

  Example: 1
• relationship: string
  Relationship

  Example: dosage-drug

{
    "type":"object",
    "properties":{
        "modelName":{
            "type":"string",
            "description":"Model Name",
            "example":"Social Media"
        },
        "modelDmsId":{
            "type":"number",
            "description":"Model DMS ID",
            "example":14532
        },
        "attributeModelJson":{
            "$ref":"#/components/schemas/AttributeModelJson"
        },
        "modelVersion":{
            "type":"number",
            "description":"Model version",
            "example":1
        },
        "relationship":{
            "type":"string",
            "description":"Relationship",
            "example":"dosage-drug"
        },
        "extractionModels":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/extractionModels"
            }
        }
    },
    "description":"Request Object to create prediction model"
}

Nested Schema : AttributeModelJson

Type: object

Attribute Model JSON

Show Source

• attributeJson: array attributeJson

{
    "type":"object",
    "properties":{
        "attributeJson":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Attribute Model JSON"
}

Nested Schema : extractionModels

Type: array

Show Source

• Array of: object extractionModels

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/extractionModels"
    }
}

Nested Schema : attributeJson

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : extractionModels

Type: object

Show Source

• modelName: string
• modelVersion: string

{
    "type":"object",
    "properties":{
        "modelName":{
            "type":"string"
        },
        "modelVersion":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PredictionModel

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• enterpriseId: number
• extractionModels: string
• id: string (uuid)
• modelAttributeJson: string
• modelDmsId: integer (int64)
• modelName: string
• modelVersion: number
• objectVersionNumber: number
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• relationship: string
• softwareVersionNumber: number
• userId: number
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "modelName":{
            "type":"string"
        },
        "modelAttributeJson":{
            "type":"string"
        },
        "modelDmsId":{
            "type":"integer",
            "format":"int64"
        },
        "modelVersion":{
            "type":"number"
        },
        "relationship":{
            "type":"string"
        },
        "extractionModels":{
            "type":"string"
        },
        "enterpriseId":{
            "type":"number"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : ErrorResponseData

Type: object

Response object for error

Show Source

• details: object details
  Error Details
• errorCode: string
  Error Code

  Example: Exception
• errorMessage: string
  Error Message

  Example: Please see the server log for details

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "example":"Exception"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "example":"Please see the server log for details"
        },
        "details":{
            "type":"object",
            "description":"Error Details"
        }
    },
    "description":"Response object for error"
}

Nested Schema : details

Type: object

Error Details

401 Response

Unauthorized User

Body ()

Root Schema : ErrorResponseData

Type: object

Response object for error

Show Source

• details: object details
  Error Details
• errorCode: string
  Error Code

  Example: Exception
• errorMessage: string
  Error Message

  Example: Please see the server log for details

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "example":"Exception"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "example":"Please see the server log for details"
        },
        "details":{
            "type":"object",
            "description":"Error Details"
        }
    },
    "description":"Response object for error"
}

Nested Schema : details

Type: object

Error Details

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponseData

Type: object

Response object for error

Show Source

• details: object details
  Error Details
• errorCode: string
  Error Code

  Example: Exception
• errorMessage: string
  Error Message

  Example: Please see the server log for details

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "example":"Exception"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "example":"Please see the server log for details"
        },
        "details":{
            "type":"object",
            "description":"Error Details"
        }
    },
    "description":"Response object for error"
}

Nested Schema : details

Type: object

Error Details

Back to Top