Skip to content

On-premise users: click in-app to access the full platform documentation for your version of DataRobot.

Use Cases

This page outlines the operations, endpoints, parameters, and example requests and responses for the Use Cases.

GET /api/v2/useCases/

Retrieve a list of Use Cases.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/useCases/?sort=-applicationsCount&orderBy=-applicationsCount&usecaseType=all \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false The number of records to skip over. Default 0.
limit query integer false The number of records to return in the range from 1 to 100. Default 100.
search query string false Only return Use Cases with names that match the given string.
projectId query string false Only return Use Cases associated with the given project id.
applicationId query string false Only return Use Cases associated with the given app.
sort query string true [DEPRECATED - replaced with order_by] The order to sort the Use Cases.
orderBy query string true The order to sort the Use Cases.
usecaseType query string true The filtered Usecases to return by its type.

Enumerated Values

Parameter Value
sort -applicationsCount
sort -createdAt
sort -createdBy
sort -datasetsCount
sort -description
sort -id
sort -name
sort -notebooksCount
sort -playgroundsCount
sort -projectsCount
sort -updatedAt
sort -updatedBy
sort -vectorDatabasesCount
sort applicationsCount
sort createdAt
sort createdBy
sort datasetsCount
sort description
sort id
sort name
sort notebooksCount
sort playgroundsCount
sort projectsCount
sort updatedAt
sort updatedBy
sort vectorDatabasesCount
orderBy -applicationsCount
orderBy -createdAt
orderBy -createdBy
orderBy -datasetsCount
orderBy -description
orderBy -id
orderBy -name
orderBy -notebooksCount
orderBy -playgroundsCount
orderBy -projectsCount
orderBy -updatedAt
orderBy -updatedBy
orderBy -vectorDatabasesCount
orderBy applicationsCount
orderBy createdAt
orderBy createdBy
orderBy datasetsCount
orderBy description
orderBy id
orderBy name
orderBy notebooksCount
orderBy playgroundsCount
orderBy projectsCount
orderBy updatedAt
orderBy updatedBy
orderBy vectorDatabasesCount
usecaseType all
usecaseType general
usecaseType walkthrough

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "advancedTour": "string",
      "applicationsCount": 0,
      "created": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "datasetsCount": 0,
      "description": "string",
      "id": "string",
      "members": [
        {
          "email": "string",
          "fullName": "string",
          "id": "string",
          "isOrganization": true,
          "userhash": "string",
          "username": "string"
        }
      ],
      "modelsCount": 0,
      "name": "string",
      "notebooksCount": 0,
      "owners": [
        {
          "email": "string",
          "fullName": "string",
          "id": "string",
          "isOrganization": true,
          "userhash": "string",
          "username": "string"
        }
      ],
      "projectsCount": 0,
      "tenantId": "string",
      "updated": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "updatedAt": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Use Cases retrieved successfully. UseCaseListResponse
403 Forbidden User does not have access to this functionality. None

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

BearerAuth

POST /api/v2/useCases/

Look up a Use Case.

Code samples

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/useCases/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter

{
  "advancedTour": "flightDelays",
  "description": null,
  "name": null
}

Parameters

Name In Type Required Description
body body UseCaseCreate false none

Example responses

200 Response

{
  "advancedTour": "string",
  "applicationsCount": 0,
  "created": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "datasetsCount": 0,
  "description": "string",
  "id": "string",
  "members": [
    {
      "email": "string",
      "fullName": "string",
      "id": "string",
      "isOrganization": true,
      "userhash": "string",
      "username": "string"
    }
  ],
  "modelsCount": 0,
  "name": "string",
  "notebooksCount": 0,
  "owners": [
    {
      "email": "string",
      "fullName": "string",
      "id": "string",
      "isOrganization": true,
      "userhash": "string",
      "username": "string"
    }
  ],
  "projectsCount": 0,
  "tenantId": "string",
  "updated": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

Responses

Status Meaning Description Schema
200 OK The experiment container. UseCaseResponse
422 Unprocessable Entity Unprocessable Entity None

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

BearerAuth

DELETE /api/v2/useCases/{useCaseId}/

Delete a Use Case.

Code samples

# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/useCases/{useCaseId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
useCaseId path string true The ID of the Use Case to update.

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/useCases/{useCaseId}/

Retrieve a single Use Case.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/useCases/{useCaseId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter

{
  "advancedTour": "string",
  "applicationsCount": 0,
  "created": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "datasetsCount": 0,
  "description": "string",
  "id": "string",
  "members": [
    {
      "email": "string",
      "fullName": "string",
      "id": "string",
      "isOrganization": true,
      "userhash": "string",
      "username": "string"
    }
  ],
  "modelsCount": 0,
  "name": "string",
  "notebooksCount": 0,
  "owners": [
    {
      "email": "string",
      "fullName": "string",
      "id": "string",
      "isOrganization": true,
      "userhash": "string",
      "username": "string"
    }
  ],
  "projectsCount": 0,
  "tenantId": "string",
  "updated": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

Parameters

Name In Type Required Description
useCaseId path string true The ID of the Use Case to update.
body body UseCaseResponse false none

Example responses

200 Response

{
  "advancedTour": "string",
  "applicationsCount": 0,
  "created": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "datasetsCount": 0,
  "description": "string",
  "id": "string",
  "members": [
    {
      "email": "string",
      "fullName": "string",
      "id": "string",
      "isOrganization": true,
      "userhash": "string",
      "username": "string"
    }
  ],
  "modelsCount": 0,
  "name": "string",
  "notebooksCount": 0,
  "owners": [
    {
      "email": "string",
      "fullName": "string",
      "id": "string",
      "isOrganization": true,
      "userhash": "string",
      "username": "string"
    }
  ],
  "projectsCount": 0,
  "tenantId": "string",
  "updated": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

Responses

Status Meaning Description Schema
200 OK none UseCaseResponse

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

BearerAuth

PATCH /api/v2/useCases/{useCaseId}/

Update a Use Case.

Code samples

# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/useCases/{useCaseId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter

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

Parameters

Name In Type Required Description
useCaseId path string true The ID of the Use Case to update.
body body UseCaseUpdate false none

Example responses

204 Response

{
  "advancedTour": "string",
  "applicationsCount": 0,
  "created": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "datasetsCount": 0,
  "description": "string",
  "id": "string",
  "members": [
    {
      "email": "string",
      "fullName": "string",
      "id": "string",
      "isOrganization": true,
      "userhash": "string",
      "username": "string"
    }
  ],
  "modelsCount": 0,
  "name": "string",
  "notebooksCount": 0,
  "owners": [
    {
      "email": "string",
      "fullName": "string",
      "id": "string",
      "isOrganization": true,
      "userhash": "string",
      "username": "string"
    }
  ],
  "projectsCount": 0,
  "tenantId": "string",
  "updated": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

Responses

Status Meaning Description Schema
204 No Content The Use Case has been successfully updated. UseCaseResponse
403 Forbidden User does not have access to this functionality. None
404 Not Found Use Case not found. None
422 Unprocessable Entity Unprocessable Entity None

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

BearerAuth

GET /api/v2/useCases/{useCaseId}/applications/

Get a list of the applications associated with a Use Case

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/useCases/{useCaseId}/applications/?sort=-applicationTemplateType&orderBy=-applicationTemplateType \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
search query string false Only return applications with names that match the given string.
sort query string true [DEPRECATED - replaced with order_by] The order to sort applications.
orderBy query string true The order to sort applications.
useCaseId path string true The ID of the Use Case to update.

Enumerated Values

Parameter Value
sort -applicationTemplateType
sort -createdAt
sort -lastActivity
sort -name
sort -source
sort -updatedAt
sort -userId
sort applicationTemplateType
sort createdAt
sort lastActivity
sort name
sort source
sort updatedAt
sort userId
orderBy -applicationTemplateType
orderBy -createdAt
orderBy -lastActivity
orderBy -name
orderBy -source
orderBy -updatedAt
orderBy -userId
orderBy applicationTemplateType
orderBy createdAt
orderBy lastActivity
orderBy name
orderBy source
orderBy updatedAt
orderBy userId

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "applicationId": "string",
      "applicationTemplateType": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "description": "string",
      "lastActivity": {
        "timestamp": "2019-08-24T14:15:22Z",
        "type": "string"
      },
      "name": "string",
      "projectId": "string",
      "source": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none UseCasesApplicationsListResponse
403 Forbidden User does not have access to this functionality. None

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

BearerAuth

GET /api/v2/useCases/{useCaseId}/datasets/

Get a list of the datasets associated with a Use Case

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/useCases/{useCaseId}/datasets/?sort=-columnCount&orderBy=-columnCount \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
sort query string true [DEPRECATED - replaced with order_by] The order to sort the Use Case datasets.
orderBy query string true The order to sort the Use Case datasets.
search query string false Only return datasets from Use Case with names that match the given string.
useCaseId path string true The ID of the Use Case to update.

Enumerated Values

Parameter Value
sort -columnCount
sort -createdAt
sort -createdBy
sort -dataSourceType
sort -datasetSize
sort -datasetSourceType
sort -lastActivity
sort -modifiedAt
sort -modifiedBy
sort -name
sort -rowCount
sort columnCount
sort createdAt
sort createdBy
sort dataSourceType
sort datasetSize
sort datasetSourceType
sort lastActivity
sort modifiedAt
sort modifiedBy
sort name
sort rowCount
orderBy -columnCount
orderBy -createdAt
orderBy -createdBy
orderBy -dataSourceType
orderBy -datasetSize
orderBy -datasetSourceType
orderBy -lastActivity
orderBy -modifiedAt
orderBy -modifiedBy
orderBy -name
orderBy -rowCount
orderBy columnCount
orderBy createdAt
orderBy createdBy
orderBy dataSourceType
orderBy datasetSize
orderBy datasetSourceType
orderBy lastActivity
orderBy modifiedAt
orderBy modifiedBy
orderBy name
orderBy rowCount

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "columnCount": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "dataPersisted": true,
      "dataSourceType": "string",
      "datasetId": "string",
      "datasetSize": 0,
      "datasetSourceType": "string",
      "featureDiscoveryProjectId": "string",
      "isSnapshot": true,
      "isWranglingEligible": true,
      "latestRecipeId": "string",
      "modifiedAt": "2019-08-24T14:15:22Z",
      "modifiedBy": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "name": "string",
      "processingState": "COMPLETED",
      "referenceMetadata": {
        "createdAt": "2019-08-24T14:15:22Z",
        "createdBy": {
          "email": "string",
          "fullName": "string",
          "id": "string",
          "userhash": "string",
          "username": "string"
        },
        "lastActivity": {
          "timestamp": "2019-08-24T14:15:22Z",
          "type": "string"
        }
      },
      "rowCount": 0,
      "versionId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none UseCaseDatasetsListResponse
403 Forbidden User does not have access to this functionality. None

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

BearerAuth

GET /api/v2/useCases/{useCaseId}/filterMetadata/

Get filtering metadata information from Use Cases associated with a Use Case.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/useCases/{useCaseId}/filterMetadata/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
useCaseId path string true The ID of the use case.

Example responses

200 Response

{
  "metrics": {
    "binary": [
      "AUC"
    ],
    "regression": [
      "FVE Poisson"
    ]
  },
  "modelFamilies": [
    {
      "fullName": "string",
      "key": "AB"
    }
  ],
  "samplePcts": [
    0
  ]
}

Responses

Status Meaning Description Schema
200 OK none ExperimentContainerFilterMetadataRetrieveResponse
403 Forbidden User does not have access to this functionality. None

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

BearerAuth

GET /api/v2/useCases/{useCaseId}/modelsForComparison/

Get a list of models from projects associated with a Use Case for direct comparison. NOTE: datetime partitioned models are not supported currently.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/useCases/{useCaseId}/modelsForComparison/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
orderBy query string false Sort by creation date of the project associated with the model, default is descending order
binarySortMetric query string false Binary Classification sort metric
binarySortPartition query string false Retrieve Validation, Cross-Validation, or Holdout metric scores for list of models, only sort by descending order (i.e. most accurate to least accurate)
regressionSortMetric query string false Regression sort metric
regressionSortPartition query string false Retrieve Validation, Cross-Validation, or Holdout metric scores for list of models, only sort by descending order (i.e. most accurate to least accurate)
numberTopModels query integer false Filter to limited number of top scoring models, where default value is 1. A value of 0 means no top scoring models will be returned.
samplePct query any false Filter to models trained at the specified sample size percentage(s)
modelFamily query any false Filter to models that match the specified model family/families
includeAllStarredModels query boolean false Whether to include all starred models in filtering output. This means starred models will be included in addition to top-scoring models.
trainingDatasetId query any false Filter to models from projects built using specified training dataset ID(s)
targetFeature query any false Filter to models from projects built using specified target feature(s)
scoringCodeOnly query boolean false Whether to include only models that can be converted to scorable java code
useCaseId path string true The ID of the use case.

Enumerated Values

Parameter Value
orderBy -createdAt
orderBy createdAt
binarySortMetric AUC
binarySortMetric Weighted AUC
binarySortMetric Area Under PR Curve
binarySortMetric Weighted Area Under PR Curve
binarySortMetric Kolmogorov-Smirnov
binarySortMetric Weighted Kolmogorov-Smirnov
binarySortMetric FVE Binomial
binarySortMetric Weighted FVE Binomial
binarySortMetric Gini Norm
binarySortMetric Weighted Gini Norm
binarySortMetric LogLoss
binarySortMetric Weighted LogLoss
binarySortMetric Max MCC
binarySortMetric Weighted Max MCC
binarySortMetric Rate@Top5%
binarySortMetric Weighted Rate@Top5%
binarySortMetric Rate@Top10%
binarySortMetric Weighted Rate@Top10%
binarySortMetric Rate@TopTenth%
binarySortMetric RMSE
binarySortMetric Weighted RMSE
binarySortPartition validation
binarySortPartition holdout
binarySortPartition crossValidation
regressionSortMetric FVE Poisson
regressionSortMetric Weighted FVE Poisson
regressionSortMetric FVE Gamma
regressionSortMetric Weighted FVE Gamma
regressionSortMetric FVE Tweedie
regressionSortMetric Weighted FVE Tweedie
regressionSortMetric Gamma Deviance
regressionSortMetric Weighted Gamma Deviance
regressionSortMetric Gini Norm
regressionSortMetric Weighted Gini Norm
regressionSortMetric MAE
regressionSortMetric Weighted MAE
regressionSortMetric MAPE
regressionSortMetric Weighted MAPE
regressionSortMetric SMAPE
regressionSortMetric Weighted SMAPE
regressionSortMetric Poisson Deviance
regressionSortMetric Weighted Poisson Deviance
regressionSortMetric RMSLE
regressionSortMetric RMSE
regressionSortMetric Weighted RMSLE
regressionSortMetric Weighted RMSE
regressionSortMetric R Squared
regressionSortMetric Weighted R Squared
regressionSortMetric Tweedie Deviance
regressionSortMetric Weighted Tweedie Deviance
regressionSortPartition validation
regressionSortPartition holdout
regressionSortPartition crossValidation

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "autopilotDataSelectionMethod": "duration",
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "datasetName": "string",
      "hasCodegen": true,
      "hasHoldout": true,
      "isDatetimePartitioned": true,
      "isScoringAvailableForModelsTrainedIntoValidationHoldout": true,
      "isStarred": true,
      "isTrainedIntoHoldout": true,
      "isTrainedIntoValidation": true,
      "metric": "\n        {\n            \"metrics\": {\n                \"RMSE\": {\n                    \"holdout\": 5000,\n                    \"validation\": 5100,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"crossValidation\": 6000,\n                    \"training\": null\n                },\n                \"FVE Poisson\": {\n                    \"holdout\": null,\n                    \"validation\": 0.56269,\n                    \"crossValidation\": 0.50166,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"training\": null\n                },\n            }\n        }\n",
      "modelFamily": "AB",
      "modelId": "string",
      "name": "string",
      "projectId": "string",
      "projectName": "string",
      "samplePct": 0,
      "targetName": "string",
      "targetType": "Binary"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none UseCaseModelsForComparisonListResponse
400 Bad Request Bad request None
403 Forbidden User does not have access to this functionality. None
422 Unprocessable Entity Unable to retrieve models for the Use Case. None

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

BearerAuth

GET /api/v2/useCases/{useCaseId}/notebooks/

Get a list of the notebooks associated with a Use Case

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/useCases/{useCaseId}/notebooks/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false The number of records to skip over. Default 0.
limit query integer false The number of records to return in the range from 1 to 100. Default 100.
useCaseId path string true The ID of the Use Case to update.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "created": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "entityId": "string",
      "entityType": "notebook",
      "experimentContainerId": "string",
      "id": "string",
      "isDeleted": true,
      "referenceId": "string",
      "tenantId": "string",
      "updatedBy": "string",
      "useCaseId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none UseCasesNotebooksListResponse
403 Forbidden User does not have access to this functionality. None

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

BearerAuth

GET /api/v2/useCases/{useCaseId}/playgrounds/

Get a list of the playgrounds associated with a Use Case

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/useCases/{useCaseId}/playgrounds/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false The number of records to skip over. Default 0.
limit query integer false The number of records to return in the range from 1 to 100. Default 100.
useCaseId path string true The ID of the Use Case to update.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "created": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "entityId": "string",
      "entityType": "playground",
      "id": "string",
      "isDeleted": true,
      "referenceId": "string",
      "tenantId": "string",
      "updatedBy": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none UseCasesPlaygroundsListResponse
403 Forbidden User does not have access to this functionality. None

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

BearerAuth

GET /api/v2/useCases/{useCaseId}/projects/

Get a list of the projects associated with a Use Case.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/useCases/{useCaseId}/projects/?sort=-createdAt&orderBy=-createdAt \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
search query string false Only return Use Cases with names that match the given string.
sort query string true [DEPRECATED - replaced with order_by] The order to sort the Use Case projects.
orderBy query string true The order to sort the Use Case projects.
useCaseId path string true The ID of the Use Case to update.

Enumerated Values

Parameter Value
sort -createdAt
sort -createdBy
sort -dataset
sort -featureCount
sort -fullName
sort -lastActivity
sort -models
sort -name
sort -projectId
sort -rowCount
sort -target
sort -targetType
sort -timeAware
sort -updatedAt
sort -updatedBy
sort createdAt
sort createdBy
sort dataset
sort featureCount
sort fullName
sort lastActivity
sort models
sort name
sort projectId
sort rowCount
sort target
sort targetType
sort timeAware
sort updatedAt
sort updatedBy
orderBy -createdAt
orderBy -createdBy
orderBy -dataset
orderBy -featureCount
orderBy -fullName
orderBy -lastActivity
orderBy -models
orderBy -name
orderBy -projectId
orderBy -rowCount
orderBy -target
orderBy -targetType
orderBy -timeAware
orderBy -updatedAt
orderBy -updatedBy
orderBy createdAt
orderBy createdBy
orderBy dataset
orderBy featureCount
orderBy fullName
orderBy lastActivity
orderBy models
orderBy name
orderBy projectId
orderBy rowCount
orderBy target
orderBy targetType
orderBy timeAware
orderBy updatedAt
orderBy updatedBy

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "autopilotDataSelectionMethod": "duration",
      "created": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "dataset": "string",
      "datasetId": "string",
      "hasHoldout": true,
      "isDraft": true,
      "isScoringAvailableForModelsTrainedIntoValidationHoldout": true,
      "isWorkbenchEligible": true,
      "lastActivity": {
        "timestamp": "2019-08-24T14:15:22Z",
        "type": "string"
      },
      "metricDetail": [
        {
          "ascending": true,
          "name": "string"
        }
      ],
      "models": 0,
      "name": "string",
      "numberOfBacktests": 0,
      "projectId": "string",
      "projectOptions": {
        "target": "string",
        "targetType": "Binary",
        "weight": "string"
      },
      "target": "string",
      "targetType": "Binary",
      "timeAware": true,
      "updated": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "updatedAt": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none UseCaseProjectsListResponse
403 Forbidden User does not have access to this functionality. None

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

BearerAuth

GET /api/v2/useCases/{useCaseId}/resources/

Get a list of the references associated with a use case

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/useCases/{useCaseId}/resources/?sort=-entityType&orderBy=-entityType \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
sort query string true [DEPRECATED - replaced with order_by] The order to sort the Use Case references.
orderBy query string true The order to sort the Use Case references.
daysSinceLastActivity query integer false Only retrieve resources that had activity within the specified number of days.
useCaseId path string true The ID of the Use Case to update.

Enumerated Values

Parameter Value
sort -entityType
sort -lastActivity
sort -name
sort -updatedAt
sort -updatedBy
sort entityType
sort lastActivity
sort name
sort updatedAt
sort updatedBy
orderBy -entityType
orderBy -lastActivity
orderBy -name
orderBy -updatedAt
orderBy -updatedBy
orderBy entityType
orderBy lastActivity
orderBy name
orderBy updatedAt
orderBy updatedBy

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "createdBy": "string",
      "entityId": "string",
      "entityType": "string",
      "id": "string",
      "lastActivity": {
        "timestamp": "2019-08-24T14:15:22Z",
        "type": "string"
      },
      "metadata": {
        "isDraft": true,
        "isWorkbenchEligible": true
      },
      "name": "string",
      "processingState": "COMPLETED",
      "updated": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "updatedAt": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none UseCaseReferenceListResponse

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

BearerAuth

GET /api/v2/useCases/{useCaseId}/sharedRoles/

Get a list of users who have access to this Use Case and their roles on the Use Case.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/useCases/{useCaseId}/sharedRoles/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false The number of records to skip over.
limit query integer false The number of records to return.
id query string false Optional, only return the access control information for a user with this user ID.
useCaseId path string true The ID of the Use Case to update.

Example responses

200 Response

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

Responses

Status Meaning Description Schema
200 OK none SharedRolesWithGrantListResponse
404 Not Found Either the Use Case does not exist or the user does not have permissions to view the data store. 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/useCases/{useCaseId}/sharedRoles/

Update the list of users who have access to this Use Case and their roles on the Use Case.

Code samples

# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/useCases/{useCaseId}/sharedRoles/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter

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

Parameters

Name In Type Required Description
useCaseId path string true The ID of the Use Case to update.
body body ExperimentContainerSharedRolesUpdate false none

Responses

Status Meaning Description Schema
200 OK none None

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

BearerAuth

GET /api/v2/useCases/{useCaseId}/vectorDatabases/

Get a list of the vector databases associated with a Use Case

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/useCases/{useCaseId}/vectorDatabases/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false The number of records to skip over. Default 0.
limit query integer false The number of records to return in the range from 1 to 100. Default 100.
useCaseId path string true The ID of the Use Case to update.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "created": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "entityId": "string",
      "entityType": "vector_database",
      "id": "string",
      "isDeleted": true,
      "referenceId": "string",
      "tenantId": "string",
      "updatedBy": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none UseCasesVectorDatabasesListResponse
403 Forbidden User does not have access to this functionality. None

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

BearerAuth

DELETE /api/v2/useCases/{useCaseId}/{referenceCollectionType}/{entityId}/

Remove a related entity from a use case.

Code samples

# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/useCases/{useCaseId}/{referenceCollectionType}/{entityId}/?deleteResource=false \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
deleteResource query boolean true If True, delete the linked resource
useCaseId path string true The id linking the Use Case with the entity type.
referenceCollectionType path string true The reference collection type.
entityId path string true The primary id of the entity.

Enumerated Values

Parameter Value
referenceCollectionType projects
referenceCollectionType datasets
referenceCollectionType notebooks
referenceCollectionType applications
referenceCollectionType recipes

Responses

Status Meaning Description Schema
200 OK none None
204 No Content The relationship has been removed successfully None
404 Not Found Use Case reference not found None

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

BearerAuth

POST /api/v2/useCases/{useCaseId}/{referenceCollectionType}/{entityId}/

Link entity to a single Use Case.

Code samples

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/useCases/{useCaseId}/{referenceCollectionType}/{entityId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter

{
  "workflow": "migration"
}

Parameters

Name In Type Required Description
useCaseId path string true The id linking the Use Case with the entity type.
referenceCollectionType path string true The reference collection type.
entityId path string true The primary id of the entity.
body body UseCaseReferenceLink false none

Enumerated Values

Parameter Value
referenceCollectionType projects
referenceCollectionType datasets
referenceCollectionType notebooks
referenceCollectionType applications
referenceCollectionType recipes

Example responses

200 Response

{
  "createdBy": "string",
  "entityId": "string",
  "entityType": "string",
  "id": "string",
  "lastActivity": {
    "timestamp": "2019-08-24T14:15:22Z",
    "type": "string"
  },
  "metadata": {
    "isDraft": true,
    "isWorkbenchEligible": true
  },
  "name": "string",
  "processingState": "COMPLETED",
  "updated": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

Responses

Status Meaning Description Schema
200 OK none ExperimentContainerReferenceRetrieve
201 Created The entity has been linked successfully None
403 Forbidden User does not have access to this functionality. None
409 Conflict The entity has already been linked None
422 Unprocessable Entity Unprocessable Entity None

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

BearerAuth

Schemas

AccessControlWithGrant

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

Properties

Name Type Required Restrictions Description
canShare boolean true Whether the recipient can share the role further.
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.
userFullName string false Full name of the recipient user.

Enumerated Values

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

ExperimentContainerApplicationResponse

{
  "applicationId": "string",
  "applicationTemplateType": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "description": "string",
  "lastActivity": {
    "timestamp": "2019-08-24T14:15:22Z",
    "type": "string"
  },
  "name": "string",
  "projectId": "string",
  "source": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
applicationId string true The application id of the application.
applicationTemplateType string¦null true The type of the application.
createdAt string(date-time) true The timestamp generated at application creation.
createdBy ExperimentContainerUserResponse true User who created the application
description string¦null true The description of the application.
lastActivity ExperimentContainerLastActivity true Last activity details
name string true The name of the application.
projectId string¦null true The ID of the associated project
source string¦null true The source used to create the application.
updatedAt string(date-time) true The timestamp generated at application modification.

ExperimentContainerFilterMetadataMetricsObjectResponse

{
  "binary": [
    "AUC"
  ],
  "regression": [
    "FVE Poisson"
  ]
}

Properties

Name Type Required Restrictions Description
binary [string] false Binary metrics associated with the models
regression [string] false Regression metrics associated with the models

ExperimentContainerFilterMetadataModelFamiliesObjectResponse

{
  "fullName": "string",
  "key": "AB"
}

Properties

Name Type Required Restrictions Description
fullName string true Full name of the model family
key string true Abbreviated form of model family name

Enumerated Values

Property Value
key AB
key AD
key BLENDER
key CAL
key CLUSTER
key COUNT_DICT
key CUSTOM
key DOCUMENT
key DT
key DUMMY
key EP
key EQ
key EQ_TS
key FM
key GAM
key GBM
key GLM
key GLMNET
key IMAGE
key KNN
key NB
key NN
key OTHER
key RF
key RI
key SEGMENTED
key SVM
key TEXT
key TS
key TS_NN
key TTS
key VW

ExperimentContainerFilterMetadataRetrieveResponse

{
  "metrics": {
    "binary": [
      "AUC"
    ],
    "regression": [
      "FVE Poisson"
    ]
  },
  "modelFamilies": [
    {
      "fullName": "string",
      "key": "AB"
    }
  ],
  "samplePcts": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
metrics ExperimentContainerFilterMetadataMetricsObjectResponse true Model performance evaluation metrics (shorthand abbreviations)
modelFamilies [ExperimentContainerFilterMetadataModelFamiliesObjectResponse] true maxItems: 32
Model families associated with the models
samplePcts [number] true maxItems: 7
Model training sample sizes (in percentage)

ExperimentContainerLastActivity

{
  "timestamp": "2019-08-24T14:15:22Z",
  "type": "string"
}

Properties

Name Type Required Restrictions Description
timestamp string(date-time) true Time when this activity occurred.
type string true The type of activity. Can be "Added" or "Modified"

ExperimentContainerModelsForComparisonModelResponse

{
  "autopilotDataSelectionMethod": "duration",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "datasetName": "string",
  "hasCodegen": true,
  "hasHoldout": true,
  "isDatetimePartitioned": true,
  "isScoringAvailableForModelsTrainedIntoValidationHoldout": true,
  "isStarred": true,
  "isTrainedIntoHoldout": true,
  "isTrainedIntoValidation": true,
  "metric": "\n        {\n            \"metrics\": {\n                \"RMSE\": {\n                    \"holdout\": 5000,\n                    \"validation\": 5100,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"crossValidation\": 6000,\n                    \"training\": null\n                },\n                \"FVE Poisson\": {\n                    \"holdout\": null,\n                    \"validation\": 0.56269,\n                    \"crossValidation\": 0.50166,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"training\": null\n                },\n            }\n        }\n",
  "modelFamily": "AB",
  "modelId": "string",
  "name": "string",
  "projectId": "string",
  "projectName": "string",
  "samplePct": 0,
  "targetName": "string",
  "targetType": "Binary"
}

Properties

Name Type Required Restrictions Description
autopilotDataSelectionMethod string¦null true The Data Selection method of the datetime-partitioned model. null if model is not datetime-partitioned.
createdAt string(date-time) true Timestamp generated at model's project creation.
createdBy ExperimentContainerUserResponse true User who created the model
datasetName string true Name of the dataset used to build the project associated with the model
hasCodegen boolean true Whether the model can be converted to scorable java code
hasHoldout boolean true Whether the model has holdout.
isDatetimePartitioned boolean true Indicates whether the model is a datetime-partitioned model.
isScoringAvailableForModelsTrainedIntoValidationHoldout boolean true Indicates whether validation scores are available. A result of 'N/A' in the UI indicates that a model was trained into validation or holdout and also either does not have stacked predictions or uses extended multiclass.
isStarred boolean true Whether the model has been starred
isTrainedIntoHoldout boolean true Whether the model used holdout data for training.
isTrainedIntoValidation boolean true Whether the model used validation data for training.
metric object true Model performance information by the specified filtered evaluation metric
modelFamily string true Model family associated with the model
modelId string true ID of the model
name string true Name of the model
projectId string true ID of the project associated with the model
projectName string true Name of the project associated with the model
samplePct number¦null true maximum: 100
minimum: 0 (exclusive)
Percentage of the dataset to use with the model
targetName string true Name of modeling target
targetType string true Type of modeling target

Enumerated Values

Property Value
autopilotDataSelectionMethod duration
autopilotDataSelectionMethod rowCount
modelFamily AB
modelFamily AD
modelFamily BLENDER
modelFamily CAL
modelFamily CLUSTER
modelFamily COUNT_DICT
modelFamily CUSTOM
modelFamily DOCUMENT
modelFamily DT
modelFamily DUMMY
modelFamily EP
modelFamily EQ
modelFamily EQ_TS
modelFamily FM
modelFamily GAM
modelFamily GBM
modelFamily GLM
modelFamily GLMNET
modelFamily IMAGE
modelFamily KNN
modelFamily NB
modelFamily NN
modelFamily OTHER
modelFamily RF
modelFamily RI
modelFamily SEGMENTED
modelFamily SVM
modelFamily TEXT
modelFamily TS
modelFamily TS_NN
modelFamily TTS
modelFamily VW
targetType Binary
targetType Regression

ExperimentContainerNotebookResponse

{
  "created": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "entityId": "string",
  "entityType": "notebook",
  "experimentContainerId": "string",
  "id": "string",
  "isDeleted": true,
  "referenceId": "string",
  "tenantId": "string",
  "updatedBy": "string",
  "useCaseId": "string"
}

Properties

Name Type Required Restrictions Description
created ExperimentContainerUserResponse true User who created the notebook
createdAt string(date-time) true The timestamp generated at notebook creation.
createdBy string¦null false The id of the user who created.
entityId string true The primary id of the entity (same as ID of the notebook).
entityType string true The type of entity provided by the entity id.
experimentContainerId string true [DEPRECATED - replaced with use_case_id] The ID of the Use Case.
id string true The ID of the notebook.
isDeleted boolean true Soft deletion flag for notebooks
referenceId string true Original ID from DB
tenantId string¦null true The id of the tenant the notebook belongs to.
updatedBy string¦null false The id of the user who last updated.
useCaseId string true The ID of the Use Case.

Enumerated Values

Property Value
entityType notebook

ExperimentContainerPlaygroundResponse

{
  "created": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "entityId": "string",
  "entityType": "playground",
  "id": "string",
  "isDeleted": true,
  "referenceId": "string",
  "tenantId": "string",
  "updatedBy": "string"
}

Properties

Name Type Required Restrictions Description
created ExperimentContainerUserResponse true User who created the playground
createdAt string(date-time) true The timestamp generated at playground creation.
createdBy string¦null false The id of the user who created.
entityId string true The primary id of the entity (same as ID of the playground).
entityType string true The type of entity provided by the entity id.
id string true The ID of the playground.
isDeleted boolean true Soft deletion flag for playgrounds
referenceId string true Original ID from DB
tenantId string¦null true The id of the tenant the playground belongs to.
updatedBy string¦null false The id of the user who last updated.

Enumerated Values

Property Value
entityType playground

ExperimentContainerReferenceDatasetMetadata

{
  "dataSourceType": "string",
  "datasetSourceType": "string",
  "isSnapshot": true,
  "isWranglingEligible": true,
  "latestRecipeId": "string"
}

Properties

Name Type Required Restrictions Description
dataSourceType string¦null true The type of the data source used to create the dataset if relevant.
datasetSourceType string¦null true The source type of the dataset
isSnapshot boolean true Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.
isWranglingEligible boolean true Whether the source of the dataset can support wrangling.
latestRecipeId string¦null true The latest recipe id linked to the dataset.

ExperimentContainerReferenceDatasetResponse

{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "lastActivity": {
    "timestamp": "2019-08-24T14:15:22Z",
    "type": "string"
  }
}

Properties

Name Type Required Restrictions Description
createdAt string(date-time) true The timestamp generated at record creation.
createdBy ExperimentContainerUserResponse false User who created the record
lastActivity ExperimentContainerLastActivity true Last activity details

ExperimentContainerReferenceProjectMetadata

{
  "isDraft": true,
  "isWorkbenchEligible": true
}

Properties

Name Type Required Restrictions Description
isDraft boolean true Indicates whether the experiment configuration has been used for modeling (False) or whether the setup can still be modified and applied in training (True)
isWorkbenchEligible boolean true Indicates whether the experiment is Workbench compatible

ExperimentContainerReferenceRecipeMetadata

{
  "dataType": "static"
}

Properties

Name Type Required Restrictions Description
dataType string¦null true The type of the recipe (wrangling or feature discovery)

Enumerated Values

Property Value
dataType static
dataType Static
dataType STATIC
dataType snapshot
dataType Snapshot
dataType SNAPSHOT
dataType dynamic
dataType Dynamic
dataType DYNAMIC
dataType wranglingRecipe
dataType WranglingRecipe
dataType WRANGLING_RECIPE
dataType featureDiscoveryRecipe
dataType FeatureDiscoveryRecipe
dataType FEATURE_DISCOVERY_RECIPE

ExperimentContainerReferenceRetrieve

{
  "createdBy": "string",
  "entityId": "string",
  "entityType": "string",
  "id": "string",
  "lastActivity": {
    "timestamp": "2019-08-24T14:15:22Z",
    "type": "string"
  },
  "metadata": {
    "isDraft": true,
    "isWorkbenchEligible": true
  },
  "name": "string",
  "processingState": "COMPLETED",
  "updated": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

Properties

Name Type Required Restrictions Description
createdBy string¦null false The id of the user who created.
entityId string true The primary id of the entity.
entityType string true The type of entity provided by the entity id.
id string true The ID of the experiment container reference.
lastActivity ExperimentContainerLastActivity true Last activity details
metadata any false Reference metadata for the experiment container

oneOf

Name Type Required Restrictions Description
» anonymous ExperimentContainerReferenceProjectMetadata false none

xor

Name Type Required Restrictions Description
» anonymous ExperimentContainerReferenceDatasetMetadata false none

xor

Name Type Required Restrictions Description
» anonymous ExperimentContainerReferenceRecipeMetadata false none

continued

Name Type Required Restrictions Description
name string true The name of the experiment container reference.
processingState string false Current ingestion process state of dataset.
updated ExperimentContainerUserResponse true User who was the last one to update the container reference
updatedAt string(date-time) true The timestamp generated at record creation.
updatedBy string¦null false The id of the user who last updated.

Enumerated Values

Property Value
processingState COMPLETED
processingState ERROR
processingState RUNNING

ExperimentContainerSharedRolesUpdate

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

Properties

Name Type Required Restrictions Description
operation string true The name of the action being taken. Only 'updateRoles' is supported.
roles [oneOf] true minItems: 1
A list of sharing role objects

oneOf

Name Type Required Restrictions Description
» anonymous ExperimentContainerSharingRoleUpdateDataWithName false none

xor

Name Type Required Restrictions Description
» anonymous ExperimentContainerSharingRoleUpdateDataWithId false none

Enumerated Values

Property Value
operation updateRoles

ExperimentContainerSharingRoleUpdateDataWithId

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

Properties

Name Type Required Restrictions Description
id string true The ID of the recipient
role string true The assigned role
shareRecipientType string true The recipient type

Enumerated Values

Property Value
role OWNER
role EDITOR
role CONSUMER
role NO_ROLE
shareRecipientType user
shareRecipientType organization

ExperimentContainerSharingRoleUpdateDataWithName

{
  "name": "string",
  "role": "OWNER",
  "shareRecipientType": "user"
}

Properties

Name Type Required Restrictions Description
name string true Name of the user to update the access role for.
role string true The assigned role
shareRecipientType string true The recipient type

Enumerated Values

Property Value
role OWNER
role EDITOR
role CONSUMER
role NO_ROLE
shareRecipientType user
shareRecipientType organization

ExperimentContainerUserResponse

{
  "email": "string",
  "fullName": "string",
  "id": "string",
  "userhash": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
email string¦null true The email address of the user.
fullName string¦null false The full name of the user.
id string true The id of the user.
userhash string¦null false User's gravatar hash.
username string¦null false The username of the user.

ExperimentContainerVectorDatabaseResponse

{
  "created": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "entityId": "string",
  "entityType": "vector_database",
  "id": "string",
  "isDeleted": true,
  "referenceId": "string",
  "tenantId": "string",
  "updatedBy": "string"
}

Properties

Name Type Required Restrictions Description
created ExperimentContainerUserResponse true User who created the vector database
createdAt string(date-time) true The timestamp generated at vector database creation.
createdBy string¦null false The id of the user who created.
entityId string true The primary id of the entity (same as ID of the vector database).
entityType string true The type of entity provided by the entity id.
id string true The ID of the vector database.
isDeleted boolean true Soft deletion flag for vector databases
referenceId string true Original ID from DB
tenantId string¦null true The id of the tenant the vector database belongs to.
updatedBy string¦null false The id of the user who last updated.

Enumerated Values

Property Value
entityType vector_database

MetricDetail

{
  "ascending": true,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
ascending boolean true Should the metric be sorted in ascending order
name string true Name of the metric

SharedRolesWithGrantListResponse

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

Properties

Name Type Required Restrictions Description
count integer true The number of items returned.
data [AccessControlWithGrant] true 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.

UseCaseCreate

{
  "advancedTour": "flightDelays",
  "description": null,
  "name": null
}

Properties

Name Type Required Restrictions Description
advancedTour string¦null false Advanced tour key.
description string¦null false maxLength: 500
The description of the Use Case.
name string¦null false maxLength: 100
The name of the Use Case.

Enumerated Values

Property Value
advancedTour flightDelays
advancedTour hospital

UseCaseDatasetResponse

{
  "columnCount": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "dataPersisted": true,
  "dataSourceType": "string",
  "datasetId": "string",
  "datasetSize": 0,
  "datasetSourceType": "string",
  "featureDiscoveryProjectId": "string",
  "isSnapshot": true,
  "isWranglingEligible": true,
  "latestRecipeId": "string",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "modifiedBy": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "name": "string",
  "processingState": "COMPLETED",
  "referenceMetadata": {
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": {
      "email": "string",
      "fullName": "string",
      "id": "string",
      "userhash": "string",
      "username": "string"
    },
    "lastActivity": {
      "timestamp": "2019-08-24T14:15:22Z",
      "type": "string"
    }
  },
  "rowCount": 0,
  "versionId": "string"
}

Properties

Name Type Required Restrictions Description
columnCount integer¦null true The number of columns in a dataset. null might be returned in case dataset is in running or errored state
createdAt string(date-time) true The timestamp generated at dataset creation.
createdBy ExperimentContainerUserResponse true User who created the dataset
dataPersisted boolean true If true, user is allowed to view extended data profile (which includes data statistics like min/max/median/mean, histogram, etc.) and download data. If false, download is not allowed and only the data schema (feature names and types) will be available.
dataSourceType string¦null true The type of the data source used to create the dataset if relevant.
datasetId string true The dataset id of the dataset.
datasetSize integer¦null true The size of the dataset as a CSV in bytes. null might be returned in case dataset is in running or errored state
datasetSourceType string¦null true The source type of the dataset
featureDiscoveryProjectId string¦null false Related feature discovery project if this is a feature discovery dataset.
isSnapshot boolean true Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.
isWranglingEligible boolean true Whether the source of the dataset can support wrangling.
latestRecipeId string¦null true The latest recipe id linked to the dataset.
modifiedAt string(date-time) true The timestamp generated at dataset modification.
modifiedBy ExperimentContainerUserResponse true User who was the last one to update the dataset
name string true The name of the dataset.
processingState string true Current ingestion process state of dataset.
referenceMetadata ExperimentContainerReferenceDatasetResponse true Metadata about the reference of the dataset in the Use Case.
rowCount integer¦null true The number of data rows in the dataset. null might be returned in case dataset is in running or errored state
versionId string true The dataset version id of the latest version of the dataset.

Enumerated Values

Property Value
processingState COMPLETED
processingState ERROR
processingState RUNNING

UseCaseDatasetsListResponse

{
  "count": 0,
  "data": [
    {
      "columnCount": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "dataPersisted": true,
      "dataSourceType": "string",
      "datasetId": "string",
      "datasetSize": 0,
      "datasetSourceType": "string",
      "featureDiscoveryProjectId": "string",
      "isSnapshot": true,
      "isWranglingEligible": true,
      "latestRecipeId": "string",
      "modifiedAt": "2019-08-24T14:15:22Z",
      "modifiedBy": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "name": "string",
      "processingState": "COMPLETED",
      "referenceMetadata": {
        "createdAt": "2019-08-24T14:15:22Z",
        "createdBy": {
          "email": "string",
          "fullName": "string",
          "id": "string",
          "userhash": "string",
          "username": "string"
        },
        "lastActivity": {
          "timestamp": "2019-08-24T14:15:22Z",
          "type": "string"
        }
      },
      "rowCount": 0,
      "versionId": "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 [UseCaseDatasetResponse] true A list of the datasets in the Use Case
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null 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.

UseCaseLastActivity

{
  "timestamp": "2019-08-24T14:15:22Z",
  "type": "string"
}

Properties

Name Type Required Restrictions Description
timestamp string(date-time) true Time when this activity occurred.
type string true The type of activity. Can be "Added" or "Modified"

UseCaseListResponse

{
  "count": 0,
  "data": [
    {
      "advancedTour": "string",
      "applicationsCount": 0,
      "created": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "datasetsCount": 0,
      "description": "string",
      "id": "string",
      "members": [
        {
          "email": "string",
          "fullName": "string",
          "id": "string",
          "isOrganization": true,
          "userhash": "string",
          "username": "string"
        }
      ],
      "modelsCount": 0,
      "name": "string",
      "notebooksCount": 0,
      "owners": [
        {
          "email": "string",
          "fullName": "string",
          "id": "string",
          "isOrganization": true,
          "userhash": "string",
          "username": "string"
        }
      ],
      "projectsCount": 0,
      "tenantId": "string",
      "updated": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "updatedAt": "2019-08-24T14:15:22Z",
      "updatedBy": "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 [UseCaseResponse] true A list of Use Cases that match the query
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null 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.

UseCaseMemberResponse

{
  "email": "string",
  "fullName": "string",
  "id": "string",
  "isOrganization": true,
  "userhash": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
email string¦null true The email address of the member.
fullName string¦null false The full name of the member.
id string true The id of the member.
isOrganization boolean¦null false Whether the member is organization.
userhash string¦null false Member's gravatar hash.
username string¦null false The username of the member.

UseCaseModelsForComparisonListResponse

{
  "count": 0,
  "data": [
    {
      "autopilotDataSelectionMethod": "duration",
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "datasetName": "string",
      "hasCodegen": true,
      "hasHoldout": true,
      "isDatetimePartitioned": true,
      "isScoringAvailableForModelsTrainedIntoValidationHoldout": true,
      "isStarred": true,
      "isTrainedIntoHoldout": true,
      "isTrainedIntoValidation": true,
      "metric": "\n        {\n            \"metrics\": {\n                \"RMSE\": {\n                    \"holdout\": 5000,\n                    \"validation\": 5100,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"crossValidation\": 6000,\n                    \"training\": null\n                },\n                \"FVE Poisson\": {\n                    \"holdout\": null,\n                    \"validation\": 0.56269,\n                    \"crossValidation\": 0.50166,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"training\": null\n                },\n            }\n        }\n",
      "modelFamily": "AB",
      "modelId": "string",
      "name": "string",
      "projectId": "string",
      "projectName": "string",
      "samplePct": 0,
      "targetName": "string",
      "targetType": "Binary"
    }
  ],
  "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 [ExperimentContainerModelsForComparisonModelResponse] true Models from multiple projects in the Use Case
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null 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.

UseCaseProjectOptionsResponse

{
  "target": "string",
  "targetType": "Binary",
  "weight": "string"
}

Properties

Name Type Required Restrictions Description
target string¦null false Name of the target
targetType string¦null false The target type of the project.
weight string¦null false Name of the weight (if configured)

Enumerated Values

Property Value
targetType Binary
targetType Regression
targetType Multiclass
targetType minInflated
targetType Multilabel
targetType TextGeneration

UseCaseProjectResponse

{
  "autopilotDataSelectionMethod": "duration",
  "created": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "dataset": "string",
  "datasetId": "string",
  "hasHoldout": true,
  "isDraft": true,
  "isScoringAvailableForModelsTrainedIntoValidationHoldout": true,
  "isWorkbenchEligible": true,
  "lastActivity": {
    "timestamp": "2019-08-24T14:15:22Z",
    "type": "string"
  },
  "metricDetail": [
    {
      "ascending": true,
      "name": "string"
    }
  ],
  "models": 0,
  "name": "string",
  "numberOfBacktests": 0,
  "projectId": "string",
  "projectOptions": {
    "target": "string",
    "targetType": "Binary",
    "weight": "string"
  },
  "target": "string",
  "targetType": "Binary",
  "timeAware": true,
  "updated": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

Properties

Name Type Required Restrictions Description
autopilotDataSelectionMethod string¦null true The Data Selection method of the datetime-partitioned project. null if project is not datetime-partitioned.
created ExperimentContainerUserResponse true User who created the project
createdAt string(date-time) true The timestamp generated at project creation.
createdBy string¦null false The id of the user who created.
dataset string true Name of the dataset in the registry used to build the project associated with the project
datasetId string true The dataset id of the dataset in the registry.
hasHoldout boolean true Whether the project has holdout.
isDraft boolean true Indicates whether the experiment configuration has been used for modeling (False) or whether the setup can still be modified and applied in training (True)
isScoringAvailableForModelsTrainedIntoValidationHoldout boolean true Indicates whether validation scores are available. A result of 'N/A' in the UI indicates that a model was trained into validation or holdout and also either does not have stacked predictions or uses extended multiclass.
isWorkbenchEligible boolean true Indicates whether the experiment is Workbench compatible
lastActivity ExperimentContainerLastActivity true Last activity details
metricDetail [MetricDetail] true Project metrics
models integer true The number of models in an use case.
name string true The name of the project.
numberOfBacktests integer true minimum: 0
The number of backtests of the datetime-partitioned project. 0 if project is not datetime-partitioned.
projectId string true The ID of the project.
projectOptions UseCaseProjectOptionsResponse true Project options currently saved for a project. Can be changed while project is in draft status.
target string¦null false Name of the target
targetType string¦null false Type of modeling target
timeAware boolean true Shows if project uses time series
updated ExperimentContainerUserResponse true User who was the last one to update the project
updatedAt string(date-time) true The timestamp generated at project modification.
updatedBy string¦null false The id of the user who last updated.

Enumerated Values

Property Value
autopilotDataSelectionMethod duration
autopilotDataSelectionMethod rowCount
targetType Binary
targetType Regression
targetType Multiclass
targetType minInflated
targetType Multilabel
targetType TextGeneration

UseCaseProjectsListResponse

{
  "count": 0,
  "data": [
    {
      "autopilotDataSelectionMethod": "duration",
      "created": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "dataset": "string",
      "datasetId": "string",
      "hasHoldout": true,
      "isDraft": true,
      "isScoringAvailableForModelsTrainedIntoValidationHoldout": true,
      "isWorkbenchEligible": true,
      "lastActivity": {
        "timestamp": "2019-08-24T14:15:22Z",
        "type": "string"
      },
      "metricDetail": [
        {
          "ascending": true,
          "name": "string"
        }
      ],
      "models": 0,
      "name": "string",
      "numberOfBacktests": 0,
      "projectId": "string",
      "projectOptions": {
        "target": "string",
        "targetType": "Binary",
        "weight": "string"
      },
      "target": "string",
      "targetType": "Binary",
      "timeAware": true,
      "updated": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "updatedAt": "2019-08-24T14:15:22Z",
      "updatedBy": "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 [UseCaseProjectResponse] true A list of the Use Case projects that match the query
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null 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.

UseCaseReferenceDatasetMetadata

{
  "dataSourceType": "string",
  "datasetSourceType": "string",
  "isSnapshot": true,
  "isWranglingEligible": true,
  "latestRecipeId": "string"
}

Properties

Name Type Required Restrictions Description
dataSourceType string¦null true The type of the data source used to create the dataset if relevant.
datasetSourceType string¦null true The source type of the dataset
isSnapshot boolean true Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.
isWranglingEligible boolean true Whether the source of the dataset can support wrangling.
latestRecipeId string¦null true The latest recipe id linked to the dataset.

{
  "workflow": "migration"
}

Properties

Name Type Required Restrictions Description
workflow string true The workflow that is attaching this entity. Does not affect the operation of the API call. Only used for analytics.

Enumerated Values

Property Value
workflow migration
workflow creation
workflow unspecified

UseCaseReferenceListResponse

{
  "count": 0,
  "data": [
    {
      "createdBy": "string",
      "entityId": "string",
      "entityType": "string",
      "id": "string",
      "lastActivity": {
        "timestamp": "2019-08-24T14:15:22Z",
        "type": "string"
      },
      "metadata": {
        "isDraft": true,
        "isWorkbenchEligible": true
      },
      "name": "string",
      "processingState": "COMPLETED",
      "updated": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "updatedAt": "2019-08-24T14:15:22Z",
      "updatedBy": "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 [UseCaseReferenceRetrieve] true A list of the Use Case references that match the query
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null 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.

UseCaseReferenceProjectMetadata

{
  "isDraft": true,
  "isWorkbenchEligible": true
}

Properties

Name Type Required Restrictions Description
isDraft boolean true Indicates whether the use case configuration has been used for modeling (False) or whether the setup can still be modified and applied in training (True)
isWorkbenchEligible boolean true Indicates whether the use case is Workbench compatible

UseCaseReferenceRecipeMetadata

{
  "dataType": "static"
}

Properties

Name Type Required Restrictions Description
dataType string¦null true The type of the recipe (wrangling or feature discovery)

Enumerated Values

Property Value
dataType static
dataType Static
dataType STATIC
dataType snapshot
dataType Snapshot
dataType SNAPSHOT
dataType dynamic
dataType Dynamic
dataType DYNAMIC
dataType wranglingRecipe
dataType WranglingRecipe
dataType WRANGLING_RECIPE
dataType featureDiscoveryRecipe
dataType FeatureDiscoveryRecipe
dataType FEATURE_DISCOVERY_RECIPE

UseCaseReferenceRetrieve

{
  "createdBy": "string",
  "entityId": "string",
  "entityType": "string",
  "id": "string",
  "lastActivity": {
    "timestamp": "2019-08-24T14:15:22Z",
    "type": "string"
  },
  "metadata": {
    "isDraft": true,
    "isWorkbenchEligible": true
  },
  "name": "string",
  "processingState": "COMPLETED",
  "updated": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

Properties

Name Type Required Restrictions Description
createdBy string¦null false The id of the user who created.
entityId string true The primary id of the entity.
entityType string true The type of entity provided by the entity id.
id string true The ID of the Use Case reference.
lastActivity UseCaseLastActivity true Last activity details
metadata any false Reference metadata for the Use Case

oneOf

Name Type Required Restrictions Description
» anonymous UseCaseReferenceProjectMetadata false none

xor

Name Type Required Restrictions Description
» anonymous UseCaseReferenceDatasetMetadata false none

xor

Name Type Required Restrictions Description
» anonymous UseCaseReferenceRecipeMetadata false none

continued

Name Type Required Restrictions Description
name string true The name of the Use Case reference.
processingState string false Current ingestion process state of dataset.
updated ExperimentContainerUserResponse true User who was the last one to update the Use Case
updatedAt string(date-time) true The timestamp generated at record creation.
updatedBy string¦null false The id of the user who last updated.

Enumerated Values

Property Value
processingState COMPLETED
processingState ERROR
processingState RUNNING

UseCaseResponse

{
  "advancedTour": "string",
  "applicationsCount": 0,
  "created": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "datasetsCount": 0,
  "description": "string",
  "id": "string",
  "members": [
    {
      "email": "string",
      "fullName": "string",
      "id": "string",
      "isOrganization": true,
      "userhash": "string",
      "username": "string"
    }
  ],
  "modelsCount": 0,
  "name": "string",
  "notebooksCount": 0,
  "owners": [
    {
      "email": "string",
      "fullName": "string",
      "id": "string",
      "isOrganization": true,
      "userhash": "string",
      "username": "string"
    }
  ],
  "projectsCount": 0,
  "tenantId": "string",
  "updated": {
    "email": "string",
    "fullName": "string",
    "id": "string",
    "userhash": "string",
    "username": "string"
  },
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

Properties

Name Type Required Restrictions Description
advancedTour string¦null false Advanced tour key.
applicationsCount integer true The number of applications in a Use Case.
created ExperimentContainerUserResponse true User who created the Use Case
createdAt string(date-time) true The timestamp generated at record creation.
createdBy string¦null false The id of the user who created.
datasetsCount integer true The number of datasets in a Use Case.
description string¦null true The description of the Use Case.
id string true The ID of the Use Case.
members [UseCaseMemberResponse] true List of members of a Use Case
modelsCount integer true The number of models in a Use Case.
name string true The name of the Use Case.
notebooksCount integer true The number of notebooks in a Use Case.
owners [UseCaseMemberResponse] false List of owners of a Use Case
projectsCount integer true The number of projects in a Use Case.
tenantId string¦null true The id of the tenant to associate this organization with.
updated ExperimentContainerUserResponse true User who was the last one to update the Use Case
updatedAt string(date-time) true The timestamp generated when the record was last updated.
updatedBy string¦null false The id of the user who last updated.

UseCaseUpdate

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

Properties

Name Type Required Restrictions Description
description string¦null false maxLength: 500
The description of the Use Case.
name string¦null false maxLength: 100
The name of the Use Case.

UseCasesApplicationsListResponse

{
  "count": 0,
  "data": [
    {
      "applicationId": "string",
      "applicationTemplateType": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "description": "string",
      "lastActivity": {
        "timestamp": "2019-08-24T14:15:22Z",
        "type": "string"
      },
      "name": "string",
      "projectId": "string",
      "source": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "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 [ExperimentContainerApplicationResponse] true A list of the applications in this Use Case
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null 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.

UseCasesNotebooksListResponse

{
  "count": 0,
  "data": [
    {
      "created": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "entityId": "string",
      "entityType": "notebook",
      "experimentContainerId": "string",
      "id": "string",
      "isDeleted": true,
      "referenceId": "string",
      "tenantId": "string",
      "updatedBy": "string",
      "useCaseId": "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 [ExperimentContainerNotebookResponse] true A list of the notebooks in this Use Case
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null 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.

UseCasesPlaygroundsListResponse

{
  "count": 0,
  "data": [
    {
      "created": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "entityId": "string",
      "entityType": "playground",
      "id": "string",
      "isDeleted": true,
      "referenceId": "string",
      "tenantId": "string",
      "updatedBy": "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 [ExperimentContainerPlaygroundResponse] true A list of the playgrounds in this Use Case
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null 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.

UseCasesVectorDatabasesListResponse

{
  "count": 0,
  "data": [
    {
      "created": {
        "email": "string",
        "fullName": "string",
        "id": "string",
        "userhash": "string",
        "username": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "entityId": "string",
      "entityType": "vector_database",
      "id": "string",
      "isDeleted": true,
      "referenceId": "string",
      "tenantId": "string",
      "updatedBy": "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 [ExperimentContainerVectorDatabaseResponse] true A list of the vector databases in this Use Case
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null 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.

Updated February 20, 2024
Back to top