REST Endpoint: DELETE: https://rason.net/api/model/{nameorid}

This REST API endpoint deletes the specified model instance and any attached files.

• If a valid model name is passed for {nameorid}, all model versions, instances, fitted models, attached files and/or results will be deleted for the given model name.
• If a valid fitted model name is passed for {nameorid}, all fitted models with that name, their versions and all corresponding PMML/JSON files will be deleted.
• If a valid model id is passed for {nameorid}, the specified model and attached files and results will be deleted.

Response format:

  
    {
    "DeletedModels": [ - Information pertaining to all successfully deleted models
      "ModelId": "", - ID of deleted model
      "ModelName": "", - Name of deleted model
      "ModelDescr": "", - Text from "modelDescription" property of deleted model (optional).
      "ModelFiles": [], - Files uploaded during model POST (optional).
      "RuntimeToken": "", - Runtime Token (optional) of deleted model.
      "ModelType": "", - Model type as specified by optional "modelType" property
      "ModelKind": "", - Kind of model (fitted, Excel or RASON)
      "IsChampion": true/false, - Specifies if model version is the champion.
      "ParentModelId": null, - DK for the Parent Model
      "QueryString": "" – Query Parameters, if used
      "ModelContainer":  Only applicable with an Organization Account. When used, this field will report the container where the model is stored.*
      "Permissions":  Only applicable with an Organization Account. When used, this field will report the user's permission for the organization's Azure storage account.* 
    ],
    "NotDeletedModels": [], - Information concerning all models not deleted because they are currently executing.
    "invalidModels": [], - Any invalid resource identifiers listed here.
    "status": "OK" – descriptive status menu
    }
  

*For more information on Organization Acounts, see the Appendix.

Note: Use ?force=true/false query parameter to force deletion of models that are still executing.

This field will only return "true" if the model has been specifically set as the champion using the REST API endpoint PATCH rason.net/api/model/{nameorid}.

• URL
• URL: https://rason.net/api/model/{nameorid}
• URL: https://rason.net/api/model/{fitted-model-name}
• URL: https://rason.net/api/model/{id}
• Method: DELETE
• URL Params

  Required: None

  Optional: None

• Headers:

  Required: Authorization - Example: Authorization: bearer {your RASON token}

  Optional: None

• Data Params: None
• Success Response

  Code: 200 (OK)

  Example Response:

  • DELETE api/model/{modelname}

    Example: DELETE api/model/NearestNeighborsClassification

    Deletes the origin, a version, a fitted model and a model instance of the NearestNeighborsClassification model.

              
    {
        "DeletedModels": [
            {
                "ModelId": "2590+NearestNeighborsClassification+2020-05-22-20-12-12-
                 800790",
                "ModelName": "NearestNeighborsClassification",
                "ModelDescr": "classification: k nearest neighbors; scoring example JSONCl
                 assifier.json uses exported fitted model, knncModel, to score new data.",
                "ModelFiles": [
                    {
                        "fileName": "hald-small-binary-train.txt",
                        "isOnServer": false
                    },
                    {
                        "fileName": "hald-small-binary-valid.txt",
                        "isOnServer": false
                    },
                    {
                        "fileName": "classification-nearest-neighbors.xml",
                        "isOnServer": false
                    },
                    {
                        "fileName": "classification-nearest-neighbors.json",
                        "isOnServer": false
                    }
                ],
                "RuntimeToken": "",
                "ModelType": "Origin",
                "ModelKind": "Rason",
                "IsChampion": false,
                "ParentModelId": null,
                "QueryString": ""
            },
            {
                "ModelId": "2590+NearestNeighborsClassification+2020-05-22-20-12-20-    
                 473765",
                "ModelName": "NearestNeighborsClassification",
                "ModelDescr": "classification: k nearest neighbors; scoring example JSONCl
                assifier.json uses exported fitted model, knncModel, to score new data.",
                "ModelFiles": [
                    {
                        "fileName": "hald-small-binary-train.txt",
                        "isOnServer": false
                    },
                    {
                        "fileName": "hald-small-binary-valid.txt",
                        "isOnServer": false
                    },
                    {
                        "fileName": "classification-nearest-neighbors.xml",
                        "isOnServer": false
                    },
                    {
                        "fileName": "classification-nearest-neighbors.json",
                        "isOnServer": false
                    }
                ],
                "RuntimeToken": "",
                "ModelType": "Instance",
                "ModelKind": "Rason",
                "IsChampion": false,
                "ParentModelId": "2590+NearestNeighborsClassification+2020-05-22-20-12-12-
                800790",
                "QueryString": "response-format=STANDALONE"
            },
            {
                "ModelId": "2590+NearestNeighborsClassification+2020-05-26-19-37-54-
                 664126",
                "ModelName": "NearestNeighborsClassification",
                "ModelDescr": "classification: k nearest neighbors; scoring example JSONCl
                 assifier.json uses exported fitted model, knncModel, to score new data.",
                "ModelFiles": [
                    {
                        "fileName": "hald-small-binary-train.txt",
                        "isOnServer": false
                    },
                    {
                        "fileName": "hald-small-binary-valid.txt",
                        "isOnServer": false
                    },
                    {
                        "fileName": "classification-nearest-neighbors.xml",
                        "isOnServer": false
                    },
                    {
                        "fileName": "classification-nearest-neighbors.json",
                        "isOnServer": false
                    }
                ],
                "RuntimeToken": "",
                "ModelType": "Version",
                "ModelKind": "Rason",
                "IsChampion": false,
                "ParentModelId": "2590+NearestNeighborsClassification+2020-05-22-20-12-12-
                 800790",
                "QueryString": ""
            },
            {
                "ModelId": "2590+fitted-myjsonsrc+2020-05-28-20-56-05-705194",
                "ModelName": "fitted-myjsonsrc",
                "ModelDescr": "classification-logistic-model.json",
                "ModelFiles": [],
                "RuntimeToken": "",
                "ModelType": "Origin",
                "ModelKind": "Fitted",
                "IsChampion": false,
                "ParentModelId": "2590+NearestNeighborsClassification+2020-05-22-20-12-12-
                 800790",
                "QueryString": ""
            }
        ],
        "NotDeletedModels": [],
        "invalidModels": [],
        "status": "OK"
    }
              
            

  • DELETE api/model/{fittedname}

    Example: DELETE api/model/fitted-myjsonsrc

              
                {
                "DeletedModels": [
                {
                "ModelId": "2590+fitted-myjsonsrc+2020-05-22-20-27-55-492264",
                "ModelName": "fitted-myjsonsrc",
                "ModelDescr": "classification-lda-model.json",
                "ModelFiles": [],
                "RuntimeToken": "",
                "ModelType": "Origin",
                "ModelKind": "Fitted",
                "IsChampion": false,
                "ParentModelId": "2590+DiscriminantAnalysis1+2020-05-22-20-27-53-212764",
                "QueryString": ""
                },
                {
                "ModelId": "2590+fitted-myjsonsrc+2020-05-22-20-29-45-743664",
                "ModelName": "fitted-myjsonsrc",
                "ModelDescr": "regression-bagging.json",
                "ModelFiles": [],
                "RuntimeToken": "",
                "ModelType": "Origin",
                "ModelKind": "Fitted",
                "IsChampion": false,
                "ParentModelId": "2590+BaggingRegression+2020-05-22-20-29-43-843501",
                "QueryString": ""
                }
                ],
                "NotDeletedModels": [],
                "invalidModels": [],
                "status": "OK"
                }
              
            

  • DELETE api/model/{id}

    Example: DELETE api/model/2590+2020-05-22-20-37-05-032407

              
      {
        "DeletedModels": [
            {
                "ModelId": "2590+2020-05-22-20-37-05-032407",
                "ModelName": "",
                "ModelDescr": "DF that partitions a dataset into three partitions, rescale
                 s the partitions and runs MLR",
                "ModelFiles": [
                    {
                        "fileName": "hald-small.txt",
                        "isOnServer": false
                    },
                    {
                        "fileName": "hald-small-unlabeled.txt",
                        "isOnServer": false
                    }
                ],
                "RuntimeToken": "",
                "ModelType": "Origin",
                "ModelKind": "Rason",
                "IsChampion": false,
                "ParentModelId": null,
                "QueryString": ""
            }
        ],
        "NotDeletedModels": [],
        "invalidModels": [],
        "status": "OK"
      }