# You can also use wget
curl -X GET http://10.97.88.31/api/v2/automatedDocumentOptions/ \
-H 'Accept: application/json'\
-H 'Authorization: Bearer {access-token}'
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:
# You can also use wget
curl -X GET http://10.97.88.31/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.
Request generation of an automated document that's available for your account. Below is an
example request body to generate Model Compliance documentation:
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.
# You can also use wget
curl -X POST http://10.97.88.31/api/v2/automatedDocuments/ \
-H 'Content-Type: application/json'\
-H 'Authorization: Bearer {access-token}'
# You can also use wget
curl -X GET http://10.97.88.31/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.
Create a new compliance documentation template. One can retrieve the default DataRobot template via GET /api/v2/complianceDocTemplates/default/ endpoint.
# You can also use wget
curl -X POST http://10.97.88.31/api/v2/complianceDocTemplates/ \
-H 'Content-Type: application/json'\
-H 'Accept: application/json'\
-H 'Authorization: Bearer {access-token}'
# You can also use wget
curl -X GET http://10.97.88.31/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.
# You can also use wget
curl -X GET http://10.97.88.31/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
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.
# You can also use wget
curl -X PATCH http://10.97.88.31/api/v2/complianceDocTemplates/{templateId}/ \
-H 'Content-Type: application/json'\
-H 'Authorization: Bearer {access-token}'
# You can also use wget
curl -X GET http://10.97.88.31/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.
# You can also use wget
curl -X PATCH http://10.97.88.31/api/v2/complianceDocTemplates/{templateId}/sharedRoles/ \
-H 'Content-Type: application/json'\
-H 'Authorization: Bearer {access-token}'
# You can also use wget
curl -X GET http://10.97.88.31/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.
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.
# You can also use wget
curl -X POST http://10.97.88.31/api/v2/modelComplianceDocsInitializations/{entityId}/ \
-H 'Content-Type: application/json'\
-H 'Authorization: Bearer {access-token}'
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
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
Provide a model ID to generate a report for a previously deployed model.
start
string(date-time)¦null
false
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.
Name of the new template. Must be unique among templates created by the user.
projectType
string
false
Type of project template.
sections
[oneOf]
true
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.
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.
New name for the template. Must be unique among templates created by the user.
projectType
string
false
Type of project template.
sections
[oneOf]
false
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.
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
maxLength: 500
Section Title
type
string
true
Section with user-defined content. It can be a section title or summary.
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
maxLength: 500
Section Title
type
string
true
Section owned by DataRobot. The content of this section type is controlled by DataRobot (see contentId attribute). Users can add sub-sections to it.
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
maxLength: 500
Section Title
type
string
true
Section with user-defined content. Those sections may contain text generated by the user.
The level of permissions for the user viewing this template.
projectType
string¦null
true
Type of project template.
sections
[oneOf]
true
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.
