Jump to

• Request
• Response

Get a list of prediction models by model name and version

put

/s1-recipe-svc/rest/v1.0/predictionmodel/getattributejson

Retrieves a list of the prediction models for the given model names and versions. Restricted to the Intake Designer role.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object ModelInfo

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

Nested Schema : ModelInfo

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 : PredictionModelResponse

Type: object

Show Source

• attributesJson: string
• extractionModels: string
• id: string (uuid)
• modelDocStoreId: integer (int64)
• modelName: string
• modelVersion: number
• relationship: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "modelDocStoreId":{
            "type":"integer",
            "format":"int64"
        },
        "modelName":{
            "type":"string"
        },
        "attributesJson":{
            "type":"string"
        },
        "modelVersion":{
            "type":"number"
        },
        "relationship":{
            "type":"string"
        },
        "extractionModels":{
            "type":"string"
        }
    }
}

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