Skip to content

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

Blueprints

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

GET /api/v2/customTasks/

Retrieve metadata for all custom tasks the user has access to.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/customTasks/?offset=0&limit=1000 \
  -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.
orderBy query string false Sort order which will be applied to custom task list, valid options are "created", "updated". Prefix the attribute name with a dash to sort in descending order, e.g. orderBy="-created". By default, the orderBy parameter is None which will result in custom tasks being returned in order of creation time descending.
searchFor query string false String to search for occurrence in custom task's description, language and name. Search is case insensitive. If not specified, all custom tasks will be returned.

Enumerated Values

Parameter Value
orderBy [created, -created, updated, -updated]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "calibratePredictions": true,
      "created": "string",
      "createdBy": "string",
      "customModelType": "training",
      "description": "string",
      "id": "string",
      "language": "string",
      "latestVersion": {
        "baseEnvironmentId": "string",
        "baseEnvironmentVersionId": "string",
        "created": "string",
        "customModelId": "string",
        "customTaskId": "string",
        "dependencies": [
          {
            "constraints": [
              {
                "constraintType": "<",
                "version": "string"
              }
            ],
            "extras": "string",
            "line": "string",
            "lineNumber": 0,
            "packageName": "string"
          }
        ],
        "description": "string",
        "id": "string",
        "isFrozen": true,
        "items": [
          {
            "commitSha": "string",
            "created": "string",
            "fileName": "string",
            "filePath": "string",
            "fileSource": "string",
            "id": "string",
            "ref": "string",
            "repositoryFilePath": "string",
            "repositoryLocation": "string",
            "repositoryName": "string"
          }
        ],
        "label": "string",
        "maximumMemory": 134217728,
        "outboundNetworkPolicy": "ISOLATED",
        "requiredMetadata": {},
        "requiredMetadataValues": [
          {
            "fieldName": "string",
            "value": "string"
          }
        ],
        "versionMajor": 0,
        "versionMinor": 0,
        "warning": [
          "string"
        ]
      },
      "maximumMemory": 134217728,
      "name": "string",
      "targetType": "Binary",
      "updated": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK OK. CustomTaskListResponse

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

BearerAuth

POST /api/v2/customTasks/

Creates a new custom task and returns the newly created metadata record for it.

A custom task may either be an estimator or a transform. Estimators must support a single target type (e.g. binaryClassification, regression). Regression and anomaly detection models are expected to produce predictions that are arbitrary floating-point or integer numbers. A classification model is expected to return predictions with probability scores for each class. For example, a binary classification model might return:

.. code:: Python

{
    positiveClassLabel: probability,
    negativeClassLabel: 1.0 - probability
}

Transforms are expected to return a dataframe or sparse matrix with the same number of rows as the input feature matrix. At this time, only numeric outputs are supported for custom transforms.

Code samples

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

Body parameter

{
  "calibratePredictions": "True",
  "description": "string",
  "language": "string",
  "maximumMemory": 134217728,
  "name": "string",
  "targetType": "Binary"
}

Parameters

Name In Type Required Description
body body CustomTaskCreate false none

Example responses

201 Response

{
  "calibratePredictions": true,
  "created": "string",
  "createdBy": "string",
  "customModelType": "training",
  "description": "string",
  "id": "string",
  "language": "string",
  "latestVersion": {
    "baseEnvironmentId": "string",
    "baseEnvironmentVersionId": "string",
    "created": "string",
    "customModelId": "string",
    "customTaskId": "string",
    "dependencies": [
      {
        "constraints": [
          {
            "constraintType": "<",
            "version": "string"
          }
        ],
        "extras": "string",
        "line": "string",
        "lineNumber": 0,
        "packageName": "string"
      }
    ],
    "description": "string",
    "id": "string",
    "isFrozen": true,
    "items": [
      {
        "commitSha": "string",
        "created": "string",
        "fileName": "string",
        "filePath": "string",
        "fileSource": "string",
        "id": "string",
        "ref": "string",
        "repositoryFilePath": "string",
        "repositoryLocation": "string",
        "repositoryName": "string"
      }
    ],
    "label": "string",
    "maximumMemory": 134217728,
    "outboundNetworkPolicy": "ISOLATED",
    "requiredMetadata": {},
    "requiredMetadataValues": [
      {
        "fieldName": "string",
        "value": "string"
      }
    ],
    "versionMajor": 0,
    "versionMinor": 0,
    "warning": [
      "string"
    ]
  },
  "maximumMemory": 134217728,
  "name": "string",
  "targetType": "Binary",
  "updated": "string"
}

Responses

Status Meaning Description Schema
201 Created Custom task successfully created. CustomTaskResponse
403 Forbidden Custom task creation is not enabled. None
422 Unprocessable Entity Input parameters invalid None

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

BearerAuth

POST /api/v2/customTasks/fromCustomTask/

Creates a copy of the provided custom task, including metadata, versions of that task, and uploaded files. Associates the new versions with files owned by the custom task.

Code samples

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

Body parameter

{
  "customTaskId": "string"
}

Parameters

Name In Type Required Description
body body CustomTaskCopy false none

Example responses

201 Response

{
  "calibratePredictions": true,
  "created": "string",
  "createdBy": "string",
  "customModelType": "training",
  "description": "string",
  "id": "string",
  "language": "string",
  "latestVersion": {
    "baseEnvironmentId": "string",
    "baseEnvironmentVersionId": "string",
    "created": "string",
    "customModelId": "string",
    "customTaskId": "string",
    "dependencies": [
      {
        "constraints": [
          {
            "constraintType": "<",
            "version": "string"
          }
        ],
        "extras": "string",
        "line": "string",
        "lineNumber": 0,
        "packageName": "string"
      }
    ],
    "description": "string",
    "id": "string",
    "isFrozen": true,
    "items": [
      {
        "commitSha": "string",
        "created": "string",
        "fileName": "string",
        "filePath": "string",
        "fileSource": "string",
        "id": "string",
        "ref": "string",
        "repositoryFilePath": "string",
        "repositoryLocation": "string",
        "repositoryName": "string"
      }
    ],
    "label": "string",
    "maximumMemory": 134217728,
    "outboundNetworkPolicy": "ISOLATED",
    "requiredMetadata": {},
    "requiredMetadataValues": [
      {
        "fieldName": "string",
        "value": "string"
      }
    ],
    "versionMajor": 0,
    "versionMinor": 0,
    "warning": [
      "string"
    ]
  },
  "maximumMemory": 134217728,
  "name": "string",
  "targetType": "Binary",
  "updated": "string"
}

Responses

Status Meaning Description Schema
201 Created Successfully created copy. CustomTaskResponse

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

BearerAuth

DELETE /api/v2/customTasks/{customTaskId}/

Delete a custom task. Only users who have permission to edit custom task can delete it. Only custom tasks which are not currently deployed, used in a blueprint, or in the AIcatalog can be deleted. Relevant CustomTaskImage will be deleted also.

Code samples

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

Parameters

Name In Type Required Description
customTaskId path string true The ID of the custom task.

Responses

Status Meaning Description Schema
204 No Content Record deleted. None
409 Conflict This custom task is currently deployed, trained, or part of a user blueprint, and cannot be deleted. The response body will contain link where these conflicts can be retrieved. None

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

BearerAuth

GET /api/v2/customTasks/{customTaskId}/

Retrieve metadata for a custom task

Code samples

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

Parameters

Name In Type Required Description
customTaskId path string true The ID of the custom task.

Example responses

200 Response

{
  "calibratePredictions": true,
  "created": "string",
  "createdBy": "string",
  "customModelType": "training",
  "description": "string",
  "id": "string",
  "language": "string",
  "latestVersion": {
    "baseEnvironmentId": "string",
    "baseEnvironmentVersionId": "string",
    "created": "string",
    "customModelId": "string",
    "customTaskId": "string",
    "dependencies": [
      {
        "constraints": [
          {
            "constraintType": "<",
            "version": "string"
          }
        ],
        "extras": "string",
        "line": "string",
        "lineNumber": 0,
        "packageName": "string"
      }
    ],
    "description": "string",
    "id": "string",
    "isFrozen": true,
    "items": [
      {
        "commitSha": "string",
        "created": "string",
        "fileName": "string",
        "filePath": "string",
        "fileSource": "string",
        "id": "string",
        "ref": "string",
        "repositoryFilePath": "string",
        "repositoryLocation": "string",
        "repositoryName": "string"
      }
    ],
    "label": "string",
    "maximumMemory": 134217728,
    "outboundNetworkPolicy": "ISOLATED",
    "requiredMetadata": {},
    "requiredMetadataValues": [
      {
        "fieldName": "string",
        "value": "string"
      }
    ],
    "versionMajor": 0,
    "versionMinor": 0,
    "warning": [
      "string"
    ]
  },
  "maximumMemory": 134217728,
  "name": "string",
  "targetType": "Binary",
  "updated": "string"
}

Responses

Status Meaning Description Schema
200 OK OK. CustomTaskResponse

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

BearerAuth

PATCH /api/v2/customTasks/{customTaskId}/

Updates metadata for an existing custom task.

All custom tasks must support one target type (e.g. binaryClassification, regression, transform).

Setting positiveClassLabel and negativeClassLabel to null will set the labels to their default values (1 and 0 for positiveClassLabel and negativeClassLabel, respectively).

Setting positiveClassLabel, negativeClassLabel, targetName is disabled if task has active deployments.

Code samples

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

Body parameter

{
  "description": "string",
  "language": "string",
  "maximumMemory": 134217728,
  "name": "string"
}

Parameters

Name In Type Required Description
customTaskId path string true The ID of the custom task.
body body CustomTaskUpdate false none

Example responses

201 Response

{
  "calibratePredictions": true,
  "created": "string",
  "createdBy": "string",
  "customModelType": "training",
  "description": "string",
  "id": "string",
  "language": "string",
  "latestVersion": {
    "baseEnvironmentId": "string",
    "baseEnvironmentVersionId": "string",
    "created": "string",
    "customModelId": "string",
    "customTaskId": "string",
    "dependencies": [
      {
        "constraints": [
          {
            "constraintType": "<",
            "version": "string"
          }
        ],
        "extras": "string",
        "line": "string",
        "lineNumber": 0,
        "packageName": "string"
      }
    ],
    "description": "string",
    "id": "string",
    "isFrozen": true,
    "items": [
      {
        "commitSha": "string",
        "created": "string",
        "fileName": "string",
        "filePath": "string",
        "fileSource": "string",
        "id": "string",
        "ref": "string",
        "repositoryFilePath": "string",
        "repositoryLocation": "string",
        "repositoryName": "string"
      }
    ],
    "label": "string",
    "maximumMemory": 134217728,
    "outboundNetworkPolicy": "ISOLATED",
    "requiredMetadata": {},
    "requiredMetadataValues": [
      {
        "fieldName": "string",
        "value": "string"
      }
    ],
    "versionMajor": 0,
    "versionMinor": 0,
    "warning": [
      "string"
    ]
  },
  "maximumMemory": 134217728,
  "name": "string",
  "targetType": "Binary",
  "updated": "string"
}

Responses

Status Meaning Description Schema
201 Created Created. CustomTaskResponse
422 Unprocessable Entity Input parameters are invalid. None

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

BearerAuth

GET /api/v2/customTasks/{customTaskId}/accessControl/

Get a list of users who have access to this custom task and their roles on it.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/customTasks/{customTaskId}/accessControl/?offset=0&limit=1000 \
  -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.
customTaskId path string true The ID of the custom task.

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 A list of users who have access to this custom task and their roles on it. CustomTaskAccessControlListResponse
400 Bad Request Both username and userId were specified. None

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

BearerAuth

PATCH /api/v2/customTasks/{customTaskId}/accessControl/

Grant access or update roles for users on this custom task and appropriate learning data. Up to 100 user roles may be set in a single request.

Code samples

# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/customTasks/{customTaskId}/accessControl/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "data": [
    {
      "canShare": true,
      "role": "ADMIN",
      "username": "string"
    }
  ]
}

Parameters

Name In Type Required Description
customTaskId path string true The ID of the custom task.
body body SharingUpdateOrRemoveWithGrant false none

Responses

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

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

BearerAuth

GET /api/v2/customTasks/{customTaskId}/download/

Download the latest item bundle from a custom task as a zip compressed archive.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/customTasks/{customTaskId}/download/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
customTaskId path string true The ID of the custom task.

Responses

Status Meaning Description Schema
200 OK The download succeeded. None

Response Headers

Status Header Type Format Description
200 Content-Disposition string Contains an auto generated filename for this download ("attachment;filename=model--version-.zip").

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

BearerAuth

GET /api/v2/customTasks/{customTaskId}/versions/

List custom task versions.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/customTasks/{customTaskId}/versions/?offset=0&limit=1000 \
  -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.
customTaskId path string true The ID of the custom task.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "baseEnvironmentId": "string",
      "baseEnvironmentVersionId": "string",
      "created": "string",
      "customModelId": "string",
      "customTaskId": "string",
      "dependencies": [
        {
          "constraints": [
            {
              "constraintType": "<",
              "version": "string"
            }
          ],
          "extras": "string",
          "line": "string",
          "lineNumber": 0,
          "packageName": "string"
        }
      ],
      "description": "string",
      "id": "string",
      "isFrozen": true,
      "items": [
        {
          "commitSha": "string",
          "created": "string",
          "fileName": "string",
          "filePath": "string",
          "fileSource": "string",
          "id": "string",
          "ref": "string",
          "repositoryFilePath": "string",
          "repositoryLocation": "string",
          "repositoryName": "string"
        }
      ],
      "label": "string",
      "maximumMemory": 134217728,
      "outboundNetworkPolicy": "ISOLATED",
      "requiredMetadata": {},
      "requiredMetadataValues": [
        {
          "fieldName": "string",
          "value": "string"
        }
      ],
      "versionMajor": 0,
      "versionMinor": 0,
      "warning": [
        "string"
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK OK. CustomTaskVersionListResponse
400 Bad Request Query parameters are invalid. None

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

BearerAuth

PATCH /api/v2/customTasks/{customTaskId}/versions/

Create a new custom task version with files added, replaced or deleted. Files from the previous version of a custom task will be used as a basis.

Code samples

# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/customTasks/{customTaskId}/versions/ \
  -H "Content-Type: multipart/form-data" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

baseEnvironmentId: string
file: string
filePath: string
filesToDelete: string
isMajorUpdate: "false"
maximumMemory: 134217728
outboundNetworkPolicy: ISOLATED
requiredMetadata: string
requiredMetadataValues: string

Parameters

Name In Type Required Description
customTaskId path string true The ID of the custom task.
body body CustomTaskVersionCreateFromLatest false none

Example responses

201 Response

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "created": "string",
  "customModelId": "string",
  "customTaskId": "string",
  "dependencies": [
    {
      "constraints": [
        {
          "constraintType": "<",
          "version": "string"
        }
      ],
      "extras": "string",
      "line": "string",
      "lineNumber": 0,
      "packageName": "string"
    }
  ],
  "description": "string",
  "id": "string",
  "isFrozen": true,
  "items": [
    {
      "commitSha": "string",
      "created": "string",
      "fileName": "string",
      "filePath": "string",
      "fileSource": "string",
      "id": "string",
      "ref": "string",
      "repositoryFilePath": "string",
      "repositoryLocation": "string",
      "repositoryName": "string"
    }
  ],
  "label": "string",
  "maximumMemory": 134217728,
  "outboundNetworkPolicy": "ISOLATED",
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ],
  "versionMajor": 0,
  "versionMinor": 0,
  "warning": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
201 Created Item successfully created. CustomTaskVersionResponse
413 Payload Too Large Item or collection of items was too large in size (bytes). None
422 Unprocessable Entity Cannot create the custom task version due to one or more errors. All error responses will have a "message" field and some may have optional fields. The optional fields include: ["errors", "dependencies", "invalidDependencies"] None

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

BearerAuth

POST /api/v2/customTasks/{customTaskId}/versions/

Create a new custom task version with attached files if supplied.

Code samples

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/customTasks/{customTaskId}/versions/ \
  -H "Content-Type: multipart/form-data" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

baseEnvironmentId: string
file: string
filePath: string
isMajorUpdate: "false"
maximumMemory: 134217728
outboundNetworkPolicy: ISOLATED
requiredMetadata: string
requiredMetadataValues: string

Parameters

Name In Type Required Description
customTaskId path string true The ID of the custom task.
body body CustomTaskVersionCreate false none

Example responses

201 Response

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "created": "string",
  "customModelId": "string",
  "customTaskId": "string",
  "dependencies": [
    {
      "constraints": [
        {
          "constraintType": "<",
          "version": "string"
        }
      ],
      "extras": "string",
      "line": "string",
      "lineNumber": 0,
      "packageName": "string"
    }
  ],
  "description": "string",
  "id": "string",
  "isFrozen": true,
  "items": [
    {
      "commitSha": "string",
      "created": "string",
      "fileName": "string",
      "filePath": "string",
      "fileSource": "string",
      "id": "string",
      "ref": "string",
      "repositoryFilePath": "string",
      "repositoryLocation": "string",
      "repositoryName": "string"
    }
  ],
  "label": "string",
  "maximumMemory": 134217728,
  "outboundNetworkPolicy": "ISOLATED",
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ],
  "versionMajor": 0,
  "versionMinor": 0,
  "warning": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
201 Created Item successfully created. CustomTaskVersionResponse
413 Payload Too Large Item or collection of items was too large in size (bytes). None
422 Unprocessable Entity Cannot create the custom task version due to one or more errors. All error responses will have a "message" field and some may have optional fields. The optional fields include: ["errors", "dependencies", "invalidDependencies"] None

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

BearerAuth

PATCH /api/v2/customTasks/{customTaskId}/versions/fromRepository/

Create a new custom task version with files added from a remote repository. Files from the previous version of a custom task will be used as a basis.

Code samples

# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/customTasks/{customTaskId}/versions/fromRepository/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "baseEnvironmentId": "string",
  "isMajorUpdate": true,
  "outboundNetworkPolicy": "ISOLATED",
  "ref": "string",
  "repositoryId": "string",
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ],
  "sourcePath": "string"
}

Parameters

Name In Type Required Description
customTaskId path string true The ID of the custom task.
body body CustomTaskVersionCreateFromRepository false none

Responses

Status Meaning Description Schema
202 Accepted Accepted: request placed to a queue for processing. None
422 Unprocessable Entity Input parameters are invalid. None

Response Headers

Status Header Type Format Description
202 Location string URL for tracking async job status.

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

BearerAuth

POST /api/v2/customTasks/{customTaskId}/versions/fromRepository/

Create a new custom task version with only files added from the specified remote repository.

Code samples

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/customTasks/{customTaskId}/versions/fromRepository/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "baseEnvironmentId": "string",
  "isMajorUpdate": true,
  "outboundNetworkPolicy": "ISOLATED",
  "ref": "string",
  "repositoryId": "string",
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ],
  "sourcePath": "string"
}

Parameters

Name In Type Required Description
customTaskId path string true The ID of the custom task.
body body CustomTaskVersionCreateFromRepository false none

Responses

Status Meaning Description Schema
202 Accepted Accepted: request placed to a queue for processing. None
422 Unprocessable Entity Input parameters are invalid. None

Response Headers

Status Header Type Format Description
202 Location string URL for tracking async job status.

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

BearerAuth

GET /api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/

Display a requested version of a custom task along with the files attached to it.

Code samples

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

Parameters

Name In Type Required Description
customTaskId path string true ID of the custom task.
customTaskVersionId path string true ID of the custom task version.

Example responses

200 Response

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "created": "string",
  "customModelId": "string",
  "customTaskId": "string",
  "dependencies": [
    {
      "constraints": [
        {
          "constraintType": "<",
          "version": "string"
        }
      ],
      "extras": "string",
      "line": "string",
      "lineNumber": 0,
      "packageName": "string"
    }
  ],
  "description": "string",
  "id": "string",
  "isFrozen": true,
  "items": [
    {
      "commitSha": "string",
      "created": "string",
      "fileName": "string",
      "filePath": "string",
      "fileSource": "string",
      "id": "string",
      "ref": "string",
      "repositoryFilePath": "string",
      "repositoryLocation": "string",
      "repositoryName": "string"
    }
  ],
  "label": "string",
  "maximumMemory": 134217728,
  "outboundNetworkPolicy": "ISOLATED",
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ],
  "versionMajor": 0,
  "versionMinor": 0,
  "warning": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK. CustomTaskVersionResponse

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

BearerAuth

PATCH /api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/

Edit metadata of a specific task version.

Code samples

# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "description": "string",
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ]
}

Parameters

Name In Type Required Description
customTaskId path string true ID of the custom task.
customTaskVersionId path string true ID of the custom task version.
body body CustomTaskVersionMetadataUpdate false none

Example responses

200 Response

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "created": "string",
  "customModelId": "string",
  "customTaskId": "string",
  "dependencies": [
    {
      "constraints": [
        {
          "constraintType": "<",
          "version": "string"
        }
      ],
      "extras": "string",
      "line": "string",
      "lineNumber": 0,
      "packageName": "string"
    }
  ],
  "description": "string",
  "id": "string",
  "isFrozen": true,
  "items": [
    {
      "commitSha": "string",
      "created": "string",
      "fileName": "string",
      "filePath": "string",
      "fileSource": "string",
      "id": "string",
      "ref": "string",
      "repositoryFilePath": "string",
      "repositoryLocation": "string",
      "repositoryName": "string"
    }
  ],
  "label": "string",
  "maximumMemory": 134217728,
  "outboundNetworkPolicy": "ISOLATED",
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ],
  "versionMajor": 0,
  "versionMinor": 0,
  "warning": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK The edit was successful. CustomTaskVersionResponse
404 Not Found Custom task not found or user does not have edit permissions. None

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

BearerAuth

DELETE /api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuild/

Cancel the custom task version's dependency build.

Code samples

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

Parameters

Name In Type Required Description
customTaskId path string true ID of the custom task.
customTaskVersionId path string true ID of the custom task version.

Responses

Status Meaning Description Schema
204 No Content Custom task version's dependency build was cancelled. None
409 Conflict Custom task dependency build has reached a terminal state and cannot be cancelled. None
422 Unprocessable Entity No custom task dependency build started for specified version or dependency image is in use and cannot be deleted None

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

BearerAuth

GET /api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuild/

Retrieve the custom task version's dependency build status.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuild/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
customTaskId path string true ID of the custom task.
customTaskVersionId path string true ID of the custom task version.

Example responses

200 Response

{
  "buildEnd": "string",
  "buildLogLocation": "http://example.com",
  "buildStart": "string",
  "buildStatus": "submitted",
  "customTaskId": "string",
  "customTaskVersionId": "string"
}

Responses

Status Meaning Description Schema
200 OK The metadata from the custom task version's dependency build. CustomTaskVersionDependencyBuildMetadataResponse
422 Unprocessable Entity Custom task dependency build has not started. None

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

BearerAuth

POST /api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuild/

Start a custom task version's dependency build. This is required to test, deploy, or train custom tasks.

Code samples

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuild/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
customTaskId path string true ID of the custom task.
customTaskVersionId path string true ID of the custom task version.

Example responses

202 Response

{
  "buildEnd": "string",
  "buildLogLocation": "http://example.com",
  "buildStart": "string",
  "buildStatus": "submitted",
  "customTaskId": "string",
  "customTaskVersionId": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Custom task version's dependency build has started. CustomTaskVersionDependencyBuildMetadataResponse
422 Unprocessable Entity Custom task dependency build has failed. None

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

BearerAuth

GET /api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuildLog/

Retrieve the custom task version's dependency build log.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuildLog/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
customTaskId path string true ID of the custom task.
customTaskVersionId path string true ID of the custom task version.

Responses

Status Meaning Description Schema
200 OK The log file generated during the custom task version's dependency build. None
404 Not Found Dependency build is in progress or could not be found. None
422 Unprocessable Entity Custom task dependency build has not started. None

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

BearerAuth

GET /api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/download/

Download a specific item bundle from a custom task as a zip compressed archive.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/download/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
customTaskId path string true ID of the custom task.
customTaskVersionId path string true ID of the custom task version.

Responses

Status Meaning Description Schema
200 OK The download succeeded. None

Response Headers

Status Header Type Format Description
200 Content-Disposition string Contains an auto generated filename for this download ("attachment;filename=model--version-.zip").

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

BearerAuth

GET /api/v2/projects/{projectId}/blueprints/

List appropriate blueprints for the project.

Code samples

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

Parameters

Name In Type Required Description
projectId path string true The project ID.

Example responses

200 Response

[
  {
    "blueprintCategory": "string",
    "id": "string",
    "isCustomModelBlueprint": true,
    "modelType": "string",
    "monotonicDecreasingFeaturelistId": "string",
    "monotonicIncreasingFeaturelistId": "string",
    "processes": [
      "string"
    ],
    "projectId": "string",
    "recommendedFeaturelistId": "string",
    "supportsComposableMl": true,
    "supportsIncrementalLearning": true,
    "supportsMonotonicConstraints": true
  }
]

Responses

Status Meaning Description Schema
200 OK The list of blueprints Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [BlueprintResponse] false none
» blueprintCategory string true describes the category of the blueprint and indicates the kind of model this blueprint produces. Will be either "DataRobot" or "Scaleout DataRobot".
» id string true the blueprint ID of this blueprint - note that this is not an ObjectId.
» isCustomModelBlueprint boolean true Whether blueprint contains custom task.
» modelType string true the model this blueprint will produce.
» monotonicDecreasingFeaturelistId string¦null true the ID of the featurelist that defines the set of features with a monotonically decreasing relationship to the target. If null, no such constraints are enforced.
» monotonicIncreasingFeaturelistId string¦null true null or str, the ID of the featurelist that defines the set of features with a monotonically increasing relationship to the target. If null, no such constraints are enforced.
» processes [string] true a list of strings representing processes the blueprint uses.
» projectId string true the project the blueprint belongs to.
» recommendedFeaturelistId string¦null false The ID of the feature list recommended for this blueprint. If this field is not present, then there is no recommended feature list.
» supportsComposableMl boolean true indicates whether this blueprint is supported in Composable ML.
» supportsIncrementalLearning boolean true Whether blueprint supports incremental learning.
» supportsMonotonicConstraints boolean true whether this model supports enforcing monotonic constraints.

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

BearerAuth

GET /api/v2/projects/{projectId}/blueprints/{blueprintId}/

Retrieve a blueprint by its ID.

Code samples

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

Parameters

Name In Type Required Description
projectId path string true The project ID.
blueprintId path string true The blueprint ID.

Example responses

200 Response

{
  "blueprintCategory": "string",
  "id": "string",
  "isCustomModelBlueprint": true,
  "modelType": "string",
  "monotonicDecreasingFeaturelistId": "string",
  "monotonicIncreasingFeaturelistId": "string",
  "processes": [
    "string"
  ],
  "projectId": "string",
  "recommendedFeaturelistId": "string",
  "supportsComposableMl": true,
  "supportsIncrementalLearning": true,
  "supportsMonotonicConstraints": true
}

Responses

Status Meaning Description Schema
200 OK A blueprint based on its blueprint ID. BlueprintResponse
404 Not Found This resource does not exist. None

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

BearerAuth

GET /api/v2/projects/{projectId}/blueprints/{blueprintId}/blueprintChart/

Retrieve a blueprint chart by blueprint id.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/blueprints/{blueprintId}/blueprintChart/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
projectId path string true The project ID.
blueprintId path string true The blueprint ID.

Example responses

200 Response

{
  "edges": [
    [
      "string",
      "string"
    ]
  ],
  "nodes": [
    {
      "id": "string",
      "label": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK A blueprint chart based on the blueprint id. BlueprintChartRetrieveResponse
404 Not Found No blueprint data found. None

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

BearerAuth

GET /api/v2/projects/{projectId}/blueprints/{blueprintId}/blueprintDocs/

Retrieve blueprint tasks documentation.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/blueprints/{blueprintId}/blueprintDocs/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
projectId path string true The project ID.
blueprintId path string true The blueprint ID.

Example responses

200 Response

[
  {
    "description": "string",
    "links": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "parameters": [
      {
        "description": "string",
        "name": "string",
        "type": "string"
      }
    ],
    "references": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "task": "string",
    "title": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK The task documentation for a blueprint. Inline
404 Not Found Model document missing. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [BlueprintListDocumentsResponse] false none
» description string true The task description.
» links [BlueprintDocLinks] true A list of external documentation links.
»» name string true The name of the documentation at the link.
»» url string¦null true The URL at which external documentation can be found.
» parameters [BlueprintDocParameters] true An array of task parameters.
»» description string true A description of what the parameter does.
»» name string true The name of the parameter.
»» type string true The type (and default value) of the parameter.
» references [BlueprintDocReferences] true A list of reference links.
»» name string true The name of the reference.
»» url string¦null true The URL at which the reference can be found.
» task string true The task described in document.
» title string true The document title.

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

BearerAuth

GET /api/v2/projects/{projectId}/blueprints/{blueprintId}/json/

Retrieve a blueprint json by its ID.

Code samples

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

Parameters

Name In Type Required Description
projectId path string true The project ID.
blueprintId path string true The blueprint ID.

Example responses

200 Response

{
  "blueprint": "\n                {\n                    \"1\": [[\"NUM\"], [\"PNI2\"], \"T\"],\n                    \"2\": [[\"1\"], [\"LASSO2\"], \"P\"],\n                }\n            "
}

Responses

Status Meaning Description Schema
200 OK Blueprint json based on its blueprint ID. BlueprintJsonResponse
404 Not Found This resource does not exist. None

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

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/blueprintChart/

Retrieve a reduced model blueprint chart by model id. The model blueprint charts are reduced from the full blueprint charts to show only those sections of the blueprint that were actually used in the model, given the selected featurelist.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/models/{modelId}/blueprintChart/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "edges": [
    [
      "string",
      "string"
    ]
  ],
  "nodes": [
    {
      "id": "string",
      "label": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK A reduced model blueprint chart based on the model id. BlueprintChartRetrieveResponse
404 Not Found No model found for given projectId and modelId. None

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

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/blueprintDocs/

Retrieve task documentation for a reduced model blueprint. The model blueprint is reduced from the full blueprint to show only those sections of the blueprint that were actually used in the model, given the selected featurelist.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/models/{modelId}/blueprintDocs/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

[
  {
    "description": "string",
    "links": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "parameters": [
      {
        "description": "string",
        "name": "string",
        "type": "string"
      }
    ],
    "references": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "task": "string",
    "title": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK The task documentation for a reduced model blueprint. Inline
404 Not Found No model found for given projectId and modelId. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [BlueprintListDocumentsResponse] false none
» description string true The task description.
» links [BlueprintDocLinks] true A list of external documentation links.
»» name string true The name of the documentation at the link.
»» url string¦null true The URL at which external documentation can be found.
» parameters [BlueprintDocParameters] true An array of task parameters.
»» description string true A description of what the parameter does.
»» name string true The name of the parameter.
»» type string true The type (and default value) of the parameter.
» references [BlueprintDocReferences] true A list of reference links.
»» name string true The name of the reference.
»» url string¦null true The URL at which the reference can be found.
» task string true The task described in document.
» title string true The document title.

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

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/logs/

Retrieve an archive (tar.gz) of the logs produced and persisted by a model. Note that only blueprints with custom tasks create persistent logs - this will not work with any other type of model.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/models/{modelId}/logs/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "data": "string"
}

Responses

Status Meaning Description Schema
200 OK An archive (tar.gz) of the logs produced and persisted by a model. PersistentLogsForModelWithCustomTasksRetrieveResponse
403 Forbidden User does not have permissions to fetch model logs. None
404 Not Found Logs for this model could not be found. None

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

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/trainingArtifact/

Retrieve an archive (tar.gz) of the artifacts produced and persisted by a model. Note that only blueprints with custom tasks create these artifacts - this will not work with any other type of model.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/models/{modelId}/trainingArtifact/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "data": "string"
}

Responses

Status Meaning Description Schema
200 OK An archive (tar.gz) of the artifacts produced by this model. ArtifactsForModelWithCustomTasksRetrieveResponse
403 Forbidden User does not have permissions to fetch this artifact. None
404 Not Found The model with this modelID does not have any artifacts. None

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

BearerAuth

DELETE /api/v2/userBlueprints/

Delete user blueprints, specified by userBlueprintIds.

Code samples

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

Body parameter

{
  "userBlueprintIds": "string"
}

Parameters

Name In Type Required Description
body body UserBlueprintsBulkDelete false none

Example responses

200 Response

{
  "failedToDelete": [
    "string"
  ],
  "successfullyDeleted": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK A list of user blueprints successfully and unsuccessfully deleted. UserBlueprintsBulkDeleteResponse
401 Unauthorized User is not authorized. None
403 Forbidden User does not have access to this functionality. None
422 Unprocessable Entity Unprocessable Entity None

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

BearerAuth

GET /api/v2/userBlueprints/

Fetch a list of the user blueprints the current user has access to

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/userBlueprints/?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 results to skip (for pagination).
limit query integer true The max number of results to return.
projectId query string false The id of the project, used to filter for original project_id.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "blender": false,
      "blueprintId": "string",
      "customTaskVersionMetadata": [
        [
          "string",
          "string"
        ]
      ],
      "decompressedFormat": false,
      "diagram": "string",
      "features": [
        "string"
      ],
      "featuresText": "string",
      "hexColumnNameLookup": [
        {
          "colname": "string",
          "hex": "string",
          "projectId": "string"
        }
      ],
      "hiddenFromCatalog": true,
      "icons": [
        0
      ],
      "insights": "string",
      "isTimeSeries": false,
      "linkedToProjectId": true,
      "modelType": "string",
      "projectId": "string",
      "referenceModel": false,
      "shapSupport": false,
      "supportedTargetTypes": [
        "binary"
      ],
      "supportsGpu": false,
      "supportsNewSeries": true,
      "userBlueprintId": "string",
      "userId": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Fetched the list of the accessible user blueprints successfully UserBlueprintsListResponse
401 Unauthorized User is not authorized. None
403 Forbidden User does not have access to this functionality. None

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

BearerAuth

POST /api/v2/userBlueprints/

Create a user blueprint

Code samples

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

Body parameter

{
  "blueprint": [
    {
      "taskData": {
        "inputs": [
          "string"
        ],
        "outputMethod": "string",
        "outputMethodParameters": [],
        "taskCode": "string",
        "taskParameters": [],
        "xTransformations": [],
        "yTransformations": []
      },
      "taskId": "string"
    }
  ],
  "decompressedBlueprint": false,
  "description": "string",
  "getDynamicLabels": false,
  "isInplaceEditor": false,
  "modelType": "string",
  "projectId": "string",
  "saveToCatalog": true
}

Parameters

Name In Type Required Description
body body UserBlueprintCreate false none

Example responses

200 Response

{
  "blender": false,
  "blueprint": [
    {
      "taskData": {
        "inputs": [
          "string"
        ],
        "outputMethod": "string",
        "outputMethodParameters": [],
        "taskCode": "string",
        "taskParameters": [],
        "xTransformations": [],
        "yTransformations": []
      },
      "taskId": "string"
    }
  ],
  "blueprintId": "string",
  "bpData": {
    "children": [
      {}
    ],
    "id": "string",
    "inputs": [
      "string"
    ],
    "output": "string",
    "taskMap": {},
    "taskParameters": "string",
    "tasks": [
      "string"
    ],
    "type": "string"
  },
  "customTaskVersionMetadata": [
    [
      "string",
      "string"
    ]
  ],
  "decompressedFormat": false,
  "diagram": "string",
  "features": [
    "string"
  ],
  "featuresText": "string",
  "hexColumnNameLookup": [
    {
      "colname": "string",
      "hex": "string",
      "projectId": "string"
    }
  ],
  "hiddenFromCatalog": true,
  "icons": [
    0
  ],
  "insights": "string",
  "isTimeSeries": false,
  "linkedToProjectId": true,
  "modelType": "string",
  "projectId": "string",
  "referenceModel": false,
  "shapSupport": false,
  "supportedTargetTypes": [
    "binary"
  ],
  "supportsGpu": false,
  "supportsNewSeries": true,
  "userBlueprintId": "string",
  "userId": "string",
  "vertexContext": [
    {
      "information": {
        "inputs": [
          "string"
        ],
        "outputs": [
          "string"
        ]
      },
      "messages": {
        "errors": [
          "string"
        ],
        "warnings": [
          "string"
        ]
      },
      "taskId": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Created the user blueprint successfully UserBlueprintsDetailedItem
401 Unauthorized User is not authorized. None
403 Forbidden User does not have access to this functionality. None
404 Not Found Project not found. None
422 Unprocessable Entity Unprocessable Entity None

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

BearerAuth

POST /api/v2/userBlueprints/fromBlueprintId/

Clone a blueprint from a project.

Code samples

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

Body parameter

{
  "blueprintId": "string",
  "decompressedBlueprint": false,
  "description": "string",
  "getDynamicLabels": false,
  "isInplaceEditor": false,
  "modelType": "string",
  "projectId": "string",
  "saveToCatalog": true
}

Parameters

Name In Type Required Description
body body UserBlueprintCreateFromBlueprintId false none

Example responses

200 Response

{
  "blender": false,
  "blueprint": [
    {
      "taskData": {
        "inputs": [
          "string"
        ],
        "outputMethod": "string",
        "outputMethodParameters": [],
        "taskCode": "string",
        "taskParameters": [],
        "xTransformations": [],
        "yTransformations": []
      },
      "taskId": "string"
    }
  ],
  "blueprintId": "string",
  "bpData": {
    "children": [
      {}
    ],
    "id": "string",
    "inputs": [
      "string"
    ],
    "output": "string",
    "taskMap": {},
    "taskParameters": "string",
    "tasks": [
      "string"
    ],
    "type": "string"
  },
  "customTaskVersionMetadata": [
    [
      "string",
      "string"
    ]
  ],
  "decompressedFormat": false,
  "diagram": "string",
  "features": [
    "string"
  ],
  "featuresText": "string",
  "hexColumnNameLookup": [
    {
      "colname": "string",
      "hex": "string",
      "projectId": "string"
    }
  ],
  "hiddenFromCatalog": true,
  "icons": [
    0
  ],
  "insights": "string",
  "isTimeSeries": false,
  "linkedToProjectId": true,
  "modelType": "string",
  "projectId": "string",
  "referenceModel": false,
  "shapSupport": false,
  "supportedTargetTypes": [
    "binary"
  ],
  "supportsGpu": false,
  "supportsNewSeries": true,
  "userBlueprintId": "string",
  "userId": "string",
  "vertexContext": [
    {
      "information": {
        "inputs": [
          "string"
        ],
        "outputs": [
          "string"
        ]
      },
      "messages": {
        "errors": [
          "string"
        ],
        "warnings": [
          "string"
        ]
      },
      "taskId": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Created the user blueprint successfully UserBlueprintsDetailedItem
401 Unauthorized User is not authorized. None
403 Forbidden User does not have access to this functionality. None
404 Not Found Project or blueprint not found. None
422 Unprocessable Entity Unprocessable Entity None

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

BearerAuth

POST /api/v2/userBlueprints/fromCustomTaskVersionId/

Create a user blueprint from a single custom task.

Code samples

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

Body parameter

{
  "customTaskVersionId": "string",
  "decompressedBlueprint": false,
  "description": "string",
  "saveToCatalog": true
}

Parameters

Name In Type Required Description
body body UserBlueprintCreateFromCustomTaskVersionIdPayload false none

Example responses

200 Response

{
  "blender": false,
  "blueprint": [
    {
      "taskData": {
        "inputs": [
          "string"
        ],
        "outputMethod": "string",
        "outputMethodParameters": [],
        "taskCode": "string",
        "taskParameters": [],
        "xTransformations": [],
        "yTransformations": []
      },
      "taskId": "string"
    }
  ],
  "blueprintId": "string",
  "bpData": {
    "children": [
      {}
    ],
    "id": "string",
    "inputs": [
      "string"
    ],
    "output": "string",
    "taskMap": {},
    "taskParameters": "string",
    "tasks": [
      "string"
    ],
    "type": "string"
  },
  "customTaskVersionMetadata": [
    [
      "string",
      "string"
    ]
  ],
  "decompressedFormat": false,
  "diagram": "string",
  "features": [
    "string"
  ],
  "featuresText": "string",
  "hexColumnNameLookup": [
    {
      "colname": "string",
      "hex": "string",
      "projectId": "string"
    }
  ],
  "hiddenFromCatalog": true,
  "icons": [
    0
  ],
  "insights": "string",
  "isTimeSeries": false,
  "linkedToProjectId": true,
  "modelType": "string",
  "projectId": "string",
  "referenceModel": false,
  "shapSupport": false,
  "supportedTargetTypes": [
    "binary"
  ],
  "supportsGpu": false,
  "supportsNewSeries": true,
  "userBlueprintId": "string",
  "userId": "string",
  "vertexContext": [
    {
      "information": {
        "inputs": [
          "string"
        ],
        "outputs": [
          "string"
        ]
      },
      "messages": {
        "errors": [
          "string"
        ],
        "warnings": [
          "string"
        ]
      },
      "taskId": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Created the user blueprint successfully UserBlueprintsDetailedItem
401 Unauthorized User is not authorized. None
403 Forbidden User does not have access to this functionality. None
404 Not Found Custom task version or custom task not found. None
422 Unprocessable Entity Unprocessable Entity None

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

BearerAuth

POST /api/v2/userBlueprints/fromUserBlueprintId/

Clone a user blueprint.

Code samples

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

Body parameter

{
  "decompressedBlueprint": false,
  "description": "string",
  "getDynamicLabels": false,
  "isInplaceEditor": false,
  "modelType": "string",
  "projectId": "string",
  "saveToCatalog": true,
  "userBlueprintId": "string"
}

Parameters

Name In Type Required Description
body body UserBlueprintCreateFromUserBlueprintId false none

Example responses

200 Response

{
  "blender": false,
  "blueprint": [
    {
      "taskData": {
        "inputs": [
          "string"
        ],
        "outputMethod": "string",
        "outputMethodParameters": [],
        "taskCode": "string",
        "taskParameters": [],
        "xTransformations": [],
        "yTransformations": []
      },
      "taskId": "string"
    }
  ],
  "blueprintId": "string",
  "bpData": {
    "children": [
      {}
    ],
    "id": "string",
    "inputs": [
      "string"
    ],
    "output": "string",
    "taskMap": {},
    "taskParameters": "string",
    "tasks": [
      "string"
    ],
    "type": "string"
  },
  "customTaskVersionMetadata": [
    [
      "string",
      "string"
    ]
  ],
  "decompressedFormat": false,
  "diagram": "string",
  "features": [
    "string"
  ],
  "featuresText": "string",
  "hexColumnNameLookup": [
    {
      "colname": "string",
      "hex": "string",
      "projectId": "string"
    }
  ],
  "hiddenFromCatalog": true,
  "icons": [
    0
  ],
  "insights": "string",
  "isTimeSeries": false,
  "linkedToProjectId": true,
  "modelType": "string",
  "projectId": "string",
  "referenceModel": false,
  "shapSupport": false,
  "supportedTargetTypes": [
    "binary"
  ],
  "supportsGpu": false,
  "supportsNewSeries": true,
  "userBlueprintId": "string",
  "userId": "string",
  "vertexContext": [
    {
      "information": {
        "inputs": [
          "string"
        ],
        "outputs": [
          "string"
        ]
      },
      "messages": {
        "errors": [
          "string"
        ],
        "warnings": [
          "string"
        ]
      },
      "taskId": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Created the user blueprint successfully UserBlueprintsDetailedItem
401 Unauthorized User is not authorized. None
403 Forbidden User does not have access to this functionality. None
404 Not Found User blueprint or project not found. None
422 Unprocessable Entity Unprocessable Entity None

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

BearerAuth

DELETE /api/v2/userBlueprints/{userBlueprintId}/

Delete a user blueprint, specified by the userBlueprintId.

Code samples

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

Parameters

Name In Type Required Description
userBlueprintId path string true Used to identify a specific user-owned blueprint.

Responses

Status Meaning Description Schema
204 No Content Successfully deleted the specified blueprint, if it existed. None

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

BearerAuth

GET /api/v2/userBlueprints/{userBlueprintId}/

Retrieve a user blueprint

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/userBlueprints/{userBlueprintId}/?editMode=false&decompressedBlueprint=false&isInplaceEditor=false \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
editMode query boolean true Whether to retrieve the extra blueprint metadata for editing.
decompressedBlueprint query boolean true Whether to retrieve the blueprint in the decompressed format.
projectId query string false String representation of ObjectId for the currently active project. The user blueprint is retrieved when this project is active.
isInplaceEditor query boolean true Whether the request is sent from the in place user BP editor.
getDynamicLabels query boolean false Whether to add dynamic labels to a decompressed blueprint.
userBlueprintId path string true Used to identify a specific user-owned blueprint.

Example responses

200 Response

{
  "blender": false,
  "blueprint": [
    {
      "taskData": {
        "inputs": [
          "string"
        ],
        "outputMethod": "string",
        "outputMethodParameters": [],
        "taskCode": "string",
        "taskParameters": [],
        "xTransformations": [],
        "yTransformations": []
      },
      "taskId": "string"
    }
  ],
  "blueprintId": "string",
  "bpData": {
    "children": [
      {}
    ],
    "id": "string",
    "inputs": [
      "string"
    ],
    "output": "string",
    "taskMap": {},
    "taskParameters": "string",
    "tasks": [
      "string"
    ],
    "type": "string"
  },
  "customTaskVersionMetadata": [
    [
      "string",
      "string"
    ]
  ],
  "decompressedFormat": false,
  "diagram": "string",
  "features": [
    "string"
  ],
  "featuresText": "string",
  "hexColumnNameLookup": [
    {
      "colname": "string",
      "hex": "string",
      "projectId": "string"
    }
  ],
  "hiddenFromCatalog": true,
  "icons": [
    0
  ],
  "insights": "string",
  "isTimeSeries": false,
  "linkedToProjectId": true,
  "modelType": "string",
  "projectId": "string",
  "referenceModel": false,
  "shapSupport": false,
  "supportedTargetTypes": [
    "binary"
  ],
  "supportsGpu": false,
  "supportsNewSeries": true,
  "userBlueprintId": "string",
  "userId": "string",
  "vertexContext": [
    {
      "information": {
        "inputs": [
          "string"
        ],
        "outputs": [
          "string"
        ]
      },
      "messages": {
        "errors": [
          "string"
        ],
        "warnings": [
          "string"
        ]
      },
      "taskId": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Retrieved the user blueprint successfully UserBlueprintsRetrieveResponse
401 Unauthorized User is not authorized. None
403 Forbidden User does not have access to this functionality. None
404 Not Found Referenced project or user blueprint not found. None

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

BearerAuth

PATCH /api/v2/userBlueprints/{userBlueprintId}/

Update a user blueprint

Code samples

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

Body parameter

{
  "blueprint": [
    {
      "taskData": {
        "inputs": [
          "string"
        ],
        "outputMethod": "string",
        "outputMethodParameters": [],
        "taskCode": "string",
        "taskParameters": [],
        "xTransformations": [],
        "yTransformations": []
      },
      "taskId": "string"
    }
  ],
  "decompressedBlueprint": false,
  "description": "string",
  "getDynamicLabels": false,
  "isInplaceEditor": false,
  "modelType": "string",
  "projectId": "string",
  "saveToCatalog": true
}

Parameters

Name In Type Required Description
userBlueprintId path string true Used to identify a specific user-owned blueprint.
body body UserBlueprintUpdate false none

Example responses

200 Response

{
  "blender": false,
  "blueprint": [
    {
      "taskData": {
        "inputs": [
          "string"
        ],
        "outputMethod": "string",
        "outputMethodParameters": [],
        "taskCode": "string",
        "taskParameters": [],
        "xTransformations": [],
        "yTransformations": []
      },
      "taskId": "string"
    }
  ],
  "blueprintId": "string",
  "bpData": {
    "children": [
      {}
    ],
    "id": "string",
    "inputs": [
      "string"
    ],
    "output": "string",
    "taskMap": {},
    "taskParameters": "string",
    "tasks": [
      "string"
    ],
    "type": "string"
  },
  "customTaskVersionMetadata": [
    [
      "string",
      "string"
    ]
  ],
  "decompressedFormat": false,
  "diagram": "string",
  "features": [
    "string"
  ],
  "featuresText": "string",
  "hexColumnNameLookup": [
    {
      "colname": "string",
      "hex": "string",
      "projectId": "string"
    }
  ],
  "hiddenFromCatalog": true,
  "icons": [
    0
  ],
  "insights": "string",
  "isTimeSeries": false,
  "linkedToProjectId": true,
  "modelType": "string",
  "projectId": "string",
  "referenceModel": false,
  "shapSupport": false,
  "supportedTargetTypes": [
    "binary"
  ],
  "supportsGpu": false,
  "supportsNewSeries": true,
  "userBlueprintId": "string",
  "userId": "string",
  "vertexContext": [
    {
      "information": {
        "inputs": [
          "string"
        ],
        "outputs": [
          "string"
        ]
      },
      "messages": {
        "errors": [
          "string"
        ],
        "warnings": [
          "string"
        ]
      },
      "taskId": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Updated the user blueprint successfully UserBlueprintsDetailedItem
401 Unauthorized User is not authorized. None
403 Forbidden User does not have access to this functionality. None
404 Not Found User blueprint not found. None
422 Unprocessable Entity Unprocessable Entity None

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

BearerAuth

GET /api/v2/userBlueprints/{userBlueprintId}/sharedRoles/

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

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/userBlueprints/{userBlueprintId}/sharedRoles/?offset=0&limit=10 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
id query string false Only return roles for a user, group or organization with this identifier.
offset query integer true This many results will be skipped
limit query integer true At most this many results are returned
name query string false Only return roles for a user, group or organization with this name.
shareRecipientType query string false List access controls for recipients with this type.
userBlueprintId path string true Used to identify a specific user-owned blueprint.

Enumerated Values

Parameter Value
shareRecipientType [user, group, organization]

Example responses

200 Response

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

Responses

Status Meaning Description Schema
200 OK Successfully retrieved roles. UserBlueprintSharedRolesListResponse

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

BearerAuth

PATCH /api/v2/userBlueprints/{userBlueprintId}/sharedRoles/

Share a user blueprint with a user, group, or organization

Code samples

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

Body parameter

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

Parameters

Name In Type Required Description
userBlueprintId path string true Used to identify a specific user-owned blueprint.
body body SharedRolesUpdate false none

Responses

Status Meaning Description Schema
204 No Content Roles updated successfully None
400 Bad Request Bad Request None
403 Forbidden User can view entity but does not have permission to grant these roles on the entity. None
404 Not Found Either the entity does not exist or the user does not have permissions to view the entity. None
409 Conflict The request would leave the entity without an owner. 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

POST /api/v2/userBlueprintsBulkValidations/

Validate many user blueprints, optionally using a specific project. Any non-existent or inaccessible user blueprints will be ignored.

Code samples

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

Body parameter

{
  "projectId": "string",
  "userBlueprintIds": [
    "string"
  ]
}

Parameters

Name In Type Required Description
body body UserBlueprintBulkValidationRequest false none

Example responses

201 Response

{
  "data": [
    {
      "userBlueprintId": "string",
      "vertexContext": [
        {
          "information": {
            "inputs": [
              "string"
            ],
            "outputs": [
              "string"
            ]
          },
          "messages": {
            "errors": [
              "string"
            ],
            "warnings": [
              "string"
            ]
          },
          "taskId": "string"
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
201 Created Validated many user blueprints successfully UserBlueprintsBulkValidationResponse
401 Unauthorized User is not authorized. None
403 Forbidden User does not have access to this functionality. None
404 Not Found Referenced project was not found. None
422 Unprocessable Entity Unprocessable Entity None

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

BearerAuth

GET /api/v2/userBlueprintsInputTypes/

Retrieve the input types which can be used with User Blueprints.

Code samples

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

Example responses

200 Response

{
  "inputTypes": [
    {
      "name": "string",
      "type": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successfully retrieved the input types. UserBlueprintsInputTypesResponse
401 Unauthorized User is not authorized. None
403 Forbidden User does not have access to this functionality. None

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

BearerAuth

POST /api/v2/userBlueprintsProjectBlueprints/

Add a list of user blueprints, by id, to a specified (by id) project's repository.

Code samples

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

Body parameter

{
  "deleteAfter": false,
  "describeFailures": false,
  "projectId": "string",
  "userBlueprintIds": [
    "string"
  ]
}

Parameters

Name In Type Required Description
body body UserBlueprintAddToMenu false none

Example responses

200 Response

{
  "addedToMenu": [
    {
      "blueprintId": "string",
      "userBlueprintId": "string"
    }
  ],
  "message": "string",
  "notAddedToMenu": [
    {
      "error": "string",
      "userBlueprintId": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successfully added the user blueprints to the project's repository. UserBlueprintAddToMenuResponse
401 Unauthorized User is not authorized. None
403 Forbidden User does not have access to this functionality. None
404 Not Found Referenced project not found. None
422 Unprocessable Entity Unprocessable Entity None

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

BearerAuth

POST /api/v2/userBlueprintsTaskParameters/

Validate that each value assigned to specified task parameters are valid.

Code samples

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

Body parameter

{
  "outputMethod": "P",
  "projectId": "string",
  "taskCode": "string",
  "taskParameters": [
    {
      "newValue": "string",
      "paramName": "string"
    }
  ]
}

Parameters

Name In Type Required Description
body body UserBlueprintTaskParameterValidation false none

Example responses

200 Response

{
  "errors": [
    {
      "message": "string",
      "paramName": "string",
      "value": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Accepted validation parameters for a task in the context of User Blueprints. UserBlueprintsValidateTaskParametersResponse
401 Unauthorized User is not authorized. None
403 Forbidden User does not have access to this functionality. None
404 Not Found Custom task version not found None
422 Unprocessable Entity Unprocessable Entity None

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

BearerAuth

GET /api/v2/userBlueprintsTasks/

Retrieve the available tasks, organized into categories, which can be used to create or modify User Blueprints.

Code samples

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

Parameters

Name In Type Required Description
projectId query string false The project id to use for task retrieval
blueprintId query string false The blueprint id to use for task retrieval
userBlueprintId query string false The user blueprint id to use for task retrieval

Example responses

200 Response

{
  "categories": [
    {
      "name": "string",
      "subcategories": [
        {}
      ],
      "taskCodes": [
        "string"
      ]
    }
  ],
  "tasks": [
    {
      "taskCode": "string",
      "taskDefinition": {
        "arguments": [
          {
            "argument": {
              "default": "string",
              "name": "string",
              "recommended": "string",
              "tunable": true,
              "type": "string",
              "values": "string"
            },
            "key": "string"
          }
        ],
        "categories": [
          "string"
        ],
        "colnamesAndTypes": [
          {
            "colname": "string",
            "hex": "string",
            "type": "string"
          }
        ],
        "customTaskId": "string",
        "customTaskVersions": [
          {
            "id": "string",
            "label": "string",
            "versionMajor": 0,
            "versionMinor": 0
          }
        ],
        "description": "string",
        "icon": 0,
        "isCommonTask": false,
        "isCustomTask": true,
        "isVisibleInComposableMl": true,
        "label": "string",
        "outputMethods": [
          "string"
        ],
        "supportsScoringCode": true,
        "taskCode": "string",
        "timeSeriesOnly": true,
        "url": {},
        "validInputs": [
          "string"
        ]
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successfully retrieved the tasks. UserBlueprintTasksResponse
401 Unauthorized User is not authorized. None
403 Forbidden User does not have access to this functionality. None
404 Not Found Referenced project or user blueprint not found. None

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

BearerAuth

POST /api/v2/userBlueprintsValidations/

Validate a user blueprint

Code samples

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

Body parameter

{
  "blueprint": [
    {
      "taskData": {
        "inputs": [
          "string"
        ],
        "outputMethod": "string",
        "outputMethodParameters": [],
        "taskCode": "string",
        "taskParameters": [],
        "xTransformations": [],
        "yTransformations": []
      },
      "taskId": "string"
    }
  ],
  "isInplaceEditor": false,
  "projectId": "string"
}

Parameters

Name In Type Required Description
body body UserBlueprintValidation false none

Example responses

201 Response

{
  "vertexContext": [
    {
      "information": {
        "inputs": [
          "string"
        ],
        "outputs": [
          "string"
        ]
      },
      "messages": {
        "errors": [
          "string"
        ],
        "warnings": [
          "string"
        ]
      },
      "taskId": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
201 Created Validated the user blueprint successfully UserBlueprintsValidationResponse
401 Unauthorized User is not authorized. None
403 Forbidden User does not have access to this functionality. None
404 Not Found Referenced project not found. None
422 Unprocessable Entity Unprocessable Entity None

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

BearerAuth

Schemas

AllowExtra

{}

Parameters submitted by the user to the failed job

Properties

None

ArtifactsForModelWithCustomTasksRetrieveResponse

{
  "data": "string"
}

Properties

Name Type Required Restrictions Description
data string(binary) true An archive (tar.gz) of the artifacts produced and persisted by a model.

BlueprintChartRetrieveResponse

{
  "edges": [
    [
      "string",
      "string"
    ]
  ],
  "nodes": [
    {
      "id": "string",
      "label": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
edges [array] true An array of chart edges - tuples of (start_id, end_id).
nodes [NodeDescription] true An array of node descriptions.

{
  "name": "string",
  "url": "string"
}

Properties

Name Type Required Restrictions Description
name string true The name of the documentation at the link.
url string¦null true The URL at which external documentation can be found.

BlueprintDocParameters

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

Properties

Name Type Required Restrictions Description
description string true A description of what the parameter does.
name string true The name of the parameter.
type string true The type (and default value) of the parameter.

BlueprintDocReferences

{
  "name": "string",
  "url": "string"
}

Properties

Name Type Required Restrictions Description
name string true The name of the reference.
url string¦null true The URL at which the reference can be found.

BlueprintJsonResponse

{
  "blueprint": "\n                {\n                    \"1\": [[\"NUM\"], [\"PNI2\"], \"T\"],\n                    \"2\": [[\"1\"], [\"LASSO2\"], \"P\"],\n                }\n            "
}

Properties

Name Type Required Restrictions Description
blueprint object true JSON blueprint representation of the model.

BlueprintListDocumentsResponse

{
  "description": "string",
  "links": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "parameters": [
    {
      "description": "string",
      "name": "string",
      "type": "string"
    }
  ],
  "references": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "task": "string",
  "title": "string"
}

Properties

Name Type Required Restrictions Description
description string true The task description.
links [BlueprintDocLinks] true A list of external documentation links.
parameters [BlueprintDocParameters] true An array of task parameters.
references [BlueprintDocReferences] true A list of reference links.
task string true The task described in document.
title string true The document title.

BlueprintResponse

{
  "blueprintCategory": "string",
  "id": "string",
  "isCustomModelBlueprint": true,
  "modelType": "string",
  "monotonicDecreasingFeaturelistId": "string",
  "monotonicIncreasingFeaturelistId": "string",
  "processes": [
    "string"
  ],
  "projectId": "string",
  "recommendedFeaturelistId": "string",
  "supportsComposableMl": true,
  "supportsIncrementalLearning": true,
  "supportsMonotonicConstraints": true
}

Properties

Name Type Required Restrictions Description
blueprintCategory string true describes the category of the blueprint and indicates the kind of model this blueprint produces. Will be either "DataRobot" or "Scaleout DataRobot".
id string true the blueprint ID of this blueprint - note that this is not an ObjectId.
isCustomModelBlueprint boolean true Whether blueprint contains custom task.
modelType string true the model this blueprint will produce.
monotonicDecreasingFeaturelistId string¦null true the ID of the featurelist that defines the set of features with a monotonically decreasing relationship to the target. If null, no such constraints are enforced.
monotonicIncreasingFeaturelistId string¦null true null or str, the ID of the featurelist that defines the set of features with a monotonically increasing relationship to the target. If null, no such constraints are enforced.
processes [string] true a list of strings representing processes the blueprint uses.
projectId string true the project the blueprint belongs to.
recommendedFeaturelistId string¦null false The ID of the feature list recommended for this blueprint. If this field is not present, then there is no recommended feature list.
supportsComposableMl boolean true indicates whether this blueprint is supported in Composable ML.
supportsIncrementalLearning boolean true Whether blueprint supports incremental learning.
supportsMonotonicConstraints boolean true whether this model supports enforcing monotonic constraints.

BpData

{
  "children": [
    {}
  ],
  "id": "string",
  "inputs": [
    "string"
  ],
  "output": "string",
  "taskMap": {},
  "taskParameters": "string",
  "tasks": [
    "string"
  ],
  "type": "string"
}

Properties

Name Type Required Restrictions Description
children [AllowExtra] false A nested dictionary representation of the blueprint DAG.
id string true The type of the node (e.g. "start", "input", "task").
inputs [string] false The inputs to the current node.
output any false Ids describing the destination of any outgoing edges.

oneOf

Name Type Required Restrictions Description
» anonymous string false Ids describing the destination of any outgoing edges.

xor

Name Type Required Restrictions Description
» anonymous [string] false none

continued

Name Type Required Restrictions Description
taskMap AllowExtra true Parameters submitted by the user to the failed job
taskParameters string true A stringified JSON object describing the parameters and their values for a task.
tasks [string] true The task defining the current node.
type string true A unique id to represent the current node.

ColnameAndType

{
  "colname": "string",
  "hex": "string",
  "type": "string"
}

Properties

Name Type Required Restrictions Description
colname string true The column name.
hex string true A safe hex representation of the column name.
type string true The data type of the column.

CustomTaskAccessControlListResponse

{
  "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 in current page.
data [CustomTaskAccessControlResponse] true List of the requested custom task access control entries.
next string(uri)¦null true URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page

CustomTaskAccessControlResponse

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

Properties

Name Type Required Restrictions Description
canShare boolean true Whether this user can share this custom task
role string true This users role.
userId string true This user's userId.
username string true The username for this user's entry.

CustomTaskCopy

{
  "customTaskId": "string"
}

Properties

Name Type Required Restrictions Description
customTaskId string true ID of the custom task to copy.

CustomTaskCreate

{
  "calibratePredictions": "True",
  "description": "string",
  "language": "string",
  "maximumMemory": 134217728,
  "name": "string",
  "targetType": "Binary"
}

Properties

Name Type Required Restrictions Description
calibratePredictions boolean false Whether model predictions should be calibrated by DataRobot.Only applies to anomaly detection; we recommend this if you have not already included calibration in your model code.Calibration improves the probability estimates of a model, and modifies the predictions of non-probabilistic models to be interpretable as probabilities. This will facilitate comparison to DataRobot models, and give access to ROC curve insights on external data.
description string false maxLength: 10000
The user-friendly description of the task.
language string false maxLength: 500
Programming language name in which task is written.
maximumMemory integer¦null false maximum: 15032385536
minimum: 134217728
DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.
name string true maxLength: 255
The user-friendly name for the task.
targetType string true The target type of the custom task

Enumerated Values

Property Value
targetType [Binary, Regression, Multiclass, Anomaly, Transform, TextGeneration, GeoPoint]

CustomTaskListResponse

{
  "count": 0,
  "data": [
    {
      "calibratePredictions": true,
      "created": "string",
      "createdBy": "string",
      "customModelType": "training",
      "description": "string",
      "id": "string",
      "language": "string",
      "latestVersion": {
        "baseEnvironmentId": "string",
        "baseEnvironmentVersionId": "string",
        "created": "string",
        "customModelId": "string",
        "customTaskId": "string",
        "dependencies": [
          {
            "constraints": [
              {
                "constraintType": "<",
                "version": "string"
              }
            ],
            "extras": "string",
            "line": "string",
            "lineNumber": 0,
            "packageName": "string"
          }
        ],
        "description": "string",
        "id": "string",
        "isFrozen": true,
        "items": [
          {
            "commitSha": "string",
            "created": "string",
            "fileName": "string",
            "filePath": "string",
            "fileSource": "string",
            "id": "string",
            "ref": "string",
            "repositoryFilePath": "string",
            "repositoryLocation": "string",
            "repositoryName": "string"
          }
        ],
        "label": "string",
        "maximumMemory": 134217728,
        "outboundNetworkPolicy": "ISOLATED",
        "requiredMetadata": {},
        "requiredMetadataValues": [
          {
            "fieldName": "string",
            "value": "string"
          }
        ],
        "versionMajor": 0,
        "versionMinor": 0,
        "warning": [
          "string"
        ]
      },
      "maximumMemory": 134217728,
      "name": "string",
      "targetType": "Binary",
      "updated": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

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

CustomTaskResponse

{
  "calibratePredictions": true,
  "created": "string",
  "createdBy": "string",
  "customModelType": "training",
  "description": "string",
  "id": "string",
  "language": "string",
  "latestVersion": {
    "baseEnvironmentId": "string",
    "baseEnvironmentVersionId": "string",
    "created": "string",
    "customModelId": "string",
    "customTaskId": "string",
    "dependencies": [
      {
        "constraints": [
          {
            "constraintType": "<",
            "version": "string"
          }
        ],
        "extras": "string",
        "line": "string",
        "lineNumber": 0,
        "packageName": "string"
      }
    ],
    "description": "string",
    "id": "string",
    "isFrozen": true,
    "items": [
      {
        "commitSha": "string",
        "created": "string",
        "fileName": "string",
        "filePath": "string",
        "fileSource": "string",
        "id": "string",
        "ref": "string",
        "repositoryFilePath": "string",
        "repositoryLocation": "string",
        "repositoryName": "string"
      }
    ],
    "label": "string",
    "maximumMemory": 134217728,
    "outboundNetworkPolicy": "ISOLATED",
    "requiredMetadata": {},
    "requiredMetadataValues": [
      {
        "fieldName": "string",
        "value": "string"
      }
    ],
    "versionMajor": 0,
    "versionMinor": 0,
    "warning": [
      "string"
    ]
  },
  "maximumMemory": 134217728,
  "name": "string",
  "targetType": "Binary",
  "updated": "string"
}

Properties

Name Type Required Restrictions Description
calibratePredictions boolean false Determines whether or not predictions should be calibrated by DataRobot. Only applies to anomaly detection.
created string true ISO-8601 timestamp of when the task was created.
createdBy string true The username of the custom task creator.
customModelType string true The type of custom task.
description string true The description of the task.
id string true The ID of the custom task.
language string true The programming language used by the task.
latestVersion CustomTaskVersionResponse true The latest version for the custom task (if this field is empty the task is not ready for use).
maximumMemory integer¦null false maximum: 15032385536
minimum: 134217728
DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.
name string true The name of the task.
targetType string true The target type of the custom task.
updated string true ISO-8601 timestamp of when task was last updated.

Enumerated Values

Property Value
customModelType [training, inference]
targetType [Binary, Regression, Multiclass, Anomaly, Transform, TextGeneration, GeoPoint]

CustomTaskUpdate

{
  "description": "string",
  "language": "string",
  "maximumMemory": 134217728,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
description string false maxLength: 10000
The user-friendly description of the task.
language string false maxLength: 500
Programming language name in which task is written.
maximumMemory integer¦null false maximum: 15032385536
minimum: 134217728
DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.
name string false maxLength: 255
The user-friendly name for the task.

CustomTaskVersionCreate

{
  "baseEnvironmentId": "string",
  "file": "string",
  "filePath": "string",
  "isMajorUpdate": "false",
  "maximumMemory": 134217728,
  "outboundNetworkPolicy": "ISOLATED",
  "requiredMetadata": "string",
  "requiredMetadataValues": "string"
}

Properties

Name Type Required Restrictions Description
baseEnvironmentId string true The base environment to use with this custom task version.
file string(binary) false A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding filePath supplied that shows the relative location of the file. For example, you have two files: /home/username/custom-task/main.py and /home/username/custom-task/helpers/helper.py. When uploading these files, you would also need to include two filePath fields of, "main.py" and "helpers/helper.py". If the supplied file already exists at the supplied filePath, the old file is replaced by the new file.
filePath any false The local path of the file being uploaded. See the file field explanation for more details.

oneOf

Name Type Required Restrictions Description
» anonymous string false none

xor

Name Type Required Restrictions Description
» anonymous [string] false maxItems: 1000
none

continued

Name Type Required Restrictions Description
isMajorUpdate string true If set to true, new major version will created, otherwise minor version will be created.
maximumMemory integer¦null false maximum: 15032385536
minimum: 134217728
DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.
outboundNetworkPolicy string false What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.
requiredMetadata string false Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you to change them, make a new version.
requiredMetadataValues string false Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.

Enumerated Values

Property Value
isMajorUpdate [false, False, true, True]
outboundNetworkPolicy [ISOLATED, PUBLIC]

CustomTaskVersionCreateFromLatest

{
  "baseEnvironmentId": "string",
  "file": "string",
  "filePath": "string",
  "filesToDelete": "string",
  "isMajorUpdate": "false",
  "maximumMemory": 134217728,
  "outboundNetworkPolicy": "ISOLATED",
  "requiredMetadata": "string",
  "requiredMetadataValues": "string"
}

Properties

Name Type Required Restrictions Description
baseEnvironmentId string true The base environment to use with this custom task version.
file string(binary) false A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding filePath supplied that shows the relative location of the file. For example, you have two files: /home/username/custom-task/main.py and /home/username/custom-task/helpers/helper.py. When uploading these files, you would also need to include two filePath fields of, "main.py" and "helpers/helper.py". If the supplied file already exists at the supplied filePath, the old file is replaced by the new file.
filePath any false The local path of the file being uploaded. See the file field explanation for more details.

oneOf

Name Type Required Restrictions Description
» anonymous string false none

xor

Name Type Required Restrictions Description
» anonymous [string] false maxItems: 1000
none

continued

Name Type Required Restrictions Description
filesToDelete any false The IDs of the files to be deleted.

oneOf

Name Type Required Restrictions Description
» anonymous string false none

xor

Name Type Required Restrictions Description
» anonymous [string] false none

continued

Name Type Required Restrictions Description
isMajorUpdate string true If set to true, new major version will created, otherwise minor version will be created.
maximumMemory integer¦null false maximum: 15032385536
minimum: 134217728
DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.
outboundNetworkPolicy string false What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.
requiredMetadata string false Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you to change them, make a new version.
requiredMetadataValues string false Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.

Enumerated Values

Property Value
isMajorUpdate [false, False, true, True]
outboundNetworkPolicy [ISOLATED, PUBLIC]

CustomTaskVersionCreateFromRepository

{
  "baseEnvironmentId": "string",
  "isMajorUpdate": true,
  "outboundNetworkPolicy": "ISOLATED",
  "ref": "string",
  "repositoryId": "string",
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ],
  "sourcePath": "string"
}

Properties

Name Type Required Restrictions Description
baseEnvironmentId string false The base environment to use with this version.
isMajorUpdate boolean false If set to true, new major version will created, otherwise minor version will be created.
outboundNetworkPolicy string false What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.
ref string false Remote reference (branch, commit, etc). Latest, if not specified.
repositoryId string true The ID of remote repository used to pull sources. This ID can be found using the /api/v2/remoteRepositories/ endpoint.
requiredMetadata object false Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you to change them, make a new version.
requiredMetadataValues [RequiredMetadataValue] false Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.
sourcePath any false A remote repository file path to be pulled into a custom model or custom task.

oneOf

Name Type Required Restrictions Description
» anonymous string false none

xor

Name Type Required Restrictions Description
» anonymous [string] false none

Enumerated Values

Property Value
outboundNetworkPolicy [ISOLATED, PUBLIC]

CustomTaskVersionDependencyBuildMetadataResponse

{
  "buildEnd": "string",
  "buildLogLocation": "http://example.com",
  "buildStart": "string",
  "buildStatus": "submitted",
  "customTaskId": "string",
  "customTaskVersionId": "string"
}

Properties

Name Type Required Restrictions Description
buildEnd string¦null true The ISO-8601 encoded time when this build completed.
buildLogLocation string(uri)¦null true The URL to download the build logs from this build.
buildStart string true The ISO-8601 encoded time when this build started.
buildStatus string true The current status of the dependency build.
customTaskId string true The ID of custom task.
customTaskVersionId string true The ID of custom task version.

Enumerated Values

Property Value
buildStatus [submitted, processing, failed, success]

CustomTaskVersionListResponse

{
  "count": 0,
  "data": [
    {
      "baseEnvironmentId": "string",
      "baseEnvironmentVersionId": "string",
      "created": "string",
      "customModelId": "string",
      "customTaskId": "string",
      "dependencies": [
        {
          "constraints": [
            {
              "constraintType": "<",
              "version": "string"
            }
          ],
          "extras": "string",
          "line": "string",
          "lineNumber": 0,
          "packageName": "string"
        }
      ],
      "description": "string",
      "id": "string",
      "isFrozen": true,
      "items": [
        {
          "commitSha": "string",
          "created": "string",
          "fileName": "string",
          "filePath": "string",
          "fileSource": "string",
          "id": "string",
          "ref": "string",
          "repositoryFilePath": "string",
          "repositoryLocation": "string",
          "repositoryName": "string"
        }
      ],
      "label": "string",
      "maximumMemory": 134217728,
      "outboundNetworkPolicy": "ISOLATED",
      "requiredMetadata": {},
      "requiredMetadataValues": [
        {
          "fieldName": "string",
          "value": "string"
        }
      ],
      "versionMajor": 0,
      "versionMinor": 0,
      "warning": [
        "string"
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

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

CustomTaskVersionMetadataUpdate

{
  "description": "string",
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
description string false maxLength: 10000
New description for the custom task or model.
requiredMetadata object false Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys.
requiredMetadataValues [RequiredMetadataValue] false Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.

CustomTaskVersionResponse

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "created": "string",
  "customModelId": "string",
  "customTaskId": "string",
  "dependencies": [
    {
      "constraints": [
        {
          "constraintType": "<",
          "version": "string"
        }
      ],
      "extras": "string",
      "line": "string",
      "lineNumber": 0,
      "packageName": "string"
    }
  ],
  "description": "string",
  "id": "string",
  "isFrozen": true,
  "items": [
    {
      "commitSha": "string",
      "created": "string",
      "fileName": "string",
      "filePath": "string",
      "fileSource": "string",
      "id": "string",
      "ref": "string",
      "repositoryFilePath": "string",
      "repositoryLocation": "string",
      "repositoryName": "string"
    }
  ],
  "label": "string",
  "maximumMemory": 134217728,
  "outboundNetworkPolicy": "ISOLATED",
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ],
  "versionMajor": 0,
  "versionMinor": 0,
  "warning": [
    "string"
  ]
}

The latest version for the custom task (if this field is empty the task is not ready for use).

Properties

Name Type Required Restrictions Description
baseEnvironmentId string¦null false The base environment to use with this task version.
baseEnvironmentVersionId string¦null false The base environment version to use with this task version.
created string true ISO-8601 timestamp of when the task was created.
customModelId string true an alias for customTaskId
customTaskId string true the ID of the custom task.
dependencies [DependencyResponse] false The parsed dependencies of the custom task version if the version has a valid requirements.txt file.
description string¦null true Description of a custom task version.
id string true the ID of the custom model version created.
isFrozen boolean true If the version is frozen and immutable (i.e. it is either deployed or has been edited, causing a newer version to be yielded).
items [WorkspaceItemResponse] true List of file items.
label string true A semantic version number of the major and minor version.
maximumMemory integer¦null false maximum: 15032385536
minimum: 134217728
DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.
outboundNetworkPolicy string true What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.
requiredMetadata object false Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you want to change them, make a new version.
requiredMetadataValues [RequiredMetadataValue] false Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.
versionMajor integer true The major version number, incremented on deployments or larger file changes.
versionMinor integer true The minor version number, incremented on general file changes.
warning [string] false Warnings about the custom task version

Enumerated Values

Property Value
outboundNetworkPolicy [ISOLATED, PUBLIC]

DependencyConstraint

{
  "constraintType": "<",
  "version": "string"
}

Properties

Name Type Required Restrictions Description
constraintType string true The constraint type to apply to the version.
version string true The version label to use in the constraint.

Enumerated Values

Property Value
constraintType [<, <=, ==, >=, >]

DependencyResponse

{
  "constraints": [
    {
      "constraintType": "<",
      "version": "string"
    }
  ],
  "extras": "string",
  "line": "string",
  "lineNumber": 0,
  "packageName": "string"
}

Properties

Name Type Required Restrictions Description
constraints [DependencyConstraint] true Constraints that should be applied to the dependency when installed.
extras string false The dependency's package extras.
line string true The original line from the requirements.txt file.
lineNumber integer true The line number the requirement was on in requirements.txt.
packageName string true The dependency's package name.

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]

NodeDescription

{
  "id": "string",
  "label": "string"
}

Properties

Name Type Required Restrictions Description
id string true The ID of the node.
label string true The label of the node.

ParamValuePair

{
  "param": "string",
  "value": "string"
}

Properties

Name Type Required Restrictions Description
param string true The name of a field associated with the value.
value any true Any value.

oneOf

Name Type Required Restrictions Description
» anonymous any false none

anyOf

Name Type Required Restrictions Description
»» anonymous string false none

or

Name Type Required Restrictions Description
»» anonymous integer false none

or

Name Type Required Restrictions Description
»» anonymous boolean false none

or

Name Type Required Restrictions Description
»» anonymous number false none

xor

Name Type Required Restrictions Description
» anonymous [anyOf] false none

anyOf

Name Type Required Restrictions Description
»» anonymous string false none

or

Name Type Required Restrictions Description
»» anonymous integer false none

or

Name Type Required Restrictions Description
»» anonymous boolean false none

or

Name Type Required Restrictions Description
»» anonymous number false none

PersistentLogsForModelWithCustomTasksRetrieveResponse

{
  "data": "string"
}

Properties

Name Type Required Restrictions Description
data string(binary) true An archive (tar.gz) of the logs produced and persisted by a model.

RequiredMetadataValue

{
  "fieldName": "string",
  "value": "string"
}

Properties

Name Type Required Restrictions Description
fieldName string true The required field name. This value will be added as an environment variable when running custom models.
value string true maxLength: 100
The value for the given field.

SharedRolesUpdate

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

Properties

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

oneOf

Name Type Required Restrictions Description
» anonymous GrantAccessControlWithUsername false none

xor

Name Type Required Restrictions Description
» anonymous GrantAccessControlWithId false none

Enumerated Values

Property Value
operation updateRoles

SharingUpdateOrRemoveWithGrant

{
  "data": [
    {
      "canShare": true,
      "role": "ADMIN",
      "username": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
data [UserRoleWithGrant] true maxItems: 100
List of sharing roles to update.

UserBlueprintAddToMenu

{
  "deleteAfter": false,
  "describeFailures": false,
  "projectId": "string",
  "userBlueprintIds": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
deleteAfter boolean true Whether to delete the user blueprint(s) after adding it (them) to the project menu.
describeFailures boolean true Whether to include extra fields to describe why any blueprints were not added to the chosen project.
projectId string true The projectId of the project for the repository to add the specified user blueprints to.
userBlueprintIds [string] true The ids of the user blueprints to add to the specified project's repository.

UserBlueprintAddToMenuResponse

{
  "addedToMenu": [
    {
      "blueprintId": "string",
      "userBlueprintId": "string"
    }
  ],
  "message": "string",
  "notAddedToMenu": [
    {
      "error": "string",
      "userBlueprintId": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
addedToMenu [UserBlueprintAddedToMenuItem] true The list of userBlueprintId and blueprintId pairs representing blueprints successfully added to the project repository.
message string false A success message or a list of reasons why the list of blueprints could not be added to the project repository.
notAddedToMenu [UserBlueprintFailedToAddToMenuItem] false The list of userBlueprintId and error message representing blueprints which failed to be added to the project repository.

UserBlueprintAddedToMenuItem

{
  "blueprintId": "string",
  "userBlueprintId": "string"
}

Properties

Name Type Required Restrictions Description
blueprintId string true The blueprintId representing the blueprint which was added to the project repository.
userBlueprintId string true The userBlueprintId associated with the blueprintId added to the project repository.

UserBlueprintBulkValidationRequest

{
  "projectId": "string",
  "userBlueprintIds": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
projectId string false String representation of ObjectId for the currently active project. The user blueprint is validated when this project is active. Necessary in the event of project specific tasks, such as column selection tasks.
userBlueprintIds [string] true The ids of the user blueprints to validate in bulk.

UserBlueprintCreate

{
  "blueprint": [
    {
      "taskData": {
        "inputs": [
          "string"
        ],
        "outputMethod": "string",
        "outputMethodParameters": [],
        "taskCode": "string",
        "taskParameters": [],
        "xTransformations": [],
        "yTransformations": []
      },
      "taskId": "string"
    }
  ],
  "decompressedBlueprint": false,
  "description": "string",
  "getDynamicLabels": false,
  "isInplaceEditor": false,
  "modelType": "string",
  "projectId": "string",
  "saveToCatalog": true
}

Properties

Name Type Required Restrictions Description
blueprint any true The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.

oneOf

Name Type Required Restrictions Description
» anonymous [UserBlueprintsBlueprintTask] false The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.

xor

Name Type Required Restrictions Description
» anonymous AllowExtra false Parameters submitted by the user to the failed job

continued

Name Type Required Restrictions Description
decompressedBlueprint boolean true Whether to retrieve the blueprint in the decompressed format.
description string false The description to give to the blueprint.
getDynamicLabels boolean false Whether to add dynamic labels to a decompressed blueprint.
isInplaceEditor boolean true Whether the request is sent from the in place user BP editor.
modelType string false maxLength: 1000
The title to give to the blueprint.
projectId string¦null false String representation of ObjectId for the currently active project. The user blueprint is created when this project is active. Necessary in the event of project specific tasks, such as column selection tasks.
saveToCatalog boolean true Whether to save the blueprint to the catalog.

UserBlueprintCreateFromBlueprintId

{
  "blueprintId": "string",
  "decompressedBlueprint": false,
  "description": "string",
  "getDynamicLabels": false,
  "isInplaceEditor": false,
  "modelType": "string",
  "projectId": "string",
  "saveToCatalog": true
}

Properties

Name Type Required Restrictions Description
blueprintId string true The id associated with the blueprint to create the user blueprint from.
decompressedBlueprint boolean true Whether to retrieve the blueprint in the decompressed format.
description string false The description to give to the blueprint.
getDynamicLabels boolean false Whether to add dynamic labels to a decompressed blueprint.
isInplaceEditor boolean true Whether the request is sent from the in place user BP editor.
modelType string false maxLength: 1000
The title to give to the blueprint.
projectId string true String representation of ObjectId for the currently active project. The user blueprint is created when this project is active.
saveToCatalog boolean true Whether to save the blueprint to the catalog.

UserBlueprintCreateFromCustomTaskVersionIdPayload

{
  "customTaskVersionId": "string",
  "decompressedBlueprint": false,
  "description": "string",
  "saveToCatalog": true
}

Properties

Name Type Required Restrictions Description
customTaskVersionId string true The ID of a custom task version.
decompressedBlueprint boolean true Whether to retrieve the blueprint in the decompressed format.
description string false The description for the user blueprint that will be created from this CustomTaskVersion.
saveToCatalog boolean true Whether to save the blueprint to the catalog.

UserBlueprintCreateFromUserBlueprintId

{
  "decompressedBlueprint": false,
  "description": "string",
  "getDynamicLabels": false,
  "isInplaceEditor": false,
  "modelType": "string",
  "projectId": "string",
  "saveToCatalog": true,
  "userBlueprintId": "string"
}

Properties

Name Type Required Restrictions Description
decompressedBlueprint boolean true Whether to retrieve the blueprint in the decompressed format.
description string false The description to give to the blueprint.
getDynamicLabels boolean false Whether to add dynamic labels to a decompressed blueprint.
isInplaceEditor boolean true Whether the request is sent from the in place user BP editor.
modelType string false maxLength: 1000
The title to give to the blueprint.
projectId string¦null false String representation of ObjectId for the currently active project. The user blueprint is created when this project is active. Necessary in the event of project specific tasks, such as column selection tasks.
saveToCatalog boolean true Whether to save the blueprint to the catalog.
userBlueprintId string true The id of the existing user blueprint to copy.

UserBlueprintFailedToAddToMenuItem

{
  "error": "string",
  "userBlueprintId": "string"
}

Properties

Name Type Required Restrictions Description
error string true The error message representing why the blueprint was not added to the project repository.
userBlueprintId string true The userBlueprintId associated with the blueprint which was not added to the project repository.

UserBlueprintSharedRolesListResponse

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

Properties

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

UserBlueprintSharedRolesResponse

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

Properties

Name Type Required Restrictions Description
id string true The ID of the recipient organization, group or user.
name string true The name of the recipient organization, group or user.
role string true The role of the org/group/user on this dataset or "NO_ROLE" for removing access when used with route to modify access.
shareRecipientType string true Describes the recipient type, either user, group, or organization.

Enumerated Values

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

UserBlueprintTask

{
  "arguments": [
    {
      "argument": {
        "default": "string",
        "name": "string",
        "recommended": "string",
        "tunable": true,
        "type": "string",
        "values": "string"
      },
      "key": "string"
    }
  ],
  "categories": [
    "string"
  ],
  "colnamesAndTypes": [
    {
      "colname": "string",
      "hex": "string",
      "type": "string"
    }
  ],
  "customTaskId": "string",
  "customTaskVersions": [
    {
      "id": "string",
      "label": "string",
      "versionMajor": 0,
      "versionMinor": 0
    }
  ],
  "description": "string",
  "icon": 0,
  "isCommonTask": false,
  "isCustomTask": true,
  "isVisibleInComposableMl": true,
  "label": "string",
  "outputMethods": [
    "string"
  ],
  "supportsScoringCode": true,
  "taskCode": "string",
  "timeSeriesOnly": true,
  "url": {},
  "validInputs": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
arguments [UserBlueprintTaskArgument] true A list of definitions of each argument which can be set for the task.
categories [string] true The categories which the task is in.
colnamesAndTypes [ColnameAndType]¦null false The column names, their types, and their hex representation, available in the specified project for the task.
customTaskId string¦null false The id of the custom task, if it is a custom task.
customTaskVersions [UserBlueprintTaskCustomTaskMetadataWithArguments]¦null false Metadata for all of the custom task's versions.
description string true A description of the task.
icon integer true The integer representing the id to be displayed when the blueprint is trained.
isCommonTask boolean false Whether the task is a common task.
isCustomTask boolean false Whether the task is custom code written by the user.
isVisibleInComposableMl boolean false Whether the task is visible in the ComposableML menu
label string true The generic / default title or label for the task.
outputMethods [string] true The methods which the task can use to produce output.
supportsScoringCode boolean true Whether the task supports Scoring Code.
taskCode string true The unique code which represents the task to be constructed and executed
timeSeriesOnly boolean true Whether the task can only be used with time series projects.
url any true The URL of the documentation of the task.

oneOf

Name Type Required Restrictions Description
» anonymous AllowExtra false Parameters submitted by the user to the failed job

xor

Name Type Required Restrictions Description
» anonymous string false none

continued

Name Type Required Restrictions Description
validInputs [string] true The supported input types of the task.

UserBlueprintTaskArgument

{
  "argument": {
    "default": "string",
    "name": "string",
    "recommended": "string",
    "tunable": true,
    "type": "string",
    "values": "string"
  },
  "key": "string"
}

Properties

Name Type Required Restrictions Description
argument UserBlueprintTaskArgumentDefinition true The definition of a task argument, used to specify a certain aspect of the task.
key string true The unique key of the argument

UserBlueprintTaskArgumentDefinition

{
  "default": "string",
  "name": "string",
  "recommended": "string",
  "tunable": true,
  "type": "string",
  "values": "string"
}

Properties

Name Type Required Restrictions Description
default any false The default value of the argument.

oneOf

Name Type Required Restrictions Description
» anonymous any false none

anyOf

Name Type Required Restrictions Description
»» anonymous string false none

or

Name Type Required Restrictions Description
»» anonymous integer false none

or

Name Type Required Restrictions Description
»» anonymous boolean false none

or

Name Type Required Restrictions Description
»» anonymous number false none

xor

Name Type Required Restrictions Description
» anonymous [anyOf] false none

anyOf

Name Type Required Restrictions Description
»» anonymous string false none

or

Name Type Required Restrictions Description
»» anonymous integer false none

or

Name Type Required Restrictions Description
»» anonymous boolean false none

or

Name Type Required Restrictions Description
»» anonymous number false none

continued

Name Type Required Restrictions Description
name string true The name of the argument.
recommended any false The recommended value, based on frequently used values.

oneOf

Name Type Required Restrictions Description
» anonymous any false none

anyOf

Name Type Required Restrictions Description
»» anonymous string false none

or

Name Type Required Restrictions Description
»» anonymous integer false none

or

Name Type Required Restrictions Description
»» anonymous boolean false none

or

Name Type Required Restrictions Description
»» anonymous number false none

xor

Name Type Required Restrictions Description
» anonymous [anyOf] false none

anyOf

Name Type Required Restrictions Description
»» anonymous string false none

or

Name Type Required Restrictions Description
»» anonymous integer false none

or

Name Type Required Restrictions Description
»» anonymous boolean false none

or

Name Type Required Restrictions Description
»» anonymous number false none

continued

Name Type Required Restrictions Description
tunable boolean false Whether the argument is tunable by the end-user.
type string true The type of the argument (e.g. "int", "float", "select", "intgrid", "multi", etc.)
values any true The possible values of the argument, which may be a range or list, or dictionary of ranges or lists keyed by type.

oneOf

Name Type Required Restrictions Description
» anonymous any false none

anyOf

Name Type Required Restrictions Description
»» anonymous string false none

or

Name Type Required Restrictions Description
»» anonymous integer false none

or

Name Type Required Restrictions Description
»» anonymous boolean false none

or

Name Type Required Restrictions Description
»» anonymous number false none

xor

Name Type Required Restrictions Description
» anonymous [anyOf] false none

anyOf

Name Type Required Restrictions Description
»» anonymous string false none

or

Name Type Required Restrictions Description
»» anonymous integer false none

or

Name Type Required Restrictions Description
»» anonymous boolean false none

or

Name Type Required Restrictions Description
»» anonymous number false none

xor

Name Type Required Restrictions Description
» anonymous AllowExtra false Parameters submitted by the user to the failed job

UserBlueprintTaskCategoryItem

{
  "name": "string",
  "subcategories": [
    {}
  ],
  "taskCodes": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
name string true The name of the category.
subcategories [AllowExtra] false A list of the available task category items.
taskCodes [string] true A list of task codes representing the tasks in this category.

UserBlueprintTaskCustomTaskMetadataWithArguments

{
  "id": "string",
  "label": "string",
  "versionMajor": 0,
  "versionMinor": 0
}

Properties

Name Type Required Restrictions Description
id string true Id of the custom task version. The ID can be latest_ which implies to use the latest version of that custom task.
label string true The name of the custom task version.
versionMajor integer true Major version of the custom task.
versionMinor integer true Minor version of the custom task.

UserBlueprintTaskLookupEntry

{
  "taskCode": "string",
  "taskDefinition": {
    "arguments": [
      {
        "argument": {
          "default": "string",
          "name": "string",
          "recommended": "string",
          "tunable": true,
          "type": "string",
          "values": "string"
        },
        "key": "string"
      }
    ],
    "categories": [
      "string"
    ],
    "colnamesAndTypes": [
      {
        "colname": "string",
        "hex": "string",
        "type": "string"
      }
    ],
    "customTaskId": "string",
    "customTaskVersions": [
      {
        "id": "string",
        "label": "string",
        "versionMajor": 0,
        "versionMinor": 0
      }
    ],
    "description": "string",
    "icon": 0,
    "isCommonTask": false,
    "isCustomTask": true,
    "isVisibleInComposableMl": true,
    "label": "string",
    "outputMethods": [
      "string"
    ],
    "supportsScoringCode": true,
    "taskCode": "string",
    "timeSeriesOnly": true,
    "url": {},
    "validInputs": [
      "string"
    ]
  }
}

Properties

Name Type Required Restrictions Description
taskCode string true The unique code which represents the task to be constructed and executed
taskDefinition UserBlueprintTask true A definition of a task in terms of label, arguments, description, and other metadata.

UserBlueprintTaskParameterValidation

{
  "outputMethod": "P",
  "projectId": "string",
  "taskCode": "string",
  "taskParameters": [
    {
      "newValue": "string",
      "paramName": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
outputMethod string true The method representing how the task will output data.
projectId string¦null false The projectId representing the project where this user blueprint is edited.
taskCode string true The task code representing the task to validate parameter values.
taskParameters [UserBlueprintTaskParameterValidationRequestParamItem] true A list of task parameters and proposed values to be validated.

Enumerated Values

Property Value
outputMethod [P, Pm, S, Sm, T, TS]

UserBlueprintTaskParameterValidationRequestParamItem

{
  "newValue": "string",
  "paramName": "string"
}

Properties

Name Type Required Restrictions Description
newValue any true The proposed value for the task parameter.

oneOf

Name Type Required Restrictions Description
» anonymous any false none

anyOf

Name Type Required Restrictions Description
»» anonymous string false none

or

Name Type Required Restrictions Description
»» anonymous integer false none

or

Name Type Required Restrictions Description
»» anonymous boolean false none

or

Name Type Required Restrictions Description
»» anonymous number false none

xor

Name Type Required Restrictions Description
» anonymous [anyOf] false none

anyOf

Name Type Required Restrictions Description
»» anonymous string false none

or

Name Type Required Restrictions Description
»» anonymous integer false none

or

Name Type Required Restrictions Description
»» anonymous boolean false none

or

Name Type Required Restrictions Description
»» anonymous number false none

continued

Name Type Required Restrictions Description
paramName string true The name of the task parameter to be validated.

UserBlueprintTasksResponse

{
  "categories": [
    {
      "name": "string",
      "subcategories": [
        {}
      ],
      "taskCodes": [
        "string"
      ]
    }
  ],
  "tasks": [
    {
      "taskCode": "string",
      "taskDefinition": {
        "arguments": [
          {
            "argument": {
              "default": "string",
              "name": "string",
              "recommended": "string",
              "tunable": true,
              "type": "string",
              "values": "string"
            },
            "key": "string"
          }
        ],
        "categories": [
          "string"
        ],
        "colnamesAndTypes": [
          {
            "colname": "string",
            "hex": "string",
            "type": "string"
          }
        ],
        "customTaskId": "string",
        "customTaskVersions": [
          {
            "id": "string",
            "label": "string",
            "versionMajor": 0,
            "versionMinor": 0
          }
        ],
        "description": "string",
        "icon": 0,
        "isCommonTask": false,
        "isCustomTask": true,
        "isVisibleInComposableMl": true,
        "label": "string",
        "outputMethods": [
          "string"
        ],
        "supportsScoringCode": true,
        "taskCode": "string",
        "timeSeriesOnly": true,
        "url": {},
        "validInputs": [
          "string"
        ]
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
categories [UserBlueprintTaskCategoryItem] true A list of the available task categories, sub-categories, and tasks.
tasks [UserBlueprintTaskLookupEntry] true A list of task codes and their task definitions.

UserBlueprintUpdate

{
  "blueprint": [
    {
      "taskData": {
        "inputs": [
          "string"
        ],
        "outputMethod": "string",
        "outputMethodParameters": [],
        "taskCode": "string",
        "taskParameters": [],
        "xTransformations": [],
        "yTransformations": []
      },
      "taskId": "string"
    }
  ],
  "decompressedBlueprint": false,
  "description": "string",
  "getDynamicLabels": false,
  "isInplaceEditor": false,
  "modelType": "string",
  "projectId": "string",
  "saveToCatalog": true
}

Properties

Name Type Required Restrictions Description
blueprint any false The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.

oneOf

Name Type Required Restrictions Description
» anonymous [UserBlueprintsBlueprintTask] false The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.

xor

Name Type Required Restrictions Description
» anonymous AllowExtra false Parameters submitted by the user to the failed job

continued

Name Type Required Restrictions Description
decompressedBlueprint boolean true Whether to retrieve the blueprint in the decompressed format.
description string false The description to give to the blueprint.
getDynamicLabels boolean false Whether to add dynamic labels to a decompressed blueprint.
isInplaceEditor boolean true Whether the request is sent from the in place user BP editor.
modelType string false maxLength: 1000
The title to give to the blueprint.
projectId string¦null false String representation of ObjectId for the currently active project. The user blueprint is created when this project is active. Necessary in the event of project specific tasks, such as column selection tasks.
saveToCatalog boolean true Whether to save the blueprint to the catalog.

UserBlueprintValidation

{
  "blueprint": [
    {
      "taskData": {
        "inputs": [
          "string"
        ],
        "outputMethod": "string",
        "outputMethodParameters": [],
        "taskCode": "string",
        "taskParameters": [],
        "xTransformations": [],
        "yTransformations": []
      },
      "taskId": "string"
    }
  ],
  "isInplaceEditor": false,
  "projectId": "string"
}

Properties

Name Type Required Restrictions Description
blueprint any true The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.

oneOf

Name Type Required Restrictions Description
» anonymous [UserBlueprintsBlueprintTask] false The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.

xor

Name Type Required Restrictions Description
» anonymous AllowExtra false Parameters submitted by the user to the failed job

continued

Name Type Required Restrictions Description
isInplaceEditor boolean true Whether the request is sent from the in place user BP editor.
projectId string¦null false String representation of ObjectId for the currently active project. The user blueprint is validated when this project is active. Necessary in the event of project specific tasks, such as column selection tasks.

UserBlueprintsBlueprintTask

{
  "taskData": {
    "inputs": [
      "string"
    ],
    "outputMethod": "string",
    "outputMethodParameters": [],
    "taskCode": "string",
    "taskParameters": [],
    "xTransformations": [],
    "yTransformations": []
  },
  "taskId": "string"
}

Properties

Name Type Required Restrictions Description
taskData UserBlueprintsBlueprintTaskData true The data defining the task / vertex in the blueprint.
taskId string true The identifier of a task / vertex in the blueprint.

UserBlueprintsBlueprintTaskData

{
  "inputs": [
    "string"
  ],
  "outputMethod": "string",
  "outputMethodParameters": [],
  "taskCode": "string",
  "taskParameters": [],
  "xTransformations": [],
  "yTransformations": []
}

Properties

Name Type Required Restrictions Description
inputs [string] true The ids or input data types which will be inputs to the task.
outputMethod string true The method which the task will use to produce output.
outputMethodParameters [ParamValuePair] true The parameters which further define how output will be produced.
taskCode string¦null true The unique code representing the python class which will be instantiated and executed.
taskParameters [ParamValuePair] true The parameters which further define the behavior of the task.
xTransformations [ParamValuePair] true Transformations to apply to the input data before fitting or predicting.
yTransformations [ParamValuePair] true Transformations to apply to the input target before fitting or predicting.

UserBlueprintsBulkDelete

{
  "userBlueprintIds": "string"
}

Properties

Name Type Required Restrictions Description
userBlueprintIds any true A list of IDs of user blueprints to be deleted.

oneOf

Name Type Required Restrictions Description
» anonymous string false none

xor

Name Type Required Restrictions Description
» anonymous [string] false none

UserBlueprintsBulkDeleteResponse

{
  "failedToDelete": [
    "string"
  ],
  "successfullyDeleted": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
failedToDelete [string] true List of IDs of User Blueprints which failed to be deleted.
successfullyDeleted [string] true List of IDs of User Blueprints successfully deleted.

UserBlueprintsBulkValidationResponse

{
  "data": [
    {
      "userBlueprintId": "string",
      "vertexContext": [
        {
          "information": {
            "inputs": [
              "string"
            ],
            "outputs": [
              "string"
            ]
          },
          "messages": {
            "errors": [
              "string"
            ],
            "warnings": [
              "string"
            ]
          },
          "taskId": "string"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
data [UserBlueprintsBulkValidationResponseItem] true A list of validation responses with their associated User Blueprint ID.

UserBlueprintsBulkValidationResponseItem

{
  "userBlueprintId": "string",
  "vertexContext": [
    {
      "information": {
        "inputs": [
          "string"
        ],
        "outputs": [
          "string"
        ]
      },
      "messages": {
        "errors": [
          "string"
        ],
        "warnings": [
          "string"
        ]
      },
      "taskId": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
userBlueprintId string true The unique id associated with the user blueprint.
vertexContext [VertexContextItem] true Info about, warnings about, and errors with a specific vertex in the blueprint.

UserBlueprintsDetailedItem

{
  "blender": false,
  "blueprint": [
    {
      "taskData": {
        "inputs": [
          "string"
        ],
        "outputMethod": "string",
        "outputMethodParameters": [],
        "taskCode": "string",
        "taskParameters": [],
        "xTransformations": [],
        "yTransformations": []
      },
      "taskId": "string"
    }
  ],
  "blueprintId": "string",
  "bpData": {
    "children": [
      {}
    ],
    "id": "string",
    "inputs": [
      "string"
    ],
    "output": "string",
    "taskMap": {},
    "taskParameters": "string",
    "tasks": [
      "string"
    ],
    "type": "string"
  },
  "customTaskVersionMetadata": [
    [
      "string",
      "string"
    ]
  ],
  "decompressedFormat": false,
  "diagram": "string",
  "features": [
    "string"
  ],
  "featuresText": "string",
  "hexColumnNameLookup": [
    {
      "colname": "string",
      "hex": "string",
      "projectId": "string"
    }
  ],
  "hiddenFromCatalog": true,
  "icons": [
    0
  ],
  "insights": "string",
  "isTimeSeries": false,
  "linkedToProjectId": true,
  "modelType": "string",
  "projectId": "string",
  "referenceModel": false,
  "shapSupport": false,
  "supportedTargetTypes": [
    "binary"
  ],
  "supportsGpu": false,
  "supportsNewSeries": true,
  "userBlueprintId": "string",
  "userId": "string",
  "vertexContext": [
    {
      "information": {
        "inputs": [
          "string"
        ],
        "outputs": [
          "string"
        ]
      },
      "messages": {
        "errors": [
          "string"
        ],
        "warnings": [
          "string"
        ]
      },
      "taskId": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
blender boolean true Whether the blueprint is a blender.
blueprint any true The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.

oneOf

Name Type Required Restrictions Description
» anonymous [UserBlueprintsBlueprintTask] false The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.

xor

Name Type Required Restrictions Description
» anonymous AllowExtra false Parameters submitted by the user to the failed job

continued

Name Type Required Restrictions Description
blueprintId string true The deterministic id of the blueprint, based on its content.
bpData BpData true Additional blueprint metadata used to render the blueprint in the UI
customTaskVersionMetadata [array] false An association of custom entity ids and task ids.
decompressedFormat boolean true Whether the blueprint is in the decompressed format.
diagram string true The diagram used by the UI to display the blueprint.
features [string] true A list of the names of tasks used in the blueprint.
featuresText string true A description of the blueprint via the names of tasks used.
hexColumnNameLookup [UserBlueprintsHexColumnNameLookupEntry] false A lookup between hex values and data column names used in the blueprint.
hiddenFromCatalog boolean false If true, the blueprint will not show up in the catalog
icons [integer] true The icon(s) associated with the blueprint.
insights string true An indication of the insights generated by the blueprint.
isTimeSeries boolean true Whether the blueprint contains time-series tasks.
linkedToProjectId boolean false Whether the user blueprint is linked to a project.
modelType string true The generated or provided title of the blueprint.
projectId string¦null false The id of the project the blueprint was originally created with, if applicable.
referenceModel boolean true Whether the blueprint is a reference model.
shapSupport boolean true Whether the blueprint supports shapley additive explanations.
supportedTargetTypes [string] true The list of supported targets of the current blueprint.
supportsGpu boolean true Whether the blueprint supports execution on the GPU.
supportsNewSeries boolean false Whether the blueprint supports new series.
userBlueprintId string true The unique id associated with the user blueprint.
userId string true The id of the user who owns the blueprint.
vertexContext [VertexContextItem] true Info about, warnings about, and errors with a specific vertex in the blueprint.

UserBlueprintsHexColumnNameLookupEntry

{
  "colname": "string",
  "hex": "string",
  "projectId": "string"
}

Properties

Name Type Required Restrictions Description
colname string true The name of the column.
hex string true A safe hex representation of the column name.
projectId string false The id of the project from which the column name originates.

UserBlueprintsInputType

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

Properties

Name Type Required Restrictions Description
name string true The human-readable name of an input type.
type string true The unique identifier of an input type.

UserBlueprintsInputTypesResponse

{
  "inputTypes": [
    {
      "name": "string",
      "type": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
inputTypes [UserBlueprintsInputType] true A list of associated pairs of an input types and their human-readable names.

UserBlueprintsListItem

{
  "blender": false,
  "blueprintId": "string",
  "customTaskVersionMetadata": [
    [
      "string",
      "string"
    ]
  ],
  "decompressedFormat": false,
  "diagram": "string",
  "features": [
    "string"
  ],
  "featuresText": "string",
  "hexColumnNameLookup": [
    {
      "colname": "string",
      "hex": "string",
      "projectId": "string"
    }
  ],
  "hiddenFromCatalog": true,
  "icons": [
    0
  ],
  "insights": "string",
  "isTimeSeries": false,
  "linkedToProjectId": true,
  "modelType": "string",
  "projectId": "string",
  "referenceModel": false,
  "shapSupport": false,
  "supportedTargetTypes": [
    "binary"
  ],
  "supportsGpu": false,
  "supportsNewSeries": true,
  "userBlueprintId": "string",
  "userId": "string"
}

Properties

Name Type Required Restrictions Description
blender boolean true Whether the blueprint is a blender.
blueprintId string true The deterministic id of the blueprint, based on its content.
customTaskVersionMetadata [array] false An association of custom entity ids and task ids.
decompressedFormat boolean true Whether the blueprint is in the decompressed format.
diagram string true The diagram used by the UI to display the blueprint.
features [string] true A list of the names of tasks used in the blueprint.
featuresText string true A description of the blueprint via the names of tasks used.
hexColumnNameLookup [UserBlueprintsHexColumnNameLookupEntry] false A lookup between hex values and data column names used in the blueprint.
hiddenFromCatalog boolean false If true, the blueprint will not show up in the catalog
icons [integer] true The icon(s) associated with the blueprint.
insights string true An indication of the insights generated by the blueprint.
isTimeSeries boolean true Whether the blueprint contains time-series tasks.
linkedToProjectId boolean false Whether the user blueprint is linked to a project.
modelType string true The generated or provided title of the blueprint.
projectId string¦null false The id of the project the blueprint was originally created with, if applicable.
referenceModel boolean true Whether the blueprint is a reference model.
shapSupport boolean true Whether the blueprint supports shapley additive explanations.
supportedTargetTypes [string] true The list of supported targets of the current blueprint.
supportsGpu boolean true Whether the blueprint supports execution on the GPU.
supportsNewSeries boolean false Whether the blueprint supports new series.
userBlueprintId string true The unique id associated with the user blueprint.
userId string true The id of the user who owns the blueprint.

UserBlueprintsListResponse

{
  "count": 0,
  "data": [
    {
      "blender": false,
      "blueprintId": "string",
      "customTaskVersionMetadata": [
        [
          "string",
          "string"
        ]
      ],
      "decompressedFormat": false,
      "diagram": "string",
      "features": [
        "string"
      ],
      "featuresText": "string",
      "hexColumnNameLookup": [
        {
          "colname": "string",
          "hex": "string",
          "projectId": "string"
        }
      ],
      "hiddenFromCatalog": true,
      "icons": [
        0
      ],
      "insights": "string",
      "isTimeSeries": false,
      "linkedToProjectId": true,
      "modelType": "string",
      "projectId": "string",
      "referenceModel": false,
      "shapSupport": false,
      "supportedTargetTypes": [
        "binary"
      ],
      "supportsGpu": false,
      "supportsNewSeries": true,
      "userBlueprintId": "string",
      "userId": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true Number of records on this page
data [UserBlueprintsListItem] true maxItems: 100
List of user blueprints
next string¦null true URL to the next page, or null if there is no such page
previous string¦null true URL to the previous page, or null if there is no such page
totalCount integer false Total number of records

UserBlueprintsRetrieveResponse

{
  "blender": false,
  "blueprint": [
    {
      "taskData": {
        "inputs": [
          "string"
        ],
        "outputMethod": "string",
        "outputMethodParameters": [],
        "taskCode": "string",
        "taskParameters": [],
        "xTransformations": [],
        "yTransformations": []
      },
      "taskId": "string"
    }
  ],
  "blueprintId": "string",
  "bpData": {
    "children": [
      {}
    ],
    "id": "string",
    "inputs": [
      "string"
    ],
    "output": "string",
    "taskMap": {},
    "taskParameters": "string",
    "tasks": [
      "string"
    ],
    "type": "string"
  },
  "customTaskVersionMetadata": [
    [
      "string",
      "string"
    ]
  ],
  "decompressedFormat": false,
  "diagram": "string",
  "features": [
    "string"
  ],
  "featuresText": "string",
  "hexColumnNameLookup": [
    {
      "colname": "string",
      "hex": "string",
      "projectId": "string"
    }
  ],
  "hiddenFromCatalog": true,
  "icons": [
    0
  ],
  "insights": "string",
  "isTimeSeries": false,
  "linkedToProjectId": true,
  "modelType": "string",
  "projectId": "string",
  "referenceModel": false,
  "shapSupport": false,
  "supportedTargetTypes": [
    "binary"
  ],
  "supportsGpu": false,
  "supportsNewSeries": true,
  "userBlueprintId": "string",
  "userId": "string",
  "vertexContext": [
    {
      "information": {
        "inputs": [
          "string"
        ],
        "outputs": [
          "string"
        ]
      },
      "messages": {
        "errors": [
          "string"
        ],
        "warnings": [
          "string"
        ]
      },
      "taskId": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
blender boolean true Whether the blueprint is a blender.
blueprint any false The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.

oneOf

Name Type Required Restrictions Description
» anonymous [UserBlueprintsBlueprintTask] false The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.

xor

Name Type Required Restrictions Description
» anonymous AllowExtra false Parameters submitted by the user to the failed job

continued

Name Type Required Restrictions Description
blueprintId string true The deterministic id of the blueprint, based on its content.
bpData BpData false Additional blueprint metadata used to render the blueprint in the UI
customTaskVersionMetadata [array] false An association of custom entity ids and task ids.
decompressedFormat boolean true Whether the blueprint is in the decompressed format.
diagram string true The diagram used by the UI to display the blueprint.
features [string] true A list of the names of tasks used in the blueprint.
featuresText string true A description of the blueprint via the names of tasks used.
hexColumnNameLookup [UserBlueprintsHexColumnNameLookupEntry] false A lookup between hex values and data column names used in the blueprint.
hiddenFromCatalog boolean false If true, the blueprint will not show up in the catalog
icons [integer] true The icon(s) associated with the blueprint.
insights string true An indication of the insights generated by the blueprint.
isTimeSeries boolean true Whether the blueprint contains time-series tasks.
linkedToProjectId boolean false Whether the user blueprint is linked to a project.
modelType string true The generated or provided title of the blueprint.
projectId string¦null false The id of the project the blueprint was originally created with, if applicable.
referenceModel boolean true Whether the blueprint is a reference model.
shapSupport boolean true Whether the blueprint supports shapley additive explanations.
supportedTargetTypes [string] true The list of supported targets of the current blueprint.
supportsGpu boolean true Whether the blueprint supports execution on the GPU.
supportsNewSeries boolean false Whether the blueprint supports new series.
userBlueprintId string true The unique id associated with the user blueprint.
userId string true The id of the user who owns the blueprint.
vertexContext [VertexContextItem] false Info about, warnings about, and errors with a specific vertex in the blueprint.

UserBlueprintsValidateTaskParameter

{
  "message": "string",
  "paramName": "string",
  "value": "string"
}

Properties

Name Type Required Restrictions Description
message string true The description of the issue with the proposed task parameter value.
paramName string true The name of the validated task parameter.
value any true The invalid value proposed for the validated task parameter.

oneOf

Name Type Required Restrictions Description
» anonymous any false none

anyOf

Name Type Required Restrictions Description
»» anonymous string false none

or

Name Type Required Restrictions Description
»» anonymous integer false none

or

Name Type Required Restrictions Description
»» anonymous boolean false none

or

Name Type Required Restrictions Description
»» anonymous number false none

xor

Name Type Required Restrictions Description
» anonymous [anyOf] false none

anyOf

Name Type Required Restrictions Description
»» anonymous string false none

or

Name Type Required Restrictions Description
»» anonymous integer false none

or

Name Type Required Restrictions Description
»» anonymous boolean false none

or

Name Type Required Restrictions Description
»» anonymous number false none

UserBlueprintsValidateTaskParametersResponse

{
  "errors": [
    {
      "message": "string",
      "paramName": "string",
      "value": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
errors [UserBlueprintsValidateTaskParameter] true A list of the task parameters, their proposed values, and messages describing why each is not valid.

UserBlueprintsValidationResponse

{
  "vertexContext": [
    {
      "information": {
        "inputs": [
          "string"
        ],
        "outputs": [
          "string"
        ]
      },
      "messages": {
        "errors": [
          "string"
        ],
        "warnings": [
          "string"
        ]
      },
      "taskId": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
vertexContext [VertexContextItem] true Info about, warnings about, and errors with a specific vertex in the blueprint.

UserRoleWithGrant

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

Properties

Name Type Required Restrictions Description
canShare boolean false Whether the org/group/user should be able to share with others.If true, the org/group/user will be able to grant any role up to and includingtheir own to other orgs/groups/user. If role is NO_ROLE canShare is ignored.
role string¦null true The role to set on the entity. When it is None, the role of this user will be removedfrom this entity.
username string true Username of the user to update the access role for.

Enumerated Values

Property Value
role [ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER]

VertexContextItem

{
  "information": {
    "inputs": [
      "string"
    ],
    "outputs": [
      "string"
    ]
  },
  "messages": {
    "errors": [
      "string"
    ],
    "warnings": [
      "string"
    ]
  },
  "taskId": "string"
}

Properties

Name Type Required Restrictions Description
information VertexContextItemInfo false A specification of requirements of the inputs and expectations of the output of the vertex.
messages VertexContextItemMessages false Warnings about and errors with a specific vertex in the blueprint.
taskId string true The id associated with a specific vertex in the blueprint.

VertexContextItemInfo

{
  "inputs": [
    "string"
  ],
  "outputs": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
inputs [string] true A specification of requirements of the inputs of the vertex.
outputs [string] true A specification of expectations of the output of the vertex.

VertexContextItemMessages

{
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
errors [string] false Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail.
warnings [string] false Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly.

WorkspaceItemResponse

{
  "commitSha": "string",
  "created": "string",
  "fileName": "string",
  "filePath": "string",
  "fileSource": "string",
  "id": "string",
  "ref": "string",
  "repositoryFilePath": "string",
  "repositoryLocation": "string",
  "repositoryName": "string"
}

Properties

Name Type Required Restrictions Description
commitSha string¦null false SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).
created string true ISO-8601 timestamp of when the file item was created.
fileName string true Name of the file item.
filePath string true Path of the file item.
fileSource string true Source of the file item.
id string true ID of the file item.
ref string¦null false Remote reference (branch, commit, tag). Branch "master", if not specified.
repositoryFilePath string¦null false Full path to the file in the remote repository.
repositoryLocation string¦null false URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).
repositoryName string¦null false Name of the repository from which the file was pulled.

Updated December 16, 2024