Skip to content

アプリケーション内で をクリックすると、お使いのDataRobotバージョンに関する全プラットフォームドキュメントにアクセスできます。

DataRobot APIのリソース > APIリファレンスドキュメント > DataRobot REST API > Secure and govern > Model management

Model Management

This page outlines the operations, endpoints, parameters, and example requests and responses for the Model Management.

GET /api/v2/modelPackages/

Retrieve the list of model packages a user has access to.

Code samples

curl -X GET https://app.datarobot.com/api/v2/modelPackages/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
modelId query string false If specified, limit results to model packages for the model with the specified ID.
similarTo query string false Return model packages similar to a given model package ID. If used, will only return model packages that match target.name, target.type, target.classNames (for classification models), modelKind.isTimeSeries, and modelKind.isMultiseries of the specified model package.
forChallenger query boolean false Can be used with similarTo to request similar model packages with the intent to use them as challenger models; for external model packages, instead of returning similar external model packages, similar DataRobot and Custom model packages will be retrieved.
search query string false Provide a term to search for in package name, model name, or description
predictionThreshold query number false Prediction threshold used for binary classification models
imported query boolean false If specified, filter for either imported (true) or non-imported (false) model packages
predictionEnvironmentId query string false Can be used to filter packages by what is supported by the prediction environment
modelKind query any false Return models from the registry that match a specific format.
buildStatus query string false If specified, filter model packages by the build status.

Enumerated Values

Parameter Value
buildStatus [inProgress, complete, failed]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "activeDeploymentCount": 0,
      "buildStatus": "inProgress",
      "capabilities": {
        "supportsAutomaticActuals": true,
        "supportsChallengerModels": true,
        "supportsFeatureDriftTracking": true,
        "supportsHumilityRecommendedRules": true,
        "supportsHumilityRules": true,
        "supportsHumilityRulesDefaultCalculations": true,
        "supportsPredictionWarning": true,
        "supportsRetraining": true,
        "supportsScoringCodeDownload": true,
        "supportsSecondaryDatasets": true,
        "supportsSegmentedAnalysisDriftAndAccuracy": true,
        "supportsShapBasedPredictionExplanations": true,
        "supportsTargetDriftTracking": true
      },
      "datasets": {
        "baselineSegmentedBy": [
          "string"
        ],
        "datasetName": "string",
        "holdoutDataCatalogId": "string",
        "holdoutDataCatalogVersionId": "string",
        "holdoutDataCreatedAt": "string",
        "holdoutDataCreatorEmail": "string",
        "holdoutDataCreatorId": null,
        "holdoutDataCreatorName": "string",
        "holdoutDatasetName": "string",
        "targetHistogramBaseline": "predictions",
        "trainingDataCatalogId": "string",
        "trainingDataCatalogVersionId": "string",
        "trainingDataCreatedAt": "string",
        "trainingDataCreatorEmail": "string",
        "trainingDataCreatorId": null,
        "trainingDataCreatorName": "string",
        "trainingDataSize": 0
      },
      "id": "string",
      "importMeta": {
        "containsFearPipeline": true,
        "containsFeaturelists": true,
        "containsLeaderboardMeta": true,
        "containsProjectMeta": true,
        "creatorFullName": "string",
        "creatorId": "string",
        "creatorUsername": "string",
        "dateCreated": "string",
        "originalFileName": "string"
      },
      "isArchived": true,
      "isDeprecated": true,
      "mlpkgFileContents": {
        "allTimeSeriesPredictionIntervals": true
      },
      "modelDescription": {
        "buildEnvironmentType": "DataRobot",
        "description": "string",
        "location": "string",
        "modelCreatedAt": "string",
        "modelCreatorEmail": "string",
        "modelCreatorId": null,
        "modelCreatorName": "string",
        "modelName": "string"
      },
      "modelExecutionType": "dedicated",
      "modelId": "string",
      "modelKind": {
        "isAnomalyDetectionModel": true,
        "isCombinedModel": true,
        "isFeatureDiscovery": true,
        "isMultiseries": true,
        "isTimeSeries": true,
        "isUnsupervisedLearning": true
      },
      "name": "string",
      "permissions": [
        "string"
      ],
      "sourceMeta": {
        "customModelDetails": {
          "createdAt": "string",
          "creatorEmail": "string",
          "creatorId": "string",
          "creatorName": "string",
          "id": "string",
          "versionLabel": "string"
        },
        "environmentUrl": "http://example.com",
        "fips_140_2Enabled": true,
        "projectCreatedAt": "string",
        "projectCreatorEmail": "string",
        "projectCreatorId": null,
        "projectCreatorName": "string",
        "projectId": "string",
        "projectName": "string",
        "scoringCode": {
          "dataRobotPredictionVersion": "string",
          "location": "local_leaderboard"
        },
        "useCaseDetails": {
          "createdAt": "string",
          "creatorEmail": "string",
          "creatorId": "string",
          "creatorName": "string",
          "id": "string",
          "name": "string"
        }
      },
      "target": {
        "classCount": 0,
        "classNames": [
          "string"
        ],
        "name": "string",
        "predictionProbabilitiesColumn": "string",
        "predictionThreshold": 1,
        "type": "Binary"
      },
      "timeseries": {
        "datetimeColumnFormat": "string",
        "datetimeColumnName": "string",
        "effectiveFeatureDerivationWindowEnd": 0,
        "effectiveFeatureDerivationWindowStart": 0,
        "featureDerivationWindowEnd": 0,
        "featureDerivationWindowStart": 0,
        "forecastDistanceColumnName": "string",
        "forecastDistances": [
          0
        ],
        "forecastDistancesTimeUnit": "MICROSECOND",
        "forecastPointColumnName": "string",
        "isCrossSeries": true,
        "isNewSeriesSupport": true,
        "isTraditionalTimeSeries": true,
        "seriesColumnName": "string"
      },
      "updatedBy": {
        "email": "string",
        "id": "string",
        "name": "string"
      },
      "userProvidedId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none ModelPackageListResponse
400 Bad Request Request invalid, refer to messages for detail. None
403 Forbidden Either MMM Model Packages or New Model Registry are not enabled. None
404 Not Found User permissions problem. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/modelPackages/fromLeaderboard/

Create model package from a Leaderboard model.

Code samples

curl -X POST https://app.datarobot.com/api/v2/modelPackages/fromLeaderboard/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{ModelPackageCreateFromLeaderboard}'

Body parameter

{
  "computeAllTsIntervals": null,
  "description": "",
  "distributionPredictionModelId": null,
  "modelId": "string",
  "name": null,
  "predictionThreshold": 1
}

Parameters

Name In Type Required Description
body body ModelPackageCreateFromLeaderboard false none

Responses

Status Meaning Description Schema
202 Accepted A job for building model package file was successfully submitted. None
422 Unprocessable Entity Unable to process the Model Package creation request. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/modelPackages/fromLearningModel/

Create model package from DataRobot model.

.. minversion:: v2.31 DEPRECATED: please use the following route instead: POST /api/v2/modelPackages/fromLeaderboard/

Code samples

curl -X POST https://app.datarobot.com/api/v2/modelPackages/fromLearningModel/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{ModelPackageCreateFromLearningModel}'

Body parameter

{
  "description": "string",
  "distributionPredictionModelId": null,
  "modelId": "string",
  "name": null,
  "predictionThreshold": 1
}

Parameters

Name In Type Required Description
body body ModelPackageCreateFromLearningModel false none

Responses

Status Meaning Description Schema
201 Created none None
403 Forbidden The user does not have permission to create a Model Package. None
404 Not Found Either the model_id not exist or the user does not have permission to view the model and project. None
422 Unprocessable Entity Unable to process the Model Package creation request. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/modelPackages/{modelPackageId}/

Retrieve info about a model package.

Code samples

curl -X GET https://app.datarobot.com/api/v2/modelPackages/{modelPackageId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
modelPackageId path string true ID of the model package.

Example responses

200 Response

{
  "activeDeploymentCount": 0,
  "buildStatus": "inProgress",
  "capabilities": {
    "supportsAutomaticActuals": true,
    "supportsChallengerModels": true,
    "supportsFeatureDriftTracking": true,
    "supportsHumilityRecommendedRules": true,
    "supportsHumilityRules": true,
    "supportsHumilityRulesDefaultCalculations": true,
    "supportsPredictionWarning": true,
    "supportsRetraining": true,
    "supportsScoringCodeDownload": true,
    "supportsSecondaryDatasets": true,
    "supportsSegmentedAnalysisDriftAndAccuracy": true,
    "supportsShapBasedPredictionExplanations": true,
    "supportsTargetDriftTracking": true
  },
  "datasets": {
    "baselineSegmentedBy": [
      "string"
    ],
    "datasetName": "string",
    "holdoutDataCatalogId": "string",
    "holdoutDataCatalogVersionId": "string",
    "holdoutDataCreatedAt": "string",
    "holdoutDataCreatorEmail": "string",
    "holdoutDataCreatorId": null,
    "holdoutDataCreatorName": "string",
    "holdoutDatasetName": "string",
    "targetHistogramBaseline": "predictions",
    "trainingDataCatalogId": "string",
    "trainingDataCatalogVersionId": "string",
    "trainingDataCreatedAt": "string",
    "trainingDataCreatorEmail": "string",
    "trainingDataCreatorId": null,
    "trainingDataCreatorName": "string",
    "trainingDataSize": 0
  },
  "id": "string",
  "importMeta": {
    "containsFearPipeline": true,
    "containsFeaturelists": true,
    "containsLeaderboardMeta": true,
    "containsProjectMeta": true,
    "creatorFullName": "string",
    "creatorId": "string",
    "creatorUsername": "string",
    "dateCreated": "string",
    "originalFileName": "string"
  },
  "isArchived": true,
  "isDeprecated": true,
  "mlpkgFileContents": {
    "allTimeSeriesPredictionIntervals": true
  },
  "modelDescription": {
    "buildEnvironmentType": "DataRobot",
    "description": "string",
    "location": "string",
    "modelCreatedAt": "string",
    "modelCreatorEmail": "string",
    "modelCreatorId": null,
    "modelCreatorName": "string",
    "modelName": "string"
  },
  "modelExecutionType": "dedicated",
  "modelId": "string",
  "modelKind": {
    "isAnomalyDetectionModel": true,
    "isCombinedModel": true,
    "isFeatureDiscovery": true,
    "isMultiseries": true,
    "isTimeSeries": true,
    "isUnsupervisedLearning": true
  },
  "name": "string",
  "permissions": [
    "string"
  ],
  "sourceMeta": {
    "customModelDetails": {
      "createdAt": "string",
      "creatorEmail": "string",
      "creatorId": "string",
      "creatorName": "string",
      "id": "string",
      "versionLabel": "string"
    },
    "environmentUrl": "http://example.com",
    "fips_140_2Enabled": true,
    "projectCreatedAt": "string",
    "projectCreatorEmail": "string",
    "projectCreatorId": null,
    "projectCreatorName": "string",
    "projectId": "string",
    "projectName": "string",
    "scoringCode": {
      "dataRobotPredictionVersion": "string",
      "location": "local_leaderboard"
    },
    "useCaseDetails": {
      "createdAt": "string",
      "creatorEmail": "string",
      "creatorId": "string",
      "creatorName": "string",
      "id": "string",
      "name": "string"
    }
  },
  "target": {
    "classCount": 0,
    "classNames": [
      "string"
    ],
    "name": "string",
    "predictionProbabilitiesColumn": "string",
    "predictionThreshold": 1,
    "type": "Binary"
  },
  "timeseries": {
    "datetimeColumnFormat": "string",
    "datetimeColumnName": "string",
    "effectiveFeatureDerivationWindowEnd": 0,
    "effectiveFeatureDerivationWindowStart": 0,
    "featureDerivationWindowEnd": 0,
    "featureDerivationWindowStart": 0,
    "forecastDistanceColumnName": "string",
    "forecastDistances": [
      0
    ],
    "forecastDistancesTimeUnit": "MICROSECOND",
    "forecastPointColumnName": "string",
    "isCrossSeries": true,
    "isNewSeriesSupport": true,
    "isTraditionalTimeSeries": true,
    "seriesColumnName": "string"
  },
  "updatedBy": {
    "email": "string",
    "id": "string",
    "name": "string"
  },
  "userProvidedId": "string"
}

Responses

Status Meaning Description Schema
200 OK none ModelPackageRetrieveResponse
404 Not Found Either the model package does not exist or the user does not have permission to view the model package. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/modelPackages/{modelPackageId}/archive/

(Deprecated in v2.32) Permanently archive a model package. It will no longer be able to be used in new deployments or replacement. It will not be accessible in the model package list api. It will only be accessible at the model package retrieve route for this model package.

Code samples

curl -X POST https://app.datarobot.com/api/v2/modelPackages/{modelPackageId}/archive/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
modelPackageId path string true ID of the model package.

Responses

Status Meaning Description Schema
204 No Content none None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/modelPackages/{modelPackageId}/capabilities/

Retrieve the capabilities for the model package.

Code samples

curl -X GET https://app.datarobot.com/api/v2/modelPackages/{modelPackageId}/capabilities/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
modelPackageId path string true ID of the model package.

Example responses

200 Response

{
  "data": [
    {
      "messages": [
        "string"
      ],
      "name": "string",
      "supported": true
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none ModelPackageCapabilitiesRetrieveResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/modelPackages/{modelPackageId}/features/

Retrieve the feature list for given model package.

Code samples

curl -X GET https://app.datarobot.com/api/v2/modelPackages/{modelPackageId}/features/?offset=0&limit=50 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer true The number of features to skip, defaults to 0.
limit query integer true The number of features to return, defaults to 0.
includeNonPredictionFeatures query string false When True will return all raw features in the universe dataset associated with the deployment, and when False will return only those raw features used to make predictions on the deployment.
forSegmentedAnalysis query string false When True, features returned will be filtered to those usable for segmented analysis.
search query string false Case insensitive search against names of the deployment's features.
orderBy query string false The sort order to apply to the list of features. Prefix the attribute name with a dash to sort in descending order, e.g., "-name".
modelPackageId path string true ID of the model package.

Enumerated Values

Parameter Value
includeNonPredictionFeatures [false, False, true, True]
forSegmentedAnalysis [false, False, true, True]
orderBy [name, importance, -name, -importance]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "dateFormat": "string",
      "featureType": "string",
      "importance": 0,
      "knownInAdvance": true,
      "name": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Model package feature list. FeatureListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/modelPackages/{modelPackageId}/modelLogs/

List model package's model logs

Code samples

curl -X GET https://app.datarobot.com/api/v2/modelPackages/{modelPackageId}/modelLogs/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Number of results that will be skipped.
limit query integer false At most this many results will be returned.
modelPackageId path string true ID of the model package.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "level": "DEBUG",
      "message": "string",
      "time": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none ModelPackageModelLogsListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/modelPackages/{modelPackageId}/sharedRoles/

(Deprecated in v2.32) instead.Get a list of users, groups and organizations who have access to this model package and their roles on the model package.

Code samples

curl -X GET https://app.datarobot.com/api/v2/modelPackages/{modelPackageId}/sharedRoles/?offset=0&limit=10 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
id query string false Only return roles for a user, group or organization with this identifier.
offset query integer true This many results will be skipped
limit query integer true At most this many results are returned
name query string false Only return roles for a user, group or organization with this name.
shareRecipientType query string false List access controls for recipients with this type.
modelPackageId path string true ID of the model package.

Enumerated Values

Parameter Value
shareRecipientType [user, group, organization]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "ADMIN",
      "shareRecipientType": "user"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK The model package's access control list. SharingListV2Response
404 Not Found Either the Model Package does not exist or the user does not have permissions to view the Model Package. None
422 Unprocessable Entity Both username and userId were specified None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/registeredModels/

List registered models.

Code samples

curl -X GET https://app.datarobot.com/api/v2/registeredModels/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
search query string false A term to search for in registered model name
createdAtStartTs query string(date-time) false Registered models created on or after this timestamp
createdAtEndTs query string(date-time) false Registered models created before this timestamp. Defaults to the current time
modifiedAtStartTs query string(date-time) false Registered models modified on or after this timestamp
modifiedAtEndTs query string(date-time) false Registered models modified before this timestamp. Defaults to the current time
targetName query string false Name of the target to filter by
targetType query string false Type of the target to filter by
createdBy query string false Email of the user that created registered model to filter by
sortKey query string false Key to order result by
sortDirection query string false Sort direction
compatibleWithLeaderboardModelId query string false If specified, limit results to registered models containing versions (model packages) for the leaderboard model with the specified ID.
compatibleWithModelPackageId query string false Return registered models that have versions (model packages) compatible with given model package ID. If used, will only return registered models which have versions that match target.name, target.type, target.classNames (for classification models), modelKind.isTimeSeries, and modelKind.isMultiseries of the specified model package.
forChallenger query boolean false Can be used with compatibleWithModelPackageId to request similar registered models that contain versions (model packages)that can be used as challenger models; for external model packages, instead of returning similar external model packages, similar DataRobot and Custom model packages will be retrieved.
predictionThreshold query number false If specified, return any registered models containing one or more versions matching the prediction threshold used for binary classification models
imported query boolean false If specified, return any registered models that contain either imported (true) or non-imported (false) versions (model packages)
predictionEnvironmentId query string false Can be used to filter registered models by what is supported by the prediction environment
modelKind query any false Return models that contain versions matching a specific format
buildStatus query string false If specified, only return models that have versions with specified build status
stage query string false If specified, only returns models that have versions in the specified stage.
isGlobal query boolean false Return only global (accessible to all users in the organization) registered models or local(accessible only to the owner and the users with whom it has been explicitly shared)
tagKeys query string false List of tag keys to filter by.
tagValues query string false List of tag values to filter by.

Enumerated Values

Parameter Value
sortKey [createdAt, modifiedAt, name]
sortDirection [asc, desc]
buildStatus [inProgress, complete, failed]
stage [Registered, Development, Staging, Production, Archived]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "email": "string",
        "id": "string",
        "name": "string"
      },
      "description": "string",
      "id": "string",
      "isArchived": true,
      "isGlobal": true,
      "lastVersionNum": 0,
      "modifiedAt": "2019-08-24T14:15:22Z",
      "modifiedBy": {
        "email": "string",
        "id": "string",
        "name": "string"
      },
      "name": "string",
      "target": {
        "name": "string",
        "type": "string"
      }
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none RegisteredModelListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/registeredModels/{registeredModelId}/

Permanently archive a registered model and all of its versions

Code samples

curl -X DELETE https://app.datarobot.com/api/v2/registeredModels/{registeredModelId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
registeredModelId path string true ID of the registered model.

Responses

Status Meaning Description Schema
204 No Content none None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/registeredModels/{registeredModelId}/

Retrieve info about a registered model.

Code samples

curl -X GET https://app.datarobot.com/api/v2/registeredModels/{registeredModelId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
registeredModelId path string true ID of the registered model.

Example responses

200 Response

{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "email": "string",
    "id": "string",
    "name": "string"
  },
  "description": "string",
  "id": "string",
  "isArchived": true,
  "isGlobal": true,
  "lastVersionNum": 0,
  "modifiedAt": "2019-08-24T14:15:22Z",
  "modifiedBy": {
    "email": "string",
    "id": "string",
    "name": "string"
  },
  "name": "string",
  "target": {
    "name": "string",
    "type": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK none RegisteredModelResponse
404 Not Found The registered model does not exist or the user does not have permission to view the model package. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/registeredModels/{registeredModelId}/

Update registered model

Code samples

curl -X PATCH https://app.datarobot.com/api/v2/registeredModels/{registeredModelId}/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "description": "string",
  "isGlobal": true,
  "name": "string"
}

Parameters

Name In Type Required Description
registeredModelId path string true ID of the registered model.
body body RegisteredModelUpdate false none

Responses

Status Meaning Description Schema
200 OK none None
422 Unprocessable Entity Unable to process the Registered Model update request None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/registeredModels/{registeredModelId}/deployments/

List deployments associated with the given registered model

Code samples

curl -X GET https://app.datarobot.com/api/v2/registeredModels/{registeredModelId}/deployments/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
search query string false Filter deployments with name matching search term
sortKey query string false Key to order result by
sortDirection query string false Sort direction
registeredModelId path string true ID of the registered model.

Enumerated Values

Parameter Value
sortKey [createdAt, label]
sortDirection [asc, desc]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "createdAt": "string",
      "createdBy": {
        "email": "string",
        "id": "string",
        "name": "string"
      },
      "currentlyDeployed": true,
      "firstDeployedAt": "string",
      "firstDeployedBy": {
        "email": "string",
        "id": "string",
        "name": "string"
      },
      "id": "string",
      "isChallenger": true,
      "label": "string",
      "predictionEnvironment": {
        "id": "string",
        "isManagedByManagementAgent": true,
        "name": "string",
        "platform": "aws",
        "plugin": "string",
        "supportedModelFormats": [
          "datarobot"
        ]
      },
      "registeredModelVersion": 0,
      "status": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none RegisteredModelDeploymentsListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/registeredModels/{registeredModelId}/sharedRoles/

Get a list of users, groups and organizations who have access to this registered model and their roles on the registered model.

Code samples

curl -X GET https://app.datarobot.com/api/v2/registeredModels/{registeredModelId}/sharedRoles/?offset=0&limit=10 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
id query string false Only return roles for a user, group or organization with this identifier.
offset query integer true This many results will be skipped
limit query integer true At most this many results are returned
name query string false Only return roles for a user, group or organization with this name.
shareRecipientType query string false List access controls for recipients with this type.
registeredModelId path string true ID of the registered model.

Enumerated Values

Parameter Value
shareRecipientType [user, group, organization]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "ADMIN",
      "shareRecipientType": "user"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK The registered model's access control list. SharingListV2Response
404 Not Found Either the Registered Model does not exist or the user does not have permissions to view the Registered Model. None
422 Unprocessable Entity Both username and userId were specified None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/registeredModels/{registeredModelId}/sharedRoles/

Set roles for users on this registered model.

Code samples

curl -X PATCH https://app.datarobot.com/api/v2/registeredModels/{registeredModelId}/sharedRoles/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "operation": "updateRoles",
  "roles": [
    {
      "role": "string",
      "shareRecipientType": "user",
      "username": "string"
    }
  ]
}

Parameters

Name In Type Required Description
registeredModelId path string true ID of the registered model.
body body SharedRolesUpdate false none

Responses

Status Meaning Description Schema
204 No Content Roles updated successfully. None
409 Conflict The request would leave the registered model without an owner. None
422 Unprocessable Entity One of the users in the request does not exist, or the request is otherwise invalid None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/registeredModels/{registeredModelId}/versions/

List registered model's versions.

Code samples

curl -X GET https://app.datarobot.com/api/v2/registeredModels/{registeredModelId}/versions/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
sortKey query string false Key to order result by
sortDirection query string false Sort direction
targetName query string false Name of the target to filter by
targetType query string false Type of the target to filter by
search query string false A term to search for in version name, model name, or description
compatibleWithLeaderboardModelId query string false If specified, limit results to versions (model packages) of the leaderboard model with the specified ID.
compatibleWithModelPackageId query string false Return versions compatible with given model package ID. If used, will only return versions that match target.name, target.type, target.classNames (for classification models), modelKind.isTimeSeries, and modelKind.isMultiseries of the specified model package
forChallenger query boolean false Can be used with compatibleWithModelPackageId to request similar versions that can be used as challenger models; for external model packages, instead of returning similar external model packages, similar DataRobot and Custom model packages will be retrieved
predictionThreshold query number false Return versions with the specified prediction threshold used for binary classification models
imported query boolean false If specified, return either imported (true) or non-imported (false) versions (model packages)
predictionEnvironmentId query string false Can be used to filter versions (model packages) by what is supported by the prediction environment
modelKind query any false Return versions that match a specific format.
buildStatus query string false If specified, filter versions by the build status.
stage query string false If specified, filter versions by the stage.
useCaseId query string false If specified, filter versions by use-case id.
createdBy query string false Email of the user that created registered model version to filter by
registeredModelId path string true ID of the registered model.

Enumerated Values

Parameter Value
sortKey [version, modelType, status, createdAt, updatedAt]
sortDirection [asc, desc]
buildStatus [inProgress, complete, failed]
stage [Registered, Development, Staging, Production, Archived]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "activeDeploymentCount": 0,
      "buildStatus": "inProgress",
      "capabilities": {
        "supportsAutomaticActuals": true,
        "supportsChallengerModels": true,
        "supportsFeatureDriftTracking": true,
        "supportsHumilityRecommendedRules": true,
        "supportsHumilityRules": true,
        "supportsHumilityRulesDefaultCalculations": true,
        "supportsPredictionWarning": true,
        "supportsRetraining": true,
        "supportsScoringCodeDownload": true,
        "supportsSecondaryDatasets": true,
        "supportsSegmentedAnalysisDriftAndAccuracy": true,
        "supportsShapBasedPredictionExplanations": true,
        "supportsTargetDriftTracking": true
      },
      "datasets": {
        "baselineSegmentedBy": [
          "string"
        ],
        "datasetName": "string",
        "holdoutDataCatalogId": "string",
        "holdoutDataCatalogVersionId": "string",
        "holdoutDataCreatedAt": "string",
        "holdoutDataCreatorEmail": "string",
        "holdoutDataCreatorId": null,
        "holdoutDataCreatorName": "string",
        "holdoutDatasetName": "string",
        "targetHistogramBaseline": "predictions",
        "trainingDataCatalogId": "string",
        "trainingDataCatalogVersionId": "string",
        "trainingDataCreatedAt": "string",
        "trainingDataCreatorEmail": "string",
        "trainingDataCreatorId": null,
        "trainingDataCreatorName": "string",
        "trainingDataSize": 0
      },
      "id": "string",
      "importMeta": {
        "containsFearPipeline": true,
        "containsFeaturelists": true,
        "containsLeaderboardMeta": true,
        "containsProjectMeta": true,
        "creatorFullName": "string",
        "creatorId": "string",
        "creatorUsername": "string",
        "dateCreated": "string",
        "originalFileName": "string"
      },
      "isArchived": true,
      "isDeprecated": true,
      "mlpkgFileContents": {
        "allTimeSeriesPredictionIntervals": true
      },
      "modelDescription": {
        "buildEnvironmentType": "DataRobot",
        "description": "string",
        "location": "string",
        "modelCreatedAt": "string",
        "modelCreatorEmail": "string",
        "modelCreatorId": null,
        "modelCreatorName": "string",
        "modelName": "string"
      },
      "modelExecutionType": "dedicated",
      "modelId": "string",
      "modelKind": {
        "isAnomalyDetectionModel": true,
        "isCombinedModel": true,
        "isFeatureDiscovery": true,
        "isMultiseries": true,
        "isTimeSeries": true,
        "isUnsupervisedLearning": true
      },
      "name": "string",
      "permissions": [
        "string"
      ],
      "sourceMeta": {
        "customModelDetails": {
          "createdAt": "string",
          "creatorEmail": "string",
          "creatorId": "string",
          "creatorName": "string",
          "id": "string",
          "versionLabel": "string"
        },
        "environmentUrl": "http://example.com",
        "fips_140_2Enabled": true,
        "projectCreatedAt": "string",
        "projectCreatorEmail": "string",
        "projectCreatorId": null,
        "projectCreatorName": "string",
        "projectId": "string",
        "projectName": "string",
        "scoringCode": {
          "dataRobotPredictionVersion": "string",
          "location": "local_leaderboard"
        },
        "useCaseDetails": {
          "createdAt": "string",
          "creatorEmail": "string",
          "creatorId": "string",
          "creatorName": "string",
          "id": "string",
          "name": "string"
        }
      },
      "target": {
        "classCount": 0,
        "classNames": [
          "string"
        ],
        "name": "string",
        "predictionProbabilitiesColumn": "string",
        "predictionThreshold": 1,
        "type": "Binary"
      },
      "timeseries": {
        "datetimeColumnFormat": "string",
        "datetimeColumnName": "string",
        "effectiveFeatureDerivationWindowEnd": 0,
        "effectiveFeatureDerivationWindowStart": 0,
        "featureDerivationWindowEnd": 0,
        "featureDerivationWindowStart": 0,
        "forecastDistanceColumnName": "string",
        "forecastDistances": [
          0
        ],
        "forecastDistancesTimeUnit": "MICROSECOND",
        "forecastPointColumnName": "string",
        "isCrossSeries": true,
        "isNewSeriesSupport": true,
        "isTraditionalTimeSeries": true,
        "seriesColumnName": "string"
      },
      "updatedBy": {
        "email": "string",
        "id": "string",
        "name": "string"
      },
      "userProvidedId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none RegisteredModelVersionsListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/registeredModels/{registeredModelId}/versions/{versionId}/

Get a registered model's version.

Code samples

curl -X GET https://app.datarobot.com/api/v2/registeredModels/{registeredModelId}/versions/{versionId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
registeredModelId path string true ID of the registered model.
versionId path string true ID of the registered model's version.

Example responses

200 Response

{
  "activeDeploymentCount": 0,
  "buildStatus": "inProgress",
  "capabilities": {
    "supportsAutomaticActuals": true,
    "supportsChallengerModels": true,
    "supportsFeatureDriftTracking": true,
    "supportsHumilityRecommendedRules": true,
    "supportsHumilityRules": true,
    "supportsHumilityRulesDefaultCalculations": true,
    "supportsPredictionWarning": true,
    "supportsRetraining": true,
    "supportsScoringCodeDownload": true,
    "supportsSecondaryDatasets": true,
    "supportsSegmentedAnalysisDriftAndAccuracy": true,
    "supportsShapBasedPredictionExplanations": true,
    "supportsTargetDriftTracking": true
  },
  "datasets": {
    "baselineSegmentedBy": [
      "string"
    ],
    "datasetName": "string",
    "holdoutDataCatalogId": "string",
    "holdoutDataCatalogVersionId": "string",
    "holdoutDataCreatedAt": "string",
    "holdoutDataCreatorEmail": "string",
    "holdoutDataCreatorId": null,
    "holdoutDataCreatorName": "string",
    "holdoutDatasetName": "string",
    "targetHistogramBaseline": "predictions",
    "trainingDataCatalogId": "string",
    "trainingDataCatalogVersionId": "string",
    "trainingDataCreatedAt": "string",
    "trainingDataCreatorEmail": "string",
    "trainingDataCreatorId": null,
    "trainingDataCreatorName": "string",
    "trainingDataSize": 0
  },
  "id": "string",
  "importMeta": {
    "containsFearPipeline": true,
    "containsFeaturelists": true,
    "containsLeaderboardMeta": true,
    "containsProjectMeta": true,
    "creatorFullName": "string",
    "creatorId": "string",
    "creatorUsername": "string",
    "dateCreated": "string",
    "originalFileName": "string"
  },
  "isArchived": true,
  "isDeprecated": true,
  "mlpkgFileContents": {
    "allTimeSeriesPredictionIntervals": true
  },
  "modelDescription": {
    "buildEnvironmentType": "DataRobot",
    "description": "string",
    "location": "string",
    "modelCreatedAt": "string",
    "modelCreatorEmail": "string",
    "modelCreatorId": null,
    "modelCreatorName": "string",
    "modelName": "string"
  },
  "modelExecutionType": "dedicated",
  "modelId": "string",
  "modelKind": {
    "isAnomalyDetectionModel": true,
    "isCombinedModel": true,
    "isFeatureDiscovery": true,
    "isMultiseries": true,
    "isTimeSeries": true,
    "isUnsupervisedLearning": true
  },
  "name": "string",
  "permissions": [
    "string"
  ],
  "sourceMeta": {
    "customModelDetails": {
      "createdAt": "string",
      "creatorEmail": "string",
      "creatorId": "string",
      "creatorName": "string",
      "id": "string",
      "versionLabel": "string"
    },
    "environmentUrl": "http://example.com",
    "fips_140_2Enabled": true,
    "projectCreatedAt": "string",
    "projectCreatorEmail": "string",
    "projectCreatorId": null,
    "projectCreatorName": "string",
    "projectId": "string",
    "projectName": "string",
    "scoringCode": {
      "dataRobotPredictionVersion": "string",
      "location": "local_leaderboard"
    },
    "useCaseDetails": {
      "createdAt": "string",
      "creatorEmail": "string",
      "creatorId": "string",
      "creatorName": "string",
      "id": "string",
      "name": "string"
    }
  },
  "target": {
    "classCount": 0,
    "classNames": [
      "string"
    ],
    "name": "string",
    "predictionProbabilitiesColumn": "string",
    "predictionThreshold": 1,
    "type": "Binary"
  },
  "timeseries": {
    "datetimeColumnFormat": "string",
    "datetimeColumnName": "string",
    "effectiveFeatureDerivationWindowEnd": 0,
    "effectiveFeatureDerivationWindowStart": 0,
    "featureDerivationWindowEnd": 0,
    "featureDerivationWindowStart": 0,
    "forecastDistanceColumnName": "string",
    "forecastDistances": [
      0
    ],
    "forecastDistancesTimeUnit": "MICROSECOND",
    "forecastPointColumnName": "string",
    "isCrossSeries": true,
    "isNewSeriesSupport": true,
    "isTraditionalTimeSeries": true,
    "seriesColumnName": "string"
  },
  "updatedBy": {
    "email": "string",
    "id": "string",
    "name": "string"
  },
  "userProvidedId": "string"
}

Responses

Status Meaning Description Schema
200 OK none ModelPackageRetrieveResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/registeredModels/{registeredModelId}/versions/{versionId}/deployments/

List all deployments associated with registered model version.

Code samples

curl -X GET https://app.datarobot.com/api/v2/registeredModels/{registeredModelId}/versions/{versionId}/deployments/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
search query string false Filter deployments with name matching search term
sortKey query string false Key to order result by
sortDirection query string false Sort direction
registeredModelId path string true ID of the registered model.
versionId path string true ID of the registered model's version.

Enumerated Values

Parameter Value
sortKey [createdAt, label]
sortDirection [asc, desc]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "createdAt": "string",
      "createdBy": {
        "email": "string",
        "id": "string",
        "name": "string"
      },
      "currentlyDeployed": true,
      "firstDeployedAt": "string",
      "firstDeployedBy": {
        "email": "string",
        "id": "string",
        "name": "string"
      },
      "id": "string",
      "isChallenger": true,
      "label": "string",
      "predictionEnvironment": {
        "id": "string",
        "isManagedByManagementAgent": true,
        "name": "string",
        "platform": "aws",
        "plugin": "string",
        "supportedModelFormats": [
          "datarobot"
        ]
      },
      "registeredModelVersion": 0,
      "status": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none RegisteredModelDeploymentsListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas

AccessControlV2

{
  "id": "string",
  "name": "string",
  "role": "ADMIN",
  "shareRecipientType": "user"
}

Properties

Name Type Required Restrictions Description
id string true The identifier of the recipient.
name string true The name of the recipient.
role string true The role of the recipient on this entity.
shareRecipientType string true The type of the recipient.

Enumerated Values

Property Value
role [ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER]
shareRecipientType [user, group, organization]

CustomModelDetails

{
  "createdAt": "string",
  "creatorEmail": "string",
  "creatorId": "string",
  "creatorName": "string",
  "id": "string",
  "versionLabel": "string"
}

Details of the custom model associated to this registered model version

Properties

Name Type Required Restrictions Description
createdAt string true Time when the custom model was created
creatorEmail string,null false Email of the user who created the custom model
creatorId string true ID of the creator of the custom model
creatorName string,null false Name of the user who created the custom model
id string true ID of the associated custom model
versionLabel string,null false Label of associated custom model version.

DeploymentPredictionEnvironmentResponse

{
  "id": "string",
  "isManagedByManagementAgent": true,
  "name": "string",
  "platform": "aws",
  "plugin": "string",
  "supportedModelFormats": [
    "datarobot"
  ]
}

Information related to the current PredictionEnvironment.

Properties

Name Type Required Restrictions Description
id string,null true ID of the PredictionEnvironment.
isManagedByManagementAgent boolean true True if PredictionEnvironment is using Management Agent.
name string true Name of the PredictionEnvironment.
platform string true Platform of the PredictionEnvironment.
plugin string,null false Plugin name of the PredictionEnvironment.
supportedModelFormats [string] false maxItems: 4
minItems: 1
 Model formats that the PredictionEnvironment supports.

Enumerated Values

Property Value
platform [aws, gcp, azure, onPremise, datarobot, datarobotServerless, openShift, other, snowflake, sapAiCore]

Feature

{
  "dateFormat": "string",
  "featureType": "string",
  "importance": 0,
  "knownInAdvance": true,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
dateFormat string,null true The date format string for how this feature was interpreted.
featureType string,null true Feature type.
importance number,null true Numeric measure of the relationship strength between the feature and target (independent of model or other features).
knownInAdvance boolean true Whether the feature was selected as known in advance in a time-series model, false for non-time-series models.
name string true Feature name.

FeatureListResponse

{
  "count": 0,
  "data": [
    {
      "dateFormat": "string",
      "featureType": "string",
      "importance": 0,
      "knownInAdvance": true,
      "name": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [Feature] true An array of features.
next string,null(uri) true URL pointing to the next page (if null, there is no next page).
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

GrantAccessControlWithId

{
  "id": "string",
  "role": "string",
  "shareRecipientType": "user"
}

Properties

Name Type Required Restrictions Description
id string true The ID of the recipient.
role string true The role of the recipient on this entity. One of OWNER, USER, OBSERVER.
shareRecipientType string true Describes the recipient type, either user, group, or organization.

Enumerated Values

Property Value
shareRecipientType [user, group, organization]

GrantAccessControlWithUsername

{
  "role": "string",
  "shareRecipientType": "user",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
role string true The role of the recipient on this entity. One of OWNER, USER, OBSERVER.
shareRecipientType string true Describes the recipient type, either user, group, or organization.
username string true Username of the user to update the access role for.

Enumerated Values

Property Value
shareRecipientType [user, group, organization]

MlpkgFileContents

{
  "allTimeSeriesPredictionIntervals": true
}

Information about the content of .mlpkg artifact

Properties

Name Type Required Restrictions Description
allTimeSeriesPredictionIntervals boolean,null false Whether .mlpkg contains TS prediction intervals computed for all percentiles

ModelPackageCapabilities

{
  "supportsAutomaticActuals": true,
  "supportsChallengerModels": true,
  "supportsFeatureDriftTracking": true,
  "supportsHumilityRecommendedRules": true,
  "supportsHumilityRules": true,
  "supportsHumilityRulesDefaultCalculations": true,
  "supportsPredictionWarning": true,
  "supportsRetraining": true,
  "supportsScoringCodeDownload": true,
  "supportsSecondaryDatasets": true,
  "supportsSegmentedAnalysisDriftAndAccuracy": true,
  "supportsShapBasedPredictionExplanations": true,
  "supportsTargetDriftTracking": true
}

Capabilities of the current model package.

Properties

Name Type Required Restrictions Description
supportsAutomaticActuals boolean false Whether inferring actual values from time series history data and automatically feeding them back for accuracy estimation is supported by this model package.
supportsChallengerModels boolean true Whether Challenger Models are supported by this model package.
supportsFeatureDriftTracking boolean true Whether Feature Drift is supported by this model package.
supportsHumilityRecommendedRules boolean true Whether calculating values for recommended Humility Rules is supported by this model package.
supportsHumilityRules boolean true Whether Humility Rules are supported by this model package.
supportsHumilityRulesDefaultCalculations boolean true Whether calculating default values for Humility Rules is supported by this model package.
supportsPredictionWarning boolean true Whether Prediction Warnings are supported by this model package.
supportsRetraining boolean false Whether deployment supports retraining.
supportsScoringCodeDownload boolean false Whether scoring code download is supported by this model package.
supportsSecondaryDatasets boolean true If the deployments supports secondary datasets.
supportsSegmentedAnalysisDriftAndAccuracy boolean true Whether tracking features in training and predictions data for segmented analysis is supported by this model package.
supportsShapBasedPredictionExplanations boolean true Whether shap-based prediction explanations are supported by this model package.
supportsTargetDriftTracking boolean true Whether Target Drift is supported by this model package.

ModelPackageCapabilitiesRetrieveResponse

{
  "data": [
    {
      "messages": [
        "string"
      ],
      "name": "string",
      "supported": true
    }
  ]
}

Properties

Name Type Required Restrictions Description
data [ModelPackageCapability] true List of all capabilities.

ModelPackageCapability

{
  "messages": [
    "string"
  ],
  "name": "string",
  "supported": true
}

Properties

Name Type Required Restrictions Description
messages [string] true Messages explaining why the capability is supported or not supported.
name string true The name of the capability.
supported boolean true If the capability is supported.

ModelPackageCreateFromLeaderboard

{
  "computeAllTsIntervals": null,
  "description": "",
  "distributionPredictionModelId": null,
  "modelId": "string",
  "name": null,
  "predictionThreshold": 1
}

Properties

Name Type Required Restrictions Description
computeAllTsIntervals boolean,null false Whether to compute all Time Series prediction intervals (1-100 percentiles)
description string,null false maxLength: 2048
 Description of the model package.
distributionPredictionModelId string,null false ID of the DataRobot distribution prediction model trained on predictions from the DataRobot model.
modelId string true ID of the DataRobot model.
name string,null false maxLength: 1024
 Name of the model package.
predictionThreshold number false maximum: 1
minimum: 0
 Threshold used for binary classification in predictions

ModelPackageCreateFromLearningModel

{
  "description": "string",
  "distributionPredictionModelId": null,
  "modelId": "string",
  "name": null,
  "predictionThreshold": 1
}

Properties

Name Type Required Restrictions Description
description string,null false maxLength: 2048
 Description of the model package.
distributionPredictionModelId string,null false ID of the DataRobot distribution prediction model trained on predictions from the DataRobot model.
modelId string true ID of the DataRobot model.
name string,null false maxLength: 1024
 Name of the model package.
predictionThreshold number false maximum: 1
minimum: 0
 Threshold used for binary classification in predictions

ModelPackageDatasets

{
  "baselineSegmentedBy": [
    "string"
  ],
  "datasetName": "string",
  "holdoutDataCatalogId": "string",
  "holdoutDataCatalogVersionId": "string",
  "holdoutDataCreatedAt": "string",
  "holdoutDataCreatorEmail": "string",
  "holdoutDataCreatorId": null,
  "holdoutDataCreatorName": "string",
  "holdoutDatasetName": "string",
  "targetHistogramBaseline": "predictions",
  "trainingDataCatalogId": "string",
  "trainingDataCatalogVersionId": "string",
  "trainingDataCreatedAt": "string",
  "trainingDataCreatorEmail": "string",
  "trainingDataCreatorId": null,
  "trainingDataCreatorName": "string",
  "trainingDataSize": 0
}

dataset information for the model package

Properties

Name Type Required Restrictions Description
baselineSegmentedBy [string] true Names of categorical features by which the training baseline was segmented. This allows for deployment prediction requests to be segmented by those same features. Segmenting the training baseline by these features allows for users to perform segmented analysis of Data Drift and Accuracy, and to compare the same subset of training and scoring data based on the selected segment attribute and segment value.
datasetName string,null true Name of dataset used to train the model
holdoutDataCatalogId string,null true ID for holdout data (returned from uploading a data set)
holdoutDataCatalogVersionId string,null true Version ID for holdout data (returned from uploading a data set)
holdoutDataCreatedAt string,null false Time when the holdout data item was created
holdoutDataCreatorEmail string,null false Email of the user who created the holdout data item
holdoutDataCreatorId string,null false ID of the creator of the holdout data item
holdoutDataCreatorName string,null false Name of the user who created the holdout data item
holdoutDatasetName string,null true Name of dataset used for model holdout
targetHistogramBaseline string false Values used to establish the training baseline
trainingDataCatalogId string,null true ID for training data (returned from uploading a data set)
trainingDataCatalogVersionId string,null true Version ID for training data (returned from uploading a data set)
trainingDataCreatedAt string,null false Time when the training data item was created
trainingDataCreatorEmail string,null false Email of the user who created the training data item
trainingDataCreatorId string,null false ID of the creator of the training data item
trainingDataCreatorName string,null false Name of the user who created the training data item
trainingDataSize integer false Number of rows in training data (used by DR models)

Enumerated Values

Property Value
targetHistogramBaseline [predictions, actuals]

ModelPackageImportMeta

{
  "containsFearPipeline": true,
  "containsFeaturelists": true,
  "containsLeaderboardMeta": true,
  "containsProjectMeta": true,
  "creatorFullName": "string",
  "creatorId": "string",
  "creatorUsername": "string",
  "dateCreated": "string",
  "originalFileName": "string"
}

Information from when this Model Package was first saved

Properties

Name Type Required Restrictions Description
containsFearPipeline boolean,null false Exists for imported models only, indicates thatmodel package contains file with fear pipeline.
containsFeaturelists boolean,null false Exists for imported models only, indicates thatmodel package contains file with featurelists.
containsLeaderboardMeta boolean,null false Exists for imported models only, indicates thatmodel package contains file with leaderboard meta.
containsProjectMeta boolean,null false Exists for imported models only, indicates thatmodel package contains file with project meta.
creatorFullName string,null true Full name of the person who created this model package
creatorId string true User ID of the person who created this Model Package
creatorUsername string true Username of the person who created this model package
dateCreated string true When this Model Package was created
originalFileName string,null true Exists for imported models only, the original file name that was uploaded

ModelPackageListResponse

{
  "count": 0,
  "data": [
    {
      "activeDeploymentCount": 0,
      "buildStatus": "inProgress",
      "capabilities": {
        "supportsAutomaticActuals": true,
        "supportsChallengerModels": true,
        "supportsFeatureDriftTracking": true,
        "supportsHumilityRecommendedRules": true,
        "supportsHumilityRules": true,
        "supportsHumilityRulesDefaultCalculations": true,
        "supportsPredictionWarning": true,
        "supportsRetraining": true,
        "supportsScoringCodeDownload": true,
        "supportsSecondaryDatasets": true,
        "supportsSegmentedAnalysisDriftAndAccuracy": true,
        "supportsShapBasedPredictionExplanations": true,
        "supportsTargetDriftTracking": true
      },
      "datasets": {
        "baselineSegmentedBy": [
          "string"
        ],
        "datasetName": "string",
        "holdoutDataCatalogId": "string",
        "holdoutDataCatalogVersionId": "string",
        "holdoutDataCreatedAt": "string",
        "holdoutDataCreatorEmail": "string",
        "holdoutDataCreatorId": null,
        "holdoutDataCreatorName": "string",
        "holdoutDatasetName": "string",
        "targetHistogramBaseline": "predictions",
        "trainingDataCatalogId": "string",
        "trainingDataCatalogVersionId": "string",
        "trainingDataCreatedAt": "string",
        "trainingDataCreatorEmail": "string",
        "trainingDataCreatorId": null,
        "trainingDataCreatorName": "string",
        "trainingDataSize": 0
      },
      "id": "string",
      "importMeta": {
        "containsFearPipeline": true,
        "containsFeaturelists": true,
        "containsLeaderboardMeta": true,
        "containsProjectMeta": true,
        "creatorFullName": "string",
        "creatorId": "string",
        "creatorUsername": "string",
        "dateCreated": "string",
        "originalFileName": "string"
      },
      "isArchived": true,
      "isDeprecated": true,
      "mlpkgFileContents": {
        "allTimeSeriesPredictionIntervals": true
      },
      "modelDescription": {
        "buildEnvironmentType": "DataRobot",
        "description": "string",
        "location": "string",
        "modelCreatedAt": "string",
        "modelCreatorEmail": "string",
        "modelCreatorId": null,
        "modelCreatorName": "string",
        "modelName": "string"
      },
      "modelExecutionType": "dedicated",
      "modelId": "string",
      "modelKind": {
        "isAnomalyDetectionModel": true,
        "isCombinedModel": true,
        "isFeatureDiscovery": true,
        "isMultiseries": true,
        "isTimeSeries": true,
        "isUnsupervisedLearning": true
      },
      "name": "string",
      "permissions": [
        "string"
      ],
      "sourceMeta": {
        "customModelDetails": {
          "createdAt": "string",
          "creatorEmail": "string",
          "creatorId": "string",
          "creatorName": "string",
          "id": "string",
          "versionLabel": "string"
        },
        "environmentUrl": "http://example.com",
        "fips_140_2Enabled": true,
        "projectCreatedAt": "string",
        "projectCreatorEmail": "string",
        "projectCreatorId": null,
        "projectCreatorName": "string",
        "projectId": "string",
        "projectName": "string",
        "scoringCode": {
          "dataRobotPredictionVersion": "string",
          "location": "local_leaderboard"
        },
        "useCaseDetails": {
          "createdAt": "string",
          "creatorEmail": "string",
          "creatorId": "string",
          "creatorName": "string",
          "id": "string",
          "name": "string"
        }
      },
      "target": {
        "classCount": 0,
        "classNames": [
          "string"
        ],
        "name": "string",
        "predictionProbabilitiesColumn": "string",
        "predictionThreshold": 1,
        "type": "Binary"
      },
      "timeseries": {
        "datetimeColumnFormat": "string",
        "datetimeColumnName": "string",
        "effectiveFeatureDerivationWindowEnd": 0,
        "effectiveFeatureDerivationWindowStart": 0,
        "featureDerivationWindowEnd": 0,
        "featureDerivationWindowStart": 0,
        "forecastDistanceColumnName": "string",
        "forecastDistances": [
          0
        ],
        "forecastDistancesTimeUnit": "MICROSECOND",
        "forecastPointColumnName": "string",
        "isCrossSeries": true,
        "isNewSeriesSupport": true,
        "isTraditionalTimeSeries": true,
        "seriesColumnName": "string"
      },
      "updatedBy": {
        "email": "string",
        "id": "string",
        "name": "string"
      },
      "userProvidedId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [ModelPackageRetrieveResponse] true list of formatted model packages
next string,null(uri) true URL pointing to the next page (if null, there is no next page).
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

ModelPackageModelDescription

{
  "buildEnvironmentType": "DataRobot",
  "description": "string",
  "location": "string",
  "modelCreatedAt": "string",
  "modelCreatorEmail": "string",
  "modelCreatorId": null,
  "modelCreatorName": "string",
  "modelName": "string"
}

model description information for the model package

Properties

Name Type Required Restrictions Description
buildEnvironmentType string true build environment type of the model
description string,null true a description of the model
location string,null true location of the model
modelCreatedAt string,null false time when the model was created
modelCreatorEmail string,null false email of the user who created the model
modelCreatorId string,null false ID of the creator of the model
modelCreatorName string,null false name of the user who created the model
modelName string false model name

Enumerated Values

Property Value
buildEnvironmentType [DataRobot, Python, R, Java, Other]

ModelPackageModelKind

{
  "isAnomalyDetectionModel": true,
  "isCombinedModel": true,
  "isFeatureDiscovery": true,
  "isMultiseries": true,
  "isTimeSeries": true,
  "isUnsupervisedLearning": true
}

Model attribute information

Properties

Name Type Required Restrictions Description
isAnomalyDetectionModel boolean true true if this is an anomaly detection model
isCombinedModel boolean true true if model is a combined model
isFeatureDiscovery boolean true true if this model uses the Feature Discovery feature
isMultiseries boolean true true if model is multiseries
isTimeSeries boolean true true if model is time series
isUnsupervisedLearning boolean true true if model used unsupervised learning

ModelPackageModelLogsEntry

{
  "level": "DEBUG",
  "message": "string",
  "time": 0
}

Properties

Name Type Required Restrictions Description
level string true Name of the level of the logging event.
message string true Message of the logging event.
time number true POSIX time of the logging event.

Enumerated Values

Property Value
level [DEBUG, INFO, WARNING, ERROR, CRITICAL]

ModelPackageModelLogsListResponse

{
  "count": 0,
  "data": [
    {
      "level": "DEBUG",
      "message": "string",
      "time": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [ModelPackageModelLogsEntry] true maxItems: 100
 Log entries.
next string,null(uri) true URL pointing to the next page (if null, there is no next page).
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

ModelPackageRetrieveResponse

{
  "activeDeploymentCount": 0,
  "buildStatus": "inProgress",
  "capabilities": {
    "supportsAutomaticActuals": true,
    "supportsChallengerModels": true,
    "supportsFeatureDriftTracking": true,
    "supportsHumilityRecommendedRules": true,
    "supportsHumilityRules": true,
    "supportsHumilityRulesDefaultCalculations": true,
    "supportsPredictionWarning": true,
    "supportsRetraining": true,
    "supportsScoringCodeDownload": true,
    "supportsSecondaryDatasets": true,
    "supportsSegmentedAnalysisDriftAndAccuracy": true,
    "supportsShapBasedPredictionExplanations": true,
    "supportsTargetDriftTracking": true
  },
  "datasets": {
    "baselineSegmentedBy": [
      "string"
    ],
    "datasetName": "string",
    "holdoutDataCatalogId": "string",
    "holdoutDataCatalogVersionId": "string",
    "holdoutDataCreatedAt": "string",
    "holdoutDataCreatorEmail": "string",
    "holdoutDataCreatorId": null,
    "holdoutDataCreatorName": "string",
    "holdoutDatasetName": "string",
    "targetHistogramBaseline": "predictions",
    "trainingDataCatalogId": "string",
    "trainingDataCatalogVersionId": "string",
    "trainingDataCreatedAt": "string",
    "trainingDataCreatorEmail": "string",
    "trainingDataCreatorId": null,
    "trainingDataCreatorName": "string",
    "trainingDataSize": 0
  },
  "id": "string",
  "importMeta": {
    "containsFearPipeline": true,
    "containsFeaturelists": true,
    "containsLeaderboardMeta": true,
    "containsProjectMeta": true,
    "creatorFullName": "string",
    "creatorId": "string",
    "creatorUsername": "string",
    "dateCreated": "string",
    "originalFileName": "string"
  },
  "isArchived": true,
  "isDeprecated": true,
  "mlpkgFileContents": {
    "allTimeSeriesPredictionIntervals": true
  },
  "modelDescription": {
    "buildEnvironmentType": "DataRobot",
    "description": "string",
    "location": "string",
    "modelCreatedAt": "string",
    "modelCreatorEmail": "string",
    "modelCreatorId": null,
    "modelCreatorName": "string",
    "modelName": "string"
  },
  "modelExecutionType": "dedicated",
  "modelId": "string",
  "modelKind": {
    "isAnomalyDetectionModel": true,
    "isCombinedModel": true,
    "isFeatureDiscovery": true,
    "isMultiseries": true,
    "isTimeSeries": true,
    "isUnsupervisedLearning": true
  },
  "name": "string",
  "permissions": [
    "string"
  ],
  "sourceMeta": {
    "customModelDetails": {
      "createdAt": "string",
      "creatorEmail": "string",
      "creatorId": "string",
      "creatorName": "string",
      "id": "string",
      "versionLabel": "string"
    },
    "environmentUrl": "http://example.com",
    "fips_140_2Enabled": true,
    "projectCreatedAt": "string",
    "projectCreatorEmail": "string",
    "projectCreatorId": null,
    "projectCreatorName": "string",
    "projectId": "string",
    "projectName": "string",
    "scoringCode": {
      "dataRobotPredictionVersion": "string",
      "location": "local_leaderboard"
    },
    "useCaseDetails": {
      "createdAt": "string",
      "creatorEmail": "string",
      "creatorId": "string",
      "creatorName": "string",
      "id": "string",
      "name": "string"
    }
  },
  "target": {
    "classCount": 0,
    "classNames": [
      "string"
    ],
    "name": "string",
    "predictionProbabilitiesColumn": "string",
    "predictionThreshold": 1,
    "type": "Binary"
  },
  "timeseries": {
    "datetimeColumnFormat": "string",
    "datetimeColumnName": "string",
    "effectiveFeatureDerivationWindowEnd": 0,
    "effectiveFeatureDerivationWindowStart": 0,
    "featureDerivationWindowEnd": 0,
    "featureDerivationWindowStart": 0,
    "forecastDistanceColumnName": "string",
    "forecastDistances": [
      0
    ],
    "forecastDistancesTimeUnit": "MICROSECOND",
    "forecastPointColumnName": "string",
    "isCrossSeries": true,
    "isNewSeriesSupport": true,
    "isTraditionalTimeSeries": true,
    "seriesColumnName": "string"
  },
  "updatedBy": {
    "email": "string",
    "id": "string",
    "name": "string"
  },
  "userProvidedId": "string"
}

Properties

Name Type Required Restrictions Description
activeDeploymentCount integer true Number of deployments currently using this model package
buildStatus string,null false Model package build status
capabilities ModelPackageCapabilities true Capabilities of the current model package.
datasets ModelPackageDatasets true dataset information for the model package
id string true ID of the Model package
importMeta ModelPackageImportMeta true Information from when this Model Package was first saved
isArchived boolean true Whether the model package is permanently archived (cannot be used in deployment or replacement)
isDeprecated boolean true Whether the model package is deprecated. eg. python2 models are deprecated.
mlpkgFileContents MlpkgFileContents false Information about the content of .mlpkg artifact
modelDescription ModelPackageModelDescription true model description information for the model package
modelExecutionType string true Type of model package. dedicated (native DataRobot models) and custom_inference_model (user added inference models) both execute on DataRobot prediction servers, external do not
modelId string true ID of the model
modelKind ModelPackageModelKind true Model attribute information
name string true Model package name
permissions [string] true List of action permissions the user making the request has on the model package
sourceMeta ModelPackageSourceMeta true Meta information from where this model was generated
target ModelPackageTarget true target information for the model package
timeseries ModelPackageTimeseries true time series information for the model package
updatedBy UserMetadata true Information on the user who last modified the registered model
userProvidedId string false A user-provided unique ID associated with the given custom inference model.

Enumerated Values

Property Value
buildStatus [inProgress, complete, failed]
modelExecutionType [dedicated, custom_inference_model, external]

ModelPackageScoringCodeMeta

{
  "dataRobotPredictionVersion": "string",
  "location": "local_leaderboard"
}

If available, information about the model's scoring code

Properties

Name Type Required Restrictions Description
dataRobotPredictionVersion string,null true DataRobot prediction API version for the scoring code
location string,null true Location of the scoring code

Enumerated Values

Property Value
location [local_leaderboard, mlpkg]

ModelPackageSourceMeta

{
  "customModelDetails": {
    "createdAt": "string",
    "creatorEmail": "string",
    "creatorId": "string",
    "creatorName": "string",
    "id": "string",
    "versionLabel": "string"
  },
  "environmentUrl": "http://example.com",
  "fips_140_2Enabled": true,
  "projectCreatedAt": "string",
  "projectCreatorEmail": "string",
  "projectCreatorId": null,
  "projectCreatorName": "string",
  "projectId": "string",
  "projectName": "string",
  "scoringCode": {
    "dataRobotPredictionVersion": "string",
    "location": "local_leaderboard"
  },
  "useCaseDetails": {
    "createdAt": "string",
    "creatorEmail": "string",
    "creatorId": "string",
    "creatorName": "string",
    "id": "string",
    "name": "string"
  }
}

Meta information from where this model was generated

Properties

Name Type Required Restrictions Description
customModelDetails CustomModelDetails false Details of the custom model associated to this registered model version
environmentUrl string,null(uri) true If available, URL of the source model
fips_140_2Enabled boolean false true if the model was built with FIPS-140-2
projectCreatedAt string,null false If available, time when the project was created
projectCreatorEmail string,null false If available, email of the user who created the project
projectCreatorId string,null false If available, ID of the creator of the project
projectCreatorName string,null false If available, name of the user who created the project
projectId string,null true If available, the project id used for this model
projectName string,null true If available, the project name for this model
scoringCode ModelPackageScoringCodeMeta true If available, information about the model's scoring code
useCaseDetails UseCaseDetails false Details of the use-case associated to this registered model version

ModelPackageTarget

{
  "classCount": 0,
  "classNames": [
    "string"
  ],
  "name": "string",
  "predictionProbabilitiesColumn": "string",
  "predictionThreshold": 1,
  "type": "Binary"
}

target information for the model package

Properties

Name Type Required Restrictions Description
classCount integer,null true minimum: 0
 Number of classes for classification models.
classNames [string] true maxItems: 100
 Class names for prediction results. When target type is Binary, two class names are returned. The first element is the minority (positive) class and the second element is the majority (negative) class. Limited to 100 returned for Multiclass.
name string true name of the target column
predictionProbabilitiesColumn string,null true Field or column name containing prediction probabilities
predictionThreshold number,null true maximum: 1
minimum: 0
 Prediction threshold used for binary classification models
type string true Target type of the model.

Enumerated Values

Property Value
type [Binary, Regression, Multiclass, Multilabel, TextGeneration, GeoPoint]

ModelPackageTimeseries

{
  "datetimeColumnFormat": "string",
  "datetimeColumnName": "string",
  "effectiveFeatureDerivationWindowEnd": 0,
  "effectiveFeatureDerivationWindowStart": 0,
  "featureDerivationWindowEnd": 0,
  "featureDerivationWindowStart": 0,
  "forecastDistanceColumnName": "string",
  "forecastDistances": [
    0
  ],
  "forecastDistancesTimeUnit": "MICROSECOND",
  "forecastPointColumnName": "string",
  "isCrossSeries": true,
  "isNewSeriesSupport": true,
  "isTraditionalTimeSeries": true,
  "seriesColumnName": "string"
}

time series information for the model package

Properties

Name Type Required Restrictions Description
datetimeColumnFormat string,null true Date format for forecast date and forecast point column
datetimeColumnName string,null true Name of the forecast date column
effectiveFeatureDerivationWindowEnd integer,null true maximum: 0
 Same concept as featureDerivationWindowEnd which is chosen by the user and based on the initial sampled data from the eda sample. When the dataset goes through aim, the pipeline reads the full dataset and figures out the "real" FDW (i.e., the effective FDW). For most models, eFDW is approximately the same as the FDW.
effectiveFeatureDerivationWindowStart integer,null true maximum: 0
 Same concept as featureDerivationWindowStart which is chosen by the user and based on the initial sampled data from the eda sample. When the dataset goes through aim, the pipeline reads the full dataset and figures out the "real" FDW (i.e., the effective FDW). For most models, eFDW is approximately the same as the FDW.
featureDerivationWindowEnd integer,null true maximum: 0
 Negative number or zero defining how many time units of the forecast distances time unit into the past relative to the forecast point the feature derivation window should end.
featureDerivationWindowStart integer,null true maximum: 0
 Negative number or zero defining how many time units of the forecast distances time unit into the past relative to the forecast point the feature derivation window should begin.
forecastDistanceColumnName string,null true Name of the forecast distance column
forecastDistances [integer] true List of integer forecast distances
forecastDistancesTimeUnit string,null true The time unit of forecast distances
forecastPointColumnName string,null true Name of the forecast point column
isCrossSeries boolean,null true true if the model is cross-series.
isNewSeriesSupport boolean,null true true if the model is optimized to support new series.
isTraditionalTimeSeries boolean,null true true if the model is traditional time series.
seriesColumnName string,null true Name of the series column in case of multi-series date

Enumerated Values

Property Value
forecastDistancesTimeUnit [MICROSECOND, MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR]

RegisteredModelCreatedBy

{
  "email": "string",
  "id": "string",
  "name": "string"
}

Information on the creator of the registered model

Properties

Name Type Required Restrictions Description
email string true Email of the user that created the registered model
id string true ID of user that created the registered model
name string,null true Full name of the user that created the registered model

RegisteredModelDeploymentResponse

{
  "createdAt": "string",
  "createdBy": {
    "email": "string",
    "id": "string",
    "name": "string"
  },
  "currentlyDeployed": true,
  "firstDeployedAt": "string",
  "firstDeployedBy": {
    "email": "string",
    "id": "string",
    "name": "string"
  },
  "id": "string",
  "isChallenger": true,
  "label": "string",
  "predictionEnvironment": {
    "id": "string",
    "isManagedByManagementAgent": true,
    "name": "string",
    "platform": "aws",
    "plugin": "string",
    "supportedModelFormats": [
      "datarobot"
    ]
  },
  "registeredModelVersion": 0,
  "status": "string"
}

Properties

Name Type Required Restrictions Description
createdAt string true Deployment creation date
createdBy UserMetadata true Information on the user who last modified the registered model
currentlyDeployed boolean true Whether version of this registered model is currently deployed
firstDeployedAt string,null true When version of this registered model was first deployed
firstDeployedBy UserMetadata true Information on the user who last modified the registered model
id string true ID of the deployment
isChallenger boolean true True if given version is a challenger in a given deployment
label string,null true Label of the deployment
predictionEnvironment DeploymentPredictionEnvironmentResponse false Information related to the current PredictionEnvironment.
registeredModelVersion integer true Version of the registered model
status string true Status of the deployment

RegisteredModelDeploymentsListResponse

{
  "count": 0,
  "data": [
    {
      "createdAt": "string",
      "createdBy": {
        "email": "string",
        "id": "string",
        "name": "string"
      },
      "currentlyDeployed": true,
      "firstDeployedAt": "string",
      "firstDeployedBy": {
        "email": "string",
        "id": "string",
        "name": "string"
      },
      "id": "string",
      "isChallenger": true,
      "label": "string",
      "predictionEnvironment": {
        "id": "string",
        "isManagedByManagementAgent": true,
        "name": "string",
        "platform": "aws",
        "plugin": "string",
        "supportedModelFormats": [
          "datarobot"
        ]
      },
      "registeredModelVersion": 0,
      "status": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [RegisteredModelDeploymentResponse] true List of formatted deployments
next string,null(uri) true URL pointing to the next page (if null, there is no next page).
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

RegisteredModelListResponse

{
  "count": 0,
  "data": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "email": "string",
        "id": "string",
        "name": "string"
      },
      "description": "string",
      "id": "string",
      "isArchived": true,
      "isGlobal": true,
      "lastVersionNum": 0,
      "modifiedAt": "2019-08-24T14:15:22Z",
      "modifiedBy": {
        "email": "string",
        "id": "string",
        "name": "string"
      },
      "name": "string",
      "target": {
        "name": "string",
        "type": "string"
      }
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [RegisteredModelResponse] true List of formatted registered models
next string,null(uri) true URL pointing to the next page (if null, there is no next page).
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

RegisteredModelResponse

{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "email": "string",
    "id": "string",
    "name": "string"
  },
  "description": "string",
  "id": "string",
  "isArchived": true,
  "isGlobal": true,
  "lastVersionNum": 0,
  "modifiedAt": "2019-08-24T14:15:22Z",
  "modifiedBy": {
    "email": "string",
    "id": "string",
    "name": "string"
  },
  "name": "string",
  "target": {
    "name": "string",
    "type": "string"
  }
}

Properties

Name Type Required Restrictions Description
createdAt string(date-time) true Date when the registered model was created
createdBy RegisteredModelCreatedBy true Information on the creator of the registered model
description string,null false Description of the registered model
id string true ID of the registered model
isArchived boolean true Whether the model is archived
isGlobal boolean false Whether the registered model is global (accessible to all users in the organization) or local(accessible only to the owner and the users with whom it has been explicitly shared)
lastVersionNum integer true Latest version associated to this registered model
modifiedAt string(date-time) true Date when the registered model was last modified
modifiedBy UserMetadata true Information on the user who last modified the registered model
name string true Name of the registered model
target RegisteredModelTarget true Information on the target variable

RegisteredModelTarget

{
  "name": "string",
  "type": "string"
}

Information on the target variable

Properties

Name Type Required Restrictions Description
name string true Name of the target variable
type string,null true Type of the target variable

RegisteredModelUpdate

{
  "description": "string",
  "isGlobal": true,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
description string false maxLength: 2048
 Description of the registered model
isGlobal boolean false Make registered model global (accessible to all users in the organization) or local(accessible only to the owner and the users with whom it has been explicitly shared)
name string false maxLength: 1024
 Name of the registered model

RegisteredModelVersionsListResponse

{
  "count": 0,
  "data": [
    {
      "activeDeploymentCount": 0,
      "buildStatus": "inProgress",
      "capabilities": {
        "supportsAutomaticActuals": true,
        "supportsChallengerModels": true,
        "supportsFeatureDriftTracking": true,
        "supportsHumilityRecommendedRules": true,
        "supportsHumilityRules": true,
        "supportsHumilityRulesDefaultCalculations": true,
        "supportsPredictionWarning": true,
        "supportsRetraining": true,
        "supportsScoringCodeDownload": true,
        "supportsSecondaryDatasets": true,
        "supportsSegmentedAnalysisDriftAndAccuracy": true,
        "supportsShapBasedPredictionExplanations": true,
        "supportsTargetDriftTracking": true
      },
      "datasets": {
        "baselineSegmentedBy": [
          "string"
        ],
        "datasetName": "string",
        "holdoutDataCatalogId": "string",
        "holdoutDataCatalogVersionId": "string",
        "holdoutDataCreatedAt": "string",
        "holdoutDataCreatorEmail": "string",
        "holdoutDataCreatorId": null,
        "holdoutDataCreatorName": "string",
        "holdoutDatasetName": "string",
        "targetHistogramBaseline": "predictions",
        "trainingDataCatalogId": "string",
        "trainingDataCatalogVersionId": "string",
        "trainingDataCreatedAt": "string",
        "trainingDataCreatorEmail": "string",
        "trainingDataCreatorId": null,
        "trainingDataCreatorName": "string",
        "trainingDataSize": 0
      },
      "id": "string",
      "importMeta": {
        "containsFearPipeline": true,
        "containsFeaturelists": true,
        "containsLeaderboardMeta": true,
        "containsProjectMeta": true,
        "creatorFullName": "string",
        "creatorId": "string",
        "creatorUsername": "string",
        "dateCreated": "string",
        "originalFileName": "string"
      },
      "isArchived": true,
      "isDeprecated": true,
      "mlpkgFileContents": {
        "allTimeSeriesPredictionIntervals": true
      },
      "modelDescription": {
        "buildEnvironmentType": "DataRobot",
        "description": "string",
        "location": "string",
        "modelCreatedAt": "string",
        "modelCreatorEmail": "string",
        "modelCreatorId": null,
        "modelCreatorName": "string",
        "modelName": "string"
      },
      "modelExecutionType": "dedicated",
      "modelId": "string",
      "modelKind": {
        "isAnomalyDetectionModel": true,
        "isCombinedModel": true,
        "isFeatureDiscovery": true,
        "isMultiseries": true,
        "isTimeSeries": true,
        "isUnsupervisedLearning": true
      },
      "name": "string",
      "permissions": [
        "string"
      ],
      "sourceMeta": {
        "customModelDetails": {
          "createdAt": "string",
          "creatorEmail": "string",
          "creatorId": "string",
          "creatorName": "string",
          "id": "string",
          "versionLabel": "string"
        },
        "environmentUrl": "http://example.com",
        "fips_140_2Enabled": true,
        "projectCreatedAt": "string",
        "projectCreatorEmail": "string",
        "projectCreatorId": null,
        "projectCreatorName": "string",
        "projectId": "string",
        "projectName": "string",
        "scoringCode": {
          "dataRobotPredictionVersion": "string",
          "location": "local_leaderboard"
        },
        "useCaseDetails": {
          "createdAt": "string",
          "creatorEmail": "string",
          "creatorId": "string",
          "creatorName": "string",
          "id": "string",
          "name": "string"
        }
      },
      "target": {
        "classCount": 0,
        "classNames": [
          "string"
        ],
        "name": "string",
        "predictionProbabilitiesColumn": "string",
        "predictionThreshold": 1,
        "type": "Binary"
      },
      "timeseries": {
        "datetimeColumnFormat": "string",
        "datetimeColumnName": "string",
        "effectiveFeatureDerivationWindowEnd": 0,
        "effectiveFeatureDerivationWindowStart": 0,
        "featureDerivationWindowEnd": 0,
        "featureDerivationWindowStart": 0,
        "forecastDistanceColumnName": "string",
        "forecastDistances": [
          0
        ],
        "forecastDistancesTimeUnit": "MICROSECOND",
        "forecastPointColumnName": "string",
        "isCrossSeries": true,
        "isNewSeriesSupport": true,
        "isTraditionalTimeSeries": true,
        "seriesColumnName": "string"
      },
      "updatedBy": {
        "email": "string",
        "id": "string",
        "name": "string"
      },
      "userProvidedId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [ModelPackageRetrieveResponse] true List of formatted registered model's versions
next string,null(uri) true URL pointing to the next page (if null, there is no next page).
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

SharedRolesUpdate

{
  "operation": "updateRoles",
  "roles": [
    {
      "role": "string",
      "shareRecipientType": "user",
      "username": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
operation string true Name of the action being taken. The only operation is 'updateRoles'.
roles [oneOf] true maxItems: 100
minItems: 1
 Array of GrantAccessControl objects., up to maximum 100 objects.

oneOf

Name Type Required Restrictions Description
» anonymous GrantAccessControlWithUsername false none

xor

Name Type Required Restrictions Description
» anonymous GrantAccessControlWithId false none

Enumerated Values

Property Value
operation updateRoles

SharingListV2Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "ADMIN",
      "shareRecipientType": "user"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true The number of items returned.
data [AccessControlV2] true maxItems: 1000
 The access control list.
next string,null true URL pointing to the next page.
previous string,null true URL pointing to the previous page.
totalCount integer true Total number of items matching the condition.

UseCaseDetails

{
  "createdAt": "string",
  "creatorEmail": "string",
  "creatorId": "string",
  "creatorName": "string",
  "id": "string",
  "name": "string"
}

Details of the use-case associated to this registered model version

Properties

Name Type Required Restrictions Description
createdAt string true Time when use-case was created
creatorEmail string,null false Email of the user who created use-case
creatorId string true ID of the creator of the use-case
creatorName string,null false Name of the user who created use-case
id string true ID of the associated use-case
name string,null false Name of the use case at the moment of creation

UserMetadata

{
  "email": "string",
  "id": "string",
  "name": "string"
}

Information on the user who last modified the registered model

Properties

Name Type Required Restrictions Description
email string,null true Email of the user
id string true ID of the user
name string,null true Full name of the user
更新しました March 19, 2025