Skip to content

Click in-app to access the full platform documentation for your version of DataRobot.

Applications

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

GET /api/v2/applicationTypes/

List of available application types to deploy.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/applicationTypes/?offset=0&limit=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true The number of records to skip over. Defaults to 0.
limit query integer true The number of records to return. Defaults to 0, meaning all records.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "configuration": {
        "deployments": [
          {
            "description": "string",
            "internalName": "string",
            "name": "string",
            "targetTypes": [
              "string"
            ]
          }
        ]
      },
      "demoAvailable": true,
      "demoDatasetLink": "http://example.com",
      "description": "string",
      "id": "string",
      "isLaunchable": true,
      "logoImage": "string",
      "maturity": "string",
      "name": "string",
      "version": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses

Status Meaning Description Schema
200 OK none ApplicationTypeListResponse

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

BearerAuth

GET /api/v2/applicationTypes/{applicationTypeId}/

Retrieve one application type

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/applicationTypes/{applicationTypeId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
applicationTypeId path string true The application type to retrieve

Example responses

200 Response

{
  "configuration": {
    "deployments": [
      {
        "description": "string",
        "internalName": "string",
        "name": "string",
        "targetTypes": [
          "string"
        ]
      }
    ]
  },
  "demoAvailable": true,
  "demoDatasetLink": "http://example.com",
  "description": "string",
  "id": "string",
  "isLaunchable": true,
  "logoImage": "string",
  "maturity": "string",
  "name": "string",
  "version": "string"
}

Responses

Status Meaning Description Schema
200 OK none ApplicationTypeRetrieveResponse
404 Not Found No app type matching the specified identifier found or user does not have permissions to access to this app type None

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

BearerAuth

GET /api/v2/applicationTypes/{applicationTypeId}/usecases/

List of available usecases for application type.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/applicationTypes/{applicationTypeId}/usecases/?offset=0&limit=100 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true The number of records to skip over. Defaults to 0.
limit query integer true The number of records to return. Defaults to 100.
applicationTypeId path string true The application type to retrieve

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "applicationTypeId": "string",
      "demoAvailable": true,
      "description": "string",
      "id": "string",
      "sources": [
        {
          "dataset": {
            "name": "string",
            "target": "string",
            "url": "http://example.com"
          }
        }
      ],
      "title": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses

Status Meaning Description Schema
200 OK none ApplicationTypeUsecasesListResponse

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

BearerAuth

GET /api/v2/applications/

Paginated list of applications created by the currently authenticated user.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/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.

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",
      "deploymentState": "string",
      "deploymentStatusId": "string",
      "deployments": [
        {
          "deploymentId": "string",
          "referenceName": "string"
        }
      ],
      "description": "string",
      "id": "string",
      "modelDeploymentId": "string",
      "name": "string",
      "permissions": [
        "CAN_DELETE"
      ],
      "poolUsed": true,
      "recentEvents": [
        "string"
      ],
      "updatedAt": "string",
      "url": "http://example.com",
      "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

# You can also use wget
curl -X POST http://10.97.110.93/api/v2/applications/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "applicationTypeId": "string",
  "authenticationType": "token",
  "cloudProvider": "heroku",
  "description": "string",
  "modelDeploymentId": "string",
  "name": "string",
  "purpose": "string",
  "sources": [
    {
      "info": {
        "datasetId": "string",
        "target": "string"
      },
      "name": "string",
      "source": "deployment"
    }
  ]
}

Parameters

Name In Type Required Description
body body ApplicationCreate false none

Example responses

200 Response

{
  "applicationTypeId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "deactivationStatusId": "string",
  "deploymentIds": [
    "string"
  ],
  "deploymentStatusId": "string",
  "id": "string",
  "modelDeploymentId": "string",
  "name": "string",
  "permissions": "CAN_UPDATE",
  "recentEvents": [
    "string"
  ],
  "updatedAt": "string",
  "userId": "string"
}

Responses

Status Meaning Description Schema
200 OK none ApplicationCreateResponse
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

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

Delete an application

Code samples

# You can also use wget
curl -X DELETE http://10.97.110.93/api/v2/applications/{applicationId}/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "applicationId": "string"
}

Parameters

Name In Type Required Description
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

# You can also use wget
curl -X GET http://10.97.110.93/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",
  "deploymentState": "string",
  "deploymentStatusId": "string",
  "deployments": [
    {
      "deploymentId": "string",
      "referenceName": "string"
    }
  ],
  "description": "string",
  "id": "string",
  "modelDeploymentId": "string",
  "name": "string",
  "permissions": [
    "CAN_DELETE"
  ],
  "poolUsed": true,
  "recentEvents": [
    {
      "eventType": "string",
      "metadata": {
        "success": true,
        "url": "http://example.com"
      },
      "timestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "updatedAt": "string",
  "url": "http://example.com",
  "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 domain prefix

Code samples

# You can also use wget
curl -X PATCH http://10.97.110.93/api/v2/applications/{applicationId}/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

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

Parameters

Name In Type Required Description
applicationId path string true The ID of the application
body body ApplicationDeploymentUpdate 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

# You can also use wget
curl -X GET http://10.97.110.93/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

# You can also use wget
curl -X PATCH http://10.97.110.93/api/v2/applications/{applicationId}/accessControl/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

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

Redeploys application with refreshed auth token.

Code samples

# You can also use wget
curl -X PATCH http://10.97.110.93/api/v2/applications/{applicationId}/authToken/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

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

Responses

Status Meaning Description Schema
200 OK none None
422 Unprocessable Entity App is not deployed. None

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

BearerAuth

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

Schedules a build job, which is normally automatically scheduled at the end of DataRobot autopilot. This is currently used in tests only, so this route is for internal use only.

Code samples

# You can also use wget
curl -X POST http://10.97.110.93/api/v2/applications/{applicationId}/buildJobs/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{}

Parameters

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

Responses

Status Meaning Description Schema
200 OK none None
202 Accepted The job has been added to the queue. See the Location header. None

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

BearerAuth

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

Update the application's deployment state. Transitioning the app to deactivated state will keep the app record in the database, but the app will not be accessible at its URL until changed back to deployed state again. When the limit of active apps has been reached, this API can be used to deactivate some applications to make space for new ones.

Code samples

# You can also use wget
curl -X PATCH http://10.97.110.93/api/v2/applications/{applicationId}/deploymentState/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "newDeploymentState": "deployed"
}

Parameters

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

Responses

Status Meaning Description Schema
200 OK none 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/{applicationId}/deployments/

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

Code samples

# You can also use wget
curl -X POST http://10.97.110.93/api/v2/applications/{applicationId}/deployments/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

# You can also use wget
curl -X DELETE http://10.97.110.93/api/v2/applications/{applicationId}/deployments/{modelDeploymentId}/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

# You can also use wget
curl -X POST http://10.97.110.93/api/v2/applications/{applicationId}/duplicate/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "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

{
  "applicationTypeId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "deactivationStatusId": "string",
  "deploymentIds": [
    "string"
  ],
  "deploymentStatusId": "string",
  "id": "string",
  "modelDeploymentId": "string",
  "name": "string",
  "permissions": "CAN_UPDATE",
  "recentEvents": [
    "string"
  ],
  "updatedAt": "string",
  "userId": "string"
}

Responses

Status Meaning Description Schema
200 OK none ApplicationCreateResponse
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

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/applications/{applicationId}/sharedRoles/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

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

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
body body ApplicationSharedRolesList false none

Enumerated Values

Parameter Value
shareRecipientType user
shareRecipientType group
shareRecipientType organization

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

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

Share an application with a user, group, or organization

Code samples

# You can also use wget
curl -X PATCH http://10.97.110.93/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}'

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

# You can also use wget
curl -X GET http://10.97.110.93/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

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

Redeploys application with specified version. If version is omitted latest available version is used.

Code samples

# You can also use wget
curl -X PATCH http://10.97.110.93/api/v2/applications/{applicationId}/version/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "version": "string"
}

Parameters

Name In Type Required Description
applicationId path string true The ID of the application
body body ApplicationUpgradeDeploymentVersion 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

POST /api/v2/demoApplications/

Create a demo application. The number of active applications users can have at the same time is limited.

Code samples

# You can also use wget
curl -X POST http://10.97.110.93/api/v2/demoApplications/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "applicationTypeId": "string",
  "usecaseId": "string"
}

Parameters

Name In Type Required Description
body body DemoApplication false none

Responses

Status Meaning Description Schema
200 OK none None
202 Accepted Creation has successfully started. See the Location header. 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

Schemas

AddDeploymentToApplication

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

Properties

Name Type Required Restrictions Description
linkName string false none Internal name of deployment to match in the application
modelDeploymentId string true none 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",
  "deploymentState": "string",
  "deploymentStatusId": "string",
  "deployments": [
    {
      "deploymentId": "string",
      "referenceName": "string"
    }
  ],
  "description": "string",
  "id": "string",
  "modelDeploymentId": "string",
  "name": "string",
  "permissions": [
    "CAN_DELETE"
  ],
  "poolUsed": true,
  "recentEvents": [
    "string"
  ],
  "updatedAt": "string",
  "url": "http://example.com",
  "userId": "string"
}

Properties

Name Type Required Restrictions Description
applicationTemplateType string¦null true none Application template type, purpose
applicationTypeId string true none The ID of the type of the application
cloudProvider string true none The host of this application
createdAt string true none The timestamp when the application was created
createdBy string true none The username of who created the application
creatorFirstName string¦null true none Application creator first name
creatorLastName string¦null true none Application creator last name
creatorUserhash string¦null true none Application creator userhash
datasets [string] true none The list of datasets IDs associated with the application
deactivationStatusId string¦null true none 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 none A list of deployment IDs for this app
deploymentName string¦null true none Name of the deployment
deploymentState string true none The state of the application deployment
deploymentStatusId string true none The ID of the status object to track the asynchronous deployment process status
deployments [ApplicationDeployment] true none A list of deployment details
description string true none A description of the application
id string true none The ID of the created application
modelDeploymentId string true none The ID of the associated model deployment
name string true none The name of the application
permissions [string] true none The list of permitted actions, which the authenticated user can perform on this application.
poolUsed boolean true none Whether the pool where used for last app deployment
recentEvents [string] true none The list of deployment events of the application.
updatedAt string true none The timestamp when the application was updated
url string(uri)¦null true none The URL of the active application
userId string true none 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 none Whether this user can share with other users
role string true none The role of the user on this application
userId string true none The ID of the user
username string true none 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 none Number of items returned on this page
data [ApplicationAccessControlData] true none An array of AccessControlData objects
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true none 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 none An array of AccessControlPermissionValidator objects
permissions [ApplicationAccessPermission] false none 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 none The role to grant to the user, or "" (empty string) to remove the users access
username string true none The username of the user to modify access for

Enumerated Values

Property Value
role CONSUMER
role EDITOR
role OWNER
role

ApplicationBuildJobCreateController

{}

Properties

None

ApplicationCreate

{
  "applicationTypeId": "string",
  "authenticationType": "token",
  "cloudProvider": "heroku",
  "description": "string",
  "modelDeploymentId": "string",
  "name": "string",
  "purpose": "string",
  "sources": [
    {
      "info": {
        "datasetId": "string",
        "target": "string"
      },
      "name": "string",
      "source": "deployment"
    }
  ]
}

Properties

Name Type Required Restrictions Description
applicationTypeId string false none The ID of the of application to be created.
authenticationType string¦null false none Authentication type
cloudProvider string false none The optional cloud provider
description string¦null false none The description of the application
modelDeploymentId string false none The ID of the model deployment. The deployed application will use this deployment to make predictions.
name string false none The name of the app
purpose string¦null false none An optional field to describe the purpose of the application.
sources [ApplicationCreateSources] false none The sources for this application

Enumerated Values

Property Value
authenticationType token
authenticationType invitedUsersOnly
cloudProvider heroku
cloudProvider drcloud

ApplicationCreateResponse

{
  "applicationTypeId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "deactivationStatusId": "string",
  "deploymentIds": [
    "string"
  ],
  "deploymentStatusId": "string",
  "id": "string",
  "modelDeploymentId": "string",
  "name": "string",
  "permissions": "CAN_UPDATE",
  "recentEvents": [
    "string"
  ],
  "updatedAt": "string",
  "userId": "string"
}

Properties

Name Type Required Restrictions Description
applicationTypeId string true none The ID of the type of the application
createdAt string true none The timestamp when the application was created
createdBy string true none The username of who created the application
deactivationStatusId string¦null true none 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 none The list of model deployment IDs associated with the application
deploymentStatusId string true none The ID of the status object to track the asynchronous deployment process status.
id string true none The ID of the created application
modelDeploymentId string true none The ID of the associated model deployment
name string true none The name of the application
permissions string true none The list of permitted actions, which the authenticated user can perform on this application.
recentEvents [string] true none The list of deployment events of the application.
updatedAt string true none The timestamp when the application was updated
userId string true none The ID of the user which created the application

Enumerated Values

Property Value
permissions CAN_UPDATE
permissions CAN_SHARE
permissions CAN_DELETE
permissions CAN_VIEW

ApplicationCreateSources

{
  "info": {
    "datasetId": "string",
    "target": "string"
  },
  "name": "string",
  "source": "deployment"
}

Properties

Name Type Required Restrictions Description
info any true none Information about the Deployment or Dataset source.

oneOf

Name Type Required Restrictions Description
» anonymous ApplicationDatasetSource false none none

xor

Name Type Required Restrictions Description
» anonymous ApplicationDeploymentSource false none none

continued

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

Enumerated Values

Property Value
source deployment
source dataset

ApplicationDatasetSource

{
  "datasetId": "string",
  "target": "string"
}

Properties

Name Type Required Restrictions Description
datasetId string true none The ID of the dataset
target string¦null true none The target

ApplicationDeployment

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

Properties

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

ApplicationDeploymentSource

{
  "modelDeploymentId": "string"
}

Properties

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

ApplicationDeploymentStateUpdate

{
  "newDeploymentState": "deployed"
}

Properties

Name Type Required Restrictions Description
newDeploymentState string true none The deployment state to transition to. Can be one of: "deployed", "deactivated".

Enumerated Values

Property Value
newDeploymentState deployed
newDeploymentState deactivated

ApplicationDeploymentUpdate

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

Properties

Name Type Required Restrictions Description
description string¦null false none The description of the application
domain string(An string suitable for use as a domain name.)¦null false none The new domain prefix for the app
name string false none The name of the app

ApplicationDuplicate

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

Properties

Name Type Required Restrictions Description
description string¦null false none The description of the application
duplicatePredictions boolean false none Import all predictions from the source application
name string false none The name of the app

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",
      "deploymentState": "string",
      "deploymentStatusId": "string",
      "deployments": [
        {
          "deploymentId": "string",
          "referenceName": "string"
        }
      ],
      "description": "string",
      "id": "string",
      "modelDeploymentId": "string",
      "name": "string",
      "permissions": [
        "CAN_DELETE"
      ],
      "poolUsed": true,
      "recentEvents": [
        "string"
      ],
      "updatedAt": "string",
      "url": "http://example.com",
      "userId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Properties

Name Type Required Restrictions Description
count integer true none Number of items returned on this page
data [Application] true none An array of Application objects
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true none 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 none The ID of the application
modelDeploymentId string true none The ID of the model deployment

ApplicationParam

{
  "applicationId": "string"
}

Properties

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

ApplicationRecentEvents

{
  "eventType": "string",
  "metadata": {
    "success": true,
    "url": "http://example.com"
  },
  "timestamp": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
eventType string true none The type of event
metadata RecentEventsMetadata true none Metadata about this event
timestamp string(date-time) true none The timestamp when the event was recorded

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",
  "deploymentState": "string",
  "deploymentStatusId": "string",
  "deployments": [
    {
      "deploymentId": "string",
      "referenceName": "string"
    }
  ],
  "description": "string",
  "id": "string",
  "modelDeploymentId": "string",
  "name": "string",
  "permissions": [
    "CAN_DELETE"
  ],
  "poolUsed": true,
  "recentEvents": [
    {
      "eventType": "string",
      "metadata": {
        "success": true,
        "url": "http://example.com"
      },
      "timestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "updatedAt": "string",
  "url": "http://example.com",
  "userId": "string"
}

Properties

Name Type Required Restrictions Description
applicationTemplateType string¦null true none Application template type, purpose
applicationTypeId string true none The ID of the type of the application
cloudProvider string true none The host of this application
createdAt string true none The timestamp when the application was created
createdBy string true none The username of who created the application
creatorFirstName string¦null true none Application creator first name
creatorLastName string¦null true none Application creator last name
creatorUserhash string¦null true none Application creator userhash
datasets [string] true none The list of datasets IDs associated with the application
deactivationStatusId string¦null true none 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 none A list of deployment IDs for this app
deploymentName string¦null true none Name of the deployment
deploymentState string true none The state of the application deployment
deploymentStatusId string true none The ID of the status object to track the asynchronous deployment process status
deployments [ApplicationDeployment] true none A list of deployment details
description string true none A description of the application
id string true none The ID of the created application
modelDeploymentId string¦null false none The ID of the model deployment. The deployed application will use this deployment to make predictions.
name string true none The name of the application
permissions [string] true none The list of permitted actions, which the authenticated user can perform on this application.
poolUsed boolean true none Whether the pool where used for last app deployment
recentEvents [ApplicationRecentEvents] true none The list of deployment events of the application.
updatedAt string true none The timestamp when the application was updated
url string(uri)¦null true none The URL of the active application
userId string true none 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 none The id of the receipient
name string true none The name of the user, group, or organization
role string true none The assigned role
shareRecipientType string true none The recipient type

Enumerated Values

Property Value
role OWNER
role USER
role CONSUMER
shareRecipientType user
shareRecipientType group
shareRecipientType organization

ApplicationSharedRolesEntryUpdate

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

Properties

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

Enumerated Values

Property Value
role OWNER
role USER
role CONSUMER
role NO_ROLE
shareRecipientType user
shareRecipientType group
shareRecipientType 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 none Number of items returned on this page
data [ApplicationSharedRolesEntry] true none Details about the Shared Role entries
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page)
totalCount integer true none 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 none A note to go with the project share
operation string true none Name of the action being taken. The only operation is 'updateRoles'.
roles [oneOf] true none Array of GrantAccessControl objects., up to maximum 100 objects.

oneOf

Name Type Required Restrictions Description
» anonymous GrantAccessControlWithUsername false none none

xor

Name Type Required Restrictions Description
» anonymous GrantAccessControlWithId false none none

continued

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

Enumerated Values

Property Value
operation updateRoles

ApplicationTypeConfiguration

{
  "deployments": [
    {
      "description": "string",
      "internalName": "string",
      "name": "string",
      "targetTypes": [
        "string"
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
deployments [ApplicationTypeConfigurationDeployment] false none The deployments for this application

ApplicationTypeConfigurationDeployment

{
  "description": "string",
  "internalName": "string",
  "name": "string",
  "targetTypes": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
description string false none A description of the deployment configuration
internalName string true none The internal name of this deployment
name string true none The name of this deployment
targetTypes [string] false none The type of the deployment

ApplicationTypeListResponse

{
  "count": 0,
  "data": [
    {
      "configuration": {
        "deployments": [
          {
            "description": "string",
            "internalName": "string",
            "name": "string",
            "targetTypes": [
              "string"
            ]
          }
        ]
      },
      "demoAvailable": true,
      "demoDatasetLink": "http://example.com",
      "description": "string",
      "id": "string",
      "isLaunchable": true,
      "logoImage": "string",
      "maturity": "string",
      "name": "string",
      "version": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Properties

Name Type Required Restrictions Description
count integer true none Number of items
data [ApplicationTypeRetrieveResponse] true none each has the same schema as when application types retrieved individually from :http:get:/api/v2/applicationTypes/(applicationTypeId)/.
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page)

ApplicationTypeRetrieveResponse

{
  "configuration": {
    "deployments": [
      {
        "description": "string",
        "internalName": "string",
        "name": "string",
        "targetTypes": [
          "string"
        ]
      }
    ]
  },
  "demoAvailable": true,
  "demoDatasetLink": "http://example.com",
  "description": "string",
  "id": "string",
  "isLaunchable": true,
  "logoImage": "string",
  "maturity": "string",
  "name": "string",
  "version": "string"
}

Properties

Name Type Required Restrictions Description
configuration ApplicationTypeConfiguration true none Required configurations for running applications: deploymentCount.
demoAvailable boolean true none Indicates if app type has the ability to launch a demo version
demoDatasetLink string(uri)¦null true none Link to demo dataset that usable with app
description string true none the description of the application
id string true none The ID of the application type
isLaunchable boolean true none Indicates if app of this type could be deployed by current user
logoImage string¦null true none The logo of the application encoded as base64 string PNG image
maturity string true none Indicates app maturity level
name string true none The name of the application type
version string true none The version

ApplicationTypeUsecases

{
  "applicationTypeId": "string",
  "demoAvailable": true,
  "description": "string",
  "id": "string",
  "sources": [
    {
      "dataset": {
        "name": "string",
        "target": "string",
        "url": "http://example.com"
      }
    }
  ],
  "title": "string"
}

Properties

Name Type Required Restrictions Description
applicationTypeId string true none id of application type
demoAvailable boolean true none Is demo app creation available for this usecase
description string true none Description of this usecase
id string true none id of usecase
sources [ApplicationTypeUsecasesSource] true none List of resources linked to usecase
title string true none Title of usecase

ApplicationTypeUsecasesDataset

{
  "name": "string",
  "target": "string",
  "url": "http://example.com"
}

Properties

Name Type Required Restrictions Description
name string¦null true none Name of current dataset
target string¦null true none Target of current dataset if required
url string(uri) true none URL to download dataset

ApplicationTypeUsecasesListResponse

{
  "count": 0,
  "data": [
    {
      "applicationTypeId": "string",
      "demoAvailable": true,
      "description": "string",
      "id": "string",
      "sources": [
        {
          "dataset": {
            "name": "string",
            "target": "string",
            "url": "http://example.com"
          }
        }
      ],
      "title": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Properties

Name Type Required Restrictions Description
count integer true none Number of items
data [ApplicationTypeUsecases] true none Information about usecases.
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page)

ApplicationTypeUsecasesSource

{
  "dataset": {
    "name": "string",
    "target": "string",
    "url": "http://example.com"
  }
}

Properties

Name Type Required Restrictions Description
dataset ApplicationTypeUsecasesDataset true none A list of information about the dataset sources

ApplicationUpgradeDeploymentVersion

{
  "version": "string"
}

Properties

Name Type Required Restrictions Description
version string false none Version to upgrade the deployment to

ApplicationUserRoleResponse

{
  "role": "string"
}

Properties

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

DemoApplication

{
  "applicationTypeId": "string",
  "usecaseId": "string"
}

Properties

Name Type Required Restrictions Description
applicationTypeId string true none The ID of the application to be created
usecaseId string¦null false none The ID of the use case to use for the demo application

GrantAccessControlWithId

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

Properties

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

Enumerated Values

Property Value
shareRecipientType user
shareRecipientType group
shareRecipientType organization

GrantAccessControlWithUsername

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

Properties

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

Enumerated Values

Property Value
shareRecipientType user
shareRecipientType group
shareRecipientType organization

RecentEventsMetadata

{
  "success": true,
  "url": "http://example.com"
}

Properties

Name Type Required Restrictions Description
success boolean true none Was this a successful event
url string(uri) true none URL

Updated June 28, 2022
Back to top