Skip to content

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

Documentation

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

GET /api/v2/automatedDocumentOptions/

Check which document types and locales are available for generation with your account.

Code samples

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

Example responses

200 Response

{
  "data": [
    {
      "documentType": "AUTOPILOT_SUMMARY",
      "locale": "EN_US"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Available document types and locales retrieved. AutomatedDocOptionsResponse

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

BearerAuth

GET /api/v2/automatedDocuments/

Get information about all previously generated documents available for your account. The information includes document ID and type, ID of the entity it was generated for, time of creation, and other information.

Example request to get a list of all documents:

.. code-block:: text

GET https://app.datarobot.com/api/v2/automatedDocuments/ HTTP/1.1
Authorization: Bearer DnwzBUSTOtKBO5Sp1hoUByG4YgZwCCw4

Query for specific documents. For example, request a list of documents generated for a specific model in docx and html formats:

.. code-block:: text

GET https://app.datarobot.com/api/v2/automatedDocuments?entityId=
5ec4ea7e41054c158c5b002f&outputFormat=docx&outputFormat=html HTTP/1.1
Authorization: Bearer DnwzBUSTOtKBO5Sp1hoUByG4YgZwCCw4

In response body, you will get a page with queried documents. This is an example response with one document returned:

.. code-block:: json

{
    "totalCount": 1,
    "count": 1,
    "previous": null,
    "next": null,
    "data": [
        {
            "id": "5ebdb5e911a5fb85edff2b3c",
            "documentType": "MODEL_COMPLIANCE",
            "entityId": "5ebbb5e7d9d7b96e3d48e3b5",
            "templateId": "5bd812e5f750edd392fa880f",
            "locale": "EN_US",
            "outputFormat": "DOCX",
            "createdAt": "2019-11-07T11:12:13.141516Z"
        }
    ]
}

If there are no matching documents, you will get a page with an empty data array.

Code samples

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

Parameters

Name In Type Required Description
offset query integer true Number of items to skip. Defaults to 0 if not provided.
limit query integer true Number of items to return, defaults to 100 if not provided.
documentType query any false Query for one or more document types.
outputFormat query any false Query for one or more output formats.
locale query any false Query generated documents by one or more locales.
entityId query any false Query generated documents by one or more entity IDs. For Model Compliance docs, the entity ID is a model ID. For Autopilot Summary reports, query by project IDs.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "docTypeSpecificInfo": {
        "endDate": "2019-08-24T14:15:22Z",
        "modelName": "string",
        "startDate": "2019-08-24T14:15:22Z"
      },
      "documentType": "AUTOPILOT_SUMMARY",
      "entityId": "string",
      "id": "string",
      "locale": "EN_US",
      "outputFormat": "docx",
      "templateId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK List of found documents retrieved. AutomatedDocListResponse

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

BearerAuth

POST /api/v2/automatedDocuments/

Request generation of an automated document that's available for your account. Below is an example request body to generate Model Compliance documentation:

.. sourcecode:: json

{
    "documentType": "MODEL_COMPLIANCE",
    "entityId": "507f191e810c19729de860ea",
    "outputFormat": "docx"
}

For Autopilot Summary, set a corresponding document type, AUTOPILOT_SUMMARY, and assign a needed project ID to the entityId value.

After the request is sent, the jobs needed for document generation are queued. You can see the status of the generation by polling the URL in the Location headers. After the generation is complete, the status URL will automatically redirect you to the resource location to download the document.

Code samples

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

Body parameter

{
  "documentType": "AUTOPILOT_SUMMARY",
  "documentTypeSpecificParameters": {
    "bucketSize": "string",
    "end": "2019-08-24T14:15:22Z",
    "modelId": "string",
    "start": "2019-08-24T14:15:22Z"
  },
  "entityId": "string",
  "locale": "EN_US",
  "outputFormat": "docx",
  "templateId": "string"
}

Parameters

Name In Type Required Description
body body AutomatedDocCreate false none

Responses

Status Meaning Description Schema
202 Accepted Document generation request accepted. None
422 Unprocessable Entity Unable to process document generation request. None

Response Headers

Status Header Type Format Description
202 Location string URL to poll document generation status: :http:get:/api/v2/status/(statusId)/

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

BearerAuth

DELETE /api/v2/automatedDocuments/{documentId}/

Delete a document using its ID. Example request:

.. code-block:: text

        DELETE https://app.datarobot.com/api/v2/automatedDocuments/5ec4ea7e41054c158c5b002f/ HTTP/1.1
        Authorization: Bearer DnwzBUSTOtKBO5Sp1hoUByG4YgZwCCw4

Code samples

# You can also use wget
curl -X DELETE http://10.97.110.93/api/v2/automatedDocuments/{documentId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
documentId path string true Unique identifier of the generated document.

Responses

Status Meaning Description Schema
204 No Content Document successfully deleted. None
404 Not Found Provided document ID not found. None

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

BearerAuth

GET /api/v2/automatedDocuments/{documentId}/

Download a generated Automated Documentation file.

.. code-block:: text

GET https://app.datarobot.com/api/v2/automatedDocuments/5ec4ea7e41054c158c5b002f/ HTTP/1.1
Authorization: Bearer DnwzBUSTOtKBO5Sp1hoUByG4YgZwCCw4

In response, you will get a file containing the generated documentation.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/automatedDocuments/{documentId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
documentId path string true Unique identifier of the generated document.

Responses

Status Meaning Description Schema
200 OK Download request succeeded. None
404 Not Found Documentation record not found. None

Response Headers

Status Header Type Format Description
200 Content-Disposition string Autogenerated filename ("attachment;filename=report_name.outputFormat").
200 Content-Type string MIME type corresponding to document file format

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

BearerAuth

GET /api/v2/complianceDocTemplates/

List user's custom-built compliance documentation templates.

Code samples

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

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
namePart query string false When present, only return templates with names that contain the given substring.
orderBy query string false Sort order to apply to the dataset list. Prefix the attribute name with a dash to sort in descending order (e.g., orderBy='-id').
labels query string false Name of labels to filter by.
projectType query string false Type of project templates to search for. If not specified, returns all project templates types.

Enumerated Values

Parameter Value
orderBy id
orderBy -id
projectType timeSeries
projectType autoMl

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "creatorId": "string",
      "creatorUsername": "string",
      "dateModified": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "instructions": "string",
      "labels": [
        "string"
      ],
      "name": "string",
      "orgId": "string",
      "permissions": {
        "CAN_DELETE_TEMPLATE": true,
        "CAN_EDIT_TEMPLATE": true,
        "CAN_SHARE": true,
        "CAN_USE_TEMPLATE": true,
        "CAN_VIEW": true
      },
      "projectType": "timeSeries",
      "sections": [
        {
          "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
          "description": "string",
          "instructions": {
            "owner": "string",
            "user": "string"
          },
          "locked": true,
          "sections": [
            {}
          ],
          "title": "string",
          "type": "datarobot"
        }
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Successfully returned list of templates ComplianceDocTemplateListResponse

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

BearerAuth

POST /api/v2/complianceDocTemplates/

Create a new compliance documentation template. One can retrieve the default DataRobot template via GET /api/v2/complianceDocTemplates/default/ endpoint.

Code samples

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

Body parameter

{
  "labels": [
    "string"
  ],
  "name": "string",
  "projectType": "timeSeries",
  "sections": [
    {
      "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
      "description": "string",
      "instructions": {
        "owner": "string",
        "user": "string"
      },
      "locked": true,
      "sections": [
        {}
      ],
      "title": "string",
      "type": "datarobot"
    }
  ]
}

Parameters

Name In Type Required Description
body body ComplianceDocTemplateCreate false none

Example responses

201 Response

{
  "dateModified": "2019-08-24T14:15:22Z",
  "id": "string"
}

Responses

Status Meaning Description Schema
201 Created Model compliance documentation template created successfully ComplianceDocTemplateCreateResponse
422 Unprocessable Entity Template cannot be created, e.g., invalid sections or name already exists None

Response Headers

Status Header Type Format Description
201 Location string url URL location of the newly created template.

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

BearerAuth

GET /api/v2/complianceDocTemplates/default/

Retrieve the default documentation template.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/complianceDocTemplates/default/?type=normal \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
type query string true Specifies the type of the default template to retrieve, either normal or timeSeries. The normal template is applicable for all AutoML projects that are not time series. The timeSeries template is only applicable to time series projects.

Enumerated Values

Parameter Value
type normal
type timeSeries

Example responses

200 Response

{
  "sections": [
    {
      "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
      "description": "string",
      "instructions": {
        "owner": "string",
        "user": "string"
      },
      "locked": true,
      "sections": [
        {}
      ],
      "title": "string",
      "type": "datarobot"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successfully retrieved default template ComplianceDocTemplateDefaultRetrieveResponse

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

BearerAuth

DELETE /api/v2/complianceDocTemplates/{templateId}/

Delete a compliance documentation template. Documentation previously generated using this template will remain unchanged.

Code samples

# You can also use wget
curl -X DELETE http://10.97.110.93/api/v2/complianceDocTemplates/{templateId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
templateId path string true The Id of a model compliance document template accessible by the user

Responses

Status Meaning Description Schema
204 No Content Template deleted successfully None
403 Forbidden Insufficient permissions to delete template None
404 Not Found Template not found None

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

BearerAuth

GET /api/v2/complianceDocTemplates/{templateId}/

Retrieve a JSON representation of a custom Compliance Documentation template.

Code samples

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

Parameters

Name In Type Required Description
templateId path string true The Id of a model compliance document template accessible by the user

Example responses

200 Response

{
  "creatorId": "string",
  "creatorUsername": "string",
  "dateModified": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "string",
  "instructions": "string",
  "labels": [
    "string"
  ],
  "name": "string",
  "orgId": "string",
  "permissions": {
    "CAN_DELETE_TEMPLATE": true,
    "CAN_EDIT_TEMPLATE": true,
    "CAN_SHARE": true,
    "CAN_USE_TEMPLATE": true,
    "CAN_VIEW": true
  },
  "projectType": "timeSeries",
  "sections": [
    {
      "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
      "description": "string",
      "instructions": {
        "owner": "string",
        "user": "string"
      },
      "locked": true,
      "sections": [
        {}
      ],
      "title": "string",
      "type": "datarobot"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successfully retrieved template TemplateResponse
404 Not Found No matching template owned by this user was found None

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

BearerAuth

PATCH /api/v2/complianceDocTemplates/{templateId}/

Update an existing model compliance documentation template with the given templateId. The template must be accessible by the user. If the templateId is not found for the user, the update cannot be performed. For a description of the template sections object options, see the sample sections on the schema below.

Code samples

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

Body parameter

{
  "description": "string",
  "labels": [
    "string"
  ],
  "name": "string",
  "projectType": "timeSeries",
  "sections": [
    {
      "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
      "description": "string",
      "instructions": {
        "owner": "string",
        "user": "string"
      },
      "locked": true,
      "sections": [
        {}
      ],
      "title": "string",
      "type": "datarobot"
    }
  ]
}

Parameters

Name In Type Required Description
templateId path string true The Id of a model compliance document template accessible by the user
body body ComplianceDocTemplateUpdate false none

Responses

Status Meaning Description Schema
204 No Content Model compliance documentation template updated successfully None
403 Forbidden Not enough permissions to edit template None
404 Not Found Template not found None

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

BearerAuth

GET /api/v2/complianceDocTemplates/{templateId}/sharedRoles/

Get a list of users, groups and organizations who have access to this template and their roles on the template.

Code samples

# You can also use wget
curl -X GET http://10.97.110.93/api/v2/complianceDocTemplates/{templateId}/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.
templateId path string true The template identifier

Enumerated Values

Parameter Value
shareRecipientType user
shareRecipientType group
shareRecipientType organization

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "DATA_SCIENTIST",
      "shareRecipientType": "user"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK The template's access control list. SharingListV2Response
400 Bad Request Both username and userId were specified None
404 Not Found Either the template does not exist or the user does not have permissions to view the template. None

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

BearerAuth

PATCH /api/v2/complianceDocTemplates/{templateId}/sharedRoles/

Set roles for users on this template.

Code samples

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

Body parameter

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

Parameters

Name In Type Required Description
templateId path string true The template identifier
body body SharedRolesUpdate false none

Responses

Status Meaning Description Schema
204 No Content Roles updated successfully. None
409 Conflict The request would leave the template 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/modelComplianceDocsInitializations/{entityId}/

Check if compliance documentation pre-processing is initialized for the current model. This is only required for custom models.

Code samples

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

Parameters

Name In Type Required Description
entityId path string true The ID of the model or model package the document corresponds to.

Example responses

200 Response

{
  "initialized": true,
  "status": "initialized"
}

Responses

Status Meaning Description Schema
200 OK Retrieve information about the status of the compliance documentation pre-preprocessing initialization. ModelComplianceDocsInitializationsResponse
404 Not Found Model not found. None

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

BearerAuth

POST /api/v2/modelComplianceDocsInitializations/{entityId}/

Initialize compliance documentation pre-processing for the current model. This route must be called before generating documentation for a custom model.

Code samples

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

Body parameter

{}

Parameters

Name In Type Required Description
entityId path string true The ID of the model or model package the document corresponds to.
body body Empty false none

Responses

Status Meaning Description Schema
202 Accepted Job to initialize compliance documentation pre-processing successfully started. None
404 Not Found Model not found. None
422 Unprocessable Entity Cannot prepare model for compliance document generation. None

Response Headers

Status Header Type Format Description
202 Location string URL to poll for getting a status of the job: :http:get:/api/v2/status/(statusId)/

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

BearerAuth

Schemas

AccessControlV2

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

Properties

Name Type Required Restrictions Description
id string true none The identifier of the recipient.
name string true none The name of the recipient.
role string true none The role of the recipient on this entity.
shareRecipientType string true none The type of the recipient.

Enumerated Values

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

AutomatedDocCreate

{
  "documentType": "AUTOPILOT_SUMMARY",
  "documentTypeSpecificParameters": {
    "bucketSize": "string",
    "end": "2019-08-24T14:15:22Z",
    "modelId": "string",
    "start": "2019-08-24T14:15:22Z"
  },
  "entityId": "string",
  "locale": "EN_US",
  "outputFormat": "docx",
  "templateId": "string"
}

Properties

Name Type Required Restrictions Description
documentType string true none Type of the automated document you want to generate.
documentTypeSpecificParameters AutomatedDocCreateDeploymentReport¦null false none Set parameters unique for a specific document type. Currently, only these document types can have document-specific parameters: ['DEPLOYMENT_REPORT']
entityId string true none ID of the entity to generate the document for. It can be a model ID, a project ID.
locale string false none Localization of the document. Defaults to EN_US.
outputFormat string true none Format to generate the document in.
templateId string false none Template ID to use for the document outline. Defaults to standard Datarobot template.

Enumerated Values

Property Value
documentType AUTOPILOT_SUMMARY
documentType DEPLOYMENT_REPORT
documentType MODEL_COMPLIANCE
locale EN_US
locale JA_JP
outputFormat docx
outputFormat html

AutomatedDocCreateDeploymentReport

{
  "bucketSize": "string",
  "end": "2019-08-24T14:15:22Z",
  "modelId": "string",
  "start": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
bucketSize string(duration) false none You can regulate the size of the buckets in charts. One bucket reflects some duration period and you can set the exact duration with this parameter. Bucket size gets defaulted to either a month, a week, or a day, based on the time range of the report. We use ISO 8601 <https://www.digi.com/resources/documentation/digidocs/90001437-13/reference/r_iso_8601_duration_format.htm>_ duration format to specify values.
end string(date-time)¦null false none RFC3339 datetime. End of time period to retrieve the features drift for. If not set, defaults to the next top of the hour from now.Note: this field only accepts top of the hour RFC3339 datetime strings For example: 2019-08-01T00:00:00Z.
modelId string false none Provide a model ID to generate a report for a previously deployed model.
start string(date-time)¦null false none RFC3339 datetime. Start of time period to retrieve the features drift for. If not set, defaults to 1 week from the end of the period.Note: this field only accepts top of the hour RFC3339 datetime strings For example: 2019-08-01T00:00:00Z.

AutomatedDocItem

{
  "createdAt": "2019-08-24T14:15:22Z",
  "docTypeSpecificInfo": {
    "endDate": "2019-08-24T14:15:22Z",
    "modelName": "string",
    "startDate": "2019-08-24T14:15:22Z"
  },
  "documentType": "AUTOPILOT_SUMMARY",
  "entityId": "string",
  "id": "string",
  "locale": "EN_US",
  "outputFormat": "docx",
  "templateId": "string"
}

Properties

Name Type Required Restrictions Description
createdAt string(date-time) true none Timestamp for the document creation time.
docTypeSpecificInfo DocTypeSpecificInfo false none Information that is specific for a certain document type.
documentType string true none Type of the generated document.
entityId string true none Unique identifier of the entity the document was generated for.
id string true none Unique identifier of the generated document.
locale string false none Locale of the generated document.
outputFormat string true none File format of the generated document.
templateId string true none Unique identifier of the template used for the document outline.

Enumerated Values

Property Value
documentType AUTOPILOT_SUMMARY
documentType DEPLOYMENT_REPORT
documentType MODEL_COMPLIANCE
locale EN_US
locale JA_JP
outputFormat docx
outputFormat html

AutomatedDocListResponse

{
  "count": 0,
  "data": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "docTypeSpecificInfo": {
        "endDate": "2019-08-24T14:15:22Z",
        "modelName": "string",
        "startDate": "2019-08-24T14:15:22Z"
      },
      "documentType": "AUTOPILOT_SUMMARY",
      "entityId": "string",
      "id": "string",
      "locale": "EN_US",
      "outputFormat": "docx",
      "templateId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

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

AutomatedDocOptions

{
  "documentType": "AUTOPILOT_SUMMARY",
  "locale": "EN_US"
}

Properties

Name Type Required Restrictions Description
documentType string true none Type of document available for generation.
locale string true none Locale available for the document generation.

Enumerated Values

Property Value
documentType AUTOPILOT_SUMMARY
documentType DEPLOYMENT_REPORT
documentType MODEL_COMPLIANCE
locale EN_US
locale JA_JP

AutomatedDocOptionsResponse

{
  "data": [
    {
      "documentType": "AUTOPILOT_SUMMARY",
      "locale": "EN_US"
    }
  ]
}

Properties

Name Type Required Restrictions Description
data [AutomatedDocOptions] true none List of document types available for generation.

ComplianceDocTemplateCreate

{
  "labels": [
    "string"
  ],
  "name": "string",
  "projectType": "timeSeries",
  "sections": [
    {
      "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
      "description": "string",
      "instructions": {
        "owner": "string",
        "user": "string"
      },
      "locked": true,
      "sections": [
        {}
      ],
      "title": "string",
      "type": "datarobot"
    }
  ]
}

Properties

Name Type Required Restrictions Description
labels [string] false none Names of the labels to assign to the template.
name string true none Name of the new template. Must be unique among templates created by the user.
projectType string false none Type of project template.
sections [oneOf] true none List of section objects representing the structure of the document. Each section can have sub-sections that have the same schema as the parent section, i.e., the structure is recursive. The number of nested sections allowed is 5. The total number of sections allowed is 500.

oneOf

Name Type Required Restrictions Description
» anonymous SectionDataRobot false none none

xor

Name Type Required Restrictions Description
» anonymous SectionUser false none none

xor

Name Type Required Restrictions Description
» anonymous SectionCustom false none none

xor

Name Type Required Restrictions Description
» anonymous SectionTableOfContents false none none

Enumerated Values

Property Value
projectType timeSeries
projectType autoMl

ComplianceDocTemplateCreateResponse

{
  "dateModified": "2019-08-24T14:15:22Z",
  "id": "string"
}

Properties

Name Type Required Restrictions Description
dateModified string(date-time) true none Timestamp of the created template
id string true none Created template Id

ComplianceDocTemplateDefaultRetrieveResponse

{
  "sections": [
    {
      "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
      "description": "string",
      "instructions": {
        "owner": "string",
        "user": "string"
      },
      "locked": true,
      "sections": [
        {}
      ],
      "title": "string",
      "type": "datarobot"
    }
  ]
}

Properties

Name Type Required Restrictions Description
sections [oneOf] true none List of section objects representing the structure of the document. Each section can have sub-sections that have the same schema as the parent section, i.e., the structure is recursive. The number of nested sections allowed is 5. The total number of sections allowed is 500.

oneOf

Name Type Required Restrictions Description
» anonymous SectionDataRobot false none none

xor

Name Type Required Restrictions Description
» anonymous SectionUser false none none

xor

Name Type Required Restrictions Description
» anonymous SectionCustom false none none

xor

Name Type Required Restrictions Description
» anonymous SectionTableOfContents false none none

ComplianceDocTemplateListResponse

{
  "count": 0,
  "data": [
    {
      "creatorId": "string",
      "creatorUsername": "string",
      "dateModified": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "instructions": "string",
      "labels": [
        "string"
      ],
      "name": "string",
      "orgId": "string",
      "permissions": {
        "CAN_DELETE_TEMPLATE": true,
        "CAN_EDIT_TEMPLATE": true,
        "CAN_SHARE": true,
        "CAN_USE_TEMPLATE": true,
        "CAN_VIEW": true
      },
      "projectType": "timeSeries",
      "sections": [
        {
          "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
          "description": "string",
          "instructions": {
            "owner": "string",
            "user": "string"
          },
          "locked": true,
          "sections": [
            {}
          ],
          "title": "string",
          "type": "datarobot"
        }
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true none Number of items returned on this page.
data [TemplateResponse] true none List of templates.
next string(uri)¦null true none URL pointing to the previous page. If null, there is no next page.
previous string(uri)¦null true none URL pointing to the previous page. If null, there is no previous page.
totalCount integer true none Total number of templates.

ComplianceDocTemplateUpdate

{
  "description": "string",
  "labels": [
    "string"
  ],
  "name": "string",
  "projectType": "timeSeries",
  "sections": [
    {
      "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
      "description": "string",
      "instructions": {
        "owner": "string",
        "user": "string"
      },
      "locked": true,
      "sections": [
        {}
      ],
      "title": "string",
      "type": "datarobot"
    }
  ]
}

Properties

Name Type Required Restrictions Description
description string false none New description for the template.
labels [string] false none Names of the labels to assign to the template.
name string false none New name for the template. Must be unique among templates created by the user.
projectType string false none Type of project template.
sections [oneOf] false none List of section objects representing the structure of the document. Each section can have sub-sections that have the same schema as the parent section, i.e., the structure is recursive. The number of nested sections allowed is 5. The total number of sections allowed is 500.

oneOf

Name Type Required Restrictions Description
» anonymous SectionDataRobot false none none

xor

Name Type Required Restrictions Description
» anonymous SectionUser false none none

xor

Name Type Required Restrictions Description
» anonymous SectionCustom false none none

xor

Name Type Required Restrictions Description
» anonymous SectionTableOfContents false none none

Enumerated Values

Property Value
projectType timeSeries
projectType autoMl

DocTypeSpecificInfo

{
  "endDate": "2019-08-24T14:15:22Z",
  "modelName": "string",
  "startDate": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
endDate string(date-time) true none End date of selected data in the document.
modelName string false none Name of the deployed model.
startDate string(date-time) true none Start date of selected data in the document.

Empty

{}

Properties

None

GrantAccessControlWithId

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

Properties

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

Enumerated Values

Property Value
shareRecipientType user
shareRecipientType group
shareRecipientType organization

GrantAccessControlWithUsername

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

Properties

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

Enumerated Values

Property Value
shareRecipientType user
shareRecipientType group
shareRecipientType organization

InstructionsField

{
  "owner": "string",
  "user": "string"
}

Properties

Name Type Required Restrictions Description
owner string true none Instructions owner
user string true none Instructions user

ModelComplianceDocsInitializationsResponse

{
  "initialized": true,
  "status": "initialized"
}

Properties

Name Type Required Restrictions Description
initialized boolean true none Whether compliance documentation pre-preprocessing is initialized for the model
status string true none Compliance documentation pre-processing initialization status

Enumerated Values

Property Value
status initialized
status initializationInProgress
status notRequested
status noTrainingData
status trainingDataAssignmentInProgress
status initializationError

SampleSection

{}

Properties

None

SectionCustom

{
  "description": "string",
  "highlightedText": "string",
  "instructions": {
    "owner": "string",
    "user": "string"
  },
  "locked": true,
  "regularText": "string",
  "sections": [
    {}
  ],
  "title": "string",
  "type": "custom"
}

Properties

Name Type Required Restrictions Description
description string¦null false none Section description
highlightedText string true none Highlighted text of the section, optionally separated by \n to split paragraphs.
instructions InstructionsField false none Section instructions
locked boolean false none Locked section flag
regularText string true none Regular text of the section, optionally separated by \n to split paragraphs.
sections [SampleSection]¦null false none List of section objects representing the structure of the document. Each section can have sub-sections that have the same schema as the parent section, e.g. the structure is recursive. The limit of nesting sections is 5. Total number of sections is limited to 500.
title string true none Section Title
type string true none Section with user-defined content. It can be a section title or summary.

Enumerated Values

Property Value
type custom

SectionDataRobot

{
  "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
  "description": "string",
  "instructions": {
    "owner": "string",
    "user": "string"
  },
  "locked": true,
  "sections": [
    {}
  ],
  "title": "string",
  "type": "datarobot"
}

Properties

Name Type Required Restrictions Description
contentId string true none The identifier of the content in the section. This attribute identifies what is going to be rendered in the section.
description string¦null false none Section description
instructions InstructionsField false none Section instructions
locked boolean false none Locked section flag
sections [SampleSection]¦null false none List of section objects representing the structure of the document. Each section can have sub-sections that have the same schema as the parent section, e.g. the structure is recursive. The limit of nesting sections is 5. Total number of sections is limited to 500.
title string true none Section Title
type string true none Section owned by DataRobot. The content of this section type is controlled by DataRobot (see contentId attribute). Users can add sub-sections to it.

Enumerated Values

Property Value
contentId MODEL_DESCRIPTION_AND_OVERVIEW
contentId MODEL_DESCRIPTION_AND_OVERVIEW_EXTERNAL_PREDICTION
contentId OVERVIEW_OF_MODEL_RESULTS
contentId MODEL_DEVELOPMENT_OVERVIEW_SUB
contentId TS_MODEL_DEVELOPMENT_OVERVIEW_SUB
contentId AD_MODEL_DEVELOPMENT_OVERVIEW_SUB
contentId MODEL_DEVELOPMENT_OVERVIEW_SUB_EXTERNAL_PREDICTION
contentId MODEL_METHODOLOGY
contentId MODEL_METHODOLOGY_EXTERNAL_PREDICTION
contentId LITERATURE_REVIEW_AND_REFERENCES
contentId ALTERNATIVE_MODEL_FRAMEWORKS_AND_THEORIES_CONSIDERED
contentId PERSONALLY_IDENTIFIABLE_INFORMATION
contentId DATA_PARTITIONING_METHODOLOGY
contentId AD_DATA_PARTITIONING_METHODOLOGY
contentId TS_DATA_PARTITIONING_METHODOLOGY
contentId QUANTITATIVE_ANALYSIS
contentId FINAL_MODEL_VARIABLES
contentId VALIDATION_STABILITY
contentId MODEL_PERFORMANCE
contentId ACCURACY_LIFT_CHART
contentId MULTICLASS_ACCURACY_LIFT_CHART
contentId SENSITIVITY_ANALYSIS
contentId AD_SENSITIVITY_ANALYSIS
contentId ACCURACY_OVER_TIME
contentId ANOMALY_OVER_TIME
contentId ACCURACY_ROC
contentId MULTICLASS_CONFUSION
contentId MODEL_VERSION_CONTROL
contentId CUSTOM_INFERENCE_VERSION_CONTROL
contentId FEATURE_ASSOCIATION_MATRIX
contentId BIAS_AND_FAIRNESS
contentId BIAS_AND_FAIRNESS_EXTERNAL_PREDICTION
contentId HOW_TO_USE
contentId PREFACE
contentId TS_MODEL_PERFORMANCE
contentId EXECUTIVE_SUMMARY_AND_MODEL_OVERVIEW
contentId MODEL_DATA_OVERVIEW
contentId MODEL_THEORETICAL_FRAMEWORK_AND_METHODOLOGY
contentId MODEL_PERFORMANCE_AND_STABILITY
contentId CUSTOM_INFERENCE_PERFORMANCE_AND_STABILITY
contentId SENSITIVITY_TESTING_AND_ANALYSIS
contentId MODEL_IMPLEMENTATION_AND_OUTPUT_REPORTING
contentId MODEL_STAKEHOLDERS
contentId MODEL_DEVELOPMENT_PURPOSE_AND_INTENDED_USE
contentId MODEL_INTERDEPENDENCIES
contentId DATA_SOURCE_OVERVIEW_AND_APPROPRIATENESS
contentId INPUT_DATA_EXTRACTION_PREPARATION
contentId DATA_ASSUMPTIONS
contentId CUSTOM_INFERENCE_MODELING_FEATURES
contentId MODEL_ASSUMPTIONS
contentId VARIABLE_SELECTION
contentId VARIABLE_SELECTION_EXTERNAL_PREDICTION
contentId TS_VARIABLE_SELECTION
contentId EXPERT_JUDGEMENT_AND_VAR_SELECTION
contentId KEY_RELATIONSHIPS
contentId AD_KEY_RELATIONSHIPS
type datarobot

SectionTableOfContents

{
  "locked": true,
  "title": "string",
  "type": "table_of_contents"
}

Properties

Name Type Required Restrictions Description
locked boolean false none Locked section flag
title string true none Section Title
type string true none Table of contents. This section has no additional attributes.

Enumerated Values

Property Value
type table_of_contents

SectionUser

{
  "description": "string",
  "highlightedText": "string",
  "instructions": {
    "owner": "string",
    "user": "string"
  },
  "locked": true,
  "regularText": "string",
  "sections": [
    {}
  ],
  "title": "string",
  "type": "user"
}

Properties

Name Type Required Restrictions Description
description string¦null false none Section description
highlightedText string true none Highlighted text of the section, optionally separated by \n to split paragraphs.
instructions InstructionsField false none Section instructions
locked boolean false none Locked section flag
regularText string true none Regular text of the section, optionally separated by \n to split paragraphs.
sections [SampleSection]¦null false none List of section objects representing the structure of the document. Each section can have sub-sections that have the same schema as the parent section, e.g. the structure is recursive. The limit of nesting sections is 5. Total number of sections is limited to 500.
title string true none Section Title
type string true none Section with user-defined content. Those sections may contain text generated by the user.

Enumerated Values

Property Value
type user

SharedRolesUpdate

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

Properties

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

oneOf

Name Type Required Restrictions Description
» anonymous GrantAccessControlWithUsername false none none

xor

Name Type Required Restrictions Description
» anonymous GrantAccessControlWithId false none none

Enumerated Values

Property Value
operation updateRoles

SharingListV2Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "DATA_SCIENTIST",
      "shareRecipientType": "user"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true none The number of items returned.
data [AccessControlV2] true none The access control list.
next string¦null true none URL pointing to the next page.
previous string¦null true none URL pointing to the previous page.
totalCount integer true none Total number of items matching the condition.

TemplatePermissionsResponse

{
  "CAN_DELETE_TEMPLATE": true,
  "CAN_EDIT_TEMPLATE": true,
  "CAN_SHARE": true,
  "CAN_USE_TEMPLATE": true,
  "CAN_VIEW": true
}

Properties

Name Type Required Restrictions Description
CAN_DELETE_TEMPLATE boolean true none Whether the current user can delete this template
CAN_EDIT_TEMPLATE boolean true none Whether the current user can edit this template
CAN_SHARE boolean true none Whether the current user can share this template
CAN_USE_TEMPLATE boolean true none Whether the current user can generate documents with this template
CAN_VIEW boolean true none Whether the current user can view this template

TemplateResponse

{
  "creatorId": "string",
  "creatorUsername": "string",
  "dateModified": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "string",
  "instructions": "string",
  "labels": [
    "string"
  ],
  "name": "string",
  "orgId": "string",
  "permissions": {
    "CAN_DELETE_TEMPLATE": true,
    "CAN_EDIT_TEMPLATE": true,
    "CAN_SHARE": true,
    "CAN_USE_TEMPLATE": true,
    "CAN_VIEW": true
  },
  "projectType": "timeSeries",
  "sections": [
    {
      "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
      "description": "string",
      "instructions": {
        "owner": "string",
        "user": "string"
      },
      "locked": true,
      "sections": [
        {}
      ],
      "title": "string",
      "type": "datarobot"
    }
  ]
}

Properties

Name Type Required Restrictions Description
creatorId string true none The ID of the user who created the template
creatorUsername string true none The username of the user who created the template
dateModified string(date-time)¦null true none Last date/time of template modification.
description string¦null true none An overview of the template
id string true none The ID of the template accessible by the user
instructions string¦null true none Currently always returns null. Maintained as a placeholder for future functionality.
labels [string]¦null true none User-added filtering labels for the template
name string true none The name of the template
orgId string true none The ID of the organization the user who created the template belongs to
permissions TemplatePermissionsResponse true none The level of permissions for the user viewing this template.
projectType string¦null true none Type of project template.
sections [oneOf] true none List of section objects representing the structure of the document. Each section can have sub-sections that have the same schema as the parent section, i.e., the structure is recursive. The number of nested sections allowed is 5. The total number of sections allowed is 500.

oneOf

Name Type Required Restrictions Description
» anonymous SectionDataRobot false none none

xor

Name Type Required Restrictions Description
» anonymous SectionUser false none none

xor

Name Type Required Restrictions Description
» anonymous SectionCustom false none none

xor

Name Type Required Restrictions Description
» anonymous SectionTableOfContents false none none

Enumerated Values

Property Value
projectType timeSeries
projectType autoMl

Updated June 28, 2022
Back to top