Skip to content
For Managed AI Platform users, see the cloud platform documentation
DataRobot APIのリソース > APIリファレンスドキュメント > DataRobot REST API > Applications > No-code applications

No-Code Applications

This page outlines the operations, endpoints, parameters, and example requests and responses for the No-Code Applications.

GET /api/v2/applications/

Paginated list of applications created by the currently authenticated user.

Code samples

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

Parameters

Name In Type Required Description
offset query integer true This many results will be skipped.
limit query integer true At most this many results are returned. If 0, all results.
lid query string false The ID of the application

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "applicationTemplateType": "string",
      "applicationTypeId": "string",
      "cloudProvider": "string",
      "createdAt": "string",
      "createdBy": "string",
      "creatorFirstName": "string",
      "creatorLastName": "string",
      "creatorUserhash": "string",
      "datasets": [
        "string"
      ],
      "deactivationStatusId": "string",
      "deploymentIds": [
        "string"
      ],
      "deploymentName": "string",
      "deploymentStatusId": "string",
      "deployments": [
        {
          "deploymentId": "string",
          "referenceName": "string"
        }
      ],
      "description": "string",
      "hasCustomLogo": true,
      "id": "string",
      "modelDeploymentId": "string",
      "name": "string",
      "orgId": "string",
      "orgName": "string",
      "permissions": [
        "CAN_DELETE"
      ],
      "poolUsed": true,
      "realtimePredictionsSupport": true,
      "relatedEntities": {
        "isFromExperimentContainer": true,
        "isFromUseCase": true,
        "isTrialOrganization": true,
        "modelId": "string",
        "projectId": "string"
      },
      "updatedAt": "string",
      "userId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses

Status Meaning Description Schema
200 OK none ApplicationList

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

BearerAuth

POST /api/v2/applications/

Create an application. Note that the number of active applications users can have at the same time is limited.

Code samples

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

Body parameter

{
  "applicationTypeId": "string",
  "authenticationType": "invitedUsersOnly",
  "cloudProvider": "drcloud",
  "description": "string",
  "experimentContainerId": "string",
  "modelDeploymentId": "string",
  "name": "string",
  "purpose": "string",
  "sources": [
    {
      "info": {
        "modelDeploymentId": "string"
      },
      "name": "string",
      "source": "deployment"
    }
  ],
  "useCaseId": "string"
}

Parameters

Name In Type Required Description
body body ApplicationCreate false none

Example responses

200 Response

{
  "applicationTemplateType": "string",
  "applicationTypeId": "string",
  "cloudProvider": "string",
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "datasets": [
    "string"
  ],
  "deactivationStatusId": "string",
  "deploymentIds": [
    "string"
  ],
  "deploymentName": "string",
  "deploymentStatusId": "string",
  "deployments": [
    {
      "deploymentId": "string",
      "referenceName": "string"
    }
  ],
  "description": "string",
  "hasCustomLogo": true,
  "id": "string",
  "modelDeploymentId": "string",
  "name": "string",
  "orgId": "string",
  "orgName": "string",
  "permissions": [
    "CAN_DELETE"
  ],
  "poolUsed": true,
  "realtimePredictionsSupport": true,
  "relatedEntities": {
    "isFromExperimentContainer": true,
    "isFromUseCase": true,
    "isTrialOrganization": true,
    "modelId": "string",
    "projectId": "string"
  },
  "updatedAt": "string",
  "userId": "string"
}

Responses

Status Meaning Description Schema
200 OK none Application
202 Accepted Creation has successfully started. See the Location header. None
403 Forbidden User does not have permission to launch application of provided type. None
404 Not Found No app type matching the specified identifier found or user does not have permissions to access to this app type. None
422 Unprocessable Entity Application could not be created with the given input. None

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

BearerAuth

POST /api/v2/applications/verify/

Verifies a user can create an app

Code samples

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

Body parameter

{
  "experimentContainerId": "string",
  "projectId": "string",
  "sourceId": "string",
  "sourceType": "deployment"
}

Parameters

Name In Type Required Description
body body ApplicationCanCreate false none

Responses

Status Meaning Description Schema
200 OK App may be created None
403 Forbidden User does not have permission to launch application of provided type. None
404 Not Found No app type matching the specified identifier found or user does not have permissions to access to this app type. None
422 Unprocessable Entity Application can not be created with the given input. None

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

BearerAuth

DELETE /api/v2/applications/{applicationId}/

Delete an application

Code samples

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

Body parameter

{
  "applicationId": "string"
}

Parameters

Name In Type Required Description
hard query boolean false Determines whether or not DataRobot deletes the underlying entity, or just marks it as deleted.
applicationId path string true The ID of the application
body body ApplicationParam false none

Responses

Status Meaning Description Schema
200 OK none None
204 No Content The application has been deleted. None

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

BearerAuth

GET /api/v2/applications/{applicationId}/

Retrieve an application

Code samples

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

Parameters

Name In Type Required Description
applicationId path string true The ID of the application

Example responses

200 Response

{
  "applicationTemplateType": "string",
  "applicationTypeId": "string",
  "cloudProvider": "string",
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "datasets": [
    "string"
  ],
  "deactivationStatusId": "string",
  "deploymentIds": [
    "string"
  ],
  "deploymentName": "string",
  "deploymentStatusId": "string",
  "deployments": [
    {
      "deploymentId": "string",
      "referenceName": "string"
    }
  ],
  "description": "string",
  "hasCustomLogo": true,
  "id": "string",
  "modelDeploymentId": "string",
  "name": "string",
  "orgId": "string",
  "orgName": "string",
  "permissions": [
    "CAN_DELETE"
  ],
  "poolUsed": true,
  "realtimePredictionsSupport": true,
  "relatedEntities": {
    "isFromExperimentContainer": true,
    "isFromUseCase": true,
    "isTrialOrganization": true,
    "modelId": "string",
    "projectId": "string"
  },
  "updatedAt": "string",
  "userId": "string"
}

Responses

Status Meaning Description Schema
200 OK none ApplicationRetrieve

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

BearerAuth

PATCH /api/v2/applications/{applicationId}/

Update an application's name and/or description

Code samples

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

Body parameter

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

Parameters

Name In Type Required Description
applicationId path string true The ID of the application
body body ApplicationNameAndDescription false none

Responses

Status Meaning Description Schema
200 OK none None
204 No Content The application has been updated. None

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

BearerAuth

GET /api/v2/applications/{applicationId}/accessControl/

A list of users who have access to this application and their roles

Code samples

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

Parameters

Name In Type Required Description
offset query integer true This many results will be skipped
limit query integer true At most this many results are returned
username query string false Optional, only return the access control information for a user with this username.
userId query string false Optional, only return the access control information for a user with this user ID.
applicationId path string true The ID of the application

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "canShare": true,
      "role": "string",
      "userId": "string",
      "username": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses

Status Meaning Description Schema
200 OK none ApplicationAccessControlList
400 Bad Request Bad Request, both username and userId were specified None
404 Not Found Entity not found. Either the application does not exist or the user does not have permissions to view the application. None

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

BearerAuth

PATCH /api/v2/applications/{applicationId}/accessControl/

Update access control for this application. Request is processed only if updates can be performed on all entries.

Code samples

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

Body parameter

{
  "data": [
    {
      "role": "CONSUMER",
      "username": "string"
    }
  ],
  "permissions": [
    {
      "role": "CONSUMER",
      "username": "string"
    }
  ]
}

Parameters

Name In Type Required Description
applicationId path string true The ID of the application
body body ApplicationAccessControlUpdateRequest false none

Responses

Status Meaning Description Schema
200 OK none None
403 Forbidden User does not have appropriate privileges None
404 Not Found Invalid applicationId provided or invalid username provided to modify access for None

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

BearerAuth

POST /api/v2/applications/{applicationId}/deployments/

If application creates deployment during its lifetime, we want to have an API to link deployment with application.

Code samples

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

Body parameter

{
  "linkName": "string",
  "modelDeploymentId": "string"
}

Parameters

Name In Type Required Description
applicationId path string true The ID of the application
body body AddDeploymentToApplication false none

Responses

Status Meaning Description Schema
200 OK none None

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

BearerAuth

DELETE /api/v2/applications/{applicationId}/deployments/{modelDeploymentId}/

Delete link between application and deployment.

Code samples

curl -X DELETE https://app.datarobot.com/api/v2/applications/{applicationId}/deployments/{modelDeploymentId}/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "applicationId": "string",
  "modelDeploymentId": "string"
}

Parameters

Name In Type Required Description
applicationId path string true The ID of the application
modelDeploymentId path string true The ID of the model deployment
body body ApplicationModelDeploymentParam false none

Responses

Status Meaning Description Schema
200 OK none None
204 No Content The link has been deleted. None

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

BearerAuth

POST /api/v2/applications/{applicationId}/duplicate/

Create a copy of App Builder application. Note that the number of active applications users can have at the same time is limited.

Code samples

curl -X POST https://app.datarobot.com/api/v2/applications/{applicationId}/duplicate/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "authenticationType": "invitedUsersOnly",
  "description": "string",
  "duplicatePredictions": false,
  "name": "string"
}

Parameters

Name In Type Required Description
applicationId path string true The ID of the application
body body ApplicationDuplicate false none

Example responses

200 Response

{
  "applicationTemplateType": "string",
  "applicationTypeId": "string",
  "cloudProvider": "string",
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "datasets": [
    "string"
  ],
  "deactivationStatusId": "string",
  "deploymentIds": [
    "string"
  ],
  "deploymentName": "string",
  "deploymentStatusId": "string",
  "deployments": [
    {
      "deploymentId": "string",
      "referenceName": "string"
    }
  ],
  "description": "string",
  "hasCustomLogo": true,
  "id": "string",
  "modelDeploymentId": "string",
  "name": "string",
  "orgId": "string",
  "orgName": "string",
  "permissions": [
    "CAN_DELETE"
  ],
  "poolUsed": true,
  "realtimePredictionsSupport": true,
  "relatedEntities": {
    "isFromExperimentContainer": true,
    "isFromUseCase": true,
    "isTrialOrganization": true,
    "modelId": "string",
    "projectId": "string"
  },
  "updatedAt": "string",
  "userId": "string"
}

Responses

Status Meaning Description Schema
200 OK none Application
202 Accepted Dulication has successfully started. See the Location header. None
403 Forbidden User does not have permission to launch application of provided type. None
404 Not Found App for duplication was not found None
422 Unprocessable Entity Application could not be created with the given input. None

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

BearerAuth

GET /api/v2/applications/{applicationId}/sharedRoles/

Get a list of users, groups and organizations that have an access to this application

Code samples

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

Parameters

Name In Type Required Description
limit query integer false The number of records to return in the range of 1 to 100
offset query integer false The number of records to skip over. Default 0.
name query string false Only return roles for a user, group or organization with this name
id query string false Only return roles for a user, group or organization with this id
shareRecipientType query string false Specify the recipient type, one of 'user', 'group', 'organization'
applicationId path string true The ID of the application

Enumerated Values

Parameter Value
shareRecipientType [user, group, organization]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "OWNER",
      "shareRecipientType": "user"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none ApplicationSharedRolesList

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

BearerAuth

PATCH /api/v2/applications/{applicationId}/sharedRoles/

Share an application with a user, group, or organization

Code samples

curl -X PATCH https://app.datarobot.com/api/v2/applications/{applicationId}/sharedRoles/?sendNotification=false&note=string&operation=string&roles=%5Bobject%20Object%5D \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

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

Parameters

Name In Type Required Description
sendNotification query boolean true Send a notification
note query string true A note to go with the project share
operation query string true Name of the action being taken, only 'updateRoles' is supported
roles query array[object] true Role objects, may contain up to 100 per request
applicationId path string true The ID of the application
body body ApplicationSharingUpdateOrRemove false none

Responses

Status Meaning Description Schema
200 OK none None
204 No Content The roles updated successfully None
422 Unprocessable Entity The request was formatted improperly. None

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

BearerAuth

GET /api/v2/applications/{applicationId}/userRole/

Get application user role

Code samples

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

Parameters

Name In Type Required Description
applicationId path string true The ID of the application

Example responses

200 Response

{
  "role": "string"
}

Responses

Status Meaning Description Schema
200 OK user's role on application entity, taking into account RBAC, groups and organization. ApplicationUserRoleResponse

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

BearerAuth

GET /api/v2/codeSnippets/

Retrieve a list of available code snippets for the given parameters.

Code samples

curl -X GET https://app.datarobot.com/api/v2/codeSnippets/?templateType=model&language=curl \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
templateType query string true The selected template type the generated snippet or notebook should be for (i.e. dataset, model, etc.).
language query string true The selected language the generated snippet or notebook should be written in.
filters query string false Optional comma separated list of sub filters to limit the returned notebooks.

Enumerated Values

Parameter Value
templateType [model, prediction]
language [curl, powershell, python, qlik]

Example responses

200 Response

{
  "codeSnippets": [
    {
      "description": "string",
      "snippetId": "string",
      "templating": [
        "string"
      ],
      "title": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK A list of snippets with descriptions and id tags. CodeSnippetListResponse

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

BearerAuth

POST /api/v2/codeSnippets/

Retrieve a code snippet to be displayed in the UI.

Code samples

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

Body parameter

{
  "config": {
    "modelId": "string",
    "projectId": "string",
    "showSecrets": "false"
  },
  "language": "curl",
  "snippetId": "string",
  "templateType": "model"
}

Parameters

Name In Type Required Description
body body CodeSnippetCreate false none

Example responses

200 Response

{
  "codeSnippet": "string",
  "snippetId": "string"
}

Responses

Status Meaning Description Schema
200 OK A generated code snippet. CodeSnippetResponse

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

BearerAuth

POST /api/v2/codeSnippets/download/

Retrieve a code snippet to be displayed in the UI.

Code samples

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

Body parameter

{
  "config": {
    "modelId": "string",
    "projectId": "string",
    "showSecrets": "false"
  },
  "language": "curl",
  "snippetId": "string",
  "templateType": "model"
}

Parameters

Name In Type Required Description
body body CodeSnippetCreate false none

Responses

Status Meaning Description Schema
200 OK A code snippet file of the selected code snippet. None

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

BearerAuth

Schemas

AddDeploymentToApplication

{
  "linkName": "string",
  "modelDeploymentId": "string"
}

Properties

Name Type Required Restrictions Description
linkName string false Internal name of deployment to match in the application
modelDeploymentId string true The ID of the model deployment to link to the application.

Application

{
  "applicationTemplateType": "string",
  "applicationTypeId": "string",
  "cloudProvider": "string",
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "datasets": [
    "string"
  ],
  "deactivationStatusId": "string",
  "deploymentIds": [
    "string"
  ],
  "deploymentName": "string",
  "deploymentStatusId": "string",
  "deployments": [
    {
      "deploymentId": "string",
      "referenceName": "string"
    }
  ],
  "description": "string",
  "hasCustomLogo": true,
  "id": "string",
  "modelDeploymentId": "string",
  "name": "string",
  "orgId": "string",
  "orgName": "string",
  "permissions": [
    "CAN_DELETE"
  ],
  "poolUsed": true,
  "realtimePredictionsSupport": true,
  "relatedEntities": {
    "isFromExperimentContainer": true,
    "isFromUseCase": true,
    "isTrialOrganization": true,
    "modelId": "string",
    "projectId": "string"
  },
  "updatedAt": "string",
  "userId": "string"
}

Properties

Name Type Required Restrictions Description
applicationTemplateType string,null true Application template type, purpose
applicationTypeId string true The ID of the type of the application
cloudProvider string true The host of this application
createdAt string true The timestamp when the application was created
createdBy string true The username of who created the application
creatorFirstName string,null true Application creator first name
creatorLastName string,null true Application creator last name
creatorUserhash string,null true Application creator userhash
datasets [string] true The list of datasets IDs associated with the application
deactivationStatusId string,null true The ID of the status object to track the asynchronous app deactivation process status. Will be null if the app was never deactivated.
deploymentIds [string] true A list of deployment IDs for this app
deploymentName string,null true Name of the deployment
deploymentStatusId string true The ID of the status object to track the asynchronous deployment process status
deployments [ApplicationDeployment] true A list of deployment details
description string false A description of the application.
hasCustomLogo boolean true Whether the app has a custom logo
id string true The ID of the created application
modelDeploymentId string true The ID of the associated model deployment
name string true The name of the application
orgId string true ID of the app's organization
orgName string,null false Name of the app's organization
permissions [string] true The list of permitted actions, which the authenticated user can perform on this application.
poolUsed boolean true Whether the pool where used for last app deployment
realtimePredictionsSupport boolean true Sets whether you can do realtime predictions in the app.
relatedEntities ApplicationRelatedEntities false IDs of entities, related to app for easy search
updatedAt string true The timestamp when the application was updated
userId string true The ID of the user which created the application

ApplicationAccessControlData

{
  "canShare": true,
  "role": "string",
  "userId": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
canShare boolean true Whether this user can share with other users
role string true The role of the user on this application
userId string true The ID of the user
username string true Username of a user with access to this application

ApplicationAccessControlList

{
  "count": 0,
  "data": [
    {
      "canShare": true,
      "role": "string",
      "userId": "string",
      "username": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Properties

Name Type Required Restrictions Description
count integer true Number of items returned on this page
data [ApplicationAccessControlData] true An array of AccessControlData objects
next string,null(uri) true URL pointing to the next page (if null, there is no next page)
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page)

ApplicationAccessControlUpdateRequest

{
  "data": [
    {
      "role": "CONSUMER",
      "username": "string"
    }
  ],
  "permissions": [
    {
      "role": "CONSUMER",
      "username": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
data [ApplicationAccessPermission] true An array of AccessControlPermissionValidator objects
permissions [ApplicationAccessPermission] false The list of permission objects describing which users to modify access for.

ApplicationAccessPermission

{
  "role": "CONSUMER",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
role string true The role to grant to the user, or "" (empty string) to remove the users access
username string true The username of the user to modify access for

Enumerated Values

Property Value
role [CONSUMER, EDITOR, OWNER, ``]

ApplicationCanCreate

{
  "experimentContainerId": "string",
  "projectId": "string",
  "sourceId": "string",
  "sourceType": "deployment"
}

Properties

Name Type Required Restrictions Description
experimentContainerId string false The ID of the experiment container (for apps from an experiment container
projectId string false The ID of the project (for apps from leaderboard)
sourceId string true The ID of the source
sourceType string true Whether the app is from a deployment or a project

Enumerated Values

Property Value
sourceType [deployment, model]

ApplicationCreate

{
  "applicationTypeId": "string",
  "authenticationType": "invitedUsersOnly",
  "cloudProvider": "drcloud",
  "description": "string",
  "experimentContainerId": "string",
  "modelDeploymentId": "string",
  "name": "string",
  "purpose": "string",
  "sources": [
    {
      "info": {
        "modelDeploymentId": "string"
      },
      "name": "string",
      "source": "deployment"
    }
  ],
  "useCaseId": "string"
}

Properties

Name Type Required Restrictions Description
applicationTypeId string false The ID of the of application to be created.
authenticationType string,null false Authentication type
cloudProvider string false The optional cloud provider
description string,null false maxLength: 512
 The description of the application
experimentContainerId string false [DEPRECATED - replaced with use_case_id] The ID of the experiment container associated with the application.
modelDeploymentId string false The ID of the model deployment. The deployed application will use this deployment to make predictions.
name string false maxLength: 512
minLength: 1
minLength: 1
 The name of the app
purpose string,null false An optional field to describe the purpose of the application.
sources [ApplicationCreateSources] false The sources for this application
useCaseId string false The ID of the Use Case associated with the application.

Enumerated Values

Property Value
authenticationType [invitedUsersOnly, token]
cloudProvider [drcloud, heroku]

ApplicationCreateSources

{
  "info": {
    "modelDeploymentId": "string"
  },
  "name": "string",
  "source": "deployment"
}

Properties

Name Type Required Restrictions Description
info any true Information about the Deployment or the Model

oneOf

Name Type Required Restrictions Description
» anonymous ApplicationDeploymentSource false none

xor

Name Type Required Restrictions Description
» anonymous ApplicationModelSource false none

continued

Name Type Required Restrictions Description
name string false The name of this source.
source string true Information about the source for this application.

Enumerated Values

Property Value
source [deployment, model]

ApplicationDeployment

{
  "deploymentId": "string",
  "referenceName": "string"
}

Properties

Name Type Required Restrictions Description
deploymentId string true The ID of the deployment
referenceName string true The reference name of the deployment

ApplicationDeploymentSource

{
  "modelDeploymentId": "string"
}

Properties

Name Type Required Restrictions Description
modelDeploymentId string true The ID of the model deployment

ApplicationDuplicate

{
  "authenticationType": "invitedUsersOnly",
  "description": "string",
  "duplicatePredictions": false,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
authenticationType string,null false Authentication type
description string,null false maxLength: 512
 The description of the application
duplicatePredictions boolean false Import all predictions from the source application
name string false maxLength: 512
minLength: 1
minLength: 1
 The name of the app

Enumerated Values

Property Value
authenticationType [invitedUsersOnly, token]

ApplicationList

{
  "count": 0,
  "data": [
    {
      "applicationTemplateType": "string",
      "applicationTypeId": "string",
      "cloudProvider": "string",
      "createdAt": "string",
      "createdBy": "string",
      "creatorFirstName": "string",
      "creatorLastName": "string",
      "creatorUserhash": "string",
      "datasets": [
        "string"
      ],
      "deactivationStatusId": "string",
      "deploymentIds": [
        "string"
      ],
      "deploymentName": "string",
      "deploymentStatusId": "string",
      "deployments": [
        {
          "deploymentId": "string",
          "referenceName": "string"
        }
      ],
      "description": "string",
      "hasCustomLogo": true,
      "id": "string",
      "modelDeploymentId": "string",
      "name": "string",
      "orgId": "string",
      "orgName": "string",
      "permissions": [
        "CAN_DELETE"
      ],
      "poolUsed": true,
      "realtimePredictionsSupport": true,
      "relatedEntities": {
        "isFromExperimentContainer": true,
        "isFromUseCase": true,
        "isTrialOrganization": true,
        "modelId": "string",
        "projectId": "string"
      },
      "updatedAt": "string",
      "userId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Properties

Name Type Required Restrictions Description
count integer true Number of items returned on this page
data [Application] true An array of Application objects
next string,null(uri) true URL pointing to the next page (if null, there is no next page)
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page)

ApplicationModelDeploymentParam

{
  "applicationId": "string",
  "modelDeploymentId": "string"
}

Properties

Name Type Required Restrictions Description
applicationId string true The ID of the application
modelDeploymentId string true The ID of the model deployment

ApplicationModelSource

{
  "modelId": "string",
  "predictionThreshold": 1,
  "projectId": "string"
}

Properties

Name Type Required Restrictions Description
modelId string true The ID of the model
predictionThreshold number false maximum: 1
minimum: 0
 Threshold used for binary classification in predictions
projectId string true The ID of the project

ApplicationNameAndDescription

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

Properties

Name Type Required Restrictions Description
description string,null false maxLength: 512
 The description of the application
name string false maxLength: 512
minLength: 1
minLength: 1
 The name of the app

ApplicationParam

{
  "applicationId": "string"
}

Properties

Name Type Required Restrictions Description
applicationId string true The ID of the application

ApplicationRelatedEntities

{
  "isFromExperimentContainer": true,
  "isFromUseCase": true,
  "isTrialOrganization": true,
  "modelId": "string",
  "projectId": "string"
}

IDs of entities, related to app for easy search

Properties

Name Type Required Restrictions Description
isFromExperimentContainer boolean false [DEPRECATED - replaced with is_from_use_case] Whether the app was created from an experiment container
isFromUseCase boolean false Whether the app was created from an Use Case
isTrialOrganization boolean false Whether the app was created from by trial customer
modelId string false The ID of the associated model
projectId string false The ID of the associated project

ApplicationRetrieve

{
  "applicationTemplateType": "string",
  "applicationTypeId": "string",
  "cloudProvider": "string",
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "datasets": [
    "string"
  ],
  "deactivationStatusId": "string",
  "deploymentIds": [
    "string"
  ],
  "deploymentName": "string",
  "deploymentStatusId": "string",
  "deployments": [
    {
      "deploymentId": "string",
      "referenceName": "string"
    }
  ],
  "description": "string",
  "hasCustomLogo": true,
  "id": "string",
  "modelDeploymentId": "string",
  "name": "string",
  "orgId": "string",
  "orgName": "string",
  "permissions": [
    "CAN_DELETE"
  ],
  "poolUsed": true,
  "realtimePredictionsSupport": true,
  "relatedEntities": {
    "isFromExperimentContainer": true,
    "isFromUseCase": true,
    "isTrialOrganization": true,
    "modelId": "string",
    "projectId": "string"
  },
  "updatedAt": "string",
  "userId": "string"
}

Properties

Name Type Required Restrictions Description
applicationTemplateType string,null true Application template type, purpose
applicationTypeId string true The ID of the type of the application
cloudProvider string true The host of this application
createdAt string true The timestamp when the application was created
createdBy string true The username of who created the application
creatorFirstName string,null true Application creator first name
creatorLastName string,null true Application creator last name
creatorUserhash string,null true Application creator userhash
datasets [string] true The list of datasets IDs associated with the application
deactivationStatusId string,null true The ID of the status object to track the asynchronous app deactivation process status. Will be null if the app was never deactivated.
deploymentIds [string] true A list of deployment IDs for this app
deploymentName string,null true Name of the deployment
deploymentStatusId string true The ID of the status object to track the asynchronous deployment process status
deployments [ApplicationDeployment] true A list of deployment details
description string false A description of the application.
hasCustomLogo boolean true Whether the app has a custom logo
id string true The ID of the created application
modelDeploymentId string,null false The ID of the model deployment. The deployed application will use this deployment to make predictions.
name string true The name of the application
orgId string true ID of the app's organization
orgName string,null false Name of the app's organization
permissions [string] true The list of permitted actions, which the authenticated user can perform on this application.
poolUsed boolean true Whether the pool where used for last app deployment
realtimePredictionsSupport boolean true Sets whether you can do realtime predictions in the app.
relatedEntities ApplicationRelatedEntities false IDs of entities, related to app for easy search
updatedAt string true The timestamp when the application was updated
userId string true The ID of the user which created the application

ApplicationSharedRolesEntry

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

Properties

Name Type Required Restrictions Description
id string true The id of the receipient
name string true The name of the user, group, or organization
role string true The assigned role
shareRecipientType string true The recipient type

Enumerated Values

Property Value
role [OWNER, USER, CONSUMER, EDITOR]
shareRecipientType [user, group, organization]

ApplicationSharedRolesEntryUpdate

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

Properties

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

Enumerated Values

Property Value
role [OWNER, USER, CONSUMER, NO_ROLE]
shareRecipientType [user, group, organization]

ApplicationSharedRolesList

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "OWNER",
      "shareRecipientType": "user"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true Number of items returned on this page
data [ApplicationSharedRolesEntry] true Details about the Shared Role entries
next string,null(uri) true URL pointing to the next page (if null, there is no next page)
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page)
totalCount integer true Number of items matching to the query condition

ApplicationSharingUpdateOrRemove

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

Properties

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

oneOf

Name Type Required Restrictions Description
» anonymous GrantAccessControlWithUsername false none

xor

Name Type Required Restrictions Description
» anonymous GrantAccessControlWithId false none

continued

Name Type Required Restrictions Description
sendNotification boolean false Send a notification?

Enumerated Values

Property Value
operation updateRoles

ApplicationUserRoleResponse

{
  "role": "string"
}

Properties

Name Type Required Restrictions Description
role string true The role of the user on this entity.

CodeSnippetCreate

{
  "config": {
    "modelId": "string",
    "projectId": "string",
    "showSecrets": "false"
  },
  "language": "curl",
  "snippetId": "string",
  "templateType": "model"
}

Properties

Name Type Required Restrictions Description
config any true Template type specific configuration used to generate a snippet or notebook.

oneOf

Name Type Required Restrictions Description
» anonymous ModelSnippetModel false none

xor

Name Type Required Restrictions Description
» anonymous PredictionSnippetModel false none

continued

Name Type Required Restrictions Description
language string true The selected language the generated snippet or notebook should be written in.
snippetId string false maxLength: 255
minLength: 1
minLength: 1
 The selected snippet to be returned to the user. This field is optional for Prediction snippets.
templateType string true The selected template type the generated snippet or notebook should be for (i.e. dataset, model, etc.).

Enumerated Values

Property Value
language [curl, powershell, python, qlik]
templateType [model, prediction]

CodeSnippetItem

{
  "description": "string",
  "snippetId": "string",
  "templating": [
    "string"
  ],
  "title": "string"
}

Properties

Name Type Required Restrictions Description
description string true maxLength: 255
minLength: 1
minLength: 1
 The descriptive text to be displayed in the UI
snippetId string true maxLength: 255
minLength: 1
minLength: 1
 The id of this snippet
templating [string] true maxItems: 255
 A list of templating variables that will be used in the snippet.
title string true maxLength: 255
minLength: 1
minLength: 1
 The title of the snippet.

CodeSnippetListResponse

{
  "codeSnippets": [
    {
      "description": "string",
      "snippetId": "string",
      "templating": [
        "string"
      ],
      "title": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
codeSnippets [CodeSnippetItem] true maxItems: 4
 A list of the available snippets for a given language and template type.

CodeSnippetResponse

{
  "codeSnippet": "string",
  "snippetId": "string"
}

Properties

Name Type Required Restrictions Description
codeSnippet string true A UTF-8 encoded code snippet generated for the user.
snippetId string true The selected snippet to be returned to the user.

GrantAccessControlWithId

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

Properties

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

Enumerated Values

Property Value
shareRecipientType [user, group, organization]

GrantAccessControlWithUsername

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

Properties

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

Enumerated Values

Property Value
shareRecipientType [user, group, organization]

ModelSnippetModel

{
  "modelId": "string",
  "projectId": "string",
  "showSecrets": "false"
}

Properties

Name Type Required Restrictions Description
modelId string true The selected model id.
projectId string true The selected project id.
showSecrets string false If true, the DATAROBOT_KEY and DATAROBOT_API_KEY will be available in the context.

Enumerated Values

Property Value
showSecrets [false, False, true, True]

PredictionSnippetModel

{
  "cliScript": true,
  "deploymentId": "string",
  "isBatchPrediction": true,
  "isLowLatencyPrediction": false,
  "isStandalone": false,
  "showSecrets": false,
  "testMode": false,
  "withApiClient": true
}

Properties

Name Type Required Restrictions Description
cliScript boolean false When combined with is_standalone, a true value returns an example CLI run script for a snippet, while a false value returns an example executable script.
deploymentId string true The selected deployment ID.
isBatchPrediction boolean false If true, returns snippet that can be used to make batch predictions. Not valid with time series projects.
isLowLatencyPrediction boolean false If true, returns snippet that can be used to make low latency predictions.Valid for Feature Discovery projects.
isStandalone boolean false If true, returns an example script for a snippet.
showSecrets boolean false If true, the DATAROBOT_KEY AND DATROBOT_API_KEY will be available in the context.
testMode boolean false Generate a snippet with mocked information.
withApiClient boolean false Instead of raw Python code in the example, show a snippet using the DataRobot Python API client.