Use Cases
The endpoints below outline how to create and manage Workbench Use Cases. They are not associated with the Value Tracker, which was formerly called Use Cases.
Retrieve Pinned Usecases
Operation path: GET /api/v2/pinnedUsecases/
Authentication requirements: BearerAuth
Example responses
200 Response
{
"properties": {
"data": {
"description": "The list of the pinned use cases.",
"items": {
"properties": {
"advancedTour": {
"description": "Advanced tour key.",
"type": [
"string",
"null"
]
},
"applicationsCount": {
"description": "The number of applications in a use case.",
"type": "integer"
},
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"customApplicationsCount": {
"description": "The number of custom applications referenced in a use case.",
"type": "integer"
},
"customJobsCount": {
"description": "The number of custom jobs referenced in a use case.",
"type": "integer"
},
"customModelVersionsCount": {
"description": "The number of custom models referenced in a use case.",
"type": "integer"
},
"datasetsCount": {
"description": "The number of datasets in a use case.",
"type": "integer"
},
"deploymentsCount": {
"description": "The number of deployments referenced in a use case.",
"type": "integer"
},
"description": {
"description": "The description of the Use Case.",
"type": [
"string",
"null"
]
},
"filesCount": {
"description": "The number of files in a use case.",
"type": "integer",
"x-versionadded": "v2.37"
},
"formattedDescription": {
"description": "The formatted description of the experiment container used as styled description.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the Use Case.",
"type": "string"
},
"modelsCount": {
"description": "[DEPRECATED] The number of models in a Use Case.",
"type": "integer",
"x-versiondeprecated": "v2.34"
},
"name": {
"description": "The name of the Use Case.",
"type": "string"
},
"notebooksCount": {
"description": "The number of notebooks in a use case.",
"type": "integer"
},
"projectsCount": {
"description": "The number of projects in a use case.",
"type": "integer"
},
"recipesCount": {
"description": "The number of recipes in a Use Case.",
"type": "integer"
},
"registeredModelVersionsCount": {
"description": "The number of registered models referenced in a use case.",
"type": "integer"
},
"riskAssessments": {
"description": "The ID List of the Risk Assessments.",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
},
"role": {
"description": "The requesting user's role on this Use Case.",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER"
],
"type": "string",
"x-versionadded": "v2.37"
},
"tenantId": {
"description": "The ID of the tenant to associate this organization with.",
"type": [
"string",
"null"
]
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated when the record was last updated.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"valueTrackerId": {
"description": "The ID of the Value Tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"applicationsCount",
"created",
"createdAt",
"customApplicationsCount",
"customJobsCount",
"customModelVersionsCount",
"datasetsCount",
"deploymentsCount",
"description",
"filesCount",
"id",
"name",
"notebooksCount",
"projectsCount",
"recipesCount",
"registeredModelVersionsCount",
"role",
"tenantId",
"updated",
"updatedAt"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 8,
"type": "array"
}
},
"required": [
"data"
],
"type": "object",
"x-versionadded": "v2.36"
}
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
Pinned Use Cases retrieved successfully. |
PinnedUsecasesResponse |
| 403 |
Forbidden |
User does not have access to this functionality. |
None |
Modify Pinned Usecases
Operation path: PATCH /api/v2/pinnedUsecases/
Authentication requirements: BearerAuth
Body parameter
{
"properties": {
"operation": {
"description": "Pinned Use Case possible operations.",
"enum": [
"add",
"remove"
],
"type": "string"
},
"pinnedUseCasesIds": {
"description": "The list of the pinned Use Case IDs.",
"items": {
"type": "string"
},
"maxItems": 8,
"minItems": 1,
"type": "array"
}
},
"required": [
"operation",
"pinnedUseCasesIds"
],
"type": "object",
"x-versionadded": "v2.36"
}
Parameters
Responses
| Status |
Meaning |
Description |
Schema |
| 204 |
No Content |
Pinned Use Cases retrieved successfully. |
None |
| 403 |
Forbidden |
User does not have access to this functionality. |
None |
Retrieve the list of use cases
Operation path: GET /api/v2/useCases/
Authentication requirements: BearerAuth
Retrieve the list of use cases.
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 |
Returns only Use Cases with names that match the given string. |
| projectId |
query |
string |
false |
Only return experiment containers associated with the given project ID. |
| applicationId |
query |
string |
false |
Only return experiment containers associated with the given app. |
| entityId |
query |
string |
false |
The id of the entity type that is linked with the Use Case. |
| entityType |
query |
string |
false |
The entity type that is linked to the use case. |
| sort |
query |
string |
true |
[DEPRECATED - replaced with order_by] The order in which Use Cases and return Use Cases. |
| orderBy |
query |
string |
true |
The order in which use cases are returned. |
| usecaseType |
query |
string |
true |
A filter to return use cases by type. |
| riskLevel |
query |
any |
false |
Only return Use Cases associated with the given risk level. |
| stage |
query |
any |
false |
Only return use cases in the given stage. |
| createdBy |
query |
string |
false |
Filter Use Cases to return only those created by the selected user. |
| showOrgUseCases |
query |
boolean |
false |
Defines if the Use Cases available on Organization level should be shown. |
Enumerated Values
| Parameter |
Value |
| entityType |
[project, dataset, file, notebook, application, recipe, playground, vectorDatabase, customModelVersion, registeredModelVersion, deployment, customApplication, customJob] |
| sort |
[-applicationsCount, -createdAt, -createdBy, -customApplicationsCount, -datasetsCount, -description, -filesCount, -id, -name, -notebooksCount, -playgroundsCount, -potentialValue, -projectsCount, -riskLevel, -stage, -updatedAt, -updatedBy, -vectorDatabasesCount, applicationsCount, createdAt, createdBy, customApplicationsCount, datasetsCount, description, filesCount, id, name, notebooksCount, playgroundsCount, potentialValue, projectsCount, riskLevel, stage, updatedAt, updatedBy, vectorDatabasesCount] |
| orderBy |
[-applicationsCount, -createdAt, -createdBy, -customApplicationsCount, -datasetsCount, -description, -filesCount, -id, -name, -notebooksCount, -playgroundsCount, -potentialValue, -projectsCount, -riskLevel, -stage, -updatedAt, -updatedBy, -vectorDatabasesCount, applicationsCount, createdAt, createdBy, customApplicationsCount, datasetsCount, description, filesCount, id, name, notebooksCount, playgroundsCount, potentialValue, projectsCount, riskLevel, stage, updatedAt, updatedBy, vectorDatabasesCount] |
| usecaseType |
[all, general, walkthrough] |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of use cases that match the query.",
"items": {
"properties": {
"advancedTour": {
"description": "Advanced tour key.",
"type": [
"string",
"null"
]
},
"applicationsCount": {
"description": "The number of applications in a Use Case.",
"type": "integer"
},
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"customApplicationsCount": {
"description": "The number of custom applications referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"customJobsCount": {
"description": "The number of custom jobs referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"customModelVersionsCount": {
"description": "The number of custom models referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"datasetsCount": {
"description": "The number of datasets in a Use Case.",
"type": "integer"
},
"deploymentsCount": {
"description": "The number of deployments referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"description": {
"description": "The description of the Use Case.",
"type": [
"string",
"null"
]
},
"filesCount": {
"description": "The number of files in a Use Case.",
"type": "integer",
"x-versionadded": "v2.37"
},
"formattedDescription": {
"description": "The formatted description of the experiment container used as styled description.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the Use Case.",
"type": "string"
},
"members": {
"description": "The list of use case members.",
"items": {
"properties": {
"email": {
"description": "The email address of the member.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the member.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the member.",
"type": "string"
},
"isOrganization": {
"description": "Whether the member is an organization.",
"type": [
"boolean",
"null"
]
},
"userhash": {
"description": "The member's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the member.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"type": "array"
},
"modelsCount": {
"description": "[DEPRECATED] The number of models in a Use Case.",
"type": "integer",
"x-versiondeprecated": "v2.34"
},
"name": {
"description": "The name of the Use Case.",
"type": "string"
},
"notebooksCount": {
"description": "The number of notebooks in a Use Case.",
"type": "integer"
},
"owners": {
"description": "The list of owners of a use case.",
"items": {
"properties": {
"email": {
"description": "The email address of the member.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the member.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the member.",
"type": "string"
},
"isOrganization": {
"description": "Whether the member is an organization.",
"type": [
"boolean",
"null"
]
},
"userhash": {
"description": "The member's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the member.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"type": "array"
},
"primaryRiskAssessment": {
"description": "Risk assessment defined as primary the current Use Case.",
"properties": {
"createdAt": {
"description": "The creation date of the risk assessment.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the risk assessment.",
"type": "string"
},
"description": {
"description": "The description of the risk assessment.",
"type": "string"
},
"evidence": {
"description": "The evidence for the risk assessment.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the risk assessment.",
"type": "string"
},
"isPrimary": {
"default": false,
"description": "Determines if the risk assessment is primary.",
"type": "boolean"
},
"mitigationPlan": {
"description": "The mitigation plan for the risk assessment.",
"type": [
"string",
"null"
]
},
"name": {
"description": "The name of the risk assessment.",
"type": "string"
},
"riskLevel": {
"description": "The name of the risk assessment level.",
"type": "string"
},
"tenantId": {
"description": "The tenant ID related to the risk assessment.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "The last updated date of the risk assessment.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who updated the risk assessment.",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"description",
"evidence",
"id",
"isPrimary",
"mitigationPlan",
"name",
"tenantId",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.36"
},
"projectsCount": {
"description": "The number of projects in a Use Case.",
"type": "integer"
},
"recipesCount": {
"description": "The number of recipes in a Use Case.",
"type": "integer",
"x-versionadded": "v2.33"
},
"registeredModelVersionsCount": {
"description": "The number of registered models referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"riskAssessments": {
"description": "The ID List of the Risk Assessments.",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.36"
},
"role": {
"description": "The requesting user's role on this Use Case.",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER"
],
"type": "string"
},
"tenantId": {
"description": "The ID of the tenant to associate this organization with.",
"type": [
"string",
"null"
]
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated when the record was last updated.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"valueTracker": {
"description": "The value tracker information.",
"properties": {
"accuracyHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the accuracy."
},
"businessImpact": {
"description": "The expected effects on overall business operations.",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The ID for this comment.",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "The value tracker description.",
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the value tracker can be accomplished across multiple dimensions.",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The ID of the ValueTracker.",
"type": "string"
},
"inProductionWarning": {
"description": "An optional warning to indicate that deployments are attached to this value tracker.",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "The list of user objects.",
"items": {
"description": "DataRobot user information.",
"properties": {
"firstName": {
"description": "The first name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DataRobot user ID.",
"type": "string"
},
"lastName": {
"description": "The last name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the ValueTracker owner.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"modelHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the model."
},
"name": {
"description": "The name of the value tracker.",
"type": "string"
},
"notes": {
"description": "The user notes.",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information.",
"properties": {
"firstName": {
"description": "The first name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DataRobot user ID.",
"type": "string"
},
"lastName": {
"description": "The last name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the ValueTracker owner.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "The permissions of the current user.",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional. Contains MonetaryValue objects.",
"properties": {
"currency": {
"description": "The ISO code of the currency.",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes.",
"type": [
"string",
"null"
]
},
"value": {
"description": "The amount of value.",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "The estimated cost of an individual incorrect decision.",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "The estimated number of incorrect decisions per year.",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "The value tracker value template type.",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"targetValue": {
"description": "The target value.",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "The value tracker value template type.",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Optional. Contains the template type and parameter information."
},
"predictionTargets": {
"description": "An array of prediction target name strings.",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"predictionsCount": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"description": "The list of prediction counts.",
"items": {
"type": "integer"
},
"type": "array"
}
],
"description": "The count of the number of predictions made."
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional. Contains MonetaryValue objects.",
"properties": {
"currency": {
"description": "The ISO code of the currency.",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes.",
"type": [
"string",
"null"
]
},
"value": {
"description": "The amount of value.",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Optional. Contains MonetaryValue objects."
},
"serviceHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the service."
},
"stage": {
"description": "The current stage of the value tracker.",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "The array of TargetDate objects.",
"items": {
"properties": {
"date": {
"description": "The date of the target.",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "The name of the target stage.",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"valueTrackerId": {
"description": "The ID of the Value Tracker.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"applicationsCount",
"created",
"createdAt",
"customApplicationsCount",
"customJobsCount",
"customModelVersionsCount",
"datasetsCount",
"deploymentsCount",
"description",
"filesCount",
"id",
"members",
"name",
"notebooksCount",
"projectsCount",
"recipesCount",
"registeredModelVersionsCount",
"role",
"tenantId",
"updated",
"updatedAt"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
The use cases were retrieved successfully. |
UseCaseListResponse |
| 403 |
Forbidden |
User does not have access to this functionality. |
None |
Get a use case
Operation path: POST /api/v2/useCases/
Authentication requirements: BearerAuth
Look up a use case.
Body parameter
{
"properties": {
"advancedTour": {
"description": "Advanced tour key.",
"enum": [
"flightDelays",
"hospital"
],
"type": [
"string",
"null"
]
},
"description": {
"default": null,
"description": "The description of the Use Case.",
"type": [
"string",
"null"
]
},
"name": {
"default": null,
"description": "The name of the Use Case.",
"maxLength": 100,
"type": [
"string",
"null"
]
}
},
"type": "object"
}
Parameters
| Name |
In |
Type |
Required |
Description |
| body |
body |
UseCaseCreate |
false |
none |
Example responses
200 Response
{
"properties": {
"advancedTour": {
"description": "Advanced tour key.",
"type": [
"string",
"null"
]
},
"applicationsCount": {
"description": "The number of applications in a Use Case.",
"type": "integer"
},
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"customApplicationsCount": {
"description": "The number of custom applications referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"customJobsCount": {
"description": "The number of custom jobs referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"customModelVersionsCount": {
"description": "The number of custom models referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"datasetsCount": {
"description": "The number of datasets in a Use Case.",
"type": "integer"
},
"deploymentsCount": {
"description": "The number of deployments referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"description": {
"description": "The description of the Use Case.",
"type": [
"string",
"null"
]
},
"filesCount": {
"description": "The number of files in a Use Case.",
"type": "integer",
"x-versionadded": "v2.37"
},
"formattedDescription": {
"description": "The formatted description of the experiment container used as styled description.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the Use Case.",
"type": "string"
},
"members": {
"description": "The list of use case members.",
"items": {
"properties": {
"email": {
"description": "The email address of the member.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the member.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the member.",
"type": "string"
},
"isOrganization": {
"description": "Whether the member is an organization.",
"type": [
"boolean",
"null"
]
},
"userhash": {
"description": "The member's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the member.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"type": "array"
},
"modelsCount": {
"description": "[DEPRECATED] The number of models in a Use Case.",
"type": "integer",
"x-versiondeprecated": "v2.34"
},
"name": {
"description": "The name of the Use Case.",
"type": "string"
},
"notebooksCount": {
"description": "The number of notebooks in a Use Case.",
"type": "integer"
},
"owners": {
"description": "The list of owners of a use case.",
"items": {
"properties": {
"email": {
"description": "The email address of the member.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the member.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the member.",
"type": "string"
},
"isOrganization": {
"description": "Whether the member is an organization.",
"type": [
"boolean",
"null"
]
},
"userhash": {
"description": "The member's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the member.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"type": "array"
},
"primaryRiskAssessment": {
"description": "Risk assessment defined as primary the current Use Case.",
"properties": {
"createdAt": {
"description": "The creation date of the risk assessment.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the risk assessment.",
"type": "string"
},
"description": {
"description": "The description of the risk assessment.",
"type": "string"
},
"evidence": {
"description": "The evidence for the risk assessment.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the risk assessment.",
"type": "string"
},
"isPrimary": {
"default": false,
"description": "Determines if the risk assessment is primary.",
"type": "boolean"
},
"mitigationPlan": {
"description": "The mitigation plan for the risk assessment.",
"type": [
"string",
"null"
]
},
"name": {
"description": "The name of the risk assessment.",
"type": "string"
},
"riskLevel": {
"description": "The name of the risk assessment level.",
"type": "string"
},
"tenantId": {
"description": "The tenant ID related to the risk assessment.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "The last updated date of the risk assessment.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who updated the risk assessment.",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"description",
"evidence",
"id",
"isPrimary",
"mitigationPlan",
"name",
"tenantId",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.36"
},
"projectsCount": {
"description": "The number of projects in a Use Case.",
"type": "integer"
},
"recipesCount": {
"description": "The number of recipes in a Use Case.",
"type": "integer",
"x-versionadded": "v2.33"
},
"registeredModelVersionsCount": {
"description": "The number of registered models referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"riskAssessments": {
"description": "The ID List of the Risk Assessments.",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.36"
},
"role": {
"description": "The requesting user's role on this Use Case.",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER"
],
"type": "string"
},
"tenantId": {
"description": "The ID of the tenant to associate this organization with.",
"type": [
"string",
"null"
]
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated when the record was last updated.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"valueTracker": {
"description": "The value tracker information.",
"properties": {
"accuracyHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the accuracy."
},
"businessImpact": {
"description": "The expected effects on overall business operations.",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The ID for this comment.",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "The value tracker description.",
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the value tracker can be accomplished across multiple dimensions.",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The ID of the ValueTracker.",
"type": "string"
},
"inProductionWarning": {
"description": "An optional warning to indicate that deployments are attached to this value tracker.",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "The list of user objects.",
"items": {
"description": "DataRobot user information.",
"properties": {
"firstName": {
"description": "The first name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DataRobot user ID.",
"type": "string"
},
"lastName": {
"description": "The last name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the ValueTracker owner.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"modelHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the model."
},
"name": {
"description": "The name of the value tracker.",
"type": "string"
},
"notes": {
"description": "The user notes.",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information.",
"properties": {
"firstName": {
"description": "The first name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DataRobot user ID.",
"type": "string"
},
"lastName": {
"description": "The last name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the ValueTracker owner.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "The permissions of the current user.",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional. Contains MonetaryValue objects.",
"properties": {
"currency": {
"description": "The ISO code of the currency.",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes.",
"type": [
"string",
"null"
]
},
"value": {
"description": "The amount of value.",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "The estimated cost of an individual incorrect decision.",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "The estimated number of incorrect decisions per year.",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "The value tracker value template type.",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"targetValue": {
"description": "The target value.",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "The value tracker value template type.",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Optional. Contains the template type and parameter information."
},
"predictionTargets": {
"description": "An array of prediction target name strings.",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"predictionsCount": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"description": "The list of prediction counts.",
"items": {
"type": "integer"
},
"type": "array"
}
],
"description": "The count of the number of predictions made."
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional. Contains MonetaryValue objects.",
"properties": {
"currency": {
"description": "The ISO code of the currency.",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes.",
"type": [
"string",
"null"
]
},
"value": {
"description": "The amount of value.",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Optional. Contains MonetaryValue objects."
},
"serviceHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the service."
},
"stage": {
"description": "The current stage of the value tracker.",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "The array of TargetDate objects.",
"items": {
"properties": {
"date": {
"description": "The date of the target.",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "The name of the target stage.",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"valueTrackerId": {
"description": "The ID of the Value Tracker.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"applicationsCount",
"created",
"createdAt",
"customApplicationsCount",
"customJobsCount",
"customModelVersionsCount",
"datasetsCount",
"deploymentsCount",
"description",
"filesCount",
"id",
"members",
"name",
"notebooksCount",
"projectsCount",
"recipesCount",
"registeredModelVersionsCount",
"role",
"tenantId",
"updated",
"updatedAt"
],
"type": "object"
}
Responses
Get the list of the references associated
Operation path: GET /api/v2/useCases/allResources/
Authentication requirements: BearerAuth
Get a list of the all used assets associated with a Use Case.
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
false |
The 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. |
| recipeStatus |
query |
any |
false |
The recipe status used for filtering recipes. |
Enumerated Values
| Parameter |
Value |
| sort |
[-entityType, -lastActivity, -name, -updatedAt, -updatedBy, entityType, lastActivity, name, updatedAt, updatedBy] |
| orderBy |
[-entityType, -lastActivity, -name, -updatedAt, -updatedBy, entityType, lastActivity, name, updatedAt, updatedBy] |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer",
"x-versionadded": "v2.33"
},
"data": {
"description": "The list of the use case references that match the query.",
"items": {
"properties": {
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary ID of the entity.",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity ID.",
"type": "string"
},
"id": {
"description": "The ID of the Use Case reference.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"metadata": {
"description": "The reference metadata for the use case.",
"oneOf": [
{
"properties": {
"isDraft": {
"description": "Indicates whether the experiment configuration has been used for modeling and is therefore locked (False) or whether the setup has not been applied , and as a draft, can still be modified and used in training (True).",
"type": "boolean"
},
"isErrored": {
"description": "Indicates whether the experiment failed.",
"type": "boolean"
},
"isWorkbenchEligible": {
"description": "Indicates whether the experiment is Workbench-compatible.",
"type": "boolean"
},
"stage": {
"description": "Stage of the experiment.",
"type": "string",
"x-versionadded": "v2.34"
},
"statusErrorMessage": {
"description": "The experiment failure explanation.",
"type": "string"
}
},
"required": [
"isDraft",
"isErrored",
"isWorkbenchEligible",
"stage",
"statusErrorMessage"
],
"type": "object"
},
{
"properties": {
"dataSourceType": {
"description": "The type of the data source used to create the dataset if relevant.",
"type": [
"string",
"null"
]
},
"datasetSize": {
"description": "The size of the dataset in bytes.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.34"
},
"datasetSourceType": {
"description": "The source type of the dataset",
"type": [
"string",
"null"
]
},
"isSnapshot": {
"description": "Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.",
"type": "boolean"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean"
},
"latestRecipeId": {
"description": "The latest recipe ID linked to the dataset.",
"type": [
"string",
"null"
]
}
},
"required": [
"dataSourceType",
"datasetSize",
"datasetSourceType",
"isSnapshot",
"isWranglingEligible",
"latestRecipeId"
],
"type": "object"
},
{
"properties": {
"dataType": {
"description": "The type of the recipe (wrangling or feature discovery)",
"enum": [
"static",
"Static",
"STATIC",
"snapshot",
"Snapshot",
"SNAPSHOT",
"dynamic",
"Dynamic",
"DYNAMIC",
"sqlRecipe",
"SqlRecipe",
"SQL_RECIPE",
"wranglingRecipe",
"WranglingRecipe",
"WRANGLING_RECIPE",
"featureDiscoveryRecipe",
"FeatureDiscoveryRecipe",
"FEATURE_DISCOVERY_RECIPE"
],
"type": [
"string",
"null"
]
}
},
"required": [
"dataType"
],
"type": "object"
},
{
"properties": {
"description": {
"description": "The description of the playground.",
"type": "string"
},
"playgroundType": {
"description": "The type of the playground.",
"type": "string",
"x-versionadded": "v2.37"
}
},
"required": [
"description"
],
"type": "object"
},
{
"properties": {
"errorMessage": {
"description": "The error message, if any, for the vector database.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.38"
},
"source": {
"description": "The source of the vector database",
"type": "string"
}
},
"required": [
"errorMessage",
"source"
],
"type": "object",
"x-versionadded": "v2.37"
},
{
"properties": {
"dataSourceType": {
"description": "The data source type used to create the file if relevant.",
"type": [
"string",
"null"
]
},
"fileSourceType": {
"description": "The source type of the file.",
"type": [
"string",
"null"
]
},
"numFiles": {
"description": "The number of files in the catalog item.",
"type": [
"integer",
"null"
]
}
},
"required": [
"dataSourceType",
"fileSourceType",
"numFiles"
],
"type": "object",
"x-versionadded": "v2.37"
}
]
},
"name": {
"description": "The name of the Use Case reference.",
"type": "string"
},
"processingState": {
"description": "The current ingestion process state of the dataset.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string"
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the linked use case.",
"type": "string"
},
"useCaseName": {
"description": "The name of the linked use case.",
"type": [
"string",
"null"
]
},
"userHasAccess": {
"description": "Identifies if a user has access to the entity.",
"type": [
"boolean",
"null"
],
"x-versionadded": "v2.36"
},
"versions": {
"description": "The list of entity versions.",
"items": {
"properties": {
"createdAt": {
"description": "Time when this entity was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"id": {
"description": "The id of the entity version.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"name": {
"description": "The name of the entity version.",
"type": "string"
},
"registeredModelVersion": {
"description": "The version number of the entity version.",
"type": "integer"
},
"updatedAt": {
"description": "Time when the last update occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"lastActivity",
"name",
"registeredModelVersion",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.36"
}
},
"required": [
"entityId",
"entityType",
"id",
"name",
"updatedAt",
"useCaseId"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer",
"x-versionadded": "v2.33"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
Get the list of the notebooks
Operation path: GET /api/v2/useCases/notebooks/
Authentication requirements: BearerAuth
Get the list of the notebooks from all use cases.
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. |
| includeName |
query |
boolean |
false |
Include use case name. |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of the notebooks in this use case.",
"items": {
"properties": {
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at notebook creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary id of the entity (same as ID of the notebook).",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity id.",
"enum": [
"notebook"
],
"type": "string"
},
"experimentContainerId": {
"description": "[DEPRECATED - replaced with use_case_id] The ID of the Use Case.",
"type": "string",
"x-versiondeprecated": "v2.32"
},
"id": {
"description": "The ID of the notebook.",
"type": "string"
},
"isDeleted": {
"description": "Soft deletion flag for notebooks",
"type": "boolean"
},
"referenceId": {
"description": "Original ID from DB",
"type": "string"
},
"tenantId": {
"description": "The id of the tenant the notebook belongs to.",
"type": [
"string",
"null"
]
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the Use Case.",
"type": "string"
},
"useCaseName": {
"description": "Use Case name",
"type": "string"
}
},
"required": [
"created",
"createdAt",
"entityId",
"entityType",
"experimentContainerId",
"id",
"isDeleted",
"referenceId",
"tenantId",
"useCaseId"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
Delete a use case by use case ID
Operation path: DELETE /api/v2/useCases/{useCaseId}/
Authentication requirements: BearerAuth
Delete a use case.
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 |
Get a use case by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/
Authentication requirements: BearerAuth
Retrieve a single Use Case.
Parameters
| Name |
In |
Type |
Required |
Description |
| useCaseId |
path |
string |
true |
The ID of the use case to update. |
Example responses
200 Response
{
"properties": {
"advancedTour": {
"description": "Advanced tour key.",
"type": [
"string",
"null"
]
},
"applicationsCount": {
"description": "The number of applications in a Use Case.",
"type": "integer"
},
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"customApplicationsCount": {
"description": "The number of custom applications referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"customJobsCount": {
"description": "The number of custom jobs referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"customModelVersionsCount": {
"description": "The number of custom models referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"datasetsCount": {
"description": "The number of datasets in a Use Case.",
"type": "integer"
},
"deploymentsCount": {
"description": "The number of deployments referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"description": {
"description": "The description of the Use Case.",
"type": [
"string",
"null"
]
},
"filesCount": {
"description": "The number of files in a Use Case.",
"type": "integer",
"x-versionadded": "v2.37"
},
"formattedDescription": {
"description": "The formatted description of the experiment container used as styled description.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the Use Case.",
"type": "string"
},
"members": {
"description": "The list of use case members.",
"items": {
"properties": {
"email": {
"description": "The email address of the member.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the member.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the member.",
"type": "string"
},
"isOrganization": {
"description": "Whether the member is an organization.",
"type": [
"boolean",
"null"
]
},
"userhash": {
"description": "The member's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the member.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"type": "array"
},
"modelsCount": {
"description": "[DEPRECATED] The number of models in a Use Case.",
"type": "integer",
"x-versiondeprecated": "v2.34"
},
"name": {
"description": "The name of the Use Case.",
"type": "string"
},
"notebooksCount": {
"description": "The number of notebooks in a Use Case.",
"type": "integer"
},
"owners": {
"description": "The list of owners of a use case.",
"items": {
"properties": {
"email": {
"description": "The email address of the member.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the member.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the member.",
"type": "string"
},
"isOrganization": {
"description": "Whether the member is an organization.",
"type": [
"boolean",
"null"
]
},
"userhash": {
"description": "The member's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the member.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"type": "array"
},
"primaryRiskAssessment": {
"description": "Risk assessment defined as primary the current Use Case.",
"properties": {
"createdAt": {
"description": "The creation date of the risk assessment.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the risk assessment.",
"type": "string"
},
"description": {
"description": "The description of the risk assessment.",
"type": "string"
},
"evidence": {
"description": "The evidence for the risk assessment.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the risk assessment.",
"type": "string"
},
"isPrimary": {
"default": false,
"description": "Determines if the risk assessment is primary.",
"type": "boolean"
},
"mitigationPlan": {
"description": "The mitigation plan for the risk assessment.",
"type": [
"string",
"null"
]
},
"name": {
"description": "The name of the risk assessment.",
"type": "string"
},
"riskLevel": {
"description": "The name of the risk assessment level.",
"type": "string"
},
"tenantId": {
"description": "The tenant ID related to the risk assessment.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "The last updated date of the risk assessment.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who updated the risk assessment.",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"description",
"evidence",
"id",
"isPrimary",
"mitigationPlan",
"name",
"tenantId",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.36"
},
"projectsCount": {
"description": "The number of projects in a Use Case.",
"type": "integer"
},
"recipesCount": {
"description": "The number of recipes in a Use Case.",
"type": "integer",
"x-versionadded": "v2.33"
},
"registeredModelVersionsCount": {
"description": "The number of registered models referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"riskAssessments": {
"description": "The ID List of the Risk Assessments.",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.36"
},
"role": {
"description": "The requesting user's role on this Use Case.",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER"
],
"type": "string"
},
"tenantId": {
"description": "The ID of the tenant to associate this organization with.",
"type": [
"string",
"null"
]
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated when the record was last updated.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"valueTracker": {
"description": "The value tracker information.",
"properties": {
"accuracyHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the accuracy."
},
"businessImpact": {
"description": "The expected effects on overall business operations.",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The ID for this comment.",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "The value tracker description.",
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the value tracker can be accomplished across multiple dimensions.",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The ID of the ValueTracker.",
"type": "string"
},
"inProductionWarning": {
"description": "An optional warning to indicate that deployments are attached to this value tracker.",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "The list of user objects.",
"items": {
"description": "DataRobot user information.",
"properties": {
"firstName": {
"description": "The first name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DataRobot user ID.",
"type": "string"
},
"lastName": {
"description": "The last name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the ValueTracker owner.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"modelHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the model."
},
"name": {
"description": "The name of the value tracker.",
"type": "string"
},
"notes": {
"description": "The user notes.",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information.",
"properties": {
"firstName": {
"description": "The first name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DataRobot user ID.",
"type": "string"
},
"lastName": {
"description": "The last name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the ValueTracker owner.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "The permissions of the current user.",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional. Contains MonetaryValue objects.",
"properties": {
"currency": {
"description": "The ISO code of the currency.",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes.",
"type": [
"string",
"null"
]
},
"value": {
"description": "The amount of value.",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "The estimated cost of an individual incorrect decision.",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "The estimated number of incorrect decisions per year.",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "The value tracker value template type.",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"targetValue": {
"description": "The target value.",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "The value tracker value template type.",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Optional. Contains the template type and parameter information."
},
"predictionTargets": {
"description": "An array of prediction target name strings.",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"predictionsCount": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"description": "The list of prediction counts.",
"items": {
"type": "integer"
},
"type": "array"
}
],
"description": "The count of the number of predictions made."
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional. Contains MonetaryValue objects.",
"properties": {
"currency": {
"description": "The ISO code of the currency.",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes.",
"type": [
"string",
"null"
]
},
"value": {
"description": "The amount of value.",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Optional. Contains MonetaryValue objects."
},
"serviceHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the service."
},
"stage": {
"description": "The current stage of the value tracker.",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "The array of TargetDate objects.",
"items": {
"properties": {
"date": {
"description": "The date of the target.",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "The name of the target stage.",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"valueTrackerId": {
"description": "The ID of the Value Tracker.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"applicationsCount",
"created",
"createdAt",
"customApplicationsCount",
"customJobsCount",
"customModelVersionsCount",
"datasetsCount",
"deploymentsCount",
"description",
"filesCount",
"id",
"members",
"name",
"notebooksCount",
"projectsCount",
"recipesCount",
"registeredModelVersionsCount",
"role",
"tenantId",
"updated",
"updatedAt"
],
"type": "object"
}
Responses
Update a Use Case by use case ID
Operation path: PATCH /api/v2/useCases/{useCaseId}/
Authentication requirements: BearerAuth
Update a Use Case.
Body parameter
{
"properties": {
"description": {
"description": "The description of the Use Case.",
"type": [
"string",
"null"
]
},
"name": {
"description": "The name of the Use Case.",
"maxLength": 100,
"type": [
"string",
"null"
]
}
},
"type": "object"
}
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
{
"properties": {
"advancedTour": {
"description": "Advanced tour key.",
"type": [
"string",
"null"
]
},
"applicationsCount": {
"description": "The number of applications in a Use Case.",
"type": "integer"
},
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"customApplicationsCount": {
"description": "The number of custom applications referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"customJobsCount": {
"description": "The number of custom jobs referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"customModelVersionsCount": {
"description": "The number of custom models referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"datasetsCount": {
"description": "The number of datasets in a Use Case.",
"type": "integer"
},
"deploymentsCount": {
"description": "The number of deployments referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"description": {
"description": "The description of the Use Case.",
"type": [
"string",
"null"
]
},
"filesCount": {
"description": "The number of files in a Use Case.",
"type": "integer",
"x-versionadded": "v2.37"
},
"formattedDescription": {
"description": "The formatted description of the experiment container used as styled description.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the Use Case.",
"type": "string"
},
"members": {
"description": "The list of use case members.",
"items": {
"properties": {
"email": {
"description": "The email address of the member.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the member.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the member.",
"type": "string"
},
"isOrganization": {
"description": "Whether the member is an organization.",
"type": [
"boolean",
"null"
]
},
"userhash": {
"description": "The member's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the member.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"type": "array"
},
"modelsCount": {
"description": "[DEPRECATED] The number of models in a Use Case.",
"type": "integer",
"x-versiondeprecated": "v2.34"
},
"name": {
"description": "The name of the Use Case.",
"type": "string"
},
"notebooksCount": {
"description": "The number of notebooks in a Use Case.",
"type": "integer"
},
"owners": {
"description": "The list of owners of a use case.",
"items": {
"properties": {
"email": {
"description": "The email address of the member.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the member.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the member.",
"type": "string"
},
"isOrganization": {
"description": "Whether the member is an organization.",
"type": [
"boolean",
"null"
]
},
"userhash": {
"description": "The member's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the member.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"type": "array"
},
"primaryRiskAssessment": {
"description": "Risk assessment defined as primary the current Use Case.",
"properties": {
"createdAt": {
"description": "The creation date of the risk assessment.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the risk assessment.",
"type": "string"
},
"description": {
"description": "The description of the risk assessment.",
"type": "string"
},
"evidence": {
"description": "The evidence for the risk assessment.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the risk assessment.",
"type": "string"
},
"isPrimary": {
"default": false,
"description": "Determines if the risk assessment is primary.",
"type": "boolean"
},
"mitigationPlan": {
"description": "The mitigation plan for the risk assessment.",
"type": [
"string",
"null"
]
},
"name": {
"description": "The name of the risk assessment.",
"type": "string"
},
"riskLevel": {
"description": "The name of the risk assessment level.",
"type": "string"
},
"tenantId": {
"description": "The tenant ID related to the risk assessment.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "The last updated date of the risk assessment.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who updated the risk assessment.",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"description",
"evidence",
"id",
"isPrimary",
"mitigationPlan",
"name",
"tenantId",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.36"
},
"projectsCount": {
"description": "The number of projects in a Use Case.",
"type": "integer"
},
"recipesCount": {
"description": "The number of recipes in a Use Case.",
"type": "integer",
"x-versionadded": "v2.33"
},
"registeredModelVersionsCount": {
"description": "The number of registered models referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"riskAssessments": {
"description": "The ID List of the Risk Assessments.",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.36"
},
"role": {
"description": "The requesting user's role on this Use Case.",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER"
],
"type": "string"
},
"tenantId": {
"description": "The ID of the tenant to associate this organization with.",
"type": [
"string",
"null"
]
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated when the record was last updated.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"valueTracker": {
"description": "The value tracker information.",
"properties": {
"accuracyHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the accuracy."
},
"businessImpact": {
"description": "The expected effects on overall business operations.",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The ID for this comment.",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "The value tracker description.",
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the value tracker can be accomplished across multiple dimensions.",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The ID of the ValueTracker.",
"type": "string"
},
"inProductionWarning": {
"description": "An optional warning to indicate that deployments are attached to this value tracker.",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "The list of user objects.",
"items": {
"description": "DataRobot user information.",
"properties": {
"firstName": {
"description": "The first name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DataRobot user ID.",
"type": "string"
},
"lastName": {
"description": "The last name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the ValueTracker owner.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"modelHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the model."
},
"name": {
"description": "The name of the value tracker.",
"type": "string"
},
"notes": {
"description": "The user notes.",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information.",
"properties": {
"firstName": {
"description": "The first name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DataRobot user ID.",
"type": "string"
},
"lastName": {
"description": "The last name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the ValueTracker owner.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "The permissions of the current user.",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional. Contains MonetaryValue objects.",
"properties": {
"currency": {
"description": "The ISO code of the currency.",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes.",
"type": [
"string",
"null"
]
},
"value": {
"description": "The amount of value.",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "The estimated cost of an individual incorrect decision.",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "The estimated number of incorrect decisions per year.",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "The value tracker value template type.",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"targetValue": {
"description": "The target value.",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "The value tracker value template type.",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Optional. Contains the template type and parameter information."
},
"predictionTargets": {
"description": "An array of prediction target name strings.",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"predictionsCount": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"description": "The list of prediction counts.",
"items": {
"type": "integer"
},
"type": "array"
}
],
"description": "The count of the number of predictions made."
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional. Contains MonetaryValue objects.",
"properties": {
"currency": {
"description": "The ISO code of the currency.",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes.",
"type": [
"string",
"null"
]
},
"value": {
"description": "The amount of value.",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Optional. Contains MonetaryValue objects."
},
"serviceHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the service."
},
"stage": {
"description": "The current stage of the value tracker.",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "The array of TargetDate objects.",
"items": {
"properties": {
"date": {
"description": "The date of the target.",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "The name of the target stage.",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"valueTrackerId": {
"description": "The ID of the Value Tracker.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"applicationsCount",
"created",
"createdAt",
"customApplicationsCount",
"customJobsCount",
"customModelVersionsCount",
"datasetsCount",
"deploymentsCount",
"description",
"filesCount",
"id",
"members",
"name",
"notebooksCount",
"projectsCount",
"recipesCount",
"registeredModelVersionsCount",
"role",
"tenantId",
"updated",
"updatedAt"
],
"type": "object"
}
Responses
Get the list of the applications associated by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/applications/
Authentication requirements: BearerAuth
Get the list of the applications associated with a use case.
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
false |
The 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, -createdAt, -lastActivity, -name, -source, -updatedAt, -userId, applicationTemplateType, createdAt, lastActivity, name, source, updatedAt, userId] |
| orderBy |
[-applicationTemplateType, -createdAt, -lastActivity, -name, -source, -updatedAt, -userId, applicationTemplateType, createdAt, lastActivity, name, source, updatedAt, userId] |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of the applications in this use case.",
"items": {
"properties": {
"applicationId": {
"description": "The application id of the application.",
"type": "string"
},
"applicationTemplateType": {
"description": "The type of the application.",
"type": [
"string",
"null"
]
},
"createdAt": {
"description": "The timestamp generated at application creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"description": {
"description": "The description of the application.",
"type": [
"string",
"null"
]
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"projectId": {
"description": "The ID of the associated project",
"type": [
"string",
"null"
]
},
"source": {
"description": "The source used to create the application.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "The timestamp generated at application modification.",
"format": "date-time",
"type": "string"
}
},
"required": [
"applicationId",
"applicationTemplateType",
"createdAt",
"createdBy",
"description",
"lastActivity",
"name",
"projectId",
"source",
"updatedAt"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
The list of the custom applications referenced by a use case by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/customApplications/
Authentication requirements: BearerAuth
The list of the custom applications referenced by a use case.
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
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of custom applications.",
"items": {
"properties": {
"applicationUrl": {
"description": "The reachable URL of the custom application.",
"type": "string",
"x-versionadded": "v2.35"
},
"createdAt": {
"description": "The time when this model was created.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.35"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"customApplicationSourceId": {
"description": "The ID of the custom application source.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.39"
},
"id": {
"description": "The ID of the custom application.",
"type": "string"
},
"lastActivity": {
"description": "The type of the last activity. Can be \"Added\" or \"Modified\".",
"enum": [
"created",
"Created",
"CREATED",
"modified",
"Modified",
"MODIFIED"
],
"type": "string"
},
"name": {
"description": "The name of the custom application.",
"type": "string"
},
"permissions": {
"description": "The list of permissions available for the user.",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.39"
},
"status": {
"description": "The status of the custom application.",
"type": "string",
"x-versionadded": "v2.35"
},
"updatedAt": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"userHasAccess": {
"description": "Indicates if a user has access to this custom application.",
"type": "boolean",
"x-versionadded": "v2.35"
}
},
"required": [
"id"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.35"
}
Responses
List datasets by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/data/
Authentication requirements: BearerAuth
Get a list of the data (datasets and recipes) associated with a use case.
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
false |
The 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 |
true |
Sorting order which will be applied to data list. |
| search |
query |
string |
false |
Only return datasets or recipes from use case with names that match the given string. |
| dataType |
query |
any |
false |
Data types used for filtering. |
| dataSourceType |
query |
any |
false |
The driver class type of the recipe wrangling engine. |
| recipeStatus |
query |
any |
false |
The recipe status used for filtering recipes. |
| creatorUserId |
query |
any |
false |
Filter results to display only those created by user(s) identified by the specified ID |
| creatorUsername |
query |
any |
false |
Filter results to display only those created by user(s) identified by the specified username |
| useCaseId |
path |
string |
true |
The ID of the use case. |
Enumerated Values
| Parameter |
Value |
| orderBy |
[name, -name, description, -description, createdBy, -createdBy, modifiedAt, -modifiedAt, dataType, -dataType, dataSourceType, -dataSourceType, rowCount, -rowCount, columnCount, -columnCount, datasetSize, -datasetSize] |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer",
"x-versionadded": "v2.33"
},
"data": {
"description": "The list of the datasets in this use case.",
"items": {
"properties": {
"columnCount": {
"description": "The number of columns in a dataset. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"dataSourceType": {
"description": "The driver class type used to create the dataset if relevant.",
"enum": [
"s3",
"native-s3",
"native-adls",
"adlsgen2",
"oracle",
"iris",
"exasol",
"sap",
"databricks-v1",
"native-databricks",
"bigquery-v1",
"bigquery1",
"bigquery2",
"athena2",
"athena1",
"kdb",
"treasuredata",
"elasticsearch",
"snowflake",
"mysql",
"mssql",
"postgres",
"palantirfoundry",
"teradata",
"redshift",
"datasphere-v1",
"trino-v1",
"native-gdrive",
"native-sharepoint",
"native-confluence",
"native-jira",
"native-box",
"unknown"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"dataType": {
"description": "The type of data entity.",
"enum": [
"static",
"Static",
"STATIC",
"snapshot",
"Snapshot",
"SNAPSHOT",
"dynamic",
"Dynamic",
"DYNAMIC",
"sqlRecipe",
"SqlRecipe",
"SQL_RECIPE",
"wranglingRecipe",
"WranglingRecipe",
"WRANGLING_RECIPE",
"featureDiscoveryRecipe",
"FeatureDiscoveryRecipe",
"FEATURE_DISCOVERY_RECIPE"
],
"type": "string",
"x-versionadded": "v2.33"
},
"datasetSize": {
"description": "The size of the dataset as a CSV in bytes. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the dataset or recipe.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"entityId": {
"description": "The primary ID of the entity.",
"type": "string",
"x-versionadded": "v2.33"
},
"entityType": {
"description": "The type of entity provided by the entity ID.",
"enum": [
"recipe",
"Recipe",
"RECIPE",
"dataset",
"Dataset",
"DATASET",
"project",
"Project",
"PROJECT",
"application",
"Application",
"APPLICATION"
],
"type": "string",
"x-versionadded": "v2.33"
},
"featureDiscoveryProjectId": {
"description": "Related feature discovery project if this is a feature discovery dataset.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean",
"x-versionadded": "v2.33"
},
"latestRecipeId": {
"description": "The latest recipe ID linked to the dataset.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"modifiedAt": {
"description": "The timestamp generated at dataset modification.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "The name of the dataset or recipe.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"processingState": {
"description": "The current ingestion process state of the dataset.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"rowCount": {
"description": "The number of data rows in the dataset. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"columnCount",
"createdBy",
"dataSourceType",
"dataType",
"datasetSize",
"description",
"entityId",
"entityType",
"featureDiscoveryProjectId",
"isWranglingEligible",
"latestRecipeId",
"modifiedAt",
"name",
"processingState",
"rowCount"
],
"type": "object"
},
"type": "array",
"x-versionadded": "v2.33"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer",
"x-versionadded": "v2.33"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
Get the list of the datasets associated by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/datasets/
Authentication requirements: BearerAuth
Get the list of the datasets associated with a use case.
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
false |
The 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, -createdAt, -createdBy, -dataSourceType, -datasetSize, -datasetSourceType, -lastActivity, -modifiedAt, -modifiedBy, -name, -rowCount, columnCount, createdAt, createdBy, dataSourceType, datasetSize, datasetSourceType, lastActivity, modifiedAt, modifiedBy, name, rowCount] |
| orderBy |
[-columnCount, -createdAt, -createdBy, -dataSourceType, -datasetSize, -datasetSourceType, -lastActivity, -modifiedAt, -modifiedBy, -name, -rowCount, columnCount, createdAt, createdBy, dataSourceType, datasetSize, datasetSourceType, lastActivity, modifiedAt, modifiedBy, name, rowCount] |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "A list of the datasets in the Use Case",
"items": {
"properties": {
"columnCount": {
"description": "The number of columns in a dataset. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
]
},
"createdAt": {
"description": "The timestamp generated at dataset creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"dataPersisted": {
"description": "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.",
"type": "boolean"
},
"dataSourceType": {
"description": "The type of the data source used to create the dataset if relevant.",
"type": [
"string",
"null"
]
},
"dataType": {
"description": "The type of data entity.",
"enum": [
"static",
"Static",
"STATIC",
"snapshot",
"Snapshot",
"SNAPSHOT",
"dynamic",
"Dynamic",
"DYNAMIC",
"sqlRecipe",
"SqlRecipe",
"SQL_RECIPE",
"wranglingRecipe",
"WranglingRecipe",
"WRANGLING_RECIPE",
"featureDiscoveryRecipe",
"FeatureDiscoveryRecipe",
"FEATURE_DISCOVERY_RECIPE"
],
"type": "string",
"x-versionadded": "v2.33"
},
"datasetId": {
"description": "The dataset ID of the dataset.",
"type": "string"
},
"datasetSize": {
"description": "The size of the dataset as a CSV in bytes. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
]
},
"datasetSourceType": {
"description": "The source type of the dataset.",
"type": [
"string",
"null"
]
},
"description": {
"description": "The description of the dataset.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"featureDiscoveryProjectId": {
"description": "Related feature discovery project if this is a feature discovery dataset.",
"type": [
"string",
"null"
]
},
"isSnapshot": {
"description": "Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.",
"type": "boolean"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean"
},
"latestRecipeId": {
"description": "The latest recipe ID linked to the dataset.",
"type": [
"string",
"null"
]
},
"modifiedAt": {
"description": "The timestamp generated at dataset modification.",
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"name": {
"description": "The name of the dataset.",
"type": "string"
},
"processingState": {
"description": "The current ingestion process state of the dataset.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string"
},
"referenceMetadata": {
"description": "Metadata about the reference of the dataset in the Use Case.",
"properties": {
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
}
},
"required": [
"createdAt",
"lastActivity"
],
"type": "object"
},
"rowCount": {
"description": "The number of data rows in the dataset. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
]
},
"versionId": {
"description": "The dataset version id of the latest version of the dataset.",
"type": "string"
}
},
"required": [
"columnCount",
"createdAt",
"createdBy",
"dataPersisted",
"dataSourceType",
"dataType",
"datasetId",
"datasetSize",
"datasetSourceType",
"description",
"isSnapshot",
"isWranglingEligible",
"latestRecipeId",
"modifiedAt",
"modifiedBy",
"name",
"processingState",
"referenceMetadata",
"rowCount",
"versionId"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
Get the dataset details by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/datasets/{datasetId}/
Authentication requirements: BearerAuth
Retrieves the details of the dataset with given ID for given use case ID.
Parameters
| Name |
In |
Type |
Required |
Description |
| useCaseId |
path |
string |
true |
The ID linking the use case with the entity type. |
| datasetId |
path |
string |
true |
The ID of the dataset. |
Example responses
200 Response
{
"properties": {
"categories": {
"description": "An array of strings describing the intended use of the dataset.",
"items": {
"description": "The dataset category.",
"enum": [
"BATCH_PREDICTIONS",
"CUSTOM_MODEL_TESTING",
"MULTI_SERIES_CALENDAR",
"PREDICTION",
"SAMPLE",
"SINGLE_SERIES_CALENDAR",
"TRAINING"
],
"type": "string"
},
"type": "array"
},
"columnCount": {
"description": "The number of columns in the dataset.",
"type": "integer",
"x-versionadded": "v2.30"
},
"createdBy": {
"description": "Username of the user who created the dataset.",
"type": [
"string",
"null"
]
},
"creationDate": {
"description": "The date when the dataset was created.",
"format": "date-time",
"type": "string"
},
"dataEngineQueryId": {
"description": "The ID of the source data engine query.",
"type": [
"string",
"null"
]
},
"dataPersisted": {
"description": "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.",
"type": "boolean"
},
"dataSourceId": {
"description": "The ID of the datasource used as the source of the dataset.",
"type": [
"string",
"null"
]
},
"dataSourceType": {
"description": "The type of the datasource that was used as the source of the dataset.",
"type": "string"
},
"datasetId": {
"description": "The ID of this dataset.",
"type": "string"
},
"datasetSize": {
"description": "The size of the dataset as a CSV in bytes.",
"type": "integer",
"x-versionadded": "v2.21"
},
"description": {
"description": "The description of the dataset.",
"type": [
"string",
"null"
]
},
"eda1ModificationDate": {
"description": "The ISO 8601 formatted date and time when the EDA1 for the dataset was updated.",
"format": "date-time",
"type": "string"
},
"eda1ModifierFullName": {
"description": "The user who was the last to update EDA1 for the dataset.",
"type": "string"
},
"entityCountByType": {
"description": "Number of different type entities that use the dataset.",
"properties": {
"numCalendars": {
"description": "The number of calendars that use the dataset",
"type": "integer"
},
"numExperimentContainer": {
"description": "The number of experiment containers that use the dataset.",
"type": "integer",
"x-versionadded": "v2.37"
},
"numExternalModelPackages": {
"description": "The number of external model packages that use the dataset",
"type": "integer"
},
"numFeatureDiscoveryConfigs": {
"description": "The number of feature discovery configs that use the dataset",
"type": "integer"
},
"numPredictionDatasets": {
"description": "The number of prediction datasets that use the dataset",
"type": "integer"
},
"numProjects": {
"description": "The number of projects that use the dataset",
"type": "integer"
},
"numSparkSqlQueries": {
"description": "The number of spark sql queries that use the dataset",
"type": "integer"
}
},
"required": [
"numCalendars",
"numExperimentContainer",
"numExternalModelPackages",
"numFeatureDiscoveryConfigs",
"numPredictionDatasets",
"numProjects",
"numSparkSqlQueries"
],
"type": "object"
},
"error": {
"description": "Details of exception raised during ingestion process, if any.",
"type": "string"
},
"featureCount": {
"description": "Total number of features in the dataset.",
"type": "integer"
},
"featureCountByType": {
"description": "Number of features in the dataset grouped by feature type.",
"items": {
"properties": {
"count": {
"description": "The number of features of this type in the dataset",
"type": "integer"
},
"featureType": {
"description": "The data type grouped in this count",
"type": "string"
}
},
"required": [
"count",
"featureType"
],
"type": "object"
},
"type": "array"
},
"featureDiscoveryProjectId": {
"description": "Feature Discovery project ID used to create the dataset.",
"type": "string",
"x-versionadded": "v2.35"
},
"isDataEngineEligible": {
"description": "Whether this dataset can be a data source of a data engine query.",
"type": "boolean",
"x-versionadded": "v2.20"
},
"isLatestVersion": {
"description": "Whether this dataset version is the latest version of this dataset.",
"type": "boolean"
},
"isSnapshot": {
"description": "Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.",
"type": "boolean"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean",
"x-versionadded": "2.30.0"
},
"lastModificationDate": {
"description": "The ISO 8601 formatted date and time when the dataset was last modified.",
"format": "date-time",
"type": "string"
},
"lastModifierFullName": {
"description": "Full name of user who was the last to modify the dataset.",
"type": "string"
},
"name": {
"description": "The name of this dataset in the catalog.",
"type": "string"
},
"processingState": {
"description": "Current ingestion process state of dataset.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string",
"x-versionadded": "v2.21"
},
"recipeId": {
"description": "The ID of the source recipe.",
"type": [
"string",
"null"
]
},
"rowCount": {
"description": "The number of rows in the dataset.",
"type": "integer",
"x-versionadded": "v2.21"
},
"sampleSize": {
"description": "Ingest size to use during dataset registration. Default behavior is to ingest full dataset.",
"properties": {
"type": {
"description": "The sample size can be specified only as a number of rows for now.",
"enum": [
"rows"
],
"type": "string",
"x-versionadded": "v2.27"
},
"value": {
"description": "Number of rows to ingest during dataset registration.",
"exclusiveMinimum": 0,
"maximum": 1000000,
"type": "integer",
"x-versionadded": "v2.27"
}
},
"required": [
"type",
"value"
],
"type": "object"
},
"tags": {
"description": "List of tags attached to the item.",
"items": {
"type": "string"
},
"type": "array"
},
"timeSeriesProperties": {
"description": "Properties related to time series data prep.",
"properties": {
"isMostlyImputed": {
"default": null,
"description": "Whether more than half of the rows are imputed.",
"type": [
"boolean",
"null"
],
"x-versionadded": "v2.26"
}
},
"required": [
"isMostlyImputed"
],
"type": "object"
},
"uri": {
"description": "The URI to datasource. For example, `file_name.csv`, or `jdbc:DATA_SOURCE_GIVEN_NAME/SCHEMA.TABLE_NAME`, or `jdbc:DATA_SOURCE_GIVEN_NAME/<query>` for `query` based datasources, or`https://s3.amazonaws.com/dr-pr-tst-data/kickcars-sample-200.csv`, etc.",
"type": "string"
},
"versionId": {
"description": "The object ID of the catalog_version the dataset belongs to.",
"type": "string"
}
},
"required": [
"categories",
"columnCount",
"createdBy",
"creationDate",
"dataEngineQueryId",
"dataPersisted",
"dataSourceId",
"dataSourceType",
"datasetId",
"datasetSize",
"description",
"eda1ModificationDate",
"eda1ModifierFullName",
"error",
"featureCount",
"featureCountByType",
"isDataEngineEligible",
"isLatestVersion",
"isSnapshot",
"isWranglingEligible",
"lastModificationDate",
"lastModifierFullName",
"name",
"processingState",
"recipeId",
"rowCount",
"tags",
"timeSeriesProperties",
"uri",
"versionId"
],
"type": "object"
}
Responses
Get the deployments associated by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/deployments/
Authentication requirements: BearerAuth
The list of deployments associated with the use case.
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
false |
The 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 |
true |
The order to sort the use case deployments. |
| search |
query |
string |
false |
Only return deployments from the use case with names that match the given string. |
| useCaseId |
path |
string |
true |
The ID of the use case. |
Enumerated Values
| Parameter |
Value |
| orderBy |
[-createdAt, -createdBy, -lastActivity, -name, -updatedAt, -updatedBy, createdAt, createdBy, lastActivity, name, updatedAt, updatedBy] |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of deployments linked to a use case.",
"items": {
"properties": {
"createdAt": {
"description": "The created date time.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"description": {
"description": "The deployment description.",
"type": "string"
},
"id": {
"description": "Unique identifier of the deployment.",
"type": "string"
},
"label": {
"description": "The deployment label.",
"type": "string"
},
"lastActivity": {
"description": "The type of the last activity. Can be \"Added\" or \"Modified\".",
"enum": [
"created",
"Created",
"CREATED",
"modified",
"Modified",
"MODIFIED"
],
"type": "string",
"x-versionadded": "v2.35"
},
"type": {
"description": "The deployment type.",
"type": "string"
},
"updatedAt": {
"description": "The last modified date time.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"userHasAccess": {
"description": "Indicates if a user has access to this deployment.",
"type": "boolean",
"x-versionadded": "v2.35"
}
},
"required": [
"id"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.35"
}
Responses
Get the list of the catalog files associated by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/files/
Authentication requirements: BearerAuth
Get the list of the catalog files associated with a use case.
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
false |
The 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 |
true |
The order to sort the Use Case files. |
| search |
query |
string |
false |
Only return files from Use Cases with names that match the given string. |
| useCaseId |
path |
string |
true |
The ID of the use case to update. |
Enumerated Values
| Parameter |
Value |
| orderBy |
[-createdAt, -createdBy, -dataSourceType, -fileSourceType, -lastActivity, -modifiedAt, -modifiedBy, -name, -numFiles, createdAt, createdBy, dataSourceType, fileSourceType, lastActivity, modifiedAt, modifiedBy, name, numFiles] |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "A list of the files in the Use Case.",
"items": {
"properties": {
"createdAt": {
"description": "The timestamp generated at file creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"dataSourceType": {
"description": "The type of the data source used to create the file (if relevant).",
"type": [
"string",
"null"
]
},
"description": {
"description": "The description of the file.",
"type": [
"string",
"null"
]
},
"fileId": {
"description": "The file ID.",
"type": "string"
},
"fileSourceType": {
"description": "The source type of the file.",
"type": [
"string",
"null"
]
},
"modifiedAt": {
"description": "The timestamp generated at file modification.",
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"name": {
"description": "The name of the file.",
"type": "string"
},
"numFiles": {
"description": "The number of files in catalog item. ``null`` might be returned in cases where the file is in a running or errored state.",
"type": [
"integer",
"null"
]
},
"processingState": {
"description": "Current ingestion process state of file.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string"
},
"referenceMetadata": {
"description": "Metadata about the reference of the dataset in the Use Case.",
"properties": {
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
}
},
"required": [
"createdAt",
"lastActivity"
],
"type": "object"
},
"versionId": {
"description": "The file version ID for the file's latest version.",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"dataSourceType",
"description",
"fileId",
"fileSourceType",
"modifiedAt",
"modifiedBy",
"name",
"numFiles",
"processingState",
"referenceMetadata",
"versionId"
],
"type": "object",
"x-versionadded": "v2.37"
},
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.37"
}
Responses
Get the file details by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/files/{fileId}/
Authentication requirements: BearerAuth
Retrieves the details of the file with given ID for a given Use Case ID.
Parameters
| Name |
In |
Type |
Required |
Description |
| useCaseId |
path |
string |
true |
The ID linking the use case with the entity type. |
| fileId |
path |
string |
true |
The ID of the file. |
Example responses
200 Response
{
"properties": {
"createdBy": {
"description": "Username of the user who created the file.",
"type": [
"string",
"null"
]
},
"creationDate": {
"description": "The date when the file was created.",
"format": "date-time",
"type": "string"
},
"dataSourceId": {
"description": "ID of the data source used as the source of the file.",
"type": [
"string",
"null"
]
},
"dataSourceType": {
"description": "The type of the data source that was used as the source of the file.",
"type": "string"
},
"description": {
"description": "The description of the file.",
"type": [
"string",
"null"
]
},
"entityCountByType": {
"description": "Number of different type entities that use the file.",
"properties": {
"numExperimentContainer": {
"description": "The number of experiment containers that use the file.",
"type": "integer"
}
},
"required": [
"numExperimentContainer"
],
"type": "object",
"x-versionadded": "v2.37"
},
"error": {
"description": "Details of exception raised during ingestion process, if any.",
"type": "string"
},
"fileId": {
"description": "The ID of this file.",
"type": "string"
},
"isLatestVersion": {
"description": "Whether this file version is the latest version of this file.",
"type": "boolean",
"x-versionadded": "v2.37"
},
"lastModificationDate": {
"description": "The ISO 8601 formatted date and time when the file was last modified.",
"format": "date-time",
"type": "string"
},
"lastModifierFullName": {
"description": "Full name of user who was the last to modify the file.",
"type": "string"
},
"name": {
"description": "The name of this file in the catalog.",
"type": "string"
},
"numFiles": {
"description": "The number of files in the file entity.",
"type": "integer"
},
"processingState": {
"description": "Current ingestion process state of file.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string"
},
"tags": {
"description": "List of tags attached to the item.",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
},
"uri": {
"description": "The URI to the data source.",
"type": "string"
},
"versionId": {
"description": "The object ID of the catalog_version the file belongs to.",
"type": "string"
}
},
"required": [
"createdBy",
"creationDate",
"dataSourceId",
"dataSourceType",
"description",
"entityCountByType",
"error",
"fileId",
"isLatestVersion",
"lastModificationDate",
"lastModifierFullName",
"name",
"numFiles",
"processingState",
"tags",
"uri",
"versionId"
],
"type": "object",
"x-versionadded": "v2.37"
}
Responses
Operation path: GET /api/v2/useCases/{useCaseId}/filterMetadata/
Authentication requirements: BearerAuth
Get filtering metadata information from Use Cases associated with a Use Case.
| Name |
In |
Type |
Required |
Description |
| useCaseId |
path |
string |
true |
The ID of the use case. |
Example responses
200 Response
{
"properties": {
"metrics": {
"description": "Model performance evaluation metrics (shorthand abbreviations)",
"properties": {
"binary": {
"description": "Binary metrics associated with the models.",
"items": {
"description": "Binary metric names",
"enum": [
"AUC",
"Weighted AUC",
"Area Under PR Curve",
"Weighted Area Under PR Curve",
"Kolmogorov-Smirnov",
"Weighted Kolmogorov-Smirnov",
"FVE Binomial",
"Weighted FVE Binomial",
"Gini Norm",
"Weighted Gini Norm",
"LogLoss",
"Weighted LogLoss",
"Max MCC",
"Weighted Max MCC",
"Rate@Top5%",
"Weighted Rate@Top5%",
"Rate@Top10%",
"Weighted Rate@Top10%",
"Rate@TopTenth%",
"RMSE",
"Weighted RMSE",
"F1 Score",
"Weighted F1 Score",
"Precision",
"Weighted Precision",
"Recall",
"Weighted Recall"
],
"type": "string"
},
"type": "array"
},
"regression": {
"description": "Regression metrics associated with the models",
"items": {
"description": "Regression metric names",
"enum": [
"FVE Poisson",
"Weighted FVE Poisson",
"FVE Gamma",
"Weighted FVE Gamma",
"FVE Tweedie",
"Weighted FVE Tweedie",
"Gamma Deviance",
"Weighted Gamma Deviance",
"Gini Norm",
"Weighted Gini Norm",
"MAE",
"Weighted MAE",
"MAPE",
"Weighted MAPE",
"SMAPE",
"Weighted SMAPE",
"Poisson Deviance",
"Weighted Poisson Deviance",
"RMSLE",
"RMSE",
"Weighted RMSLE",
"Weighted RMSE",
"R Squared",
"Weighted R Squared",
"Tweedie Deviance",
"Weighted Tweedie Deviance"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"modelFamilies": {
"description": "Model families associated with the models",
"items": {
"properties": {
"fullName": {
"description": "Full name of the model family",
"type": "string"
},
"key": {
"description": "Abbreviated form of model family name",
"enum": [
"AB",
"AD",
"BLENDER",
"CAL",
"CLUSTER",
"COUNT_DICT",
"CUSTOM",
"DOCUMENT",
"DT",
"DUMMY",
"EP",
"EQ",
"EQ_TS",
"FM",
"GAM",
"GBM",
"GLM",
"GLMNET",
"IMAGE",
"KNN",
"NB",
"NN",
"OTHER",
"RF",
"RI",
"SEGMENTED",
"SVM",
"TEXT",
"TS",
"TS_NN",
"TTS",
"VW"
],
"type": "string"
}
},
"required": [
"fullName",
"key"
],
"type": "object"
},
"maxItems": 32,
"type": "array"
},
"samplePcts": {
"description": "Model training sample sizes (in percentage)",
"items": {
"exclusiveMinimum": 0,
"maximum": 100,
"type": "number"
},
"maxItems": 7,
"type": "array"
}
},
"required": [
"metrics",
"modelFamilies",
"samplePcts"
],
"type": "object"
}
Responses
Get a list of models from projects associated with a Use Case by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/modelsForComparison/
Authentication requirements: BearerAuth
Get a list of models from projects associated with a Use Case for direct comparison. NOTE: datetime partitioned models are not supported currently.
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
false |
The 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 |
The 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 |
The 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, createdAt] |
| binarySortMetric |
[AUC, Weighted AUC, Area Under PR Curve, Weighted Area Under PR Curve, Kolmogorov-Smirnov, Weighted Kolmogorov-Smirnov, FVE Binomial, Weighted FVE Binomial, Gini Norm, Weighted Gini Norm, LogLoss, Weighted LogLoss, Max MCC, Weighted Max MCC, Rate@Top5%, Weighted Rate@Top5%, Rate@Top10%, Weighted Rate@Top10%, Rate@TopTenth%, RMSE, Weighted RMSE, F1 Score, Weighted F1 Score, Precision, Weighted Precision, Recall, Weighted Recall] |
| binarySortPartition |
[validation, holdout, crossValidation] |
| regressionSortMetric |
[FVE Poisson, Weighted FVE Poisson, FVE Gamma, Weighted FVE Gamma, FVE Tweedie, Weighted FVE Tweedie, Gamma Deviance, Weighted Gamma Deviance, Gini Norm, Weighted Gini Norm, MAE, Weighted MAE, MAPE, Weighted MAPE, SMAPE, Weighted SMAPE, Poisson Deviance, Weighted Poisson Deviance, RMSLE, RMSE, Weighted RMSLE, Weighted RMSE, R Squared, Weighted R Squared, Tweedie Deviance, Weighted Tweedie Deviance] |
| regressionSortPartition |
[validation, holdout, crossValidation] |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "Models from multiple projects in the Use Case",
"items": {
"properties": {
"autopilotDataSelectionMethod": {
"description": "The Data Selection method of the datetime-partitioned model. `null` if model is not datetime-partitioned.",
"enum": [
"duration",
"rowCount"
],
"type": [
"string",
"null"
]
},
"blenderInputModelNumbers": {
"description": "List of model ID numbers used in the blender.",
"items": {
"description": "Model ID numbers used in the blender.",
"type": "integer"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.36"
},
"blueprintNumber": {
"description": "The blueprint number associated with the model.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Timestamp generated at model's project creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"datasetName": {
"description": "The name of the dataset used to build the model in the associated project.",
"type": "string"
},
"featurelistName": {
"description": "The name of the feature list associated with the model.",
"type": "string",
"x-versionadded": "v2.36"
},
"frozenPct": {
"description": "The percentage used to train the frozen model.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.36"
},
"hasCodegen": {
"description": "A boolean setting whether the model can be converted to scorable Java code.",
"type": "boolean"
},
"hasHoldout": {
"description": "Whether the model has holdout.",
"type": "boolean"
},
"icons": {
"description": "The icons associated with the model.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.36"
},
"isBlender": {
"description": "Indicates if the model is a blender.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isCustom": {
"description": "Indicates if the model contains custom tasks.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isDatetimePartitioned": {
"description": "Indicates whether the model is a datetime-partitioned model.",
"type": "boolean"
},
"isExternalPredictionModel": {
"description": "Indicates if the model is an external prediction model.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isFrozen": {
"description": "Indicates if the model is a frozen model.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isMaseBaselineModel": {
"description": "Indicates if the model is a baseline model with MASE score '1.000'.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isReferenceModel": {
"description": "Indicates if the model is a reference model.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isScoringAvailableForModelsTrainedIntoValidationHoldout": {
"description": "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.",
"type": "boolean"
},
"isStarred": {
"description": "Indicates whether the model has been starred for easier identification.",
"type": "boolean"
},
"isTrainedIntoHoldout": {
"description": "Whether the model used holdout data for training.",
"type": "boolean"
},
"isTrainedIntoValidation": {
"description": "Whether the model used validation data for training.",
"type": "boolean"
},
"isTrainedOnGpu": {
"description": "Indicates if the model was trained using GPU workers.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isTransparent": {
"description": "Indicates if the model is a transparent model with exposed coefficients.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isUserModel": {
"description": "Indicates if the model was created with Composable ML.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isUsingCrossValidation": {
"default": true,
"description": "Indicates whether cross-validation is the partitioning strategy used for the project associated with the model.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"metric": {
"description": "Model performance information by the specified filtered evaluation metric",
"type": "object"
},
"modelFamily": {
"description": "Model family associated with the model",
"enum": [
"AB",
"AD",
"BLENDER",
"CAL",
"CLUSTER",
"COUNT_DICT",
"CUSTOM",
"DOCUMENT",
"DT",
"DUMMY",
"EP",
"EQ",
"EQ_TS",
"FM",
"GAM",
"GBM",
"GLM",
"GLMNET",
"IMAGE",
"KNN",
"NB",
"NN",
"OTHER",
"RF",
"RI",
"SEGMENTED",
"SVM",
"TEXT",
"TS",
"TS_NN",
"TTS",
"VW"
],
"type": "string"
},
"modelId": {
"description": "ID of the model",
"type": "string"
},
"modelNumber": {
"description": "The model number from the single experiment leaderboard.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the model",
"type": "string"
},
"projectId": {
"description": "ID of the project associated with the model",
"type": "string"
},
"projectName": {
"description": "Name of the project associated with the model",
"type": "string"
},
"samplePct": {
"description": "Percentage of the dataset to use with the model",
"exclusiveMinimum": 0,
"maximum": 100,
"type": [
"number",
"null"
]
},
"supportsMonotonicConstraints": {
"description": "Indicates if the model supports enforcing monotonic constraints.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"supportsNewSeries": {
"description": "Indicates if the model supports new series (time series only).",
"type": "boolean",
"x-versionadded": "v2.36"
},
"targetName": {
"description": "Name of modeling target",
"type": "string"
},
"targetType": {
"description": "The type of modeling target",
"enum": [
"Binary",
"Regression"
],
"type": "string"
},
"trainingRowCount": {
"default": 1,
"description": "The number of rows used to train the model.",
"exclusiveMinimum": 0,
"type": "integer",
"x-versionadded": "v2.36"
}
},
"required": [
"autopilotDataSelectionMethod",
"blueprintNumber",
"createdAt",
"createdBy",
"datasetName",
"hasCodegen",
"hasHoldout",
"icons",
"isBlender",
"isCustom",
"isDatetimePartitioned",
"isExternalPredictionModel",
"isFrozen",
"isMaseBaselineModel",
"isReferenceModel",
"isScoringAvailableForModelsTrainedIntoValidationHoldout",
"isStarred",
"isTrainedIntoHoldout",
"isTrainedIntoValidation",
"isTrainedOnGpu",
"isTransparent",
"isUserModel",
"isUsingCrossValidation",
"metric",
"modelFamily",
"modelId",
"name",
"projectId",
"projectName",
"samplePct",
"supportsMonotonicConstraints",
"supportsNewSeries",
"targetName",
"targetType",
"trainingRowCount"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
Link multiple entities by use case ID
Operation path: POST /api/v2/useCases/{useCaseId}/multilink/
Authentication requirements: BearerAuth
Link multiple entities to a use case.
Body parameter
{
"properties": {
"entitiesList": {
"description": "Entities to link to this Use Case",
"items": {
"properties": {
"entityId": {
"description": "The primary id of the entity to link.",
"type": "string",
"x-versionadded": "v2.33"
},
"entityType": {
"description": "The type of entity to link.",
"enum": [
"project",
"dataset",
"file",
"notebook",
"application",
"recipe",
"customModelVersion",
"registeredModelVersion",
"deployment",
"customApplication",
"customJob"
],
"type": "string",
"x-versionadded": "v2.33"
},
"includeDataset": {
"default": true,
"description": "Include dataset migration when an experiment is migrated",
"type": "boolean",
"x-versionadded": "v2.34"
}
},
"required": [
"entityId",
"entityType"
],
"type": "object"
},
"maxItems": 100,
"minItems": 1,
"type": "array",
"x-versionadded": "v2.33"
},
"workflow": {
"default": "unspecified",
"description": "The workflow that is attaching this entity. Does not affect the operation of the API call. Only used for analytics.",
"enum": [
"migration",
"creation",
"move",
"unspecified"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"entitiesList",
"workflow"
],
"type": "object"
}
Parameters
| Name |
In |
Type |
Required |
Description |
| useCaseId |
path |
string |
true |
The ID of the use case. |
| body |
body |
UseCaseReferenceMultilink |
false |
none |
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
none |
None |
Get the list of the notebooks associated by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/notebooks/
Authentication requirements: BearerAuth
Get the list of the notebooks associated with a use case.
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
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of the notebooks in this use case.",
"items": {
"properties": {
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at notebook creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary id of the entity (same as ID of the notebook).",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity id.",
"enum": [
"notebook"
],
"type": "string"
},
"experimentContainerId": {
"description": "[DEPRECATED - replaced with use_case_id] The ID of the Use Case.",
"type": "string",
"x-versiondeprecated": "v2.32"
},
"id": {
"description": "The ID of the notebook.",
"type": "string"
},
"isDeleted": {
"description": "Soft deletion flag for notebooks",
"type": "boolean"
},
"referenceId": {
"description": "Original ID from DB",
"type": "string"
},
"tenantId": {
"description": "The id of the tenant the notebook belongs to.",
"type": [
"string",
"null"
]
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the Use Case.",
"type": "string"
},
"useCaseName": {
"description": "Use Case name",
"type": "string"
}
},
"required": [
"created",
"createdAt",
"entityId",
"entityType",
"experimentContainerId",
"id",
"isDeleted",
"referenceId",
"tenantId",
"useCaseId"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
Get the list of the playgrounds associated by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/playgrounds/
Authentication requirements: BearerAuth
Get the list of the playgrounds associated with a use case.
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
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of the playgrounds in this use case.",
"items": {
"properties": {
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at playground creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary id of the entity (same as ID of the playground).",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity id.",
"enum": [
"playground"
],
"type": "string"
},
"id": {
"description": "The ID of the playground.",
"type": "string"
},
"isDeleted": {
"description": "Soft deletion flag for playgrounds",
"type": "boolean"
},
"referenceId": {
"description": "Original ID from DB",
"type": "string"
},
"tenantId": {
"description": "The id of the tenant the playground belongs to.",
"type": [
"string",
"null"
]
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"createdAt",
"entityId",
"entityType",
"id",
"isDeleted",
"referenceId",
"tenantId"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
Get the list of the projects associated by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/projects/
Authentication requirements: BearerAuth
Get the list of the projects associated with a use case.
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
false |
The 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 |
Returns only 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, -createdBy, -dataset, -featureCount, -fullName, -lastActivity, -models, -name, -projectId, -rowCount, -target, -targetType, -timeAware, -updatedAt, -updatedBy, createdAt, createdBy, dataset, featureCount, fullName, lastActivity, models, name, projectId, rowCount, target, targetType, timeAware, updatedAt, updatedBy] |
| orderBy |
[-createdAt, -createdBy, -dataset, -featureCount, -fullName, -lastActivity, -models, -name, -projectId, -rowCount, -target, -targetType, -timeAware, -updatedAt, -updatedBy, createdAt, createdBy, dataset, featureCount, fullName, lastActivity, models, name, projectId, rowCount, target, targetType, timeAware, updatedAt, updatedBy] |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "A list of the Use Case projects that match the query",
"items": {
"properties": {
"autopilotDataSelectionMethod": {
"description": "The Data Selection method of the datetime-partitioned project. `null` if project is not datetime-partitioned.",
"enum": [
"duration",
"rowCount"
],
"type": [
"string",
"null"
]
},
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at project creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"dataset": {
"description": "Name of the dataset in the registry used to build the project associated with the project",
"type": "string"
},
"datasetId": {
"description": "The dataset ID of the dataset in the registry.",
"type": [
"string",
"null"
]
},
"datasetVersionId": {
"description": "The dataset version ID of the dataset in the registry.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.41"
},
"hasHoldout": {
"description": "Whether the project has holdout.",
"type": "boolean"
},
"isDatasetLinkedToUseCase": {
"description": "Indicates whether the dataset that this project was created from is attached to this Use Case.",
"type": "boolean"
},
"isDraft": {
"description": "Indicates whether the experiment configuration has been used for modeling and is therefore locked (False) or whether the setup has not been applied , and as a draft, can still be modified and used in training (True).",
"type": "boolean"
},
"isErrored": {
"description": "Indicates whether the experiment failed.",
"type": "boolean"
},
"isScoringAvailableForModelsTrainedIntoValidationHoldout": {
"description": "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.",
"type": "boolean"
},
"isWorkbenchEligible": {
"description": "Indicates whether the experiment is Workbench-compatible.",
"type": "boolean"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"metricDetail": {
"description": "Project metrics",
"items": {
"properties": {
"ascending": {
"description": "Should the metric be sorted in ascending order",
"type": "boolean"
},
"name": {
"description": "Name of the metric",
"type": "string"
}
},
"required": [
"ascending",
"name"
],
"type": "object"
},
"type": "array"
},
"models": {
"description": "The number of models in an use case.",
"type": "integer"
},
"name": {
"description": "The name of the project.",
"type": "string"
},
"numberOfBacktests": {
"description": "The number of backtests of the datetime-partitioned project. 0 if project is not datetime-partitioned.",
"minimum": 0,
"type": "integer"
},
"projectId": {
"description": "The ID of the project.",
"type": "string"
},
"projectOptions": {
"description": "Project options currently saved for a project. Can be changed while project is in draft status.",
"properties": {
"target": {
"description": "Name of the target",
"type": [
"string",
"null"
]
},
"targetType": {
"description": "The target type of the project.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"minInflated",
"Multilabel",
"TextGeneration",
"GeoPoint",
"VectorDatabase"
],
"type": [
"string",
"null"
]
},
"validationType": {
"description": "The validation type of the partitioning strategy for the project, either CV for cross-validation or TVH for train-validation-holdout split.",
"enum": [
"CV",
"TVH"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"weight": {
"description": "Name of the weight (if configured)",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"stage": {
"description": "Stage of the experiment.",
"type": "string",
"x-versionadded": "v2.34"
},
"statusErrorMessage": {
"description": "Experiment failure explanation.",
"type": "string"
},
"target": {
"description": "Name of the target",
"type": [
"string",
"null"
]
},
"targetType": {
"description": "The type of modeling target.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"minInflated",
"Multilabel",
"TextGeneration",
"GeoPoint",
"VectorDatabase"
],
"type": [
"string",
"null"
]
},
"timeAware": {
"description": "Shows if project uses time series",
"type": "boolean"
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated at project modification.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
}
},
"required": [
"autopilotDataSelectionMethod",
"created",
"createdAt",
"dataset",
"datasetId",
"datasetVersionId",
"hasHoldout",
"isDatasetLinkedToUseCase",
"isDraft",
"isErrored",
"isScoringAvailableForModelsTrainedIntoValidationHoldout",
"isWorkbenchEligible",
"lastActivity",
"metricDetail",
"models",
"name",
"numberOfBacktests",
"projectId",
"projectOptions",
"stage",
"statusErrorMessage",
"timeAware",
"updated",
"updatedAt"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
The list of the registered models referenced by a use case by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/registeredModels/
Authentication requirements: BearerAuth
The list of the registered models referenced by a use case.
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 10. |
| useCaseId |
path |
string |
true |
The ID of the use case to update. |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of registered models.",
"items": {
"properties": {
"createdAt": {
"description": "The time when this model was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"id": {
"description": "The ID of the registered model.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "The name of the registered model.",
"type": "string"
},
"updatedAt": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"userHasAccess": {
"description": "Indicates if a user has access to this registered model.",
"type": "boolean",
"x-versionadded": "v2.35"
},
"versions": {
"description": "The list of registered model versions.",
"items": {
"properties": {
"createdAt": {
"description": "The time when this model was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"id": {
"description": "The ID of the registered model version.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "The name of the registered model version.",
"type": "string"
},
"registeredModelVersion": {
"description": "The version number of the registered model version.",
"type": "integer",
"x-versionadded": "v2.35"
},
"updatedAt": {
"description": "The time when the last update occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"lastActivity",
"name",
"registeredModelVersion",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"id",
"userHasAccess"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.35"
}
Responses
Get the list of the references associated by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/resources/
Authentication requirements: BearerAuth
Get the list of the references associated with a use case.
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
false |
The 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. |
| recipeStatus |
query |
any |
false |
The recipe status used for filtering recipes. |
| useCaseId |
path |
string |
true |
The ID of the use case to update. |
Enumerated Values
| Parameter |
Value |
| sort |
[-entityType, -lastActivity, -name, -updatedAt, -updatedBy, entityType, lastActivity, name, updatedAt, updatedBy] |
| orderBy |
[-entityType, -lastActivity, -name, -updatedAt, -updatedBy, entityType, lastActivity, name, updatedAt, updatedBy] |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of the use case references that match the query.",
"items": {
"properties": {
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary ID of the entity.",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity ID.",
"type": "string"
},
"id": {
"description": "The ID of the Use Case reference.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"metadata": {
"description": "The reference metadata for the use case.",
"oneOf": [
{
"properties": {
"isDraft": {
"description": "Indicates whether the experiment configuration has been used for modeling and is therefore locked (False) or whether the setup has not been applied , and as a draft, can still be modified and used in training (True).",
"type": "boolean"
},
"isErrored": {
"description": "Indicates whether the experiment failed.",
"type": "boolean"
},
"isWorkbenchEligible": {
"description": "Indicates whether the experiment is Workbench-compatible.",
"type": "boolean"
},
"stage": {
"description": "Stage of the experiment.",
"type": "string",
"x-versionadded": "v2.34"
},
"statusErrorMessage": {
"description": "The experiment failure explanation.",
"type": "string"
}
},
"required": [
"isDraft",
"isErrored",
"isWorkbenchEligible",
"stage",
"statusErrorMessage"
],
"type": "object"
},
{
"properties": {
"dataSourceType": {
"description": "The type of the data source used to create the dataset if relevant.",
"type": [
"string",
"null"
]
},
"datasetSize": {
"description": "The size of the dataset in bytes.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.34"
},
"datasetSourceType": {
"description": "The source type of the dataset",
"type": [
"string",
"null"
]
},
"isSnapshot": {
"description": "Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.",
"type": "boolean"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean"
},
"latestRecipeId": {
"description": "The latest recipe ID linked to the dataset.",
"type": [
"string",
"null"
]
}
},
"required": [
"dataSourceType",
"datasetSize",
"datasetSourceType",
"isSnapshot",
"isWranglingEligible",
"latestRecipeId"
],
"type": "object"
},
{
"properties": {
"dataType": {
"description": "The type of the recipe (wrangling or feature discovery)",
"enum": [
"static",
"Static",
"STATIC",
"snapshot",
"Snapshot",
"SNAPSHOT",
"dynamic",
"Dynamic",
"DYNAMIC",
"sqlRecipe",
"SqlRecipe",
"SQL_RECIPE",
"wranglingRecipe",
"WranglingRecipe",
"WRANGLING_RECIPE",
"featureDiscoveryRecipe",
"FeatureDiscoveryRecipe",
"FEATURE_DISCOVERY_RECIPE"
],
"type": [
"string",
"null"
]
}
},
"required": [
"dataType"
],
"type": "object"
},
{
"properties": {
"description": {
"description": "The description of the playground.",
"type": "string"
},
"playgroundType": {
"description": "The type of the playground.",
"type": "string",
"x-versionadded": "v2.37"
}
},
"required": [
"description"
],
"type": "object"
},
{
"properties": {
"errorMessage": {
"description": "The error message, if any, for the vector database.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.38"
},
"source": {
"description": "The source of the vector database",
"type": "string"
}
},
"required": [
"errorMessage",
"source"
],
"type": "object",
"x-versionadded": "v2.37"
},
{
"properties": {
"dataSourceType": {
"description": "The data source type used to create the file if relevant.",
"type": [
"string",
"null"
]
},
"fileSourceType": {
"description": "The source type of the file.",
"type": [
"string",
"null"
]
},
"numFiles": {
"description": "The number of files in the catalog item.",
"type": [
"integer",
"null"
]
}
},
"required": [
"dataSourceType",
"fileSourceType",
"numFiles"
],
"type": "object",
"x-versionadded": "v2.37"
}
]
},
"name": {
"description": "The name of the Use Case reference.",
"type": "string"
},
"processingState": {
"description": "The current ingestion process state of the dataset.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string"
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the linked use case.",
"type": "string"
},
"useCaseName": {
"description": "The name of the linked use case.",
"type": [
"string",
"null"
]
},
"userHasAccess": {
"description": "Identifies if a user has access to the entity.",
"type": [
"boolean",
"null"
],
"x-versionadded": "v2.36"
},
"versions": {
"description": "The list of entity versions.",
"items": {
"properties": {
"createdAt": {
"description": "Time when this entity was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"id": {
"description": "The id of the entity version.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"name": {
"description": "The name of the entity version.",
"type": "string"
},
"registeredModelVersion": {
"description": "The version number of the entity version.",
"type": "integer"
},
"updatedAt": {
"description": "Time when the last update occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"lastActivity",
"name",
"registeredModelVersion",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.36"
}
},
"required": [
"entityId",
"entityType",
"id",
"name",
"updatedAt",
"useCaseId"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
Get the use case's access control list by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/sharedRoles/
Authentication requirements: BearerAuth
Get a list of users who have access to this Use Case and their roles on the Use Case.
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
{
"properties": {
"count": {
"description": "The number of items returned.",
"type": "integer"
},
"data": {
"description": "The access control list.",
"items": {
"properties": {
"canShare": {
"description": "Whether the recipient can share the role further.",
"type": "boolean"
},
"id": {
"description": "The identifier of the recipient.",
"type": "string"
},
"name": {
"description": "The name of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": "string"
},
"shareRecipientType": {
"description": "The type of the recipient.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
},
"userFullName": {
"description": "The full name of the recipient user.",
"type": "string"
}
},
"required": [
"canShare",
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "The URL pointing to the next page.",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL pointing to the previous page.",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items matching the condition.",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
Update the use case's access control list by use case ID
Operation path: PATCH /api/v2/useCases/{useCaseId}/sharedRoles/
Authentication requirements: BearerAuth
Update the list of users who have access to this Use Case and their roles on the Use Case.
Body parameter
{
"properties": {
"operation": {
"description": "The name of the action being taken. Only 'updateRoles' is supported.",
"enum": [
"updateRoles"
],
"type": "string"
},
"roles": {
"description": "A list of sharing role objects",
"items": {
"oneOf": [
{
"properties": {
"role": {
"description": "The assigned role",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER",
"NO_ROLE"
],
"type": "string",
"x-versionadded": "v2.33"
},
"shareRecipientType": {
"description": "The recipient type",
"enum": [
"user",
"organization"
],
"type": "string",
"x-versionadded": "v2.33"
},
"username": {
"description": "The username of the user to update the access role for. If included with a name, the username is used.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"role",
"shareRecipientType",
"username"
],
"type": "object"
},
{
"properties": {
"name": {
"description": "The name of the user to update the access role for. If included with a username, the username is used.",
"type": "string"
},
"role": {
"description": "The assigned role",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER",
"NO_ROLE"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type",
"enum": [
"user",
"organization"
],
"type": "string"
}
},
"required": [
"name",
"role",
"shareRecipientType"
],
"type": "object"
},
{
"properties": {
"id": {
"description": "The ID of the recipient",
"type": "string"
},
"role": {
"description": "The assigned role",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER",
"NO_ROLE"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type",
"enum": [
"user",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"role",
"shareRecipientType"
],
"type": "object"
}
]
},
"minItems": 1,
"type": "array"
}
},
"required": [
"operation",
"roles"
],
"type": "object"
}
Parameters
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
none |
None |
Get the list of the vector databases associated by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/vectorDatabases/
Authentication requirements: BearerAuth
Get a list of the vector databases associated with a Use Case.
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
false |
The number of results to skip. |
| limit |
query |
integer |
false |
At most this many results are returned. The default may change without notice. |
| useCaseId |
path |
string |
true |
The ID of the use case to update. |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of the vector databases in this use case.",
"items": {
"properties": {
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at vector database creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary id of the entity (same as ID of the vector database).",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity id.",
"enum": [
"vector_database"
],
"type": "string"
},
"id": {
"description": "The ID of the vector database.",
"type": "string"
},
"isDeleted": {
"description": "Soft deletion flag for vector databases",
"type": "boolean"
},
"referenceId": {
"description": "Original ID from DB",
"type": "string"
},
"tenantId": {
"description": "The id of the tenant the vector database belongs to.",
"type": [
"string",
"null"
]
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"createdAt",
"entityId",
"entityType",
"id",
"isDeleted",
"referenceId",
"tenantId"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
Get a list of custom models that are associated by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/vectorDatabases/{vectorDatabaseId}/relatedCustomModels/
Authentication requirements: BearerAuth
Get a list of custom models that are associated with this vector database.
| 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 this vector database belongs to. |
| vectorDatabaseId |
path |
string |
true |
The ID of the vector database. |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of custom model versions created from this vector database.",
"items": {
"properties": {
"createdAt": {
"description": "The time that this custom model version was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The username of the user who created this custom model version.",
"type": "string"
},
"customModelId": {
"description": "The ID of this custom model.",
"type": "string"
},
"customModelVersionId": {
"description": "The ID of this version of this custom model.",
"type": "string"
},
"name": {
"description": "The name of the custom model created from this vector database.",
"type": "string"
},
"role": {
"description": "The role that the requesting user has on this custom model version",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": [
"string",
"null"
]
},
"versionMajor": {
"description": "The major version number of this custom model version.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number of this custom model version.",
"type": "integer"
}
},
"required": [
"createdAt",
"createdBy",
"customModelId",
"customModelVersionId",
"name",
"role",
"versionMajor",
"versionMinor"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"data",
"next",
"previous"
],
"type": "object",
"x-versionadded": "v2.36"
}
Responses
Get a list of deployments that are associated by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/vectorDatabases/{vectorDatabaseId}/relatedDeployments/
Authentication requirements: BearerAuth
Get a list of deployments that are associated with this vector database.
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
false |
The number of results to skip. |
| limit |
query |
integer |
false |
At most this many results are returned. |
| targetType |
query |
string |
false |
Filters related deployments by target type. |
| status |
query |
string |
false |
Filters related deployments by deployment status. |
| includeModelInfo |
query |
boolean |
true |
Indicates if IDs of champion registered model and champion custom model for each deployment should be returned |
| useCaseId |
path |
string |
true |
The ID of the use case this vector database belongs to. |
| vectorDatabaseId |
path |
string |
true |
The ID of the vector database. |
Enumerated Values
| Parameter |
Value |
| targetType |
[Binary, Regression, Multiclass, Anomaly, Transform, TextGeneration, GeoPoint, Unstructured, VectorDatabase, AgenticWorkflow, MCP] |
| status |
[active, archived, errored, inactive, launching, replacingModel, stopping] |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of deployments that this vector database is currently deployed on.",
"items": {
"properties": {
"createdAt": {
"description": "The time that this deployment was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The username of the user who created this deployment.",
"type": "string"
},
"customModelId": {
"description": "ID of the custom model currently deployed to this deployment",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"customModelVersionId": {
"description": "ID of the custom model version currently deployed to this deployment",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"id": {
"description": "The ID of the deployment with this vector database deployed.",
"type": "string"
},
"name": {
"description": "The name of the deployment with this vector database deployed.",
"type": "string"
},
"registeredModelId": {
"description": "ID of the registered model currently deployed to this deployment",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"registeredModelVersionId": {
"description": "ID of the registered model version currently deployed to this deployment",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"role": {
"description": "The role that the requesting user has on this deployment",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": [
"string",
"null"
]
}
},
"required": [
"createdAt",
"createdBy",
"id",
"name",
"role"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"data",
"next",
"previous"
],
"type": "object",
"x-versionadded": "v2.36"
}
Responses
Get a list of registered models that are associated by use case ID
Operation path: GET /api/v2/useCases/{useCaseId}/vectorDatabases/{vectorDatabaseId}/relatedRegisteredModels/
Authentication requirements: BearerAuth
Get a list of registered models that are associated with this vector database.
| 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 this vector database belongs to. |
| vectorDatabaseId |
path |
string |
true |
The ID of the vector database. |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of registered model versions created from this vector database.",
"items": {
"properties": {
"createdAt": {
"description": "The time that this registered model version was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The username of the user who created this registered model version.",
"type": "string"
},
"registeredModelId": {
"description": "The ID of this registered model.",
"type": "string"
},
"registeredModelName": {
"description": "The name of the registered model created from this vector database.",
"type": "string"
},
"registeredModelVersionId": {
"description": "The ID of this version of this registered model.",
"type": "string"
},
"registeredModelVersionName": {
"description": "The name of the registered model version created from this vector database.",
"type": "string"
},
"role": {
"description": "The role that the requesting user has on this registered model version",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": [
"string",
"null"
]
},
"version": {
"description": "The version number of this registered model version.",
"type": "integer"
}
},
"required": [
"createdAt",
"createdBy",
"registeredModelId",
"registeredModelName",
"registeredModelVersionId",
"registeredModelVersionName",
"role",
"version"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"data",
"next",
"previous"
],
"type": "object",
"x-versionadded": "v2.36"
}
Responses
Operation path: DELETE /api/v2/useCases/{useCaseId}/{referenceCollectionType}/{entityId}/
Authentication requirements: BearerAuth
Remove a related entity from a use case.
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, datasets, files, notebooks, applications, recipes, customModelVersions, registeredModelVersions, deployments, customApplications, customJobs] |
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
none |
None |
| 204 |
No Content |
The relationship has been removed successfully |
None |
| 404 |
Not Found |
The use case reference was not found. |
None |
Move entity from one Use Case by use case ID
Operation path: PATCH /api/v2/useCases/{useCaseId}/{referenceCollectionType}/{entityId}/
Authentication requirements: BearerAuth
Move entity from one Use Case to another.
Body parameter
{
"properties": {
"includeDataset": {
"default": true,
"description": "Include dataset migration when project is migrated.",
"type": "boolean"
}
},
"type": "object",
"x-versionadded": "v2.34"
}
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 |
UseCasesProjectMigrationParam |
false |
none |
Enumerated Values
| Parameter |
Value |
| referenceCollectionType |
[projects, datasets, files, notebooks, applications, recipes, customModelVersions, registeredModelVersions, deployments, customApplications, customJobs] |
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
none |
None |
Link entity by use case ID
Operation path: POST /api/v2/useCases/{useCaseId}/{referenceCollectionType}/{entityId}/
Authentication requirements: BearerAuth
Link entity to a single use case.
Body parameter
{
"properties": {
"workflow": {
"default": "unspecified",
"description": "The workflow that is attaching this entity. Does not affect the operation of the API call. Only used for analytics.",
"enum": [
"migration",
"creation",
"move",
"unspecified"
],
"type": "string"
}
},
"required": [
"workflow"
],
"type": "object"
}
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, datasets, files, notebooks, applications, recipes, customModelVersions, registeredModelVersions, deployments, customApplications, customJobs] |
Example responses
200 Response
{
"properties": {
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary id of the entity.",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity id.",
"type": "string"
},
"id": {
"description": "The ID of the experiment container reference.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"metadata": {
"description": "Reference metadata for the experiment container",
"oneOf": [
{
"properties": {
"isDraft": {
"description": "Indicates whether the experiment configuration has been used for modeling and is therefore locked (False) or whether the setup has not been applied , and as a draft, can still be modified and used in training (True).",
"type": "boolean"
},
"isErrored": {
"description": "Indicates whether the experiment failed.",
"type": "boolean"
},
"isWorkbenchEligible": {
"description": "Indicates whether the experiment is Workbench-compatible.",
"type": "boolean"
},
"stage": {
"description": "Stage of the experiment.",
"type": "string",
"x-versionadded": "v2.34"
},
"statusErrorMessage": {
"description": "Experiment failure explanation.",
"type": "string"
}
},
"required": [
"isDraft",
"isErrored",
"isWorkbenchEligible",
"stage",
"statusErrorMessage"
],
"type": "object"
},
{
"properties": {
"dataSourceType": {
"description": "The type of the data source used to create the dataset if relevant.",
"type": [
"string",
"null"
]
},
"datasetSize": {
"description": "Size of the dataset in bytes",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.34"
},
"datasetSourceType": {
"description": "The source type of the dataset.",
"type": [
"string",
"null"
]
},
"isSnapshot": {
"description": "Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.",
"type": "boolean"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean"
},
"latestRecipeId": {
"description": "The latest recipe ID linked to the dataset.",
"type": [
"string",
"null"
]
}
},
"required": [
"dataSourceType",
"datasetSize",
"datasetSourceType",
"isSnapshot",
"isWranglingEligible",
"latestRecipeId"
],
"type": "object"
},
{
"properties": {
"dataType": {
"description": "The type of the recipe (wrangling or feature discovery)",
"enum": [
"static",
"Static",
"STATIC",
"snapshot",
"Snapshot",
"SNAPSHOT",
"dynamic",
"Dynamic",
"DYNAMIC",
"sqlRecipe",
"SqlRecipe",
"SQL_RECIPE",
"wranglingRecipe",
"WranglingRecipe",
"WRANGLING_RECIPE",
"featureDiscoveryRecipe",
"FeatureDiscoveryRecipe",
"FEATURE_DISCOVERY_RECIPE"
],
"type": [
"string",
"null"
]
}
},
"required": [
"dataType"
],
"type": "object"
},
{
"properties": {
"description": {
"description": "Description of the playground",
"type": "string"
},
"playgroundType": {
"description": "The type of the playground",
"type": "string",
"x-versionadded": "v2.37"
}
},
"required": [
"description"
],
"type": "object"
},
{
"properties": {
"errorMessage": {
"description": "The error message, if any, for the vector database.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.38"
},
"source": {
"description": "The source of the vector database",
"type": "string"
}
},
"required": [
"errorMessage",
"source"
],
"type": "object",
"x-versionadded": "v2.37"
},
{
"properties": {
"dataSourceType": {
"description": "The data source type used to create the file if relevant.",
"type": [
"string",
"null"
]
},
"fileSourceType": {
"description": "The source type of the file.",
"type": [
"string",
"null"
]
},
"numFiles": {
"description": "The number of files in the file.",
"type": [
"integer",
"null"
]
}
},
"required": [
"dataSourceType",
"fileSourceType",
"numFiles"
],
"type": "object",
"x-versionadded": "v2.37"
}
]
},
"name": {
"description": "The name of the experiment container reference.",
"type": "string"
},
"processingState": {
"description": "The current ingestion process state of the dataset.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string"
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID linking the Use Case with the entity type.",
"type": "string"
},
"userHasAccess": {
"description": "Identifies if a user has access to the entity.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"versions": {
"description": "A list of entity versions.",
"items": {
"properties": {
"createdAt": {
"description": "Time when this entity was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"id": {
"description": "The id of the entity version.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"name": {
"description": "The name of the entity version.",
"type": "string"
},
"registeredModelVersion": {
"description": "The version number of the entity version.",
"type": "integer"
},
"updatedAt": {
"description": "Time when the last update occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"lastActivity",
"name",
"registeredModelVersion",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.36"
}
},
"required": [
"entityId",
"entityType",
"id",
"name",
"updatedAt",
"useCaseId"
],
"type": "object"
}
Responses
Use an endpoint
Operation path: GET /api/v2/useCasesWithShortenedInfo/
Authentication requirements: BearerAuth
Retrieves the list of use cases using a new endpoint that abbreviates the display metadata for faster retrieval.
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 |
Returns only Use Cases with names that match the given string. |
| projectId |
query |
string |
false |
Only return experiment containers associated with the given project ID. |
| applicationId |
query |
string |
false |
Only return experiment containers associated with the given app. |
| entityId |
query |
string |
false |
The id of the entity type that is linked with the Use Case. |
| entityType |
query |
string |
false |
The entity type that is linked to the use case. |
| sort |
query |
string |
true |
[DEPRECATED - replaced with order_by] The order in which Use Cases and return Use Cases. |
| orderBy |
query |
string |
true |
The order in which use cases are returned. |
| usecaseType |
query |
string |
true |
A filter to return use cases by type. |
| riskLevel |
query |
any |
false |
Only return Use Cases associated with the given risk level. |
| stage |
query |
any |
false |
Only return use cases in the given stage. |
| createdBy |
query |
string |
false |
Filter Use Cases to return only those created by the selected user. |
| showOrgUseCases |
query |
boolean |
false |
Defines if the Use Cases available on Organization level should be shown. |
Enumerated Values
| Parameter |
Value |
| entityType |
[project, dataset, file, notebook, application, recipe, playground, vectorDatabase, customModelVersion, registeredModelVersion, deployment, customApplication, customJob] |
| sort |
[-applicationsCount, -createdAt, -createdBy, -customApplicationsCount, -datasetsCount, -description, -filesCount, -id, -name, -notebooksCount, -playgroundsCount, -potentialValue, -projectsCount, -riskLevel, -stage, -updatedAt, -updatedBy, -vectorDatabasesCount, applicationsCount, createdAt, createdBy, customApplicationsCount, datasetsCount, description, filesCount, id, name, notebooksCount, playgroundsCount, potentialValue, projectsCount, riskLevel, stage, updatedAt, updatedBy, vectorDatabasesCount] |
| orderBy |
[-applicationsCount, -createdAt, -createdBy, -customApplicationsCount, -datasetsCount, -description, -filesCount, -id, -name, -notebooksCount, -playgroundsCount, -potentialValue, -projectsCount, -riskLevel, -stage, -updatedAt, -updatedBy, -vectorDatabasesCount, applicationsCount, createdAt, createdBy, customApplicationsCount, datasetsCount, description, filesCount, id, name, notebooksCount, playgroundsCount, potentialValue, projectsCount, riskLevel, stage, updatedAt, updatedBy, vectorDatabasesCount] |
| usecaseType |
[all, general, walkthrough] |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "A list of Use Cases with shortened info that match the query",
"items": {
"properties": {
"advancedTour": {
"description": "Advanced tour key.",
"type": [
"string",
"null"
]
},
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the Use Case.",
"type": [
"string",
"null"
]
},
"description": {
"description": "The description of the Use Case.",
"type": [
"string",
"null"
]
},
"formattedDescription": {
"description": "The formatted description of the experiment container used as styled description.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the Use Case.",
"type": "string"
},
"name": {
"description": "The name of the Use Case.",
"type": "string"
},
"tenantId": {
"description": "The ID of the tenant to associate this organization with.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "The timestamp generated when the record was last updated.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated the Use Case.",
"type": [
"string",
"null"
]
},
"valueTrackerId": {
"description": "The ID of the Value Tracker.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"createdAt",
"description",
"formattedDescription",
"id",
"name",
"tenantId",
"updatedAt"
],
"type": "object",
"x-versionadded": "v2.34"
},
"maxItems": 100,
"minItems": 1,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.34"
}
Responses
Schemas
AccessControlWithGrant
{
"properties": {
"canShare": {
"description": "Whether the recipient can share the role further.",
"type": "boolean"
},
"id": {
"description": "The identifier of the recipient.",
"type": "string"
},
"name": {
"description": "The name of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": "string"
},
"shareRecipientType": {
"description": "The type of the recipient.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
},
"userFullName": {
"description": "The full name of the recipient user.",
"type": "string"
}
},
"required": [
"canShare",
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object"
}
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 |
|
The full name of the recipient user. |
Enumerated Values
| Property |
Value |
| role |
[ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER] |
| shareRecipientType |
[user, group, organization] |
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of deployments linked to a use case.",
"items": {
"properties": {
"createdAt": {
"description": "The created date time.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"description": {
"description": "The deployment description.",
"type": "string"
},
"id": {
"description": "Unique identifier of the deployment.",
"type": "string"
},
"label": {
"description": "The deployment label.",
"type": "string"
},
"lastActivity": {
"description": "The type of the last activity. Can be \"Added\" or \"Modified\".",
"enum": [
"created",
"Created",
"CREATED",
"modified",
"Modified",
"MODIFIED"
],
"type": "string",
"x-versionadded": "v2.35"
},
"type": {
"description": "The deployment type.",
"type": "string"
},
"updatedAt": {
"description": "The last modified date time.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"userHasAccess": {
"description": "Indicates if a user has access to this deployment.",
"type": "boolean",
"x-versionadded": "v2.35"
}
},
"required": [
"id"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[FormattedResponseDeployment] |
true |
maxItems: 100
|
The list of deployments linked to a use case. |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
EntityCountByTypeResponse
{
"description": "Number of different type entities that use the dataset.",
"properties": {
"numCalendars": {
"description": "The number of calendars that use the dataset",
"type": "integer"
},
"numExperimentContainer": {
"description": "The number of experiment containers that use the dataset.",
"type": "integer",
"x-versionadded": "v2.37"
},
"numExternalModelPackages": {
"description": "The number of external model packages that use the dataset",
"type": "integer"
},
"numFeatureDiscoveryConfigs": {
"description": "The number of feature discovery configs that use the dataset",
"type": "integer"
},
"numPredictionDatasets": {
"description": "The number of prediction datasets that use the dataset",
"type": "integer"
},
"numProjects": {
"description": "The number of projects that use the dataset",
"type": "integer"
},
"numSparkSqlQueries": {
"description": "The number of spark sql queries that use the dataset",
"type": "integer"
}
},
"required": [
"numCalendars",
"numExperimentContainer",
"numExternalModelPackages",
"numFeatureDiscoveryConfigs",
"numPredictionDatasets",
"numProjects",
"numSparkSqlQueries"
],
"type": "object"
}
Number of different type entities that use the dataset.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| numCalendars |
integer |
true |
|
The number of calendars that use the dataset |
| numExperimentContainer |
integer |
true |
|
The number of experiment containers that use the dataset. |
| numExternalModelPackages |
integer |
true |
|
The number of external model packages that use the dataset |
| numFeatureDiscoveryConfigs |
integer |
true |
|
The number of feature discovery configs that use the dataset |
| numPredictionDatasets |
integer |
true |
|
The number of prediction datasets that use the dataset |
| numProjects |
integer |
true |
|
The number of projects that use the dataset |
| numSparkSqlQueries |
integer |
true |
|
The number of spark sql queries that use the dataset |
ExperimentContainerApplicationResponse
{
"properties": {
"applicationId": {
"description": "The application id of the application.",
"type": "string"
},
"applicationTemplateType": {
"description": "The type of the application.",
"type": [
"string",
"null"
]
},
"createdAt": {
"description": "The timestamp generated at application creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"description": {
"description": "The description of the application.",
"type": [
"string",
"null"
]
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"projectId": {
"description": "The ID of the associated project",
"type": [
"string",
"null"
]
},
"source": {
"description": "The source used to create the application.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "The timestamp generated at application modification.",
"format": "date-time",
"type": "string"
}
},
"required": [
"applicationId",
"applicationTemplateType",
"createdAt",
"createdBy",
"description",
"lastActivity",
"name",
"projectId",
"source",
"updatedAt"
],
"type": "object"
}
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 |
|
A user associated with a use case. |
| description |
string,null |
true |
|
The description of the application. |
| lastActivity |
ExperimentContainerLastActivity |
true |
|
The 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. |
{
"description": "Model performance evaluation metrics (shorthand abbreviations)",
"properties": {
"binary": {
"description": "Binary metrics associated with the models.",
"items": {
"description": "Binary metric names",
"enum": [
"AUC",
"Weighted AUC",
"Area Under PR Curve",
"Weighted Area Under PR Curve",
"Kolmogorov-Smirnov",
"Weighted Kolmogorov-Smirnov",
"FVE Binomial",
"Weighted FVE Binomial",
"Gini Norm",
"Weighted Gini Norm",
"LogLoss",
"Weighted LogLoss",
"Max MCC",
"Weighted Max MCC",
"Rate@Top5%",
"Weighted Rate@Top5%",
"Rate@Top10%",
"Weighted Rate@Top10%",
"Rate@TopTenth%",
"RMSE",
"Weighted RMSE",
"F1 Score",
"Weighted F1 Score",
"Precision",
"Weighted Precision",
"Recall",
"Weighted Recall"
],
"type": "string"
},
"type": "array"
},
"regression": {
"description": "Regression metrics associated with the models",
"items": {
"description": "Regression metric names",
"enum": [
"FVE Poisson",
"Weighted FVE Poisson",
"FVE Gamma",
"Weighted FVE Gamma",
"FVE Tweedie",
"Weighted FVE Tweedie",
"Gamma Deviance",
"Weighted Gamma Deviance",
"Gini Norm",
"Weighted Gini Norm",
"MAE",
"Weighted MAE",
"MAPE",
"Weighted MAPE",
"SMAPE",
"Weighted SMAPE",
"Poisson Deviance",
"Weighted Poisson Deviance",
"RMSLE",
"RMSE",
"Weighted RMSLE",
"Weighted RMSE",
"R Squared",
"Weighted R Squared",
"Tweedie Deviance",
"Weighted Tweedie Deviance"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
Model performance evaluation metrics (shorthand abbreviations)
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| binary |
[string] |
false |
|
Binary metrics associated with the models. |
| regression |
[string] |
false |
|
Regression metrics associated with the models |
{
"properties": {
"fullName": {
"description": "Full name of the model family",
"type": "string"
},
"key": {
"description": "Abbreviated form of model family name",
"enum": [
"AB",
"AD",
"BLENDER",
"CAL",
"CLUSTER",
"COUNT_DICT",
"CUSTOM",
"DOCUMENT",
"DT",
"DUMMY",
"EP",
"EQ",
"EQ_TS",
"FM",
"GAM",
"GBM",
"GLM",
"GLMNET",
"IMAGE",
"KNN",
"NB",
"NN",
"OTHER",
"RF",
"RI",
"SEGMENTED",
"SVM",
"TEXT",
"TS",
"TS_NN",
"TTS",
"VW"
],
"type": "string"
}
},
"required": [
"fullName",
"key"
],
"type": "object"
}
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, AD, BLENDER, CAL, CLUSTER, COUNT_DICT, CUSTOM, DOCUMENT, DT, DUMMY, EP, EQ, EQ_TS, FM, GAM, GBM, GLM, GLMNET, IMAGE, KNN, NB, NN, OTHER, RF, RI, SEGMENTED, SVM, TEXT, TS, TS_NN, TTS, VW] |
{
"properties": {
"metrics": {
"description": "Model performance evaluation metrics (shorthand abbreviations)",
"properties": {
"binary": {
"description": "Binary metrics associated with the models.",
"items": {
"description": "Binary metric names",
"enum": [
"AUC",
"Weighted AUC",
"Area Under PR Curve",
"Weighted Area Under PR Curve",
"Kolmogorov-Smirnov",
"Weighted Kolmogorov-Smirnov",
"FVE Binomial",
"Weighted FVE Binomial",
"Gini Norm",
"Weighted Gini Norm",
"LogLoss",
"Weighted LogLoss",
"Max MCC",
"Weighted Max MCC",
"Rate@Top5%",
"Weighted Rate@Top5%",
"Rate@Top10%",
"Weighted Rate@Top10%",
"Rate@TopTenth%",
"RMSE",
"Weighted RMSE",
"F1 Score",
"Weighted F1 Score",
"Precision",
"Weighted Precision",
"Recall",
"Weighted Recall"
],
"type": "string"
},
"type": "array"
},
"regression": {
"description": "Regression metrics associated with the models",
"items": {
"description": "Regression metric names",
"enum": [
"FVE Poisson",
"Weighted FVE Poisson",
"FVE Gamma",
"Weighted FVE Gamma",
"FVE Tweedie",
"Weighted FVE Tweedie",
"Gamma Deviance",
"Weighted Gamma Deviance",
"Gini Norm",
"Weighted Gini Norm",
"MAE",
"Weighted MAE",
"MAPE",
"Weighted MAPE",
"SMAPE",
"Weighted SMAPE",
"Poisson Deviance",
"Weighted Poisson Deviance",
"RMSLE",
"RMSE",
"Weighted RMSLE",
"Weighted RMSE",
"R Squared",
"Weighted R Squared",
"Tweedie Deviance",
"Weighted Tweedie Deviance"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"modelFamilies": {
"description": "Model families associated with the models",
"items": {
"properties": {
"fullName": {
"description": "Full name of the model family",
"type": "string"
},
"key": {
"description": "Abbreviated form of model family name",
"enum": [
"AB",
"AD",
"BLENDER",
"CAL",
"CLUSTER",
"COUNT_DICT",
"CUSTOM",
"DOCUMENT",
"DT",
"DUMMY",
"EP",
"EQ",
"EQ_TS",
"FM",
"GAM",
"GBM",
"GLM",
"GLMNET",
"IMAGE",
"KNN",
"NB",
"NN",
"OTHER",
"RF",
"RI",
"SEGMENTED",
"SVM",
"TEXT",
"TS",
"TS_NN",
"TTS",
"VW"
],
"type": "string"
}
},
"required": [
"fullName",
"key"
],
"type": "object"
},
"maxItems": 32,
"type": "array"
},
"samplePcts": {
"description": "Model training sample sizes (in percentage)",
"items": {
"exclusiveMinimum": 0,
"maximum": 100,
"type": "number"
},
"maxItems": 7,
"type": "array"
}
},
"required": [
"metrics",
"modelFamilies",
"samplePcts"
],
"type": "object"
}
Properties
ExperimentContainerLastActivity
{
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
}
The last activity details.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| timestamp |
string(date-time) |
true |
|
The time when this activity occurred. |
| type |
string |
true |
|
The type of activity. Can be "Added" or "Modified". |
ExperimentContainerModelsForComparisonModelResponse
{
"properties": {
"autopilotDataSelectionMethod": {
"description": "The Data Selection method of the datetime-partitioned model. `null` if model is not datetime-partitioned.",
"enum": [
"duration",
"rowCount"
],
"type": [
"string",
"null"
]
},
"blenderInputModelNumbers": {
"description": "List of model ID numbers used in the blender.",
"items": {
"description": "Model ID numbers used in the blender.",
"type": "integer"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.36"
},
"blueprintNumber": {
"description": "The blueprint number associated with the model.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Timestamp generated at model's project creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"datasetName": {
"description": "The name of the dataset used to build the model in the associated project.",
"type": "string"
},
"featurelistName": {
"description": "The name of the feature list associated with the model.",
"type": "string",
"x-versionadded": "v2.36"
},
"frozenPct": {
"description": "The percentage used to train the frozen model.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.36"
},
"hasCodegen": {
"description": "A boolean setting whether the model can be converted to scorable Java code.",
"type": "boolean"
},
"hasHoldout": {
"description": "Whether the model has holdout.",
"type": "boolean"
},
"icons": {
"description": "The icons associated with the model.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.36"
},
"isBlender": {
"description": "Indicates if the model is a blender.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isCustom": {
"description": "Indicates if the model contains custom tasks.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isDatetimePartitioned": {
"description": "Indicates whether the model is a datetime-partitioned model.",
"type": "boolean"
},
"isExternalPredictionModel": {
"description": "Indicates if the model is an external prediction model.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isFrozen": {
"description": "Indicates if the model is a frozen model.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isMaseBaselineModel": {
"description": "Indicates if the model is a baseline model with MASE score '1.000'.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isReferenceModel": {
"description": "Indicates if the model is a reference model.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isScoringAvailableForModelsTrainedIntoValidationHoldout": {
"description": "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.",
"type": "boolean"
},
"isStarred": {
"description": "Indicates whether the model has been starred for easier identification.",
"type": "boolean"
},
"isTrainedIntoHoldout": {
"description": "Whether the model used holdout data for training.",
"type": "boolean"
},
"isTrainedIntoValidation": {
"description": "Whether the model used validation data for training.",
"type": "boolean"
},
"isTrainedOnGpu": {
"description": "Indicates if the model was trained using GPU workers.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isTransparent": {
"description": "Indicates if the model is a transparent model with exposed coefficients.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isUserModel": {
"description": "Indicates if the model was created with Composable ML.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isUsingCrossValidation": {
"default": true,
"description": "Indicates whether cross-validation is the partitioning strategy used for the project associated with the model.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"metric": {
"description": "Model performance information by the specified filtered evaluation metric",
"type": "object"
},
"modelFamily": {
"description": "Model family associated with the model",
"enum": [
"AB",
"AD",
"BLENDER",
"CAL",
"CLUSTER",
"COUNT_DICT",
"CUSTOM",
"DOCUMENT",
"DT",
"DUMMY",
"EP",
"EQ",
"EQ_TS",
"FM",
"GAM",
"GBM",
"GLM",
"GLMNET",
"IMAGE",
"KNN",
"NB",
"NN",
"OTHER",
"RF",
"RI",
"SEGMENTED",
"SVM",
"TEXT",
"TS",
"TS_NN",
"TTS",
"VW"
],
"type": "string"
},
"modelId": {
"description": "ID of the model",
"type": "string"
},
"modelNumber": {
"description": "The model number from the single experiment leaderboard.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the model",
"type": "string"
},
"projectId": {
"description": "ID of the project associated with the model",
"type": "string"
},
"projectName": {
"description": "Name of the project associated with the model",
"type": "string"
},
"samplePct": {
"description": "Percentage of the dataset to use with the model",
"exclusiveMinimum": 0,
"maximum": 100,
"type": [
"number",
"null"
]
},
"supportsMonotonicConstraints": {
"description": "Indicates if the model supports enforcing monotonic constraints.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"supportsNewSeries": {
"description": "Indicates if the model supports new series (time series only).",
"type": "boolean",
"x-versionadded": "v2.36"
},
"targetName": {
"description": "Name of modeling target",
"type": "string"
},
"targetType": {
"description": "The type of modeling target",
"enum": [
"Binary",
"Regression"
],
"type": "string"
},
"trainingRowCount": {
"default": 1,
"description": "The number of rows used to train the model.",
"exclusiveMinimum": 0,
"type": "integer",
"x-versionadded": "v2.36"
}
},
"required": [
"autopilotDataSelectionMethod",
"blueprintNumber",
"createdAt",
"createdBy",
"datasetName",
"hasCodegen",
"hasHoldout",
"icons",
"isBlender",
"isCustom",
"isDatetimePartitioned",
"isExternalPredictionModel",
"isFrozen",
"isMaseBaselineModel",
"isReferenceModel",
"isScoringAvailableForModelsTrainedIntoValidationHoldout",
"isStarred",
"isTrainedIntoHoldout",
"isTrainedIntoValidation",
"isTrainedOnGpu",
"isTransparent",
"isUserModel",
"isUsingCrossValidation",
"metric",
"modelFamily",
"modelId",
"name",
"projectId",
"projectName",
"samplePct",
"supportsMonotonicConstraints",
"supportsNewSeries",
"targetName",
"targetType",
"trainingRowCount"
],
"type": "object"
}
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. |
| blenderInputModelNumbers |
[integer] |
false |
maxItems: 100
|
List of model ID numbers used in the blender. |
| blueprintNumber |
integer,null |
true |
|
The blueprint number associated with the model. |
| createdAt |
string(date-time) |
true |
|
Timestamp generated at model's project creation. |
| createdBy |
ExperimentContainerUserResponse |
true |
|
A user associated with a use case. |
| datasetName |
string |
true |
|
The name of the dataset used to build the model in the associated project. |
| featurelistName |
string |
false |
|
The name of the feature list associated with the model. |
| frozenPct |
number,null |
false |
|
The percentage used to train the frozen model. |
| hasCodegen |
boolean |
true |
|
A boolean setting whether the model can be converted to scorable Java code. |
| hasHoldout |
boolean |
true |
|
Whether the model has holdout. |
| icons |
integer,null |
true |
|
The icons associated with the model. |
| isBlender |
boolean |
true |
|
Indicates if the model is a blender. |
| isCustom |
boolean |
true |
|
Indicates if the model contains custom tasks. |
| isDatetimePartitioned |
boolean |
true |
|
Indicates whether the model is a datetime-partitioned model. |
| isExternalPredictionModel |
boolean |
true |
|
Indicates if the model is an external prediction model. |
| isFrozen |
boolean |
true |
|
Indicates if the model is a frozen model. |
| isMaseBaselineModel |
boolean |
true |
|
Indicates if the model is a baseline model with MASE score '1.000'. |
| isReferenceModel |
boolean |
true |
|
Indicates if the model is a reference 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 |
|
Indicates whether the model has been starred for easier identification. |
| isTrainedIntoHoldout |
boolean |
true |
|
Whether the model used holdout data for training. |
| isTrainedIntoValidation |
boolean |
true |
|
Whether the model used validation data for training. |
| isTrainedOnGpu |
boolean |
true |
|
Indicates if the model was trained using GPU workers. |
| isTransparent |
boolean |
true |
|
Indicates if the model is a transparent model with exposed coefficients. |
| isUserModel |
boolean |
true |
|
Indicates if the model was created with Composable ML. |
| isUsingCrossValidation |
boolean |
true |
|
Indicates whether cross-validation is the partitioning strategy used for the project associated with the model. |
| 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 |
| modelNumber |
integer,null |
false |
|
The model number from the single experiment leaderboard. |
| 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
|
Percentage of the dataset to use with the model |
| supportsMonotonicConstraints |
boolean |
true |
|
Indicates if the model supports enforcing monotonic constraints. |
| supportsNewSeries |
boolean |
true |
|
Indicates if the model supports new series (time series only). |
| targetName |
string |
true |
|
Name of modeling target |
| targetType |
string |
true |
|
The type of modeling target |
| trainingRowCount |
integer |
true |
|
The number of rows used to train the model. |
Enumerated Values
| Property |
Value |
| autopilotDataSelectionMethod |
[duration, rowCount] |
| modelFamily |
[AB, AD, BLENDER, CAL, CLUSTER, COUNT_DICT, CUSTOM, DOCUMENT, DT, DUMMY, EP, EQ, EQ_TS, FM, GAM, GBM, GLM, GLMNET, IMAGE, KNN, NB, NN, OTHER, RF, RI, SEGMENTED, SVM, TEXT, TS, TS_NN, TTS, VW] |
| targetType |
[Binary, Regression] |
ExperimentContainerNotebookResponse
{
"properties": {
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at notebook creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary id of the entity (same as ID of the notebook).",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity id.",
"enum": [
"notebook"
],
"type": "string"
},
"experimentContainerId": {
"description": "[DEPRECATED - replaced with use_case_id] The ID of the Use Case.",
"type": "string",
"x-versiondeprecated": "v2.32"
},
"id": {
"description": "The ID of the notebook.",
"type": "string"
},
"isDeleted": {
"description": "Soft deletion flag for notebooks",
"type": "boolean"
},
"referenceId": {
"description": "Original ID from DB",
"type": "string"
},
"tenantId": {
"description": "The id of the tenant the notebook belongs to.",
"type": [
"string",
"null"
]
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the Use Case.",
"type": "string"
},
"useCaseName": {
"description": "Use Case name",
"type": "string"
}
},
"required": [
"created",
"createdAt",
"entityId",
"entityType",
"experimentContainerId",
"id",
"isDeleted",
"referenceId",
"tenantId",
"useCaseId"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| created |
ExperimentContainerUserResponse |
true |
|
A user associated with a use case. |
| 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. |
| useCaseName |
string |
false |
|
Use Case name |
Enumerated Values
| Property |
Value |
| entityType |
notebook |
ExperimentContainerPlaygroundResponse
{
"properties": {
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at playground creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary id of the entity (same as ID of the playground).",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity id.",
"enum": [
"playground"
],
"type": "string"
},
"id": {
"description": "The ID of the playground.",
"type": "string"
},
"isDeleted": {
"description": "Soft deletion flag for playgrounds",
"type": "boolean"
},
"referenceId": {
"description": "Original ID from DB",
"type": "string"
},
"tenantId": {
"description": "The id of the tenant the playground belongs to.",
"type": [
"string",
"null"
]
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"createdAt",
"entityId",
"entityType",
"id",
"isDeleted",
"referenceId",
"tenantId"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| created |
ExperimentContainerUserResponse |
true |
|
A user associated with a use case. |
| 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 |
{
"properties": {
"dataSourceType": {
"description": "The type of the data source used to create the dataset if relevant.",
"type": [
"string",
"null"
]
},
"datasetSize": {
"description": "Size of the dataset in bytes",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.34"
},
"datasetSourceType": {
"description": "The source type of the dataset.",
"type": [
"string",
"null"
]
},
"isSnapshot": {
"description": "Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.",
"type": "boolean"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean"
},
"latestRecipeId": {
"description": "The latest recipe ID linked to the dataset.",
"type": [
"string",
"null"
]
}
},
"required": [
"dataSourceType",
"datasetSize",
"datasetSourceType",
"isSnapshot",
"isWranglingEligible",
"latestRecipeId"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| dataSourceType |
string,null |
true |
|
The type of the data source used to create the dataset if relevant. |
| datasetSize |
integer,null |
true |
|
Size of the dataset in bytes |
| 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
{
"description": "Metadata about the reference of the dataset in the Use Case.",
"properties": {
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
}
},
"required": [
"createdAt",
"lastActivity"
],
"type": "object"
}
Metadata about the reference of the dataset in the Use Case.
Properties
{
"properties": {
"dataSourceType": {
"description": "The data source type used to create the file if relevant.",
"type": [
"string",
"null"
]
},
"fileSourceType": {
"description": "The source type of the file.",
"type": [
"string",
"null"
]
},
"numFiles": {
"description": "The number of files in the file.",
"type": [
"integer",
"null"
]
}
},
"required": [
"dataSourceType",
"fileSourceType",
"numFiles"
],
"type": "object",
"x-versionadded": "v2.37"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| dataSourceType |
string,null |
true |
|
The data source type used to create the file if relevant. |
| fileSourceType |
string,null |
true |
|
The source type of the file. |
| numFiles |
integer,null |
true |
|
The number of files in the file. |
{
"properties": {
"description": {
"description": "Description of the playground",
"type": "string"
},
"playgroundType": {
"description": "The type of the playground",
"type": "string",
"x-versionadded": "v2.37"
}
},
"required": [
"description"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| description |
string |
true |
|
Description of the playground |
| playgroundType |
string |
false |
|
The type of the playground |
{
"properties": {
"isDraft": {
"description": "Indicates whether the experiment configuration has been used for modeling and is therefore locked (False) or whether the setup has not been applied , and as a draft, can still be modified and used in training (True).",
"type": "boolean"
},
"isErrored": {
"description": "Indicates whether the experiment failed.",
"type": "boolean"
},
"isWorkbenchEligible": {
"description": "Indicates whether the experiment is Workbench-compatible.",
"type": "boolean"
},
"stage": {
"description": "Stage of the experiment.",
"type": "string",
"x-versionadded": "v2.34"
},
"statusErrorMessage": {
"description": "Experiment failure explanation.",
"type": "string"
}
},
"required": [
"isDraft",
"isErrored",
"isWorkbenchEligible",
"stage",
"statusErrorMessage"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| isDraft |
boolean |
true |
|
Indicates whether the experiment configuration has been used for modeling and is therefore locked (False) or whether the setup has not been applied , and as a draft, can still be modified and used in training (True). |
| isErrored |
boolean |
true |
|
Indicates whether the experiment failed. |
| isWorkbenchEligible |
boolean |
true |
|
Indicates whether the experiment is Workbench-compatible. |
| stage |
string |
true |
|
Stage of the experiment. |
| statusErrorMessage |
string |
true |
|
Experiment failure explanation. |
{
"properties": {
"dataType": {
"description": "The type of the recipe (wrangling or feature discovery)",
"enum": [
"static",
"Static",
"STATIC",
"snapshot",
"Snapshot",
"SNAPSHOT",
"dynamic",
"Dynamic",
"DYNAMIC",
"sqlRecipe",
"SqlRecipe",
"SQL_RECIPE",
"wranglingRecipe",
"WranglingRecipe",
"WRANGLING_RECIPE",
"featureDiscoveryRecipe",
"FeatureDiscoveryRecipe",
"FEATURE_DISCOVERY_RECIPE"
],
"type": [
"string",
"null"
]
}
},
"required": [
"dataType"
],
"type": "object"
}
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, Static, STATIC, snapshot, Snapshot, SNAPSHOT, dynamic, Dynamic, DYNAMIC, sqlRecipe, SqlRecipe, SQL_RECIPE, wranglingRecipe, WranglingRecipe, WRANGLING_RECIPE, featureDiscoveryRecipe, FeatureDiscoveryRecipe, FEATURE_DISCOVERY_RECIPE] |
ExperimentContainerReferenceRetrieve
{
"properties": {
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary id of the entity.",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity id.",
"type": "string"
},
"id": {
"description": "The ID of the experiment container reference.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"metadata": {
"description": "Reference metadata for the experiment container",
"oneOf": [
{
"properties": {
"isDraft": {
"description": "Indicates whether the experiment configuration has been used for modeling and is therefore locked (False) or whether the setup has not been applied , and as a draft, can still be modified and used in training (True).",
"type": "boolean"
},
"isErrored": {
"description": "Indicates whether the experiment failed.",
"type": "boolean"
},
"isWorkbenchEligible": {
"description": "Indicates whether the experiment is Workbench-compatible.",
"type": "boolean"
},
"stage": {
"description": "Stage of the experiment.",
"type": "string",
"x-versionadded": "v2.34"
},
"statusErrorMessage": {
"description": "Experiment failure explanation.",
"type": "string"
}
},
"required": [
"isDraft",
"isErrored",
"isWorkbenchEligible",
"stage",
"statusErrorMessage"
],
"type": "object"
},
{
"properties": {
"dataSourceType": {
"description": "The type of the data source used to create the dataset if relevant.",
"type": [
"string",
"null"
]
},
"datasetSize": {
"description": "Size of the dataset in bytes",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.34"
},
"datasetSourceType": {
"description": "The source type of the dataset.",
"type": [
"string",
"null"
]
},
"isSnapshot": {
"description": "Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.",
"type": "boolean"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean"
},
"latestRecipeId": {
"description": "The latest recipe ID linked to the dataset.",
"type": [
"string",
"null"
]
}
},
"required": [
"dataSourceType",
"datasetSize",
"datasetSourceType",
"isSnapshot",
"isWranglingEligible",
"latestRecipeId"
],
"type": "object"
},
{
"properties": {
"dataType": {
"description": "The type of the recipe (wrangling or feature discovery)",
"enum": [
"static",
"Static",
"STATIC",
"snapshot",
"Snapshot",
"SNAPSHOT",
"dynamic",
"Dynamic",
"DYNAMIC",
"sqlRecipe",
"SqlRecipe",
"SQL_RECIPE",
"wranglingRecipe",
"WranglingRecipe",
"WRANGLING_RECIPE",
"featureDiscoveryRecipe",
"FeatureDiscoveryRecipe",
"FEATURE_DISCOVERY_RECIPE"
],
"type": [
"string",
"null"
]
}
},
"required": [
"dataType"
],
"type": "object"
},
{
"properties": {
"description": {
"description": "Description of the playground",
"type": "string"
},
"playgroundType": {
"description": "The type of the playground",
"type": "string",
"x-versionadded": "v2.37"
}
},
"required": [
"description"
],
"type": "object"
},
{
"properties": {
"errorMessage": {
"description": "The error message, if any, for the vector database.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.38"
},
"source": {
"description": "The source of the vector database",
"type": "string"
}
},
"required": [
"errorMessage",
"source"
],
"type": "object",
"x-versionadded": "v2.37"
},
{
"properties": {
"dataSourceType": {
"description": "The data source type used to create the file if relevant.",
"type": [
"string",
"null"
]
},
"fileSourceType": {
"description": "The source type of the file.",
"type": [
"string",
"null"
]
},
"numFiles": {
"description": "The number of files in the file.",
"type": [
"integer",
"null"
]
}
},
"required": [
"dataSourceType",
"fileSourceType",
"numFiles"
],
"type": "object",
"x-versionadded": "v2.37"
}
]
},
"name": {
"description": "The name of the experiment container reference.",
"type": "string"
},
"processingState": {
"description": "The current ingestion process state of the dataset.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string"
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID linking the Use Case with the entity type.",
"type": "string"
},
"userHasAccess": {
"description": "Identifies if a user has access to the entity.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"versions": {
"description": "A list of entity versions.",
"items": {
"properties": {
"createdAt": {
"description": "Time when this entity was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"id": {
"description": "The id of the entity version.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"name": {
"description": "The name of the entity version.",
"type": "string"
},
"registeredModelVersion": {
"description": "The version number of the entity version.",
"type": "integer"
},
"updatedAt": {
"description": "Time when the last update occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"lastActivity",
"name",
"registeredModelVersion",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.36"
}
},
"required": [
"entityId",
"entityType",
"id",
"name",
"updatedAt",
"useCaseId"
],
"type": "object"
}
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 |
false |
|
The last activity details. |
| metadata |
any |
false |
|
Reference metadata for the experiment container |
oneOf
xor
xor
xor
xor
xor
continued
| Name |
Type |
Required |
Restrictions |
Description |
| name |
string |
true |
|
The name of the experiment container reference. |
| processingState |
string |
false |
|
The current ingestion process state of the dataset. |
| updated |
ExperimentContainerUserResponse |
false |
|
A user associated with a 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. |
| useCaseId |
string |
true |
|
The ID linking the Use Case with the entity type. |
| userHasAccess |
boolean |
false |
|
Identifies if a user has access to the entity. |
| versions |
[UseCaseEntityVersion] |
false |
maxItems: 100
|
A list of entity versions. |
Enumerated Values
| Property |
Value |
| processingState |
[COMPLETED, ERROR, RUNNING] |
{
"properties": {
"errorMessage": {
"description": "The error message, if any, for the vector database.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.38"
},
"source": {
"description": "The source of the vector database",
"type": "string"
}
},
"required": [
"errorMessage",
"source"
],
"type": "object",
"x-versionadded": "v2.37"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| errorMessage |
string,null |
true |
|
The error message, if any, for the vector database. |
| source |
string |
true |
|
The source of the vector database |
ExperimentContainerSharedRolesUpdate
{
"properties": {
"operation": {
"description": "The name of the action being taken. Only 'updateRoles' is supported.",
"enum": [
"updateRoles"
],
"type": "string"
},
"roles": {
"description": "A list of sharing role objects",
"items": {
"oneOf": [
{
"properties": {
"role": {
"description": "The assigned role",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER",
"NO_ROLE"
],
"type": "string",
"x-versionadded": "v2.33"
},
"shareRecipientType": {
"description": "The recipient type",
"enum": [
"user",
"organization"
],
"type": "string",
"x-versionadded": "v2.33"
},
"username": {
"description": "The username of the user to update the access role for. If included with a name, the username is used.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"role",
"shareRecipientType",
"username"
],
"type": "object"
},
{
"properties": {
"name": {
"description": "The name of the user to update the access role for. If included with a username, the username is used.",
"type": "string"
},
"role": {
"description": "The assigned role",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER",
"NO_ROLE"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type",
"enum": [
"user",
"organization"
],
"type": "string"
}
},
"required": [
"name",
"role",
"shareRecipientType"
],
"type": "object"
},
{
"properties": {
"id": {
"description": "The ID of the recipient",
"type": "string"
},
"role": {
"description": "The assigned role",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER",
"NO_ROLE"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type",
"enum": [
"user",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"role",
"shareRecipientType"
],
"type": "object"
}
]
},
"minItems": 1,
"type": "array"
}
},
"required": [
"operation",
"roles"
],
"type": "object"
}
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
xor
xor
Enumerated Values
| Property |
Value |
| operation |
updateRoles |
ExperimentContainerSharingRoleUpdateDataWithId
{
"properties": {
"id": {
"description": "The ID of the recipient",
"type": "string"
},
"role": {
"description": "The assigned role",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER",
"NO_ROLE"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type",
"enum": [
"user",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"role",
"shareRecipientType"
],
"type": "object"
}
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, EDITOR, CONSUMER, NO_ROLE] |
| shareRecipientType |
[user, organization] |
ExperimentContainerSharingRoleUpdateDataWithName
{
"properties": {
"name": {
"description": "The name of the user to update the access role for. If included with a username, the username is used.",
"type": "string"
},
"role": {
"description": "The assigned role",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER",
"NO_ROLE"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type",
"enum": [
"user",
"organization"
],
"type": "string"
}
},
"required": [
"name",
"role",
"shareRecipientType"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| name |
string |
true |
|
The name of the user to update the access role for. If included with a username, the username is used. |
| role |
string |
true |
|
The assigned role |
| shareRecipientType |
string |
true |
|
The recipient type |
Enumerated Values
| Property |
Value |
| role |
[OWNER, EDITOR, CONSUMER, NO_ROLE] |
| shareRecipientType |
[user, organization] |
ExperimentContainerSharingRoleUpdateDataWithUsername
{
"properties": {
"role": {
"description": "The assigned role",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER",
"NO_ROLE"
],
"type": "string",
"x-versionadded": "v2.33"
},
"shareRecipientType": {
"description": "The recipient type",
"enum": [
"user",
"organization"
],
"type": "string",
"x-versionadded": "v2.33"
},
"username": {
"description": "The username of the user to update the access role for. If included with a name, the username is used.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"role",
"shareRecipientType",
"username"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| role |
string |
true |
|
The assigned role |
| shareRecipientType |
string |
true |
|
The recipient type |
| username |
string |
true |
|
The username of the user to update the access role for. If included with a name, the username is used. |
Enumerated Values
| Property |
Value |
| role |
[OWNER, EDITOR, CONSUMER, NO_ROLE] |
| shareRecipientType |
[user, organization] |
ExperimentContainerUserResponse
{
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
}
A user associated with a use case.
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 |
|
The user's gravatar hash. |
| username |
string,null |
false |
|
The username of the user. |
ExperimentContainerVectorDatabaseResponse
{
"properties": {
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at vector database creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary id of the entity (same as ID of the vector database).",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity id.",
"enum": [
"vector_database"
],
"type": "string"
},
"id": {
"description": "The ID of the vector database.",
"type": "string"
},
"isDeleted": {
"description": "Soft deletion flag for vector databases",
"type": "boolean"
},
"referenceId": {
"description": "Original ID from DB",
"type": "string"
},
"tenantId": {
"description": "The id of the tenant the vector database belongs to.",
"type": [
"string",
"null"
]
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"createdAt",
"entityId",
"entityType",
"id",
"isDeleted",
"referenceId",
"tenantId"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| created |
ExperimentContainerUserResponse |
true |
|
A user associated with a use case. |
| 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 |
FeatureCountByTypeResponse
{
"properties": {
"count": {
"description": "The number of features of this type in the dataset",
"type": "integer"
},
"featureType": {
"description": "The data type grouped in this count",
"type": "string"
}
},
"required": [
"count",
"featureType"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
true |
|
The number of features of this type in the dataset |
| featureType |
string |
true |
|
The data type grouped in this count |
FilesEntityCountByTypeResponse
{
"description": "Number of different type entities that use the file.",
"properties": {
"numExperimentContainer": {
"description": "The number of experiment containers that use the file.",
"type": "integer"
}
},
"required": [
"numExperimentContainer"
],
"type": "object",
"x-versionadded": "v2.37"
}
Number of different type entities that use the file.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| numExperimentContainer |
integer |
true |
|
The number of experiment containers that use the file. |
{
"properties": {
"createdAt": {
"description": "The created date time.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"description": {
"description": "The deployment description.",
"type": "string"
},
"id": {
"description": "Unique identifier of the deployment.",
"type": "string"
},
"label": {
"description": "The deployment label.",
"type": "string"
},
"lastActivity": {
"description": "The type of the last activity. Can be \"Added\" or \"Modified\".",
"enum": [
"created",
"Created",
"CREATED",
"modified",
"Modified",
"MODIFIED"
],
"type": "string",
"x-versionadded": "v2.35"
},
"type": {
"description": "The deployment type.",
"type": "string"
},
"updatedAt": {
"description": "The last modified date time.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"userHasAccess": {
"description": "Indicates if a user has access to this deployment.",
"type": "boolean",
"x-versionadded": "v2.35"
}
},
"required": [
"id"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| createdAt |
string(date-time) |
false |
|
The created date time. |
| createdBy |
ExperimentContainerUserResponse |
false |
|
A user associated with a use case. |
| description |
string |
false |
|
The deployment description. |
| id |
string |
true |
|
Unique identifier of the deployment. |
| label |
string |
false |
|
The deployment label. |
| lastActivity |
string |
false |
|
The type of the last activity. Can be "Added" or "Modified". |
| type |
string |
false |
|
The deployment type. |
| updatedAt |
string(date-time) |
false |
|
The last modified date time. |
| updatedBy |
ExperimentContainerUserResponse |
false |
|
A user associated with a use case. |
| userHasAccess |
boolean |
false |
|
Indicates if a user has access to this deployment. |
Enumerated Values
| Property |
Value |
| lastActivity |
[created, Created, CREATED, modified, Modified, MODIFIED] |
FullDatasetDetailsResponse
{
"properties": {
"categories": {
"description": "An array of strings describing the intended use of the dataset.",
"items": {
"description": "The dataset category.",
"enum": [
"BATCH_PREDICTIONS",
"CUSTOM_MODEL_TESTING",
"MULTI_SERIES_CALENDAR",
"PREDICTION",
"SAMPLE",
"SINGLE_SERIES_CALENDAR",
"TRAINING"
],
"type": "string"
},
"type": "array"
},
"columnCount": {
"description": "The number of columns in the dataset.",
"type": "integer",
"x-versionadded": "v2.30"
},
"createdBy": {
"description": "Username of the user who created the dataset.",
"type": [
"string",
"null"
]
},
"creationDate": {
"description": "The date when the dataset was created.",
"format": "date-time",
"type": "string"
},
"dataEngineQueryId": {
"description": "The ID of the source data engine query.",
"type": [
"string",
"null"
]
},
"dataPersisted": {
"description": "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.",
"type": "boolean"
},
"dataSourceId": {
"description": "The ID of the datasource used as the source of the dataset.",
"type": [
"string",
"null"
]
},
"dataSourceType": {
"description": "The type of the datasource that was used as the source of the dataset.",
"type": "string"
},
"datasetId": {
"description": "The ID of this dataset.",
"type": "string"
},
"datasetSize": {
"description": "The size of the dataset as a CSV in bytes.",
"type": "integer",
"x-versionadded": "v2.21"
},
"description": {
"description": "The description of the dataset.",
"type": [
"string",
"null"
]
},
"eda1ModificationDate": {
"description": "The ISO 8601 formatted date and time when the EDA1 for the dataset was updated.",
"format": "date-time",
"type": "string"
},
"eda1ModifierFullName": {
"description": "The user who was the last to update EDA1 for the dataset.",
"type": "string"
},
"entityCountByType": {
"description": "Number of different type entities that use the dataset.",
"properties": {
"numCalendars": {
"description": "The number of calendars that use the dataset",
"type": "integer"
},
"numExperimentContainer": {
"description": "The number of experiment containers that use the dataset.",
"type": "integer",
"x-versionadded": "v2.37"
},
"numExternalModelPackages": {
"description": "The number of external model packages that use the dataset",
"type": "integer"
},
"numFeatureDiscoveryConfigs": {
"description": "The number of feature discovery configs that use the dataset",
"type": "integer"
},
"numPredictionDatasets": {
"description": "The number of prediction datasets that use the dataset",
"type": "integer"
},
"numProjects": {
"description": "The number of projects that use the dataset",
"type": "integer"
},
"numSparkSqlQueries": {
"description": "The number of spark sql queries that use the dataset",
"type": "integer"
}
},
"required": [
"numCalendars",
"numExperimentContainer",
"numExternalModelPackages",
"numFeatureDiscoveryConfigs",
"numPredictionDatasets",
"numProjects",
"numSparkSqlQueries"
],
"type": "object"
},
"error": {
"description": "Details of exception raised during ingestion process, if any.",
"type": "string"
},
"featureCount": {
"description": "Total number of features in the dataset.",
"type": "integer"
},
"featureCountByType": {
"description": "Number of features in the dataset grouped by feature type.",
"items": {
"properties": {
"count": {
"description": "The number of features of this type in the dataset",
"type": "integer"
},
"featureType": {
"description": "The data type grouped in this count",
"type": "string"
}
},
"required": [
"count",
"featureType"
],
"type": "object"
},
"type": "array"
},
"featureDiscoveryProjectId": {
"description": "Feature Discovery project ID used to create the dataset.",
"type": "string",
"x-versionadded": "v2.35"
},
"isDataEngineEligible": {
"description": "Whether this dataset can be a data source of a data engine query.",
"type": "boolean",
"x-versionadded": "v2.20"
},
"isLatestVersion": {
"description": "Whether this dataset version is the latest version of this dataset.",
"type": "boolean"
},
"isSnapshot": {
"description": "Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.",
"type": "boolean"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean",
"x-versionadded": "2.30.0"
},
"lastModificationDate": {
"description": "The ISO 8601 formatted date and time when the dataset was last modified.",
"format": "date-time",
"type": "string"
},
"lastModifierFullName": {
"description": "Full name of user who was the last to modify the dataset.",
"type": "string"
},
"name": {
"description": "The name of this dataset in the catalog.",
"type": "string"
},
"processingState": {
"description": "Current ingestion process state of dataset.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string",
"x-versionadded": "v2.21"
},
"recipeId": {
"description": "The ID of the source recipe.",
"type": [
"string",
"null"
]
},
"rowCount": {
"description": "The number of rows in the dataset.",
"type": "integer",
"x-versionadded": "v2.21"
},
"sampleSize": {
"description": "Ingest size to use during dataset registration. Default behavior is to ingest full dataset.",
"properties": {
"type": {
"description": "The sample size can be specified only as a number of rows for now.",
"enum": [
"rows"
],
"type": "string",
"x-versionadded": "v2.27"
},
"value": {
"description": "Number of rows to ingest during dataset registration.",
"exclusiveMinimum": 0,
"maximum": 1000000,
"type": "integer",
"x-versionadded": "v2.27"
}
},
"required": [
"type",
"value"
],
"type": "object"
},
"tags": {
"description": "List of tags attached to the item.",
"items": {
"type": "string"
},
"type": "array"
},
"timeSeriesProperties": {
"description": "Properties related to time series data prep.",
"properties": {
"isMostlyImputed": {
"default": null,
"description": "Whether more than half of the rows are imputed.",
"type": [
"boolean",
"null"
],
"x-versionadded": "v2.26"
}
},
"required": [
"isMostlyImputed"
],
"type": "object"
},
"uri": {
"description": "The URI to datasource. For example, `file_name.csv`, or `jdbc:DATA_SOURCE_GIVEN_NAME/SCHEMA.TABLE_NAME`, or `jdbc:DATA_SOURCE_GIVEN_NAME/<query>` for `query` based datasources, or`https://s3.amazonaws.com/dr-pr-tst-data/kickcars-sample-200.csv`, etc.",
"type": "string"
},
"versionId": {
"description": "The object ID of the catalog_version the dataset belongs to.",
"type": "string"
}
},
"required": [
"categories",
"columnCount",
"createdBy",
"creationDate",
"dataEngineQueryId",
"dataPersisted",
"dataSourceId",
"dataSourceType",
"datasetId",
"datasetSize",
"description",
"eda1ModificationDate",
"eda1ModifierFullName",
"error",
"featureCount",
"featureCountByType",
"isDataEngineEligible",
"isLatestVersion",
"isSnapshot",
"isWranglingEligible",
"lastModificationDate",
"lastModifierFullName",
"name",
"processingState",
"recipeId",
"rowCount",
"tags",
"timeSeriesProperties",
"uri",
"versionId"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| categories |
[string] |
true |
|
An array of strings describing the intended use of the dataset. |
| columnCount |
integer |
true |
|
The number of columns in the dataset. |
| createdBy |
string,null |
true |
|
Username of the user who created the dataset. |
| creationDate |
string(date-time) |
true |
|
The date when the dataset was created. |
| dataEngineQueryId |
string,null |
true |
|
The ID of the source data engine query. |
| 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. |
| dataSourceId |
string,null |
true |
|
The ID of the datasource used as the source of the dataset. |
| dataSourceType |
string |
true |
|
The type of the datasource that was used as the source of the dataset. |
| datasetId |
string |
true |
|
The ID of this dataset. |
| datasetSize |
integer |
true |
|
The size of the dataset as a CSV in bytes. |
| description |
string,null |
true |
|
The description of the dataset. |
| eda1ModificationDate |
string(date-time) |
true |
|
The ISO 8601 formatted date and time when the EDA1 for the dataset was updated. |
| eda1ModifierFullName |
string |
true |
|
The user who was the last to update EDA1 for the dataset. |
| entityCountByType |
EntityCountByTypeResponse |
false |
|
Number of different type entities that use the dataset. |
| error |
string |
true |
|
Details of exception raised during ingestion process, if any. |
| featureCount |
integer |
true |
|
Total number of features in the dataset. |
| featureCountByType |
[FeatureCountByTypeResponse] |
true |
|
Number of features in the dataset grouped by feature type. |
| featureDiscoveryProjectId |
string |
false |
|
Feature Discovery project ID used to create the dataset. |
| isDataEngineEligible |
boolean |
true |
|
Whether this dataset can be a data source of a data engine query. |
| isLatestVersion |
boolean |
true |
|
Whether this dataset version is the latest version of this 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. |
| lastModificationDate |
string(date-time) |
true |
|
The ISO 8601 formatted date and time when the dataset was last modified. |
| lastModifierFullName |
string |
true |
|
Full name of user who was the last to modify the dataset. |
| name |
string |
true |
|
The name of this dataset in the catalog. |
| processingState |
string |
true |
|
Current ingestion process state of dataset. |
| recipeId |
string,null |
true |
|
The ID of the source recipe. |
| rowCount |
integer |
true |
|
The number of rows in the dataset. |
| sampleSize |
SampleSize |
false |
|
Ingest size to use during dataset registration. Default behavior is to ingest full dataset. |
| tags |
[string] |
true |
|
List of tags attached to the item. |
| timeSeriesProperties |
TimeSeriesProperties |
true |
|
Properties related to time series data prep. |
| uri |
string |
true |
|
The URI to datasource. For example, file_name.csv, or jdbc:DATA_SOURCE_GIVEN_NAME/SCHEMA.TABLE_NAME, or jdbc:DATA_SOURCE_GIVEN_NAME/<query> for query based datasources, orhttps://s3.amazonaws.com/dr-pr-tst-data/kickcars-sample-200.csv, etc. |
| versionId |
string |
true |
|
The object ID of the catalog_version the dataset belongs to. |
Enumerated Values
| Property |
Value |
| processingState |
[COMPLETED, ERROR, RUNNING] |
FullFileDetailsResponse
{
"properties": {
"createdBy": {
"description": "Username of the user who created the file.",
"type": [
"string",
"null"
]
},
"creationDate": {
"description": "The date when the file was created.",
"format": "date-time",
"type": "string"
},
"dataSourceId": {
"description": "ID of the data source used as the source of the file.",
"type": [
"string",
"null"
]
},
"dataSourceType": {
"description": "The type of the data source that was used as the source of the file.",
"type": "string"
},
"description": {
"description": "The description of the file.",
"type": [
"string",
"null"
]
},
"entityCountByType": {
"description": "Number of different type entities that use the file.",
"properties": {
"numExperimentContainer": {
"description": "The number of experiment containers that use the file.",
"type": "integer"
}
},
"required": [
"numExperimentContainer"
],
"type": "object",
"x-versionadded": "v2.37"
},
"error": {
"description": "Details of exception raised during ingestion process, if any.",
"type": "string"
},
"fileId": {
"description": "The ID of this file.",
"type": "string"
},
"isLatestVersion": {
"description": "Whether this file version is the latest version of this file.",
"type": "boolean",
"x-versionadded": "v2.37"
},
"lastModificationDate": {
"description": "The ISO 8601 formatted date and time when the file was last modified.",
"format": "date-time",
"type": "string"
},
"lastModifierFullName": {
"description": "Full name of user who was the last to modify the file.",
"type": "string"
},
"name": {
"description": "The name of this file in the catalog.",
"type": "string"
},
"numFiles": {
"description": "The number of files in the file entity.",
"type": "integer"
},
"processingState": {
"description": "Current ingestion process state of file.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string"
},
"tags": {
"description": "List of tags attached to the item.",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
},
"uri": {
"description": "The URI to the data source.",
"type": "string"
},
"versionId": {
"description": "The object ID of the catalog_version the file belongs to.",
"type": "string"
}
},
"required": [
"createdBy",
"creationDate",
"dataSourceId",
"dataSourceType",
"description",
"entityCountByType",
"error",
"fileId",
"isLatestVersion",
"lastModificationDate",
"lastModifierFullName",
"name",
"numFiles",
"processingState",
"tags",
"uri",
"versionId"
],
"type": "object",
"x-versionadded": "v2.37"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| createdBy |
string,null |
true |
|
Username of the user who created the file. |
| creationDate |
string(date-time) |
true |
|
The date when the file was created. |
| dataSourceId |
string,null |
true |
|
ID of the data source used as the source of the file. |
| dataSourceType |
string |
true |
|
The type of the data source that was used as the source of the file. |
| description |
string,null |
true |
|
The description of the file. |
| entityCountByType |
FilesEntityCountByTypeResponse |
true |
|
Number of different type entities that use the file. |
| error |
string |
true |
|
Details of exception raised during ingestion process, if any. |
| fileId |
string |
true |
|
The ID of this file. |
| isLatestVersion |
boolean |
true |
|
Whether this file version is the latest version of this file. |
| lastModificationDate |
string(date-time) |
true |
|
The ISO 8601 formatted date and time when the file was last modified. |
| lastModifierFullName |
string |
true |
|
Full name of user who was the last to modify the file. |
| name |
string |
true |
|
The name of this file in the catalog. |
| numFiles |
integer |
true |
|
The number of files in the file entity. |
| processingState |
string |
true |
|
Current ingestion process state of file. |
| tags |
[string] |
true |
maxItems: 100
|
List of tags attached to the item. |
| uri |
string |
true |
|
The URI to the data source. |
| versionId |
string |
true |
|
The object ID of the catalog_version the file belongs to. |
Enumerated Values
| Property |
Value |
| processingState |
[COMPLETED, ERROR, RUNNING] |
MetricDetail
{
"properties": {
"ascending": {
"description": "Should the metric be sorted in ascending order",
"type": "boolean"
},
"name": {
"description": "Name of the metric",
"type": "string"
}
},
"required": [
"ascending",
"name"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| ascending |
boolean |
true |
|
Should the metric be sorted in ascending order |
| name |
string |
true |
|
Name of the metric |
PinnedUsecaseResponse
{
"properties": {
"advancedTour": {
"description": "Advanced tour key.",
"type": [
"string",
"null"
]
},
"applicationsCount": {
"description": "The number of applications in a use case.",
"type": "integer"
},
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"customApplicationsCount": {
"description": "The number of custom applications referenced in a use case.",
"type": "integer"
},
"customJobsCount": {
"description": "The number of custom jobs referenced in a use case.",
"type": "integer"
},
"customModelVersionsCount": {
"description": "The number of custom models referenced in a use case.",
"type": "integer"
},
"datasetsCount": {
"description": "The number of datasets in a use case.",
"type": "integer"
},
"deploymentsCount": {
"description": "The number of deployments referenced in a use case.",
"type": "integer"
},
"description": {
"description": "The description of the Use Case.",
"type": [
"string",
"null"
]
},
"filesCount": {
"description": "The number of files in a use case.",
"type": "integer",
"x-versionadded": "v2.37"
},
"formattedDescription": {
"description": "The formatted description of the experiment container used as styled description.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the Use Case.",
"type": "string"
},
"modelsCount": {
"description": "[DEPRECATED] The number of models in a Use Case.",
"type": "integer",
"x-versiondeprecated": "v2.34"
},
"name": {
"description": "The name of the Use Case.",
"type": "string"
},
"notebooksCount": {
"description": "The number of notebooks in a use case.",
"type": "integer"
},
"projectsCount": {
"description": "The number of projects in a use case.",
"type": "integer"
},
"recipesCount": {
"description": "The number of recipes in a Use Case.",
"type": "integer"
},
"registeredModelVersionsCount": {
"description": "The number of registered models referenced in a use case.",
"type": "integer"
},
"riskAssessments": {
"description": "The ID List of the Risk Assessments.",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
},
"role": {
"description": "The requesting user's role on this Use Case.",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER"
],
"type": "string",
"x-versionadded": "v2.37"
},
"tenantId": {
"description": "The ID of the tenant to associate this organization with.",
"type": [
"string",
"null"
]
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated when the record was last updated.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"valueTrackerId": {
"description": "The ID of the Value Tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"applicationsCount",
"created",
"createdAt",
"customApplicationsCount",
"customJobsCount",
"customModelVersionsCount",
"datasetsCount",
"deploymentsCount",
"description",
"filesCount",
"id",
"name",
"notebooksCount",
"projectsCount",
"recipesCount",
"registeredModelVersionsCount",
"role",
"tenantId",
"updated",
"updatedAt"
],
"type": "object",
"x-versionadded": "v2.36"
}
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 |
|
A user associated with a use case. |
| createdAt |
string(date-time) |
true |
|
The timestamp generated at record creation. |
| createdBy |
string,null |
false |
|
The ID of the user who created. |
| customApplicationsCount |
integer |
true |
|
The number of custom applications referenced in a use case. |
| customJobsCount |
integer |
true |
|
The number of custom jobs referenced in a use case. |
| customModelVersionsCount |
integer |
true |
|
The number of custom models referenced in a use case. |
| datasetsCount |
integer |
true |
|
The number of datasets in a use case. |
| deploymentsCount |
integer |
true |
|
The number of deployments referenced in a use case. |
| description |
string,null |
true |
|
The description of the Use Case. |
| filesCount |
integer |
true |
|
The number of files in a use case. |
| formattedDescription |
string,null |
false |
|
The formatted description of the experiment container used as styled description. |
| id |
string |
true |
|
The ID of the Use Case. |
| modelsCount |
integer |
false |
|
[DEPRECATED] 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. |
| projectsCount |
integer |
true |
|
The number of projects in a use case. |
| recipesCount |
integer |
true |
|
The number of recipes in a Use Case. |
| registeredModelVersionsCount |
integer |
true |
|
The number of registered models referenced in a use case. |
| riskAssessments |
[string] |
false |
maxItems: 100
|
The ID List of the Risk Assessments. |
| role |
string |
true |
|
The requesting user's role on this Use Case. |
| tenantId |
string,null |
true |
|
The ID of the tenant to associate this organization with. |
| updated |
ExperimentContainerUserResponse |
true |
|
A user associated with a 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. |
| valueTrackerId |
string,null |
false |
|
The ID of the Value Tracker. |
Enumerated Values
| Property |
Value |
| role |
[OWNER, EDITOR, CONSUMER] |
PinnedUsecaseUpdatePayload
{
"properties": {
"operation": {
"description": "Pinned Use Case possible operations.",
"enum": [
"add",
"remove"
],
"type": "string"
},
"pinnedUseCasesIds": {
"description": "The list of the pinned Use Case IDs.",
"items": {
"type": "string"
},
"maxItems": 8,
"minItems": 1,
"type": "array"
}
},
"required": [
"operation",
"pinnedUseCasesIds"
],
"type": "object",
"x-versionadded": "v2.36"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| operation |
string |
true |
|
Pinned Use Case possible operations. |
| pinnedUseCasesIds |
[string] |
true |
maxItems: 8
minItems: 1
|
The list of the pinned Use Case IDs. |
Enumerated Values
| Property |
Value |
| operation |
[add, remove] |
PinnedUsecasesResponse
{
"properties": {
"data": {
"description": "The list of the pinned use cases.",
"items": {
"properties": {
"advancedTour": {
"description": "Advanced tour key.",
"type": [
"string",
"null"
]
},
"applicationsCount": {
"description": "The number of applications in a use case.",
"type": "integer"
},
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"customApplicationsCount": {
"description": "The number of custom applications referenced in a use case.",
"type": "integer"
},
"customJobsCount": {
"description": "The number of custom jobs referenced in a use case.",
"type": "integer"
},
"customModelVersionsCount": {
"description": "The number of custom models referenced in a use case.",
"type": "integer"
},
"datasetsCount": {
"description": "The number of datasets in a use case.",
"type": "integer"
},
"deploymentsCount": {
"description": "The number of deployments referenced in a use case.",
"type": "integer"
},
"description": {
"description": "The description of the Use Case.",
"type": [
"string",
"null"
]
},
"filesCount": {
"description": "The number of files in a use case.",
"type": "integer",
"x-versionadded": "v2.37"
},
"formattedDescription": {
"description": "The formatted description of the experiment container used as styled description.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the Use Case.",
"type": "string"
},
"modelsCount": {
"description": "[DEPRECATED] The number of models in a Use Case.",
"type": "integer",
"x-versiondeprecated": "v2.34"
},
"name": {
"description": "The name of the Use Case.",
"type": "string"
},
"notebooksCount": {
"description": "The number of notebooks in a use case.",
"type": "integer"
},
"projectsCount": {
"description": "The number of projects in a use case.",
"type": "integer"
},
"recipesCount": {
"description": "The number of recipes in a Use Case.",
"type": "integer"
},
"registeredModelVersionsCount": {
"description": "The number of registered models referenced in a use case.",
"type": "integer"
},
"riskAssessments": {
"description": "The ID List of the Risk Assessments.",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
},
"role": {
"description": "The requesting user's role on this Use Case.",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER"
],
"type": "string",
"x-versionadded": "v2.37"
},
"tenantId": {
"description": "The ID of the tenant to associate this organization with.",
"type": [
"string",
"null"
]
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated when the record was last updated.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"valueTrackerId": {
"description": "The ID of the Value Tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"applicationsCount",
"created",
"createdAt",
"customApplicationsCount",
"customJobsCount",
"customModelVersionsCount",
"datasetsCount",
"deploymentsCount",
"description",
"filesCount",
"id",
"name",
"notebooksCount",
"projectsCount",
"recipesCount",
"registeredModelVersionsCount",
"role",
"tenantId",
"updated",
"updatedAt"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 8,
"type": "array"
}
},
"required": [
"data"
],
"type": "object",
"x-versionadded": "v2.36"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| data |
[PinnedUsecaseResponse] |
true |
maxItems: 8
|
The list of the pinned use cases. |
RiskAssessmentComplete
{
"description": "Risk assessment defined as primary the current Use Case.",
"properties": {
"createdAt": {
"description": "The creation date of the risk assessment.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the risk assessment.",
"type": "string"
},
"description": {
"description": "The description of the risk assessment.",
"type": "string"
},
"evidence": {
"description": "The evidence for the risk assessment.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the risk assessment.",
"type": "string"
},
"isPrimary": {
"default": false,
"description": "Determines if the risk assessment is primary.",
"type": "boolean"
},
"mitigationPlan": {
"description": "The mitigation plan for the risk assessment.",
"type": [
"string",
"null"
]
},
"name": {
"description": "The name of the risk assessment.",
"type": "string"
},
"riskLevel": {
"description": "The name of the risk assessment level.",
"type": "string"
},
"tenantId": {
"description": "The tenant ID related to the risk assessment.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "The last updated date of the risk assessment.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who updated the risk assessment.",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"description",
"evidence",
"id",
"isPrimary",
"mitigationPlan",
"name",
"tenantId",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.36"
}
Risk assessment defined as primary the current Use Case.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| createdAt |
string(date-time) |
true |
|
The creation date of the risk assessment. |
| createdBy |
string |
true |
|
The ID of the user who created the risk assessment. |
| description |
string |
true |
|
The description of the risk assessment. |
| evidence |
string,null |
true |
|
The evidence for the risk assessment. |
| id |
string |
true |
|
The ID of the risk assessment. |
| isPrimary |
boolean |
true |
|
Determines if the risk assessment is primary. |
| mitigationPlan |
string,null |
true |
|
The mitigation plan for the risk assessment. |
| name |
string |
true |
|
The name of the risk assessment. |
| riskLevel |
string |
false |
|
The name of the risk assessment level. |
| tenantId |
string,null |
true |
|
The tenant ID related to the risk assessment. |
| updatedAt |
string(date-time) |
true |
|
The last updated date of the risk assessment. |
| updatedBy |
string |
true |
|
The ID of the user who updated the risk assessment. |
SampleSize
{
"description": "Ingest size to use during dataset registration. Default behavior is to ingest full dataset.",
"properties": {
"type": {
"description": "The sample size can be specified only as a number of rows for now.",
"enum": [
"rows"
],
"type": "string",
"x-versionadded": "v2.27"
},
"value": {
"description": "Number of rows to ingest during dataset registration.",
"exclusiveMinimum": 0,
"maximum": 1000000,
"type": "integer",
"x-versionadded": "v2.27"
}
},
"required": [
"type",
"value"
],
"type": "object"
}
Ingest size to use during dataset registration. Default behavior is to ingest full dataset.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| type |
string |
true |
|
The sample size can be specified only as a number of rows for now. |
| value |
integer |
true |
maximum: 1000000
|
Number of rows to ingest during dataset registration. |
Enumerated Values
SharedRolesWithGrantListResponse
{
"properties": {
"count": {
"description": "The number of items returned.",
"type": "integer"
},
"data": {
"description": "The access control list.",
"items": {
"properties": {
"canShare": {
"description": "Whether the recipient can share the role further.",
"type": "boolean"
},
"id": {
"description": "The identifier of the recipient.",
"type": "string"
},
"name": {
"description": "The name of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": "string"
},
"shareRecipientType": {
"description": "The type of the recipient.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
},
"userFullName": {
"description": "The full name of the recipient user.",
"type": "string"
}
},
"required": [
"canShare",
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "The URL pointing to the next page.",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL pointing to the previous page.",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items matching the condition.",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
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 |
|
The URL pointing to the next page. |
| previous |
string,null |
true |
|
The URL pointing to the previous page. |
| totalCount |
integer |
true |
|
The total number of items matching the condition. |
TimeSeriesProperties
{
"description": "Properties related to time series data prep.",
"properties": {
"isMostlyImputed": {
"default": null,
"description": "Whether more than half of the rows are imputed.",
"type": [
"boolean",
"null"
],
"x-versionadded": "v2.26"
}
},
"required": [
"isMostlyImputed"
],
"type": "object"
}
Properties related to time series data prep.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| isMostlyImputed |
boolean,null |
true |
|
Whether more than half of the rows are imputed. |
UseCaseCreate
{
"properties": {
"advancedTour": {
"description": "Advanced tour key.",
"enum": [
"flightDelays",
"hospital"
],
"type": [
"string",
"null"
]
},
"description": {
"default": null,
"description": "The description of the Use Case.",
"type": [
"string",
"null"
]
},
"name": {
"default": null,
"description": "The name of the Use Case.",
"maxLength": 100,
"type": [
"string",
"null"
]
}
},
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| advancedTour |
string,null |
false |
|
Advanced tour key. |
| description |
string,null |
false |
|
The description of the Use Case. |
| name |
string,null |
false |
maxLength: 100
|
The name of the Use Case. |
Enumerated Values
| Property |
Value |
| advancedTour |
[flightDelays, hospital] |
UseCaseCustomApplication
{
"properties": {
"applicationUrl": {
"description": "The reachable URL of the custom application.",
"type": "string",
"x-versionadded": "v2.35"
},
"createdAt": {
"description": "The time when this model was created.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.35"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"customApplicationSourceId": {
"description": "The ID of the custom application source.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.39"
},
"id": {
"description": "The ID of the custom application.",
"type": "string"
},
"lastActivity": {
"description": "The type of the last activity. Can be \"Added\" or \"Modified\".",
"enum": [
"created",
"Created",
"CREATED",
"modified",
"Modified",
"MODIFIED"
],
"type": "string"
},
"name": {
"description": "The name of the custom application.",
"type": "string"
},
"permissions": {
"description": "The list of permissions available for the user.",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.39"
},
"status": {
"description": "The status of the custom application.",
"type": "string",
"x-versionadded": "v2.35"
},
"updatedAt": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"userHasAccess": {
"description": "Indicates if a user has access to this custom application.",
"type": "boolean",
"x-versionadded": "v2.35"
}
},
"required": [
"id"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| applicationUrl |
string |
false |
|
The reachable URL of the custom application. |
| createdAt |
string(date-time) |
false |
|
The time when this model was created. |
| createdBy |
ExperimentContainerUserResponse |
false |
|
A user associated with a use case. |
| customApplicationSourceId |
string,null |
false |
|
The ID of the custom application source. |
| id |
string |
true |
|
The ID of the custom application. |
| lastActivity |
string |
false |
|
The type of the last activity. Can be "Added" or "Modified". |
| name |
string |
false |
|
The name of the custom application. |
| permissions |
[string] |
false |
maxItems: 100
|
The list of permissions available for the user. |
| status |
string |
false |
|
The status of the custom application. |
| updatedAt |
string(date-time) |
false |
|
The time when this activity occurred. |
| updatedBy |
ExperimentContainerUserResponse |
false |
|
A user associated with a use case. |
| userHasAccess |
boolean |
false |
|
Indicates if a user has access to this custom application. |
Enumerated Values
| Property |
Value |
| lastActivity |
[created, Created, CREATED, modified, Modified, MODIFIED] |
UseCaseCustomApplicationsResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of custom applications.",
"items": {
"properties": {
"applicationUrl": {
"description": "The reachable URL of the custom application.",
"type": "string",
"x-versionadded": "v2.35"
},
"createdAt": {
"description": "The time when this model was created.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.35"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"customApplicationSourceId": {
"description": "The ID of the custom application source.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.39"
},
"id": {
"description": "The ID of the custom application.",
"type": "string"
},
"lastActivity": {
"description": "The type of the last activity. Can be \"Added\" or \"Modified\".",
"enum": [
"created",
"Created",
"CREATED",
"modified",
"Modified",
"MODIFIED"
],
"type": "string"
},
"name": {
"description": "The name of the custom application.",
"type": "string"
},
"permissions": {
"description": "The list of permissions available for the user.",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.39"
},
"status": {
"description": "The status of the custom application.",
"type": "string",
"x-versionadded": "v2.35"
},
"updatedAt": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"userHasAccess": {
"description": "Indicates if a user has access to this custom application.",
"type": "boolean",
"x-versionadded": "v2.35"
}
},
"required": [
"id"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[UseCaseCustomApplication] |
true |
maxItems: 100
|
The list of custom applications. |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
UseCaseDataListResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer",
"x-versionadded": "v2.33"
},
"data": {
"description": "The list of the datasets in this use case.",
"items": {
"properties": {
"columnCount": {
"description": "The number of columns in a dataset. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"dataSourceType": {
"description": "The driver class type used to create the dataset if relevant.",
"enum": [
"s3",
"native-s3",
"native-adls",
"adlsgen2",
"oracle",
"iris",
"exasol",
"sap",
"databricks-v1",
"native-databricks",
"bigquery-v1",
"bigquery1",
"bigquery2",
"athena2",
"athena1",
"kdb",
"treasuredata",
"elasticsearch",
"snowflake",
"mysql",
"mssql",
"postgres",
"palantirfoundry",
"teradata",
"redshift",
"datasphere-v1",
"trino-v1",
"native-gdrive",
"native-sharepoint",
"native-confluence",
"native-jira",
"native-box",
"unknown"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"dataType": {
"description": "The type of data entity.",
"enum": [
"static",
"Static",
"STATIC",
"snapshot",
"Snapshot",
"SNAPSHOT",
"dynamic",
"Dynamic",
"DYNAMIC",
"sqlRecipe",
"SqlRecipe",
"SQL_RECIPE",
"wranglingRecipe",
"WranglingRecipe",
"WRANGLING_RECIPE",
"featureDiscoveryRecipe",
"FeatureDiscoveryRecipe",
"FEATURE_DISCOVERY_RECIPE"
],
"type": "string",
"x-versionadded": "v2.33"
},
"datasetSize": {
"description": "The size of the dataset as a CSV in bytes. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the dataset or recipe.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"entityId": {
"description": "The primary ID of the entity.",
"type": "string",
"x-versionadded": "v2.33"
},
"entityType": {
"description": "The type of entity provided by the entity ID.",
"enum": [
"recipe",
"Recipe",
"RECIPE",
"dataset",
"Dataset",
"DATASET",
"project",
"Project",
"PROJECT",
"application",
"Application",
"APPLICATION"
],
"type": "string",
"x-versionadded": "v2.33"
},
"featureDiscoveryProjectId": {
"description": "Related feature discovery project if this is a feature discovery dataset.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean",
"x-versionadded": "v2.33"
},
"latestRecipeId": {
"description": "The latest recipe ID linked to the dataset.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"modifiedAt": {
"description": "The timestamp generated at dataset modification.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "The name of the dataset or recipe.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"processingState": {
"description": "The current ingestion process state of the dataset.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"rowCount": {
"description": "The number of data rows in the dataset. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"columnCount",
"createdBy",
"dataSourceType",
"dataType",
"datasetSize",
"description",
"entityId",
"entityType",
"featureDiscoveryProjectId",
"isWranglingEligible",
"latestRecipeId",
"modifiedAt",
"name",
"processingState",
"rowCount"
],
"type": "object"
},
"type": "array",
"x-versionadded": "v2.33"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer",
"x-versionadded": "v2.33"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[UseCaseDataResponse] |
true |
|
The list of the datasets in this use case. |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
UseCaseDataResponse
{
"properties": {
"columnCount": {
"description": "The number of columns in a dataset. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"dataSourceType": {
"description": "The driver class type used to create the dataset if relevant.",
"enum": [
"s3",
"native-s3",
"native-adls",
"adlsgen2",
"oracle",
"iris",
"exasol",
"sap",
"databricks-v1",
"native-databricks",
"bigquery-v1",
"bigquery1",
"bigquery2",
"athena2",
"athena1",
"kdb",
"treasuredata",
"elasticsearch",
"snowflake",
"mysql",
"mssql",
"postgres",
"palantirfoundry",
"teradata",
"redshift",
"datasphere-v1",
"trino-v1",
"native-gdrive",
"native-sharepoint",
"native-confluence",
"native-jira",
"native-box",
"unknown"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"dataType": {
"description": "The type of data entity.",
"enum": [
"static",
"Static",
"STATIC",
"snapshot",
"Snapshot",
"SNAPSHOT",
"dynamic",
"Dynamic",
"DYNAMIC",
"sqlRecipe",
"SqlRecipe",
"SQL_RECIPE",
"wranglingRecipe",
"WranglingRecipe",
"WRANGLING_RECIPE",
"featureDiscoveryRecipe",
"FeatureDiscoveryRecipe",
"FEATURE_DISCOVERY_RECIPE"
],
"type": "string",
"x-versionadded": "v2.33"
},
"datasetSize": {
"description": "The size of the dataset as a CSV in bytes. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the dataset or recipe.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"entityId": {
"description": "The primary ID of the entity.",
"type": "string",
"x-versionadded": "v2.33"
},
"entityType": {
"description": "The type of entity provided by the entity ID.",
"enum": [
"recipe",
"Recipe",
"RECIPE",
"dataset",
"Dataset",
"DATASET",
"project",
"Project",
"PROJECT",
"application",
"Application",
"APPLICATION"
],
"type": "string",
"x-versionadded": "v2.33"
},
"featureDiscoveryProjectId": {
"description": "Related feature discovery project if this is a feature discovery dataset.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean",
"x-versionadded": "v2.33"
},
"latestRecipeId": {
"description": "The latest recipe ID linked to the dataset.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"modifiedAt": {
"description": "The timestamp generated at dataset modification.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "The name of the dataset or recipe.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"processingState": {
"description": "The current ingestion process state of the dataset.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"rowCount": {
"description": "The number of data rows in the dataset. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"columnCount",
"createdBy",
"dataSourceType",
"dataType",
"datasetSize",
"description",
"entityId",
"entityType",
"featureDiscoveryProjectId",
"isWranglingEligible",
"latestRecipeId",
"modifiedAt",
"name",
"processingState",
"rowCount"
],
"type": "object"
}
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 |
| createdBy |
ExperimentContainerUserResponse |
true |
|
A user associated with a use case. |
| dataSourceType |
string,null |
true |
|
The driver class type used to create the dataset if relevant. |
| dataType |
string |
true |
|
The type of data entity. |
| 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 |
| description |
string,null |
true |
|
The description of the dataset or recipe. |
| entityId |
string |
true |
|
The primary ID of the entity. |
| entityType |
string |
true |
|
The type of entity provided by the entity ID. |
| featureDiscoveryProjectId |
string,null |
true |
|
Related feature discovery project if this is a feature discovery dataset. |
| 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,null(date-time) |
true |
|
The timestamp generated at dataset modification. |
| name |
string,null |
true |
|
The name of the dataset or recipe. |
| processingState |
string,null |
true |
|
The current ingestion process state of the dataset. |
| 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 |
Enumerated Values
| Property |
Value |
| dataSourceType |
[s3, native-s3, native-adls, adlsgen2, oracle, iris, exasol, sap, databricks-v1, native-databricks, bigquery-v1, bigquery1, bigquery2, athena2, athena1, kdb, treasuredata, elasticsearch, snowflake, mysql, mssql, postgres, palantirfoundry, teradata, redshift, datasphere-v1, trino-v1, native-gdrive, native-sharepoint, native-confluence, native-jira, native-box, unknown] |
| dataType |
[static, Static, STATIC, snapshot, Snapshot, SNAPSHOT, dynamic, Dynamic, DYNAMIC, sqlRecipe, SqlRecipe, SQL_RECIPE, wranglingRecipe, WranglingRecipe, WRANGLING_RECIPE, featureDiscoveryRecipe, FeatureDiscoveryRecipe, FEATURE_DISCOVERY_RECIPE] |
| entityType |
[recipe, Recipe, RECIPE, dataset, Dataset, DATASET, project, Project, PROJECT, application, Application, APPLICATION] |
| processingState |
[COMPLETED, ERROR, RUNNING] |
UseCaseDatasetResponse
{
"properties": {
"columnCount": {
"description": "The number of columns in a dataset. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
]
},
"createdAt": {
"description": "The timestamp generated at dataset creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"dataPersisted": {
"description": "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.",
"type": "boolean"
},
"dataSourceType": {
"description": "The type of the data source used to create the dataset if relevant.",
"type": [
"string",
"null"
]
},
"dataType": {
"description": "The type of data entity.",
"enum": [
"static",
"Static",
"STATIC",
"snapshot",
"Snapshot",
"SNAPSHOT",
"dynamic",
"Dynamic",
"DYNAMIC",
"sqlRecipe",
"SqlRecipe",
"SQL_RECIPE",
"wranglingRecipe",
"WranglingRecipe",
"WRANGLING_RECIPE",
"featureDiscoveryRecipe",
"FeatureDiscoveryRecipe",
"FEATURE_DISCOVERY_RECIPE"
],
"type": "string",
"x-versionadded": "v2.33"
},
"datasetId": {
"description": "The dataset ID of the dataset.",
"type": "string"
},
"datasetSize": {
"description": "The size of the dataset as a CSV in bytes. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
]
},
"datasetSourceType": {
"description": "The source type of the dataset.",
"type": [
"string",
"null"
]
},
"description": {
"description": "The description of the dataset.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"featureDiscoveryProjectId": {
"description": "Related feature discovery project if this is a feature discovery dataset.",
"type": [
"string",
"null"
]
},
"isSnapshot": {
"description": "Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.",
"type": "boolean"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean"
},
"latestRecipeId": {
"description": "The latest recipe ID linked to the dataset.",
"type": [
"string",
"null"
]
},
"modifiedAt": {
"description": "The timestamp generated at dataset modification.",
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"name": {
"description": "The name of the dataset.",
"type": "string"
},
"processingState": {
"description": "The current ingestion process state of the dataset.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string"
},
"referenceMetadata": {
"description": "Metadata about the reference of the dataset in the Use Case.",
"properties": {
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
}
},
"required": [
"createdAt",
"lastActivity"
],
"type": "object"
},
"rowCount": {
"description": "The number of data rows in the dataset. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
]
},
"versionId": {
"description": "The dataset version id of the latest version of the dataset.",
"type": "string"
}
},
"required": [
"columnCount",
"createdAt",
"createdBy",
"dataPersisted",
"dataSourceType",
"dataType",
"datasetId",
"datasetSize",
"datasetSourceType",
"description",
"isSnapshot",
"isWranglingEligible",
"latestRecipeId",
"modifiedAt",
"modifiedBy",
"name",
"processingState",
"referenceMetadata",
"rowCount",
"versionId"
],
"type": "object"
}
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 |
|
A user associated with a use case. |
| 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. |
| dataType |
string |
true |
|
The type of data entity. |
| 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. |
| description |
string,null |
true |
|
The description 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 |
|
A user associated with a use case. |
| name |
string |
true |
|
The name of the dataset. |
| processingState |
string |
true |
|
The current ingestion process state of the 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 |
| dataType |
[static, Static, STATIC, snapshot, Snapshot, SNAPSHOT, dynamic, Dynamic, DYNAMIC, sqlRecipe, SqlRecipe, SQL_RECIPE, wranglingRecipe, WranglingRecipe, WRANGLING_RECIPE, featureDiscoveryRecipe, FeatureDiscoveryRecipe, FEATURE_DISCOVERY_RECIPE] |
| processingState |
[COMPLETED, ERROR, RUNNING] |
UseCaseDatasetsListResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "A list of the datasets in the Use Case",
"items": {
"properties": {
"columnCount": {
"description": "The number of columns in a dataset. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
]
},
"createdAt": {
"description": "The timestamp generated at dataset creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"dataPersisted": {
"description": "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.",
"type": "boolean"
},
"dataSourceType": {
"description": "The type of the data source used to create the dataset if relevant.",
"type": [
"string",
"null"
]
},
"dataType": {
"description": "The type of data entity.",
"enum": [
"static",
"Static",
"STATIC",
"snapshot",
"Snapshot",
"SNAPSHOT",
"dynamic",
"Dynamic",
"DYNAMIC",
"sqlRecipe",
"SqlRecipe",
"SQL_RECIPE",
"wranglingRecipe",
"WranglingRecipe",
"WRANGLING_RECIPE",
"featureDiscoveryRecipe",
"FeatureDiscoveryRecipe",
"FEATURE_DISCOVERY_RECIPE"
],
"type": "string",
"x-versionadded": "v2.33"
},
"datasetId": {
"description": "The dataset ID of the dataset.",
"type": "string"
},
"datasetSize": {
"description": "The size of the dataset as a CSV in bytes. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
]
},
"datasetSourceType": {
"description": "The source type of the dataset.",
"type": [
"string",
"null"
]
},
"description": {
"description": "The description of the dataset.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"featureDiscoveryProjectId": {
"description": "Related feature discovery project if this is a feature discovery dataset.",
"type": [
"string",
"null"
]
},
"isSnapshot": {
"description": "Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.",
"type": "boolean"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean"
},
"latestRecipeId": {
"description": "The latest recipe ID linked to the dataset.",
"type": [
"string",
"null"
]
},
"modifiedAt": {
"description": "The timestamp generated at dataset modification.",
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"name": {
"description": "The name of the dataset.",
"type": "string"
},
"processingState": {
"description": "The current ingestion process state of the dataset.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string"
},
"referenceMetadata": {
"description": "Metadata about the reference of the dataset in the Use Case.",
"properties": {
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
}
},
"required": [
"createdAt",
"lastActivity"
],
"type": "object"
},
"rowCount": {
"description": "The number of data rows in the dataset. ``null`` might be returned in case dataset is in running or errored state",
"type": [
"integer",
"null"
]
},
"versionId": {
"description": "The dataset version id of the latest version of the dataset.",
"type": "string"
}
},
"required": [
"columnCount",
"createdAt",
"createdBy",
"dataPersisted",
"dataSourceType",
"dataType",
"datasetId",
"datasetSize",
"datasetSourceType",
"description",
"isSnapshot",
"isWranglingEligible",
"latestRecipeId",
"modifiedAt",
"modifiedBy",
"name",
"processingState",
"referenceMetadata",
"rowCount",
"versionId"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[UseCaseDatasetResponse] |
true |
|
A list of the datasets in the Use Case |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
UseCaseEntityVersion
{
"properties": {
"createdAt": {
"description": "Time when this entity was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"id": {
"description": "The id of the entity version.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"name": {
"description": "The name of the entity version.",
"type": "string"
},
"registeredModelVersion": {
"description": "The version number of the entity version.",
"type": "integer"
},
"updatedAt": {
"description": "Time when the last update occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"lastActivity",
"name",
"registeredModelVersion",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.36"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| createdAt |
string(date-time) |
true |
|
Time when this entity was created. |
| createdBy |
ExperimentContainerUserResponse |
true |
|
A user associated with a use case. |
| id |
string |
true |
|
The id of the entity version. |
| lastActivity |
ExperimentContainerLastActivity |
true |
|
The last activity details. |
| name |
string |
true |
|
The name of the entity version. |
| registeredModelVersion |
integer |
true |
|
The version number of the entity version. |
| updatedAt |
string(date-time) |
true |
|
Time when the last update occurred. |
| updatedBy |
ExperimentContainerUserResponse |
true |
|
A user associated with a use case. |
UseCaseFileResponse
{
"properties": {
"createdAt": {
"description": "The timestamp generated at file creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"dataSourceType": {
"description": "The type of the data source used to create the file (if relevant).",
"type": [
"string",
"null"
]
},
"description": {
"description": "The description of the file.",
"type": [
"string",
"null"
]
},
"fileId": {
"description": "The file ID.",
"type": "string"
},
"fileSourceType": {
"description": "The source type of the file.",
"type": [
"string",
"null"
]
},
"modifiedAt": {
"description": "The timestamp generated at file modification.",
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"name": {
"description": "The name of the file.",
"type": "string"
},
"numFiles": {
"description": "The number of files in catalog item. ``null`` might be returned in cases where the file is in a running or errored state.",
"type": [
"integer",
"null"
]
},
"processingState": {
"description": "Current ingestion process state of file.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string"
},
"referenceMetadata": {
"description": "Metadata about the reference of the dataset in the Use Case.",
"properties": {
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
}
},
"required": [
"createdAt",
"lastActivity"
],
"type": "object"
},
"versionId": {
"description": "The file version ID for the file's latest version.",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"dataSourceType",
"description",
"fileId",
"fileSourceType",
"modifiedAt",
"modifiedBy",
"name",
"numFiles",
"processingState",
"referenceMetadata",
"versionId"
],
"type": "object",
"x-versionadded": "v2.37"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| createdAt |
string(date-time) |
true |
|
The timestamp generated at file creation. |
| createdBy |
ExperimentContainerUserResponse |
true |
|
A user associated with a use case. |
| dataSourceType |
string,null |
true |
|
The type of the data source used to create the file (if relevant). |
| description |
string,null |
true |
|
The description of the file. |
| fileId |
string |
true |
|
The file ID. |
| fileSourceType |
string,null |
true |
|
The source type of the file. |
| modifiedAt |
string(date-time) |
true |
|
The timestamp generated at file modification. |
| modifiedBy |
ExperimentContainerUserResponse |
true |
|
A user associated with a use case. |
| name |
string |
true |
|
The name of the file. |
| numFiles |
integer,null |
true |
|
The number of files in catalog item. null might be returned in cases where the file is in a running or errored state. |
| processingState |
string |
true |
|
Current ingestion process state of file. |
| referenceMetadata |
ExperimentContainerReferenceDatasetResponse |
true |
|
Metadata about the reference of the dataset in the Use Case. |
| versionId |
string |
true |
|
The file version ID for the file's latest version. |
Enumerated Values
| Property |
Value |
| processingState |
[COMPLETED, ERROR, RUNNING] |
UseCaseFilesListResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "A list of the files in the Use Case.",
"items": {
"properties": {
"createdAt": {
"description": "The timestamp generated at file creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"dataSourceType": {
"description": "The type of the data source used to create the file (if relevant).",
"type": [
"string",
"null"
]
},
"description": {
"description": "The description of the file.",
"type": [
"string",
"null"
]
},
"fileId": {
"description": "The file ID.",
"type": "string"
},
"fileSourceType": {
"description": "The source type of the file.",
"type": [
"string",
"null"
]
},
"modifiedAt": {
"description": "The timestamp generated at file modification.",
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"name": {
"description": "The name of the file.",
"type": "string"
},
"numFiles": {
"description": "The number of files in catalog item. ``null`` might be returned in cases where the file is in a running or errored state.",
"type": [
"integer",
"null"
]
},
"processingState": {
"description": "Current ingestion process state of file.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string"
},
"referenceMetadata": {
"description": "Metadata about the reference of the dataset in the Use Case.",
"properties": {
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
}
},
"required": [
"createdAt",
"lastActivity"
],
"type": "object"
},
"versionId": {
"description": "The file version ID for the file's latest version.",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"dataSourceType",
"description",
"fileId",
"fileSourceType",
"modifiedAt",
"modifiedBy",
"name",
"numFiles",
"processingState",
"referenceMetadata",
"versionId"
],
"type": "object",
"x-versionadded": "v2.37"
},
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.37"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[UseCaseFileResponse] |
true |
|
A list of the files in the Use Case. |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
UseCaseLastActivity
{
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
}
The last activity details.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| timestamp |
string(date-time) |
true |
|
The time when this activity occurred. |
| type |
string |
true |
|
The type of activity. Can be "Added" or "Modified". |
UseCaseListResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of use cases that match the query.",
"items": {
"properties": {
"advancedTour": {
"description": "Advanced tour key.",
"type": [
"string",
"null"
]
},
"applicationsCount": {
"description": "The number of applications in a Use Case.",
"type": "integer"
},
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"customApplicationsCount": {
"description": "The number of custom applications referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"customJobsCount": {
"description": "The number of custom jobs referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"customModelVersionsCount": {
"description": "The number of custom models referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"datasetsCount": {
"description": "The number of datasets in a Use Case.",
"type": "integer"
},
"deploymentsCount": {
"description": "The number of deployments referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"description": {
"description": "The description of the Use Case.",
"type": [
"string",
"null"
]
},
"filesCount": {
"description": "The number of files in a Use Case.",
"type": "integer",
"x-versionadded": "v2.37"
},
"formattedDescription": {
"description": "The formatted description of the experiment container used as styled description.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the Use Case.",
"type": "string"
},
"members": {
"description": "The list of use case members.",
"items": {
"properties": {
"email": {
"description": "The email address of the member.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the member.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the member.",
"type": "string"
},
"isOrganization": {
"description": "Whether the member is an organization.",
"type": [
"boolean",
"null"
]
},
"userhash": {
"description": "The member's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the member.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"type": "array"
},
"modelsCount": {
"description": "[DEPRECATED] The number of models in a Use Case.",
"type": "integer",
"x-versiondeprecated": "v2.34"
},
"name": {
"description": "The name of the Use Case.",
"type": "string"
},
"notebooksCount": {
"description": "The number of notebooks in a Use Case.",
"type": "integer"
},
"owners": {
"description": "The list of owners of a use case.",
"items": {
"properties": {
"email": {
"description": "The email address of the member.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the member.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the member.",
"type": "string"
},
"isOrganization": {
"description": "Whether the member is an organization.",
"type": [
"boolean",
"null"
]
},
"userhash": {
"description": "The member's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the member.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"type": "array"
},
"primaryRiskAssessment": {
"description": "Risk assessment defined as primary the current Use Case.",
"properties": {
"createdAt": {
"description": "The creation date of the risk assessment.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the risk assessment.",
"type": "string"
},
"description": {
"description": "The description of the risk assessment.",
"type": "string"
},
"evidence": {
"description": "The evidence for the risk assessment.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the risk assessment.",
"type": "string"
},
"isPrimary": {
"default": false,
"description": "Determines if the risk assessment is primary.",
"type": "boolean"
},
"mitigationPlan": {
"description": "The mitigation plan for the risk assessment.",
"type": [
"string",
"null"
]
},
"name": {
"description": "The name of the risk assessment.",
"type": "string"
},
"riskLevel": {
"description": "The name of the risk assessment level.",
"type": "string"
},
"tenantId": {
"description": "The tenant ID related to the risk assessment.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "The last updated date of the risk assessment.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who updated the risk assessment.",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"description",
"evidence",
"id",
"isPrimary",
"mitigationPlan",
"name",
"tenantId",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.36"
},
"projectsCount": {
"description": "The number of projects in a Use Case.",
"type": "integer"
},
"recipesCount": {
"description": "The number of recipes in a Use Case.",
"type": "integer",
"x-versionadded": "v2.33"
},
"registeredModelVersionsCount": {
"description": "The number of registered models referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"riskAssessments": {
"description": "The ID List of the Risk Assessments.",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.36"
},
"role": {
"description": "The requesting user's role on this Use Case.",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER"
],
"type": "string"
},
"tenantId": {
"description": "The ID of the tenant to associate this organization with.",
"type": [
"string",
"null"
]
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated when the record was last updated.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"valueTracker": {
"description": "The value tracker information.",
"properties": {
"accuracyHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the accuracy."
},
"businessImpact": {
"description": "The expected effects on overall business operations.",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The ID for this comment.",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "The value tracker description.",
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the value tracker can be accomplished across multiple dimensions.",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The ID of the ValueTracker.",
"type": "string"
},
"inProductionWarning": {
"description": "An optional warning to indicate that deployments are attached to this value tracker.",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "The list of user objects.",
"items": {
"description": "DataRobot user information.",
"properties": {
"firstName": {
"description": "The first name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DataRobot user ID.",
"type": "string"
},
"lastName": {
"description": "The last name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the ValueTracker owner.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"modelHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the model."
},
"name": {
"description": "The name of the value tracker.",
"type": "string"
},
"notes": {
"description": "The user notes.",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information.",
"properties": {
"firstName": {
"description": "The first name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DataRobot user ID.",
"type": "string"
},
"lastName": {
"description": "The last name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the ValueTracker owner.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "The permissions of the current user.",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional. Contains MonetaryValue objects.",
"properties": {
"currency": {
"description": "The ISO code of the currency.",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes.",
"type": [
"string",
"null"
]
},
"value": {
"description": "The amount of value.",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "The estimated cost of an individual incorrect decision.",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "The estimated number of incorrect decisions per year.",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "The value tracker value template type.",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"targetValue": {
"description": "The target value.",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "The value tracker value template type.",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Optional. Contains the template type and parameter information."
},
"predictionTargets": {
"description": "An array of prediction target name strings.",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"predictionsCount": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"description": "The list of prediction counts.",
"items": {
"type": "integer"
},
"type": "array"
}
],
"description": "The count of the number of predictions made."
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional. Contains MonetaryValue objects.",
"properties": {
"currency": {
"description": "The ISO code of the currency.",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes.",
"type": [
"string",
"null"
]
},
"value": {
"description": "The amount of value.",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Optional. Contains MonetaryValue objects."
},
"serviceHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the service."
},
"stage": {
"description": "The current stage of the value tracker.",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "The array of TargetDate objects.",
"items": {
"properties": {
"date": {
"description": "The date of the target.",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "The name of the target stage.",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"valueTrackerId": {
"description": "The ID of the Value Tracker.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"applicationsCount",
"created",
"createdAt",
"customApplicationsCount",
"customJobsCount",
"customModelVersionsCount",
"datasetsCount",
"deploymentsCount",
"description",
"filesCount",
"id",
"members",
"name",
"notebooksCount",
"projectsCount",
"recipesCount",
"registeredModelVersionsCount",
"role",
"tenantId",
"updated",
"updatedAt"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[UseCaseResponse] |
true |
maxItems: 100
|
The list of use cases that match the query. |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
UseCaseListWithShortenedInfoResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "A list of Use Cases with shortened info that match the query",
"items": {
"properties": {
"advancedTour": {
"description": "Advanced tour key.",
"type": [
"string",
"null"
]
},
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the Use Case.",
"type": [
"string",
"null"
]
},
"description": {
"description": "The description of the Use Case.",
"type": [
"string",
"null"
]
},
"formattedDescription": {
"description": "The formatted description of the experiment container used as styled description.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the Use Case.",
"type": "string"
},
"name": {
"description": "The name of the Use Case.",
"type": "string"
},
"tenantId": {
"description": "The ID of the tenant to associate this organization with.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "The timestamp generated when the record was last updated.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated the Use Case.",
"type": [
"string",
"null"
]
},
"valueTrackerId": {
"description": "The ID of the Value Tracker.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"createdAt",
"description",
"formattedDescription",
"id",
"name",
"tenantId",
"updatedAt"
],
"type": "object",
"x-versionadded": "v2.34"
},
"maxItems": 100,
"minItems": 1,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.34"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[UseCaseWithShortenedInfoResponse] |
true |
maxItems: 100
minItems: 1
|
A list of Use Cases with shortened info that match the query |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
UseCaseMemberResponse
{
"properties": {
"email": {
"description": "The email address of the member.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the member.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the member.",
"type": "string"
},
"isOrganization": {
"description": "Whether the member is an organization.",
"type": [
"boolean",
"null"
]
},
"userhash": {
"description": "The member's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the member.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
}
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 an organization. |
| userhash |
string,null |
false |
|
The member's gravatar hash. |
| username |
string,null |
false |
|
The username of the member. |
UseCaseModelsForComparisonListResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "Models from multiple projects in the Use Case",
"items": {
"properties": {
"autopilotDataSelectionMethod": {
"description": "The Data Selection method of the datetime-partitioned model. `null` if model is not datetime-partitioned.",
"enum": [
"duration",
"rowCount"
],
"type": [
"string",
"null"
]
},
"blenderInputModelNumbers": {
"description": "List of model ID numbers used in the blender.",
"items": {
"description": "Model ID numbers used in the blender.",
"type": "integer"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.36"
},
"blueprintNumber": {
"description": "The blueprint number associated with the model.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Timestamp generated at model's project creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"datasetName": {
"description": "The name of the dataset used to build the model in the associated project.",
"type": "string"
},
"featurelistName": {
"description": "The name of the feature list associated with the model.",
"type": "string",
"x-versionadded": "v2.36"
},
"frozenPct": {
"description": "The percentage used to train the frozen model.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.36"
},
"hasCodegen": {
"description": "A boolean setting whether the model can be converted to scorable Java code.",
"type": "boolean"
},
"hasHoldout": {
"description": "Whether the model has holdout.",
"type": "boolean"
},
"icons": {
"description": "The icons associated with the model.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.36"
},
"isBlender": {
"description": "Indicates if the model is a blender.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isCustom": {
"description": "Indicates if the model contains custom tasks.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isDatetimePartitioned": {
"description": "Indicates whether the model is a datetime-partitioned model.",
"type": "boolean"
},
"isExternalPredictionModel": {
"description": "Indicates if the model is an external prediction model.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isFrozen": {
"description": "Indicates if the model is a frozen model.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isMaseBaselineModel": {
"description": "Indicates if the model is a baseline model with MASE score '1.000'.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isReferenceModel": {
"description": "Indicates if the model is a reference model.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isScoringAvailableForModelsTrainedIntoValidationHoldout": {
"description": "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.",
"type": "boolean"
},
"isStarred": {
"description": "Indicates whether the model has been starred for easier identification.",
"type": "boolean"
},
"isTrainedIntoHoldout": {
"description": "Whether the model used holdout data for training.",
"type": "boolean"
},
"isTrainedIntoValidation": {
"description": "Whether the model used validation data for training.",
"type": "boolean"
},
"isTrainedOnGpu": {
"description": "Indicates if the model was trained using GPU workers.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isTransparent": {
"description": "Indicates if the model is a transparent model with exposed coefficients.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isUserModel": {
"description": "Indicates if the model was created with Composable ML.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isUsingCrossValidation": {
"default": true,
"description": "Indicates whether cross-validation is the partitioning strategy used for the project associated with the model.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"metric": {
"description": "Model performance information by the specified filtered evaluation metric",
"type": "object"
},
"modelFamily": {
"description": "Model family associated with the model",
"enum": [
"AB",
"AD",
"BLENDER",
"CAL",
"CLUSTER",
"COUNT_DICT",
"CUSTOM",
"DOCUMENT",
"DT",
"DUMMY",
"EP",
"EQ",
"EQ_TS",
"FM",
"GAM",
"GBM",
"GLM",
"GLMNET",
"IMAGE",
"KNN",
"NB",
"NN",
"OTHER",
"RF",
"RI",
"SEGMENTED",
"SVM",
"TEXT",
"TS",
"TS_NN",
"TTS",
"VW"
],
"type": "string"
},
"modelId": {
"description": "ID of the model",
"type": "string"
},
"modelNumber": {
"description": "The model number from the single experiment leaderboard.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the model",
"type": "string"
},
"projectId": {
"description": "ID of the project associated with the model",
"type": "string"
},
"projectName": {
"description": "Name of the project associated with the model",
"type": "string"
},
"samplePct": {
"description": "Percentage of the dataset to use with the model",
"exclusiveMinimum": 0,
"maximum": 100,
"type": [
"number",
"null"
]
},
"supportsMonotonicConstraints": {
"description": "Indicates if the model supports enforcing monotonic constraints.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"supportsNewSeries": {
"description": "Indicates if the model supports new series (time series only).",
"type": "boolean",
"x-versionadded": "v2.36"
},
"targetName": {
"description": "Name of modeling target",
"type": "string"
},
"targetType": {
"description": "The type of modeling target",
"enum": [
"Binary",
"Regression"
],
"type": "string"
},
"trainingRowCount": {
"default": 1,
"description": "The number of rows used to train the model.",
"exclusiveMinimum": 0,
"type": "integer",
"x-versionadded": "v2.36"
}
},
"required": [
"autopilotDataSelectionMethod",
"blueprintNumber",
"createdAt",
"createdBy",
"datasetName",
"hasCodegen",
"hasHoldout",
"icons",
"isBlender",
"isCustom",
"isDatetimePartitioned",
"isExternalPredictionModel",
"isFrozen",
"isMaseBaselineModel",
"isReferenceModel",
"isScoringAvailableForModelsTrainedIntoValidationHoldout",
"isStarred",
"isTrainedIntoHoldout",
"isTrainedIntoValidation",
"isTrainedOnGpu",
"isTransparent",
"isUserModel",
"isUsingCrossValidation",
"metric",
"modelFamily",
"modelId",
"name",
"projectId",
"projectName",
"samplePct",
"supportsMonotonicConstraints",
"supportsNewSeries",
"targetName",
"targetType",
"trainingRowCount"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[ExperimentContainerModelsForComparisonModelResponse] |
true |
|
Models from multiple projects in the Use Case |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
UseCaseProjectOptionsResponse
{
"description": "Project options currently saved for a project. Can be changed while project is in draft status.",
"properties": {
"target": {
"description": "Name of the target",
"type": [
"string",
"null"
]
},
"targetType": {
"description": "The target type of the project.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"minInflated",
"Multilabel",
"TextGeneration",
"GeoPoint",
"VectorDatabase"
],
"type": [
"string",
"null"
]
},
"validationType": {
"description": "The validation type of the partitioning strategy for the project, either CV for cross-validation or TVH for train-validation-holdout split.",
"enum": [
"CV",
"TVH"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"weight": {
"description": "Name of the weight (if configured)",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
Project options currently saved for a project. Can be changed while project is in draft status.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| target |
string,null |
false |
|
Name of the target |
| targetType |
string,null |
false |
|
The target type of the project. |
| validationType |
string,null |
false |
|
The validation type of the partitioning strategy for the project, either CV for cross-validation or TVH for train-validation-holdout split. |
| weight |
string,null |
false |
|
Name of the weight (if configured) |
Enumerated Values
| Property |
Value |
| targetType |
[Binary, Regression, Multiclass, minInflated, Multilabel, TextGeneration, GeoPoint, VectorDatabase] |
| validationType |
[CV, TVH] |
UseCaseProjectResponse
{
"properties": {
"autopilotDataSelectionMethod": {
"description": "The Data Selection method of the datetime-partitioned project. `null` if project is not datetime-partitioned.",
"enum": [
"duration",
"rowCount"
],
"type": [
"string",
"null"
]
},
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at project creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"dataset": {
"description": "Name of the dataset in the registry used to build the project associated with the project",
"type": "string"
},
"datasetId": {
"description": "The dataset ID of the dataset in the registry.",
"type": [
"string",
"null"
]
},
"datasetVersionId": {
"description": "The dataset version ID of the dataset in the registry.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.41"
},
"hasHoldout": {
"description": "Whether the project has holdout.",
"type": "boolean"
},
"isDatasetLinkedToUseCase": {
"description": "Indicates whether the dataset that this project was created from is attached to this Use Case.",
"type": "boolean"
},
"isDraft": {
"description": "Indicates whether the experiment configuration has been used for modeling and is therefore locked (False) or whether the setup has not been applied , and as a draft, can still be modified and used in training (True).",
"type": "boolean"
},
"isErrored": {
"description": "Indicates whether the experiment failed.",
"type": "boolean"
},
"isScoringAvailableForModelsTrainedIntoValidationHoldout": {
"description": "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.",
"type": "boolean"
},
"isWorkbenchEligible": {
"description": "Indicates whether the experiment is Workbench-compatible.",
"type": "boolean"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"metricDetail": {
"description": "Project metrics",
"items": {
"properties": {
"ascending": {
"description": "Should the metric be sorted in ascending order",
"type": "boolean"
},
"name": {
"description": "Name of the metric",
"type": "string"
}
},
"required": [
"ascending",
"name"
],
"type": "object"
},
"type": "array"
},
"models": {
"description": "The number of models in an use case.",
"type": "integer"
},
"name": {
"description": "The name of the project.",
"type": "string"
},
"numberOfBacktests": {
"description": "The number of backtests of the datetime-partitioned project. 0 if project is not datetime-partitioned.",
"minimum": 0,
"type": "integer"
},
"projectId": {
"description": "The ID of the project.",
"type": "string"
},
"projectOptions": {
"description": "Project options currently saved for a project. Can be changed while project is in draft status.",
"properties": {
"target": {
"description": "Name of the target",
"type": [
"string",
"null"
]
},
"targetType": {
"description": "The target type of the project.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"minInflated",
"Multilabel",
"TextGeneration",
"GeoPoint",
"VectorDatabase"
],
"type": [
"string",
"null"
]
},
"validationType": {
"description": "The validation type of the partitioning strategy for the project, either CV for cross-validation or TVH for train-validation-holdout split.",
"enum": [
"CV",
"TVH"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"weight": {
"description": "Name of the weight (if configured)",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"stage": {
"description": "Stage of the experiment.",
"type": "string",
"x-versionadded": "v2.34"
},
"statusErrorMessage": {
"description": "Experiment failure explanation.",
"type": "string"
},
"target": {
"description": "Name of the target",
"type": [
"string",
"null"
]
},
"targetType": {
"description": "The type of modeling target.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"minInflated",
"Multilabel",
"TextGeneration",
"GeoPoint",
"VectorDatabase"
],
"type": [
"string",
"null"
]
},
"timeAware": {
"description": "Shows if project uses time series",
"type": "boolean"
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated at project modification.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
}
},
"required": [
"autopilotDataSelectionMethod",
"created",
"createdAt",
"dataset",
"datasetId",
"datasetVersionId",
"hasHoldout",
"isDatasetLinkedToUseCase",
"isDraft",
"isErrored",
"isScoringAvailableForModelsTrainedIntoValidationHoldout",
"isWorkbenchEligible",
"lastActivity",
"metricDetail",
"models",
"name",
"numberOfBacktests",
"projectId",
"projectOptions",
"stage",
"statusErrorMessage",
"timeAware",
"updated",
"updatedAt"
],
"type": "object"
}
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 |
|
A user associated with a use case. |
| 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,null |
true |
|
The dataset ID of the dataset in the registry. |
| datasetVersionId |
string,null |
true |
|
The dataset version ID of the dataset in the registry. |
| hasHoldout |
boolean |
true |
|
Whether the project has holdout. |
| isDatasetLinkedToUseCase |
boolean |
true |
|
Indicates whether the dataset that this project was created from is attached to this Use Case. |
| isDraft |
boolean |
true |
|
Indicates whether the experiment configuration has been used for modeling and is therefore locked (False) or whether the setup has not been applied , and as a draft, can still be modified and used in training (True). |
| isErrored |
boolean |
true |
|
Indicates whether the experiment failed. |
| 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 |
|
The 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. |
| stage |
string |
true |
|
Stage of the experiment. |
| statusErrorMessage |
string |
true |
|
Experiment failure explanation. |
| target |
string,null |
false |
|
Name of the target |
| targetType |
string,null |
false |
|
The type of modeling target. |
| timeAware |
boolean |
true |
|
Shows if project uses time series |
| updated |
ExperimentContainerUserResponse |
true |
|
A user associated with a use case. |
| 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, rowCount] |
| targetType |
[Binary, Regression, Multiclass, minInflated, Multilabel, TextGeneration, GeoPoint, VectorDatabase] |
UseCaseProjectsListResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "A list of the Use Case projects that match the query",
"items": {
"properties": {
"autopilotDataSelectionMethod": {
"description": "The Data Selection method of the datetime-partitioned project. `null` if project is not datetime-partitioned.",
"enum": [
"duration",
"rowCount"
],
"type": [
"string",
"null"
]
},
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at project creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"dataset": {
"description": "Name of the dataset in the registry used to build the project associated with the project",
"type": "string"
},
"datasetId": {
"description": "The dataset ID of the dataset in the registry.",
"type": [
"string",
"null"
]
},
"datasetVersionId": {
"description": "The dataset version ID of the dataset in the registry.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.41"
},
"hasHoldout": {
"description": "Whether the project has holdout.",
"type": "boolean"
},
"isDatasetLinkedToUseCase": {
"description": "Indicates whether the dataset that this project was created from is attached to this Use Case.",
"type": "boolean"
},
"isDraft": {
"description": "Indicates whether the experiment configuration has been used for modeling and is therefore locked (False) or whether the setup has not been applied , and as a draft, can still be modified and used in training (True).",
"type": "boolean"
},
"isErrored": {
"description": "Indicates whether the experiment failed.",
"type": "boolean"
},
"isScoringAvailableForModelsTrainedIntoValidationHoldout": {
"description": "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.",
"type": "boolean"
},
"isWorkbenchEligible": {
"description": "Indicates whether the experiment is Workbench-compatible.",
"type": "boolean"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"metricDetail": {
"description": "Project metrics",
"items": {
"properties": {
"ascending": {
"description": "Should the metric be sorted in ascending order",
"type": "boolean"
},
"name": {
"description": "Name of the metric",
"type": "string"
}
},
"required": [
"ascending",
"name"
],
"type": "object"
},
"type": "array"
},
"models": {
"description": "The number of models in an use case.",
"type": "integer"
},
"name": {
"description": "The name of the project.",
"type": "string"
},
"numberOfBacktests": {
"description": "The number of backtests of the datetime-partitioned project. 0 if project is not datetime-partitioned.",
"minimum": 0,
"type": "integer"
},
"projectId": {
"description": "The ID of the project.",
"type": "string"
},
"projectOptions": {
"description": "Project options currently saved for a project. Can be changed while project is in draft status.",
"properties": {
"target": {
"description": "Name of the target",
"type": [
"string",
"null"
]
},
"targetType": {
"description": "The target type of the project.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"minInflated",
"Multilabel",
"TextGeneration",
"GeoPoint",
"VectorDatabase"
],
"type": [
"string",
"null"
]
},
"validationType": {
"description": "The validation type of the partitioning strategy for the project, either CV for cross-validation or TVH for train-validation-holdout split.",
"enum": [
"CV",
"TVH"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"weight": {
"description": "Name of the weight (if configured)",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"stage": {
"description": "Stage of the experiment.",
"type": "string",
"x-versionadded": "v2.34"
},
"statusErrorMessage": {
"description": "Experiment failure explanation.",
"type": "string"
},
"target": {
"description": "Name of the target",
"type": [
"string",
"null"
]
},
"targetType": {
"description": "The type of modeling target.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"minInflated",
"Multilabel",
"TextGeneration",
"GeoPoint",
"VectorDatabase"
],
"type": [
"string",
"null"
]
},
"timeAware": {
"description": "Shows if project uses time series",
"type": "boolean"
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated at project modification.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
}
},
"required": [
"autopilotDataSelectionMethod",
"created",
"createdAt",
"dataset",
"datasetId",
"datasetVersionId",
"hasHoldout",
"isDatasetLinkedToUseCase",
"isDraft",
"isErrored",
"isScoringAvailableForModelsTrainedIntoValidationHoldout",
"isWorkbenchEligible",
"lastActivity",
"metricDetail",
"models",
"name",
"numberOfBacktests",
"projectId",
"projectOptions",
"stage",
"statusErrorMessage",
"timeAware",
"updated",
"updatedAt"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[UseCaseProjectResponse] |
true |
|
A list of the Use Case projects that match the query |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
UseCaseRecentAssetsListResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer",
"x-versionadded": "v2.33"
},
"data": {
"description": "The list of the use case references that match the query.",
"items": {
"properties": {
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary ID of the entity.",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity ID.",
"type": "string"
},
"id": {
"description": "The ID of the Use Case reference.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"metadata": {
"description": "The reference metadata for the use case.",
"oneOf": [
{
"properties": {
"isDraft": {
"description": "Indicates whether the experiment configuration has been used for modeling and is therefore locked (False) or whether the setup has not been applied , and as a draft, can still be modified and used in training (True).",
"type": "boolean"
},
"isErrored": {
"description": "Indicates whether the experiment failed.",
"type": "boolean"
},
"isWorkbenchEligible": {
"description": "Indicates whether the experiment is Workbench-compatible.",
"type": "boolean"
},
"stage": {
"description": "Stage of the experiment.",
"type": "string",
"x-versionadded": "v2.34"
},
"statusErrorMessage": {
"description": "The experiment failure explanation.",
"type": "string"
}
},
"required": [
"isDraft",
"isErrored",
"isWorkbenchEligible",
"stage",
"statusErrorMessage"
],
"type": "object"
},
{
"properties": {
"dataSourceType": {
"description": "The type of the data source used to create the dataset if relevant.",
"type": [
"string",
"null"
]
},
"datasetSize": {
"description": "The size of the dataset in bytes.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.34"
},
"datasetSourceType": {
"description": "The source type of the dataset",
"type": [
"string",
"null"
]
},
"isSnapshot": {
"description": "Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.",
"type": "boolean"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean"
},
"latestRecipeId": {
"description": "The latest recipe ID linked to the dataset.",
"type": [
"string",
"null"
]
}
},
"required": [
"dataSourceType",
"datasetSize",
"datasetSourceType",
"isSnapshot",
"isWranglingEligible",
"latestRecipeId"
],
"type": "object"
},
{
"properties": {
"dataType": {
"description": "The type of the recipe (wrangling or feature discovery)",
"enum": [
"static",
"Static",
"STATIC",
"snapshot",
"Snapshot",
"SNAPSHOT",
"dynamic",
"Dynamic",
"DYNAMIC",
"sqlRecipe",
"SqlRecipe",
"SQL_RECIPE",
"wranglingRecipe",
"WranglingRecipe",
"WRANGLING_RECIPE",
"featureDiscoveryRecipe",
"FeatureDiscoveryRecipe",
"FEATURE_DISCOVERY_RECIPE"
],
"type": [
"string",
"null"
]
}
},
"required": [
"dataType"
],
"type": "object"
},
{
"properties": {
"description": {
"description": "The description of the playground.",
"type": "string"
},
"playgroundType": {
"description": "The type of the playground.",
"type": "string",
"x-versionadded": "v2.37"
}
},
"required": [
"description"
],
"type": "object"
},
{
"properties": {
"errorMessage": {
"description": "The error message, if any, for the vector database.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.38"
},
"source": {
"description": "The source of the vector database",
"type": "string"
}
},
"required": [
"errorMessage",
"source"
],
"type": "object",
"x-versionadded": "v2.37"
},
{
"properties": {
"dataSourceType": {
"description": "The data source type used to create the file if relevant.",
"type": [
"string",
"null"
]
},
"fileSourceType": {
"description": "The source type of the file.",
"type": [
"string",
"null"
]
},
"numFiles": {
"description": "The number of files in the catalog item.",
"type": [
"integer",
"null"
]
}
},
"required": [
"dataSourceType",
"fileSourceType",
"numFiles"
],
"type": "object",
"x-versionadded": "v2.37"
}
]
},
"name": {
"description": "The name of the Use Case reference.",
"type": "string"
},
"processingState": {
"description": "The current ingestion process state of the dataset.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string"
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the linked use case.",
"type": "string"
},
"useCaseName": {
"description": "The name of the linked use case.",
"type": [
"string",
"null"
]
},
"userHasAccess": {
"description": "Identifies if a user has access to the entity.",
"type": [
"boolean",
"null"
],
"x-versionadded": "v2.36"
},
"versions": {
"description": "The list of entity versions.",
"items": {
"properties": {
"createdAt": {
"description": "Time when this entity was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"id": {
"description": "The id of the entity version.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"name": {
"description": "The name of the entity version.",
"type": "string"
},
"registeredModelVersion": {
"description": "The version number of the entity version.",
"type": "integer"
},
"updatedAt": {
"description": "Time when the last update occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"lastActivity",
"name",
"registeredModelVersion",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.36"
}
},
"required": [
"entityId",
"entityType",
"id",
"name",
"updatedAt",
"useCaseId"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer",
"x-versionadded": "v2.33"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[UseCaseReferenceRetrieve] |
true |
maxItems: 100
|
The list of the use case references that match the query. |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
{
"properties": {
"dataSourceType": {
"description": "The type of the data source used to create the dataset if relevant.",
"type": [
"string",
"null"
]
},
"datasetSize": {
"description": "The size of the dataset in bytes.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.34"
},
"datasetSourceType": {
"description": "The source type of the dataset",
"type": [
"string",
"null"
]
},
"isSnapshot": {
"description": "Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.",
"type": "boolean"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean"
},
"latestRecipeId": {
"description": "The latest recipe ID linked to the dataset.",
"type": [
"string",
"null"
]
}
},
"required": [
"dataSourceType",
"datasetSize",
"datasetSourceType",
"isSnapshot",
"isWranglingEligible",
"latestRecipeId"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| dataSourceType |
string,null |
true |
|
The type of the data source used to create the dataset if relevant. |
| datasetSize |
integer,null |
true |
|
The size of the dataset in bytes. |
| 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. |
{
"properties": {
"dataSourceType": {
"description": "The data source type used to create the file if relevant.",
"type": [
"string",
"null"
]
},
"fileSourceType": {
"description": "The source type of the file.",
"type": [
"string",
"null"
]
},
"numFiles": {
"description": "The number of files in the catalog item.",
"type": [
"integer",
"null"
]
}
},
"required": [
"dataSourceType",
"fileSourceType",
"numFiles"
],
"type": "object",
"x-versionadded": "v2.37"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| dataSourceType |
string,null |
true |
|
The data source type used to create the file if relevant. |
| fileSourceType |
string,null |
true |
|
The source type of the file. |
| numFiles |
integer,null |
true |
|
The number of files in the catalog item. |
UseCaseReferenceLink
{
"properties": {
"workflow": {
"default": "unspecified",
"description": "The workflow that is attaching this entity. Does not affect the operation of the API call. Only used for analytics.",
"enum": [
"migration",
"creation",
"move",
"unspecified"
],
"type": "string"
}
},
"required": [
"workflow"
],
"type": "object"
}
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, creation, move, unspecified] |
UseCaseReferenceListResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of the use case references that match the query.",
"items": {
"properties": {
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary ID of the entity.",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity ID.",
"type": "string"
},
"id": {
"description": "The ID of the Use Case reference.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"metadata": {
"description": "The reference metadata for the use case.",
"oneOf": [
{
"properties": {
"isDraft": {
"description": "Indicates whether the experiment configuration has been used for modeling and is therefore locked (False) or whether the setup has not been applied , and as a draft, can still be modified and used in training (True).",
"type": "boolean"
},
"isErrored": {
"description": "Indicates whether the experiment failed.",
"type": "boolean"
},
"isWorkbenchEligible": {
"description": "Indicates whether the experiment is Workbench-compatible.",
"type": "boolean"
},
"stage": {
"description": "Stage of the experiment.",
"type": "string",
"x-versionadded": "v2.34"
},
"statusErrorMessage": {
"description": "The experiment failure explanation.",
"type": "string"
}
},
"required": [
"isDraft",
"isErrored",
"isWorkbenchEligible",
"stage",
"statusErrorMessage"
],
"type": "object"
},
{
"properties": {
"dataSourceType": {
"description": "The type of the data source used to create the dataset if relevant.",
"type": [
"string",
"null"
]
},
"datasetSize": {
"description": "The size of the dataset in bytes.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.34"
},
"datasetSourceType": {
"description": "The source type of the dataset",
"type": [
"string",
"null"
]
},
"isSnapshot": {
"description": "Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.",
"type": "boolean"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean"
},
"latestRecipeId": {
"description": "The latest recipe ID linked to the dataset.",
"type": [
"string",
"null"
]
}
},
"required": [
"dataSourceType",
"datasetSize",
"datasetSourceType",
"isSnapshot",
"isWranglingEligible",
"latestRecipeId"
],
"type": "object"
},
{
"properties": {
"dataType": {
"description": "The type of the recipe (wrangling or feature discovery)",
"enum": [
"static",
"Static",
"STATIC",
"snapshot",
"Snapshot",
"SNAPSHOT",
"dynamic",
"Dynamic",
"DYNAMIC",
"sqlRecipe",
"SqlRecipe",
"SQL_RECIPE",
"wranglingRecipe",
"WranglingRecipe",
"WRANGLING_RECIPE",
"featureDiscoveryRecipe",
"FeatureDiscoveryRecipe",
"FEATURE_DISCOVERY_RECIPE"
],
"type": [
"string",
"null"
]
}
},
"required": [
"dataType"
],
"type": "object"
},
{
"properties": {
"description": {
"description": "The description of the playground.",
"type": "string"
},
"playgroundType": {
"description": "The type of the playground.",
"type": "string",
"x-versionadded": "v2.37"
}
},
"required": [
"description"
],
"type": "object"
},
{
"properties": {
"errorMessage": {
"description": "The error message, if any, for the vector database.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.38"
},
"source": {
"description": "The source of the vector database",
"type": "string"
}
},
"required": [
"errorMessage",
"source"
],
"type": "object",
"x-versionadded": "v2.37"
},
{
"properties": {
"dataSourceType": {
"description": "The data source type used to create the file if relevant.",
"type": [
"string",
"null"
]
},
"fileSourceType": {
"description": "The source type of the file.",
"type": [
"string",
"null"
]
},
"numFiles": {
"description": "The number of files in the catalog item.",
"type": [
"integer",
"null"
]
}
},
"required": [
"dataSourceType",
"fileSourceType",
"numFiles"
],
"type": "object",
"x-versionadded": "v2.37"
}
]
},
"name": {
"description": "The name of the Use Case reference.",
"type": "string"
},
"processingState": {
"description": "The current ingestion process state of the dataset.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string"
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the linked use case.",
"type": "string"
},
"useCaseName": {
"description": "The name of the linked use case.",
"type": [
"string",
"null"
]
},
"userHasAccess": {
"description": "Identifies if a user has access to the entity.",
"type": [
"boolean",
"null"
],
"x-versionadded": "v2.36"
},
"versions": {
"description": "The list of entity versions.",
"items": {
"properties": {
"createdAt": {
"description": "Time when this entity was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"id": {
"description": "The id of the entity version.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"name": {
"description": "The name of the entity version.",
"type": "string"
},
"registeredModelVersion": {
"description": "The version number of the entity version.",
"type": "integer"
},
"updatedAt": {
"description": "Time when the last update occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"lastActivity",
"name",
"registeredModelVersion",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.36"
}
},
"required": [
"entityId",
"entityType",
"id",
"name",
"updatedAt",
"useCaseId"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[UseCaseReferenceRetrieve] |
true |
|
The list of the use case references that match the query. |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
UseCaseReferenceMultilink
{
"properties": {
"entitiesList": {
"description": "Entities to link to this Use Case",
"items": {
"properties": {
"entityId": {
"description": "The primary id of the entity to link.",
"type": "string",
"x-versionadded": "v2.33"
},
"entityType": {
"description": "The type of entity to link.",
"enum": [
"project",
"dataset",
"file",
"notebook",
"application",
"recipe",
"customModelVersion",
"registeredModelVersion",
"deployment",
"customApplication",
"customJob"
],
"type": "string",
"x-versionadded": "v2.33"
},
"includeDataset": {
"default": true,
"description": "Include dataset migration when an experiment is migrated",
"type": "boolean",
"x-versionadded": "v2.34"
}
},
"required": [
"entityId",
"entityType"
],
"type": "object"
},
"maxItems": 100,
"minItems": 1,
"type": "array",
"x-versionadded": "v2.33"
},
"workflow": {
"default": "unspecified",
"description": "The workflow that is attaching this entity. Does not affect the operation of the API call. Only used for analytics.",
"enum": [
"migration",
"creation",
"move",
"unspecified"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"entitiesList",
"workflow"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| entitiesList |
[UseCaseReferenceMultilinkEntity] |
true |
maxItems: 100
minItems: 1
|
Entities to link to this Use Case |
| 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, creation, move, unspecified] |
UseCaseReferenceMultilinkEntity
{
"properties": {
"entityId": {
"description": "The primary id of the entity to link.",
"type": "string",
"x-versionadded": "v2.33"
},
"entityType": {
"description": "The type of entity to link.",
"enum": [
"project",
"dataset",
"file",
"notebook",
"application",
"recipe",
"customModelVersion",
"registeredModelVersion",
"deployment",
"customApplication",
"customJob"
],
"type": "string",
"x-versionadded": "v2.33"
},
"includeDataset": {
"default": true,
"description": "Include dataset migration when an experiment is migrated",
"type": "boolean",
"x-versionadded": "v2.34"
}
},
"required": [
"entityId",
"entityType"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| entityId |
string |
true |
|
The primary id of the entity to link. |
| entityType |
string |
true |
|
The type of entity to link. |
| includeDataset |
boolean |
false |
|
Include dataset migration when an experiment is migrated |
Enumerated Values
| Property |
Value |
| entityType |
[project, dataset, file, notebook, application, recipe, customModelVersion, registeredModelVersion, deployment, customApplication, customJob] |
{
"properties": {
"description": {
"description": "The description of the playground.",
"type": "string"
},
"playgroundType": {
"description": "The type of the playground.",
"type": "string",
"x-versionadded": "v2.37"
}
},
"required": [
"description"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| description |
string |
true |
|
The description of the playground. |
| playgroundType |
string |
false |
|
The type of the playground. |
{
"properties": {
"isDraft": {
"description": "Indicates whether the experiment configuration has been used for modeling and is therefore locked (False) or whether the setup has not been applied , and as a draft, can still be modified and used in training (True).",
"type": "boolean"
},
"isErrored": {
"description": "Indicates whether the experiment failed.",
"type": "boolean"
},
"isWorkbenchEligible": {
"description": "Indicates whether the experiment is Workbench-compatible.",
"type": "boolean"
},
"stage": {
"description": "Stage of the experiment.",
"type": "string",
"x-versionadded": "v2.34"
},
"statusErrorMessage": {
"description": "The experiment failure explanation.",
"type": "string"
}
},
"required": [
"isDraft",
"isErrored",
"isWorkbenchEligible",
"stage",
"statusErrorMessage"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| isDraft |
boolean |
true |
|
Indicates whether the experiment configuration has been used for modeling and is therefore locked (False) or whether the setup has not been applied , and as a draft, can still be modified and used in training (True). |
| isErrored |
boolean |
true |
|
Indicates whether the experiment failed. |
| isWorkbenchEligible |
boolean |
true |
|
Indicates whether the experiment is Workbench-compatible. |
| stage |
string |
true |
|
Stage of the experiment. |
| statusErrorMessage |
string |
true |
|
The experiment failure explanation. |
{
"properties": {
"dataType": {
"description": "The type of the recipe (wrangling or feature discovery)",
"enum": [
"static",
"Static",
"STATIC",
"snapshot",
"Snapshot",
"SNAPSHOT",
"dynamic",
"Dynamic",
"DYNAMIC",
"sqlRecipe",
"SqlRecipe",
"SQL_RECIPE",
"wranglingRecipe",
"WranglingRecipe",
"WRANGLING_RECIPE",
"featureDiscoveryRecipe",
"FeatureDiscoveryRecipe",
"FEATURE_DISCOVERY_RECIPE"
],
"type": [
"string",
"null"
]
}
},
"required": [
"dataType"
],
"type": "object"
}
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, Static, STATIC, snapshot, Snapshot, SNAPSHOT, dynamic, Dynamic, DYNAMIC, sqlRecipe, SqlRecipe, SQL_RECIPE, wranglingRecipe, WranglingRecipe, WRANGLING_RECIPE, featureDiscoveryRecipe, FeatureDiscoveryRecipe, FEATURE_DISCOVERY_RECIPE] |
UseCaseReferenceRetrieve
{
"properties": {
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary ID of the entity.",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity ID.",
"type": "string"
},
"id": {
"description": "The ID of the Use Case reference.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"metadata": {
"description": "The reference metadata for the use case.",
"oneOf": [
{
"properties": {
"isDraft": {
"description": "Indicates whether the experiment configuration has been used for modeling and is therefore locked (False) or whether the setup has not been applied , and as a draft, can still be modified and used in training (True).",
"type": "boolean"
},
"isErrored": {
"description": "Indicates whether the experiment failed.",
"type": "boolean"
},
"isWorkbenchEligible": {
"description": "Indicates whether the experiment is Workbench-compatible.",
"type": "boolean"
},
"stage": {
"description": "Stage of the experiment.",
"type": "string",
"x-versionadded": "v2.34"
},
"statusErrorMessage": {
"description": "The experiment failure explanation.",
"type": "string"
}
},
"required": [
"isDraft",
"isErrored",
"isWorkbenchEligible",
"stage",
"statusErrorMessage"
],
"type": "object"
},
{
"properties": {
"dataSourceType": {
"description": "The type of the data source used to create the dataset if relevant.",
"type": [
"string",
"null"
]
},
"datasetSize": {
"description": "The size of the dataset in bytes.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.34"
},
"datasetSourceType": {
"description": "The source type of the dataset",
"type": [
"string",
"null"
]
},
"isSnapshot": {
"description": "Whether the dataset is an immutable snapshot of data which has previously been retrieved and saved to DataRobot.",
"type": "boolean"
},
"isWranglingEligible": {
"description": "Whether the source of the dataset can support wrangling.",
"type": "boolean"
},
"latestRecipeId": {
"description": "The latest recipe ID linked to the dataset.",
"type": [
"string",
"null"
]
}
},
"required": [
"dataSourceType",
"datasetSize",
"datasetSourceType",
"isSnapshot",
"isWranglingEligible",
"latestRecipeId"
],
"type": "object"
},
{
"properties": {
"dataType": {
"description": "The type of the recipe (wrangling or feature discovery)",
"enum": [
"static",
"Static",
"STATIC",
"snapshot",
"Snapshot",
"SNAPSHOT",
"dynamic",
"Dynamic",
"DYNAMIC",
"sqlRecipe",
"SqlRecipe",
"SQL_RECIPE",
"wranglingRecipe",
"WranglingRecipe",
"WRANGLING_RECIPE",
"featureDiscoveryRecipe",
"FeatureDiscoveryRecipe",
"FEATURE_DISCOVERY_RECIPE"
],
"type": [
"string",
"null"
]
}
},
"required": [
"dataType"
],
"type": "object"
},
{
"properties": {
"description": {
"description": "The description of the playground.",
"type": "string"
},
"playgroundType": {
"description": "The type of the playground.",
"type": "string",
"x-versionadded": "v2.37"
}
},
"required": [
"description"
],
"type": "object"
},
{
"properties": {
"errorMessage": {
"description": "The error message, if any, for the vector database.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.38"
},
"source": {
"description": "The source of the vector database",
"type": "string"
}
},
"required": [
"errorMessage",
"source"
],
"type": "object",
"x-versionadded": "v2.37"
},
{
"properties": {
"dataSourceType": {
"description": "The data source type used to create the file if relevant.",
"type": [
"string",
"null"
]
},
"fileSourceType": {
"description": "The source type of the file.",
"type": [
"string",
"null"
]
},
"numFiles": {
"description": "The number of files in the catalog item.",
"type": [
"integer",
"null"
]
}
},
"required": [
"dataSourceType",
"fileSourceType",
"numFiles"
],
"type": "object",
"x-versionadded": "v2.37"
}
]
},
"name": {
"description": "The name of the Use Case reference.",
"type": "string"
},
"processingState": {
"description": "The current ingestion process state of the dataset.",
"enum": [
"COMPLETED",
"ERROR",
"RUNNING"
],
"type": "string"
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the linked use case.",
"type": "string"
},
"useCaseName": {
"description": "The name of the linked use case.",
"type": [
"string",
"null"
]
},
"userHasAccess": {
"description": "Identifies if a user has access to the entity.",
"type": [
"boolean",
"null"
],
"x-versionadded": "v2.36"
},
"versions": {
"description": "The list of entity versions.",
"items": {
"properties": {
"createdAt": {
"description": "Time when this entity was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"id": {
"description": "The id of the entity version.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"name": {
"description": "The name of the entity version.",
"type": "string"
},
"registeredModelVersion": {
"description": "The version number of the entity version.",
"type": "integer"
},
"updatedAt": {
"description": "Time when the last update occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"lastActivity",
"name",
"registeredModelVersion",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.36"
}
},
"required": [
"entityId",
"entityType",
"id",
"name",
"updatedAt",
"useCaseId"
],
"type": "object"
}
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 |
false |
|
The last activity details. |
| metadata |
any |
false |
|
The reference metadata for the use case. |
oneOf
xor
xor
xor
xor
xor
continued
| Name |
Type |
Required |
Restrictions |
Description |
| name |
string |
true |
|
The name of the Use Case reference. |
| processingState |
string |
false |
|
The current ingestion process state of the dataset. |
| updated |
ExperimentContainerUserResponse |
false |
|
A user associated with a 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. |
| useCaseId |
string |
true |
|
The ID of the linked use case. |
| useCaseName |
string,null |
false |
|
The name of the linked use case. |
| userHasAccess |
boolean,null |
false |
|
Identifies if a user has access to the entity. |
| versions |
[UseCaseEntityVersion] |
false |
maxItems: 100
|
The list of entity versions. |
Enumerated Values
| Property |
Value |
| processingState |
[COMPLETED, ERROR, RUNNING] |
{
"properties": {
"errorMessage": {
"description": "The error message, if any, for the vector database.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.38"
},
"source": {
"description": "The source of the vector database",
"type": "string"
}
},
"required": [
"errorMessage",
"source"
],
"type": "object",
"x-versionadded": "v2.37"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| errorMessage |
string,null |
true |
|
The error message, if any, for the vector database. |
| source |
string |
true |
|
The source of the vector database |
UseCaseRegisteredModel
{
"properties": {
"createdAt": {
"description": "The time when this model was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"id": {
"description": "The ID of the registered model.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "The name of the registered model.",
"type": "string"
},
"updatedAt": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"userHasAccess": {
"description": "Indicates if a user has access to this registered model.",
"type": "boolean",
"x-versionadded": "v2.35"
},
"versions": {
"description": "The list of registered model versions.",
"items": {
"properties": {
"createdAt": {
"description": "The time when this model was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"id": {
"description": "The ID of the registered model version.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "The name of the registered model version.",
"type": "string"
},
"registeredModelVersion": {
"description": "The version number of the registered model version.",
"type": "integer",
"x-versionadded": "v2.35"
},
"updatedAt": {
"description": "The time when the last update occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"lastActivity",
"name",
"registeredModelVersion",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"id",
"userHasAccess"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| createdAt |
string(date-time) |
false |
|
The time when this model was created. |
| createdBy |
ExperimentContainerUserResponse |
false |
|
A user associated with a use case. |
| id |
string |
true |
|
The ID of the registered model. |
| lastActivity |
UseCaseRegisteredModelLastActivity |
false |
|
The last activity details. |
| name |
string |
false |
|
The name of the registered model. |
| updatedAt |
string(date-time) |
false |
|
The time when this activity occurred. |
| updatedBy |
ExperimentContainerUserResponse |
false |
|
A user associated with a use case. |
| userHasAccess |
boolean |
true |
|
Indicates if a user has access to this registered model. |
| versions |
[UseCaseRegisteredModelVersion] |
false |
maxItems: 100
|
The list of registered model versions. |
UseCaseRegisteredModelLastActivity
{
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object",
"x-versionadded": "v2.36"
}
The last activity details.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| timestamp |
string(date-time) |
true |
|
The time when this activity occurred. |
| type |
string |
true |
|
The type of activity. Can be "Added" or "Modified". |
UseCaseRegisteredModelVersion
{
"properties": {
"createdAt": {
"description": "The time when this model was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"id": {
"description": "The ID of the registered model version.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "The name of the registered model version.",
"type": "string"
},
"registeredModelVersion": {
"description": "The version number of the registered model version.",
"type": "integer",
"x-versionadded": "v2.35"
},
"updatedAt": {
"description": "The time when the last update occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"lastActivity",
"name",
"registeredModelVersion",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| createdAt |
string(date-time) |
true |
|
The time when this model was created. |
| createdBy |
ExperimentContainerUserResponse |
true |
|
A user associated with a use case. |
| id |
string |
true |
|
The ID of the registered model version. |
| lastActivity |
UseCaseRegisteredModelLastActivity |
true |
|
The last activity details. |
| name |
string |
true |
|
The name of the registered model version. |
| registeredModelVersion |
integer |
true |
|
The version number of the registered model version. |
| updatedAt |
string(date-time) |
true |
|
The time when the last update occurred. |
| updatedBy |
ExperimentContainerUserResponse |
true |
|
A user associated with a use case. |
UseCaseRegisteredModelsResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of registered models.",
"items": {
"properties": {
"createdAt": {
"description": "The time when this model was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"id": {
"description": "The ID of the registered model.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "The name of the registered model.",
"type": "string"
},
"updatedAt": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"userHasAccess": {
"description": "Indicates if a user has access to this registered model.",
"type": "boolean",
"x-versionadded": "v2.35"
},
"versions": {
"description": "The list of registered model versions.",
"items": {
"properties": {
"createdAt": {
"description": "The time when this model was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"id": {
"description": "The ID of the registered model version.",
"type": "string"
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "The name of the registered model version.",
"type": "string"
},
"registeredModelVersion": {
"description": "The version number of the registered model version.",
"type": "integer",
"x-versionadded": "v2.35"
},
"updatedAt": {
"description": "The time when the last update occurred.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"lastActivity",
"name",
"registeredModelVersion",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"id",
"userHasAccess"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[UseCaseRegisteredModel] |
true |
maxItems: 100
|
The list of registered models. |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
UseCaseResponse
{
"properties": {
"advancedTour": {
"description": "Advanced tour key.",
"type": [
"string",
"null"
]
},
"applicationsCount": {
"description": "The number of applications in a Use Case.",
"type": "integer"
},
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"customApplicationsCount": {
"description": "The number of custom applications referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"customJobsCount": {
"description": "The number of custom jobs referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"customModelVersionsCount": {
"description": "The number of custom models referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"datasetsCount": {
"description": "The number of datasets in a Use Case.",
"type": "integer"
},
"deploymentsCount": {
"description": "The number of deployments referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"description": {
"description": "The description of the Use Case.",
"type": [
"string",
"null"
]
},
"filesCount": {
"description": "The number of files in a Use Case.",
"type": "integer",
"x-versionadded": "v2.37"
},
"formattedDescription": {
"description": "The formatted description of the experiment container used as styled description.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the Use Case.",
"type": "string"
},
"members": {
"description": "The list of use case members.",
"items": {
"properties": {
"email": {
"description": "The email address of the member.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the member.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the member.",
"type": "string"
},
"isOrganization": {
"description": "Whether the member is an organization.",
"type": [
"boolean",
"null"
]
},
"userhash": {
"description": "The member's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the member.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"type": "array"
},
"modelsCount": {
"description": "[DEPRECATED] The number of models in a Use Case.",
"type": "integer",
"x-versiondeprecated": "v2.34"
},
"name": {
"description": "The name of the Use Case.",
"type": "string"
},
"notebooksCount": {
"description": "The number of notebooks in a Use Case.",
"type": "integer"
},
"owners": {
"description": "The list of owners of a use case.",
"items": {
"properties": {
"email": {
"description": "The email address of the member.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the member.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the member.",
"type": "string"
},
"isOrganization": {
"description": "Whether the member is an organization.",
"type": [
"boolean",
"null"
]
},
"userhash": {
"description": "The member's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the member.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"type": "array"
},
"primaryRiskAssessment": {
"description": "Risk assessment defined as primary the current Use Case.",
"properties": {
"createdAt": {
"description": "The creation date of the risk assessment.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the risk assessment.",
"type": "string"
},
"description": {
"description": "The description of the risk assessment.",
"type": "string"
},
"evidence": {
"description": "The evidence for the risk assessment.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the risk assessment.",
"type": "string"
},
"isPrimary": {
"default": false,
"description": "Determines if the risk assessment is primary.",
"type": "boolean"
},
"mitigationPlan": {
"description": "The mitigation plan for the risk assessment.",
"type": [
"string",
"null"
]
},
"name": {
"description": "The name of the risk assessment.",
"type": "string"
},
"riskLevel": {
"description": "The name of the risk assessment level.",
"type": "string"
},
"tenantId": {
"description": "The tenant ID related to the risk assessment.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "The last updated date of the risk assessment.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who updated the risk assessment.",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"description",
"evidence",
"id",
"isPrimary",
"mitigationPlan",
"name",
"tenantId",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.36"
},
"projectsCount": {
"description": "The number of projects in a Use Case.",
"type": "integer"
},
"recipesCount": {
"description": "The number of recipes in a Use Case.",
"type": "integer",
"x-versionadded": "v2.33"
},
"registeredModelVersionsCount": {
"description": "The number of registered models referenced in a Use Case.",
"type": "integer",
"x-versionadded": "v2.35"
},
"riskAssessments": {
"description": "The ID List of the Risk Assessments.",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.36"
},
"role": {
"description": "The requesting user's role on this Use Case.",
"enum": [
"OWNER",
"EDITOR",
"CONSUMER"
],
"type": "string"
},
"tenantId": {
"description": "The ID of the tenant to associate this organization with.",
"type": [
"string",
"null"
]
},
"updated": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"updatedAt": {
"description": "The timestamp generated when the record was last updated.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"valueTracker": {
"description": "The value tracker information.",
"properties": {
"accuracyHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the accuracy."
},
"businessImpact": {
"description": "The expected effects on overall business operations.",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The ID for this comment.",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "The value tracker description.",
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the value tracker can be accomplished across multiple dimensions.",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The ID of the ValueTracker.",
"type": "string"
},
"inProductionWarning": {
"description": "An optional warning to indicate that deployments are attached to this value tracker.",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "The list of user objects.",
"items": {
"description": "DataRobot user information.",
"properties": {
"firstName": {
"description": "The first name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DataRobot user ID.",
"type": "string"
},
"lastName": {
"description": "The last name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the ValueTracker owner.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"modelHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the model."
},
"name": {
"description": "The name of the value tracker.",
"type": "string"
},
"notes": {
"description": "The user notes.",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information.",
"properties": {
"firstName": {
"description": "The first name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DataRobot user ID.",
"type": "string"
},
"lastName": {
"description": "The last name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the ValueTracker owner.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "The permissions of the current user.",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional. Contains MonetaryValue objects.",
"properties": {
"currency": {
"description": "The ISO code of the currency.",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes.",
"type": [
"string",
"null"
]
},
"value": {
"description": "The amount of value.",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "The estimated cost of an individual incorrect decision.",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "The estimated number of incorrect decisions per year.",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "The value tracker value template type.",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"targetValue": {
"description": "The target value.",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "The value tracker value template type.",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Optional. Contains the template type and parameter information."
},
"predictionTargets": {
"description": "An array of prediction target name strings.",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"predictionsCount": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"description": "The list of prediction counts.",
"items": {
"type": "integer"
},
"type": "array"
}
],
"description": "The count of the number of predictions made."
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional. Contains MonetaryValue objects.",
"properties": {
"currency": {
"description": "The ISO code of the currency.",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes.",
"type": [
"string",
"null"
]
},
"value": {
"description": "The amount of value.",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Optional. Contains MonetaryValue objects."
},
"serviceHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the service."
},
"stage": {
"description": "The current stage of the value tracker.",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "The array of TargetDate objects.",
"items": {
"properties": {
"date": {
"description": "The date of the target.",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "The name of the target stage.",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"valueTrackerId": {
"description": "The ID of the Value Tracker.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"applicationsCount",
"created",
"createdAt",
"customApplicationsCount",
"customJobsCount",
"customModelVersionsCount",
"datasetsCount",
"deploymentsCount",
"description",
"filesCount",
"id",
"members",
"name",
"notebooksCount",
"projectsCount",
"recipesCount",
"registeredModelVersionsCount",
"role",
"tenantId",
"updated",
"updatedAt"
],
"type": "object"
}
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 |
|
A user associated with a use case. |
| createdAt |
string(date-time) |
true |
|
The timestamp generated at record creation. |
| createdBy |
string,null |
false |
|
The ID of the user who created. |
| customApplicationsCount |
integer |
true |
|
The number of custom applications referenced in a Use Case. |
| customJobsCount |
integer |
true |
|
The number of custom jobs referenced in a Use Case. |
| customModelVersionsCount |
integer |
true |
|
The number of custom models referenced in a Use Case. |
| datasetsCount |
integer |
true |
|
The number of datasets in a Use Case. |
| deploymentsCount |
integer |
true |
|
The number of deployments referenced in a Use Case. |
| description |
string,null |
true |
|
The description of the Use Case. |
| filesCount |
integer |
true |
|
The number of files in a Use Case. |
| formattedDescription |
string,null |
false |
|
The formatted description of the experiment container used as styled description. |
| id |
string |
true |
|
The ID of the Use Case. |
| members |
[UseCaseMemberResponse] |
true |
|
The list of use case members. |
| modelsCount |
integer |
false |
|
[DEPRECATED] 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 |
|
The list of owners of a use case. |
| primaryRiskAssessment |
RiskAssessmentComplete |
false |
|
Risk assessment defined as primary the current Use Case. |
| projectsCount |
integer |
true |
|
The number of projects in a Use Case. |
| recipesCount |
integer |
true |
|
The number of recipes in a Use Case. |
| registeredModelVersionsCount |
integer |
true |
|
The number of registered models referenced in a Use Case. |
| riskAssessments |
[string] |
false |
maxItems: 100
|
The ID List of the Risk Assessments. |
| role |
string |
true |
|
The requesting user's role on this Use Case. |
| tenantId |
string,null |
true |
|
The ID of the tenant to associate this organization with. |
| updated |
ExperimentContainerUserResponse |
true |
|
A user associated with a 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. |
| valueTracker |
ValueTrackerResponse |
false |
|
The value tracker information. |
| valueTrackerId |
string,null |
false |
|
The ID of the Value Tracker. |
Enumerated Values
| Property |
Value |
| role |
[OWNER, EDITOR, CONSUMER] |
UseCaseUpdate
{
"properties": {
"description": {
"description": "The description of the Use Case.",
"type": [
"string",
"null"
]
},
"name": {
"description": "The name of the Use Case.",
"maxLength": 100,
"type": [
"string",
"null"
]
}
},
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| description |
string,null |
false |
|
The description of the Use Case. |
| name |
string,null |
false |
maxLength: 100
|
The name of the Use Case. |
{
"properties": {
"createdAt": {
"description": "The time that this custom model version was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The username of the user who created this custom model version.",
"type": "string"
},
"customModelId": {
"description": "The ID of this custom model.",
"type": "string"
},
"customModelVersionId": {
"description": "The ID of this version of this custom model.",
"type": "string"
},
"name": {
"description": "The name of the custom model created from this vector database.",
"type": "string"
},
"role": {
"description": "The role that the requesting user has on this custom model version",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": [
"string",
"null"
]
},
"versionMajor": {
"description": "The major version number of this custom model version.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number of this custom model version.",
"type": "integer"
}
},
"required": [
"createdAt",
"createdBy",
"customModelId",
"customModelVersionId",
"name",
"role",
"versionMajor",
"versionMinor"
],
"type": "object",
"x-versionadded": "v2.36"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| createdAt |
string(date-time) |
true |
|
The time that this custom model version was created. |
| createdBy |
string |
true |
|
The username of the user who created this custom model version. |
| customModelId |
string |
true |
|
The ID of this custom model. |
| customModelVersionId |
string |
true |
|
The ID of this version of this custom model. |
| name |
string |
true |
|
The name of the custom model created from this vector database. |
| role |
string,null |
true |
|
The role that the requesting user has on this custom model version |
| versionMajor |
integer |
true |
|
The major version number of this custom model version. |
| versionMinor |
integer |
true |
|
The minor version number of this custom model version. |
Enumerated Values
| Property |
Value |
| role |
[ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER] |
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of custom model versions created from this vector database.",
"items": {
"properties": {
"createdAt": {
"description": "The time that this custom model version was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The username of the user who created this custom model version.",
"type": "string"
},
"customModelId": {
"description": "The ID of this custom model.",
"type": "string"
},
"customModelVersionId": {
"description": "The ID of this version of this custom model.",
"type": "string"
},
"name": {
"description": "The name of the custom model created from this vector database.",
"type": "string"
},
"role": {
"description": "The role that the requesting user has on this custom model version",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": [
"string",
"null"
]
},
"versionMajor": {
"description": "The major version number of this custom model version.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number of this custom model version.",
"type": "integer"
}
},
"required": [
"createdAt",
"createdBy",
"customModelId",
"customModelVersionId",
"name",
"role",
"versionMajor",
"versionMinor"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"data",
"next",
"previous"
],
"type": "object",
"x-versionadded": "v2.36"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[UseCaseVectorDatabaseRelatedCustomModel] |
true |
maxItems: 100
|
The list of custom model versions created from this vector database. |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
{
"properties": {
"createdAt": {
"description": "The time that this deployment was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The username of the user who created this deployment.",
"type": "string"
},
"customModelId": {
"description": "ID of the custom model currently deployed to this deployment",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"customModelVersionId": {
"description": "ID of the custom model version currently deployed to this deployment",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"id": {
"description": "The ID of the deployment with this vector database deployed.",
"type": "string"
},
"name": {
"description": "The name of the deployment with this vector database deployed.",
"type": "string"
},
"registeredModelId": {
"description": "ID of the registered model currently deployed to this deployment",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"registeredModelVersionId": {
"description": "ID of the registered model version currently deployed to this deployment",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"role": {
"description": "The role that the requesting user has on this deployment",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": [
"string",
"null"
]
}
},
"required": [
"createdAt",
"createdBy",
"id",
"name",
"role"
],
"type": "object",
"x-versionadded": "v2.36"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| createdAt |
string(date-time) |
true |
|
The time that this deployment was created. |
| createdBy |
string |
true |
|
The username of the user who created this deployment. |
| customModelId |
string,null |
false |
|
ID of the custom model currently deployed to this deployment |
| customModelVersionId |
string,null |
false |
|
ID of the custom model version currently deployed to this deployment |
| id |
string |
true |
|
The ID of the deployment with this vector database deployed. |
| name |
string |
true |
|
The name of the deployment with this vector database deployed. |
| registeredModelId |
string,null |
false |
|
ID of the registered model currently deployed to this deployment |
| registeredModelVersionId |
string,null |
false |
|
ID of the registered model version currently deployed to this deployment |
| role |
string,null |
true |
|
The role that the requesting user has on this deployment |
Enumerated Values
| Property |
Value |
| role |
[ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER] |
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of deployments that this vector database is currently deployed on.",
"items": {
"properties": {
"createdAt": {
"description": "The time that this deployment was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The username of the user who created this deployment.",
"type": "string"
},
"customModelId": {
"description": "ID of the custom model currently deployed to this deployment",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"customModelVersionId": {
"description": "ID of the custom model version currently deployed to this deployment",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"id": {
"description": "The ID of the deployment with this vector database deployed.",
"type": "string"
},
"name": {
"description": "The name of the deployment with this vector database deployed.",
"type": "string"
},
"registeredModelId": {
"description": "ID of the registered model currently deployed to this deployment",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"registeredModelVersionId": {
"description": "ID of the registered model version currently deployed to this deployment",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"role": {
"description": "The role that the requesting user has on this deployment",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": [
"string",
"null"
]
}
},
"required": [
"createdAt",
"createdBy",
"id",
"name",
"role"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"data",
"next",
"previous"
],
"type": "object",
"x-versionadded": "v2.36"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[UseCaseVectorDatabaseRelatedDeployment] |
true |
maxItems: 100
|
The list of deployments that this vector database is currently deployed on. |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
{
"properties": {
"createdAt": {
"description": "The time that this registered model version was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The username of the user who created this registered model version.",
"type": "string"
},
"registeredModelId": {
"description": "The ID of this registered model.",
"type": "string"
},
"registeredModelName": {
"description": "The name of the registered model created from this vector database.",
"type": "string"
},
"registeredModelVersionId": {
"description": "The ID of this version of this registered model.",
"type": "string"
},
"registeredModelVersionName": {
"description": "The name of the registered model version created from this vector database.",
"type": "string"
},
"role": {
"description": "The role that the requesting user has on this registered model version",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": [
"string",
"null"
]
},
"version": {
"description": "The version number of this registered model version.",
"type": "integer"
}
},
"required": [
"createdAt",
"createdBy",
"registeredModelId",
"registeredModelName",
"registeredModelVersionId",
"registeredModelVersionName",
"role",
"version"
],
"type": "object",
"x-versionadded": "v2.36"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| createdAt |
string(date-time) |
true |
|
The time that this registered model version was created. |
| createdBy |
string |
true |
|
The username of the user who created this registered model version. |
| registeredModelId |
string |
true |
|
The ID of this registered model. |
| registeredModelName |
string |
true |
|
The name of the registered model created from this vector database. |
| registeredModelVersionId |
string |
true |
|
The ID of this version of this registered model. |
| registeredModelVersionName |
string |
true |
|
The name of the registered model version created from this vector database. |
| role |
string,null |
true |
|
The role that the requesting user has on this registered model version |
| version |
integer |
true |
|
The version number of this registered model version. |
Enumerated Values
| Property |
Value |
| role |
[ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER] |
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of registered model versions created from this vector database.",
"items": {
"properties": {
"createdAt": {
"description": "The time that this registered model version was created.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The username of the user who created this registered model version.",
"type": "string"
},
"registeredModelId": {
"description": "The ID of this registered model.",
"type": "string"
},
"registeredModelName": {
"description": "The name of the registered model created from this vector database.",
"type": "string"
},
"registeredModelVersionId": {
"description": "The ID of this version of this registered model.",
"type": "string"
},
"registeredModelVersionName": {
"description": "The name of the registered model version created from this vector database.",
"type": "string"
},
"role": {
"description": "The role that the requesting user has on this registered model version",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": [
"string",
"null"
]
},
"version": {
"description": "The version number of this registered model version.",
"type": "integer"
}
},
"required": [
"createdAt",
"createdBy",
"registeredModelId",
"registeredModelName",
"registeredModelVersionId",
"registeredModelVersionName",
"role",
"version"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"data",
"next",
"previous"
],
"type": "object",
"x-versionadded": "v2.36"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[UseCaseVectorDatabaseRelatedRegisteredModel] |
true |
maxItems: 100
|
The list of registered model versions created from this vector database. |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
UseCaseWithShortenedInfoResponse
{
"properties": {
"advancedTour": {
"description": "Advanced tour key.",
"type": [
"string",
"null"
]
},
"createdAt": {
"description": "The timestamp generated at record creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the Use Case.",
"type": [
"string",
"null"
]
},
"description": {
"description": "The description of the Use Case.",
"type": [
"string",
"null"
]
},
"formattedDescription": {
"description": "The formatted description of the experiment container used as styled description.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the Use Case.",
"type": "string"
},
"name": {
"description": "The name of the Use Case.",
"type": "string"
},
"tenantId": {
"description": "The ID of the tenant to associate this organization with.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "The timestamp generated when the record was last updated.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated the Use Case.",
"type": [
"string",
"null"
]
},
"valueTrackerId": {
"description": "The ID of the Value Tracker.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"createdAt",
"description",
"formattedDescription",
"id",
"name",
"tenantId",
"updatedAt"
],
"type": "object",
"x-versionadded": "v2.34"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| advancedTour |
string,null |
false |
|
Advanced tour key. |
| createdAt |
string(date-time) |
true |
|
The timestamp generated at record creation. |
| createdBy |
string,null |
false |
|
The ID of the user who created the Use Case. |
| description |
string,null |
true |
|
The description of the Use Case. |
| formattedDescription |
string,null |
true |
|
The formatted description of the experiment container used as styled description. |
| id |
string |
true |
|
The ID of the Use Case. |
| name |
string |
true |
|
The name of the Use Case. |
| tenantId |
string,null |
true |
|
The ID of the tenant to associate this organization with. |
| 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 the Use Case. |
| valueTrackerId |
string,null |
false |
|
The ID of the Value Tracker. |
UseCasesApplicationsListResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of the applications in this use case.",
"items": {
"properties": {
"applicationId": {
"description": "The application id of the application.",
"type": "string"
},
"applicationTemplateType": {
"description": "The type of the application.",
"type": [
"string",
"null"
]
},
"createdAt": {
"description": "The timestamp generated at application creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"description": {
"description": "The description of the application.",
"type": [
"string",
"null"
]
},
"lastActivity": {
"description": "The last activity details.",
"properties": {
"timestamp": {
"description": "The time when this activity occurred.",
"format": "date-time",
"type": "string"
},
"type": {
"description": "The type of activity. Can be \"Added\" or \"Modified\".",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"type": "object"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"projectId": {
"description": "The ID of the associated project",
"type": [
"string",
"null"
]
},
"source": {
"description": "The source used to create the application.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "The timestamp generated at application modification.",
"format": "date-time",
"type": "string"
}
},
"required": [
"applicationId",
"applicationTemplateType",
"createdAt",
"createdBy",
"description",
"lastActivity",
"name",
"projectId",
"source",
"updatedAt"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[ExperimentContainerApplicationResponse] |
true |
|
The list of the applications in this use case. |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
UseCasesNotebooksListResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of the notebooks in this use case.",
"items": {
"properties": {
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at notebook creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary id of the entity (same as ID of the notebook).",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity id.",
"enum": [
"notebook"
],
"type": "string"
},
"experimentContainerId": {
"description": "[DEPRECATED - replaced with use_case_id] The ID of the Use Case.",
"type": "string",
"x-versiondeprecated": "v2.32"
},
"id": {
"description": "The ID of the notebook.",
"type": "string"
},
"isDeleted": {
"description": "Soft deletion flag for notebooks",
"type": "boolean"
},
"referenceId": {
"description": "Original ID from DB",
"type": "string"
},
"tenantId": {
"description": "The id of the tenant the notebook belongs to.",
"type": [
"string",
"null"
]
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the Use Case.",
"type": "string"
},
"useCaseName": {
"description": "Use Case name",
"type": "string"
}
},
"required": [
"created",
"createdAt",
"entityId",
"entityType",
"experimentContainerId",
"id",
"isDeleted",
"referenceId",
"tenantId",
"useCaseId"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[ExperimentContainerNotebookResponse] |
true |
maxItems: 100
|
The list of the notebooks in this use case. |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
UseCasesPlaygroundsListResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of the playgrounds in this use case.",
"items": {
"properties": {
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at playground creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary id of the entity (same as ID of the playground).",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity id.",
"enum": [
"playground"
],
"type": "string"
},
"id": {
"description": "The ID of the playground.",
"type": "string"
},
"isDeleted": {
"description": "Soft deletion flag for playgrounds",
"type": "boolean"
},
"referenceId": {
"description": "Original ID from DB",
"type": "string"
},
"tenantId": {
"description": "The id of the tenant the playground belongs to.",
"type": [
"string",
"null"
]
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"createdAt",
"entityId",
"entityType",
"id",
"isDeleted",
"referenceId",
"tenantId"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[ExperimentContainerPlaygroundResponse] |
true |
|
The list of the playgrounds in this use case. |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
UseCasesProjectMigrationParam
{
"properties": {
"includeDataset": {
"default": true,
"description": "Include dataset migration when project is migrated.",
"type": "boolean"
}
},
"type": "object",
"x-versionadded": "v2.34"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| includeDataset |
boolean |
false |
|
Include dataset migration when project is migrated. |
UseCasesVectorDatabasesListResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The list of the vector databases in this use case.",
"items": {
"properties": {
"created": {
"description": "A user associated with a use case.",
"properties": {
"email": {
"description": "The email address of the user.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the user.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"userhash": {
"description": "The user's gravatar hash.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the user.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"id"
],
"type": "object"
},
"createdAt": {
"description": "The timestamp generated at vector database creation.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created.",
"type": [
"string",
"null"
]
},
"entityId": {
"description": "The primary id of the entity (same as ID of the vector database).",
"type": "string"
},
"entityType": {
"description": "The type of entity provided by the entity id.",
"enum": [
"vector_database"
],
"type": "string"
},
"id": {
"description": "The ID of the vector database.",
"type": "string"
},
"isDeleted": {
"description": "Soft deletion flag for vector databases",
"type": "boolean"
},
"referenceId": {
"description": "Original ID from DB",
"type": "string"
},
"tenantId": {
"description": "The id of the tenant the vector database belongs to.",
"type": [
"string",
"null"
]
},
"updatedBy": {
"description": "The ID of the user who last updated.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"createdAt",
"entityId",
"entityType",
"id",
"isDeleted",
"referenceId",
"tenantId"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[ExperimentContainerVectorDatabaseResponse] |
true |
|
The list of the vector databases in this use case. |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
ValueTrackerDrUserId
{
"description": "DataRobot user information.",
"properties": {
"firstName": {
"description": "The first name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DataRobot user ID.",
"type": "string"
},
"lastName": {
"description": "The last name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the ValueTracker owner.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
DataRobot user information.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| firstName |
string,null |
false |
|
The first name of the ValueTracker owner. |
| id |
string |
true |
|
The DataRobot user ID. |
| lastName |
string,null |
false |
|
The last name of the ValueTracker owner. |
| username |
string |
false |
|
The username of the ValueTracker owner. |
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| endDate |
string,null(date-time) |
true |
|
The end date for this health status. |
| message |
string,null |
true |
|
Information about the health status. |
| startDate |
string,null(date-time) |
true |
|
The start date for this health status. |
| status |
string,null |
true |
|
The status of the value tracker. |
ValueTrackerMonetaryValue
{
"description": "Optional. Contains MonetaryValue objects.",
"properties": {
"currency": {
"description": "The ISO code of the currency.",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes.",
"type": [
"string",
"null"
]
},
"value": {
"description": "The amount of value.",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
}
Optional. Contains MonetaryValue objects.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| currency |
string |
true |
|
The ISO code of the currency. |
| details |
string,null |
false |
|
Optional user notes. |
| value |
number |
true |
|
The amount of value. |
Enumerated Values
| Property |
Value |
| currency |
[AED, BRL, CHF, EUR, GBP, JPY, KRW, UAH, USD, ZAR] |
ValueTrackerResponse
{
"description": "The value tracker information.",
"properties": {
"accuracyHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the accuracy."
},
"businessImpact": {
"description": "The expected effects on overall business operations.",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The ID for this comment.",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "The value tracker description.",
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the value tracker can be accomplished across multiple dimensions.",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The ID of the ValueTracker.",
"type": "string"
},
"inProductionWarning": {
"description": "An optional warning to indicate that deployments are attached to this value tracker.",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "The list of user objects.",
"items": {
"description": "DataRobot user information.",
"properties": {
"firstName": {
"description": "The first name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DataRobot user ID.",
"type": "string"
},
"lastName": {
"description": "The last name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the ValueTracker owner.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"modelHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the model."
},
"name": {
"description": "The name of the value tracker.",
"type": "string"
},
"notes": {
"description": "The user notes.",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information.",
"properties": {
"firstName": {
"description": "The first name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DataRobot user ID.",
"type": "string"
},
"lastName": {
"description": "The last name of the ValueTracker owner.",
"type": [
"string",
"null"
]
},
"username": {
"description": "The username of the ValueTracker owner.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "The permissions of the current user.",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional. Contains MonetaryValue objects.",
"properties": {
"currency": {
"description": "The ISO code of the currency.",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes.",
"type": [
"string",
"null"
]
},
"value": {
"description": "The amount of value.",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "The estimated cost of an individual incorrect decision.",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "The estimated number of incorrect decisions per year.",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "The value tracker value template type.",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"targetValue": {
"description": "The target value.",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "The value tracker value template type.",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Optional. Contains the template type and parameter information."
},
"predictionTargets": {
"description": "An array of prediction target name strings.",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"predictionsCount": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"description": "The list of prediction counts.",
"items": {
"type": "integer"
},
"type": "array"
}
],
"description": "The count of the number of predictions made."
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional. Contains MonetaryValue objects.",
"properties": {
"currency": {
"description": "The ISO code of the currency.",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes.",
"type": [
"string",
"null"
]
},
"value": {
"description": "The amount of value.",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Optional. Contains MonetaryValue objects."
},
"serviceHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the value tracker.",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "The health of the service."
},
"stage": {
"description": "The current stage of the value tracker.",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "The array of TargetDate objects.",
"items": {
"properties": {
"date": {
"description": "The date of the target.",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "The name of the target stage.",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
The value tracker information.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| accuracyHealth |
any |
false |
|
The health of the accuracy. |
anyOf
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
string |
false |
|
none |
or
or
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
null |
false |
|
none |
continued
| Name |
Type |
Required |
Restrictions |
Description |
| businessImpact |
integer,null |
false |
maximum: 5
minimum: 1
|
The expected effects on overall business operations. |
| commentId |
string |
false |
|
The ID for this comment. |
| content |
string |
false |
|
A string |
| description |
string,null |
false |
|
The value tracker description. |
| feasibility |
integer,null |
false |
maximum: 5
minimum: 1
|
Assessment of how the value tracker can be accomplished across multiple dimensions. |
| id |
string |
false |
|
The ID of the ValueTracker. |
| inProductionWarning |
string,null |
false |
|
An optional warning to indicate that deployments are attached to this value tracker. |
| mentions |
[ValueTrackerDrUserId] |
false |
|
The list of user objects. |
| modelHealth |
any |
false |
|
The health of the model. |
anyOf
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
string |
false |
|
none |
or
or
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
null |
false |
|
none |
continued
| Name |
Type |
Required |
Restrictions |
Description |
| name |
string |
false |
|
The name of the value tracker. |
| notes |
string,null |
false |
|
The user notes. |
| owner |
ValueTrackerDrUserId |
false |
|
DataRobot user information. |
| permissions |
[string] |
false |
|
The permissions of the current user. |
| potentialValue |
ValueTrackerMonetaryValue |
false |
|
Optional. Contains MonetaryValue objects. |
| potentialValueTemplate |
any |
false |
|
Optional. Contains the template type and parameter information. |
anyOf
or
or
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
null |
false |
|
none |
continued
| Name |
Type |
Required |
Restrictions |
Description |
| predictionTargets |
[string] |
false |
|
An array of prediction target name strings. |
| predictionsCount |
any |
false |
|
The count of the number of predictions made. |
anyOf
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
string |
false |
|
none |
or
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
integer |
false |
|
none |
or
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
[integer] |
false |
|
The list of prediction counts. |
continued
| Name |
Type |
Required |
Restrictions |
Description |
| realizedValue |
any |
false |
|
Optional. Contains MonetaryValue objects. |
anyOf
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
string |
false |
|
none |
or
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
ValueTrackerMonetaryValue |
false |
|
Optional. Contains MonetaryValue objects. |
or
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
null |
false |
|
none |
continued
| Name |
Type |
Required |
Restrictions |
Description |
| serviceHealth |
any |
false |
|
The health of the service. |
anyOf
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
string |
false |
|
none |
or
or
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
null |
false |
|
none |
continued
| Name |
Type |
Required |
Restrictions |
Description |
| stage |
string |
false |
|
The current stage of the value tracker. |
| targetDates |
[ValueTrackerTargetDate] |
false |
|
The array of TargetDate objects. |
Enumerated Values
| Property |
Value |
| stage |
[ideation, queued, dataPrepAndModeling, validatingAndDeploying, inProduction, retired, onHold] |
ValueTrackerTargetDate
{
"properties": {
"date": {
"description": "The date of the target.",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "The name of the target stage.",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| date |
string(date-time) |
true |
|
The date of the target. |
| stage |
string |
true |
|
The name of the target stage. |
Enumerated Values
| Property |
Value |
| stage |
[ideation, queued, dataPrepAndModeling, validatingAndDeploying, inProduction, retired, onHold] |
ValueTrackerValueTemplateClassification
{
"properties": {
"data": {
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "The estimated cost of an individual incorrect decision.",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "The estimated number of incorrect decisions per year.",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "The value tracker value template type.",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
Properties
Enumerated Values
| Property |
Value |
| templateType |
classification |
ValueTrackerValueTemplateClassificationData
{
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "The estimated cost of an individual incorrect decision.",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "The estimated number of incorrect decisions per year.",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
}
The value tracker value data.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| accuracyImprovement |
number |
true |
|
Accuracy improvement. |
| decisionsCount |
integer |
true |
|
The estimated number of decisions per year. |
| incorrectDecisionCost |
number |
true |
|
The estimated cost of an individual incorrect decision. |
| incorrectDecisionsCount |
integer |
true |
|
The estimated number of incorrect decisions per year. |
ValueTrackerValueTemplateRegression
{
"properties": {
"data": {
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"targetValue": {
"description": "The target value.",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "The value tracker value template type.",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
Properties
Enumerated Values
| Property |
Value |
| templateType |
regression |
ValueTrackerValueTemplateRegressionData
{
"description": "The value tracker value data.",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement.",
"type": "number"
},
"decisionsCount": {
"description": "The estimated number of decisions per year.",
"type": "integer"
},
"targetValue": {
"description": "The target value.",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
}
The value tracker value data.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| accuracyImprovement |
number |
true |
|
Accuracy improvement. |
| decisionsCount |
integer |
true |
|
The estimated number of decisions per year. |
| targetValue |
number |
true |
|
The target value. |