DataRobot APIのリソース > APIリファレンスドキュメント > DataRobot REST API > Secure and govern > Notifications

Notifications¶

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

POST /api/v2/entityNotificationChannels/¶

Create a new entity notification channel.

Code samples¶

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

Body parameter¶

{
  "channelType": "DataRobotCustomJob",
  "contentType": "application/json",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "drEntities": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "emailAddress": "string",
  "languageCode": "en",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "relatedEntityId": "string",
  "relatedEntityType": "deployment",
  "secretToken": "string",
  "validateSsl": true,
  "verificationCode": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	EntityNotificationChannelCreate	false	none

Example responses¶

{
  "channelType": "DataRobotCustomJob",
  "contentType": "application/json",
  "createdAt": "2019-08-24T14:15:22Z",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "drEntities": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "emailAddress": "string",
  "id": "string",
  "languageCode": "en",
  "lastNotificationAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "policyCount": 0,
  "relatedEntityId": "string",
  "relatedEntityType": "deployment",
  "secretToken": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "validateSsl": true
}

Responses¶

Status	Meaning	Description	Schema
201	Created	Entity notification channel created successfully.	EntityNotificationChannelResponse

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

BearerAuth

GET /api/v2/entityNotificationChannels/{relatedEntityType}/{relatedEntityId}/¶

List the notification channels related to the entity according to the query.

Code samples¶

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

Parameters

Name	In	Type	Required	Description
offset	query	integer	true	How many notification channels to skip.
limit	query	integer	true	At most this many notification channels to return.
namePart	query	string	false	Only return the notification channels whose names contain the given substring.
relatedEntityId	path	string	true	The id of related entity.
relatedEntityType	path	string	true	Type of related entity.

Enumerated Values¶

Parameter	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

Example responses¶

{
  "count": 0,
  "data": [
    {
      "channelType": "DataRobotCustomJob",
      "contentType": "application/json",
      "createdAt": "2019-08-24T14:15:22Z",
      "customHeaders": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "drEntities": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "emailAddress": "string",
      "id": "string",
      "languageCode": "en",
      "lastNotificationAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "orgId": "string",
      "payloadUrl": "http://example.com",
      "policyCount": 0,
      "relatedEntityId": "string",
      "relatedEntityType": "deployment",
      "secretToken": "string",
      "uid": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "validateSsl": true
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Entity notification channels listed successfully.	EntityNotificationChannelsListResponse

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

BearerAuth

DELETE /api/v2/entityNotificationChannels/{relatedEntityType}/{relatedEntityId}/{channelId}/¶

Delete the entity notification channel.

Code samples¶

curl -X DELETE https://app.datarobot.com/api/v2/entityNotificationChannels/{relatedEntityType}/{relatedEntityId}/{channelId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
channelId	path	string	true	The id of the entity notification channel.
relatedEntityId	path	string	true	The id of related entity.
relatedEntityType	path	string	true	Type of related entity.

Enumerated Values¶

Parameter	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

Responses¶

Status	Meaning	Description	Schema
204	No Content	Entity otification channel deleted successfully.	None

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

BearerAuth

GET /api/v2/entityNotificationChannels/{relatedEntityType}/{relatedEntityId}/{channelId}/¶

Retrieve the entity notification channel.

Code samples¶

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

Parameters

Name	In	Type	Required	Description
channelId	path	string	true	The id of the entity notification channel.
relatedEntityId	path	string	true	The id of related entity.
relatedEntityType	path	string	true	Type of related entity.

Enumerated Values¶

Parameter	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

Example responses¶

{
  "channelType": "DataRobotCustomJob",
  "contentType": "application/json",
  "createdAt": "2019-08-24T14:15:22Z",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "drEntities": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "emailAddress": "string",
  "id": "string",
  "languageCode": "en",
  "lastNotificationAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "policyCount": 0,
  "relatedEntityId": "string",
  "relatedEntityType": "deployment",
  "secretToken": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "validateSsl": true
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Entity notification channel retrieved successfully.	EntityNotificationChannelResponse

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

BearerAuth

PUT /api/v2/entityNotificationChannels/{relatedEntityType}/{relatedEntityId}/{channelId}/¶

Update the entity notification channel.

Code samples¶

curl -X PUT https://app.datarobot.com/api/v2/entityNotificationChannels/{relatedEntityType}/{relatedEntityId}/{channelId}/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶

{
  "channelType": "DataRobotCustomJob",
  "contentType": "application/json",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "drEntities": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "emailAddress": "string",
  "languageCode": "en",
  "name": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true,
  "verificationCode": "string"
}

Parameters

Name	In	Type	Required	Description
channelId	path	string	true	The id of the entity notification channel.
relatedEntityId	path	string	true	The id of related entity.
relatedEntityType	path	string	true	Type of related entity.
body	body	NotificationChannelWithDREntityUpdate	false	none

Enumerated Values¶

Parameter	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

Responses¶

Status	Meaning	Description	Schema
204	No Content	Entity notification channel updated successfully.	None
400	Bad Request	Email verification code is invalid.	None

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

BearerAuth

POST /api/v2/entityNotificationPolicies/¶

Create a new entity notification policy.

Code samples¶

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

Body parameter¶

{
  "active": true,
  "channelId": "string",
  "channelScope": "organization",
  "eventGroup": "secure_config.all",
  "eventType": "secure_config.created",
  "maximalFrequency": "string",
  "name": "string",
  "orgId": "string",
  "relatedEntityId": "string",
  "relatedEntityType": "deployment"
}

Parameters

Name	In	Type	Required	Description
body	body	EntityNotificationPolicyCreate	false	none

Example responses¶

{
  "active": true,
  "channel": {
    "channelType": "DataRobotCustomJob",
    "contentType": "application/json",
    "createdAt": "2019-08-24T14:15:22Z",
    "customHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "drEntities": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "emailAddress": "string",
    "id": "string",
    "languageCode": "en",
    "name": "string",
    "orgId": "string",
    "payloadUrl": "http://example.com",
    "relatedEntityId": "string",
    "relatedEntityType": "deployment",
    "secretToken": "string",
    "uid": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "validateSsl": true
  },
  "channelId": "string",
  "channelScope": "organization",
  "created": "2019-08-24T14:15:22Z",
  "eventGroup": {
    "events": [
      {
        "id": "string",
        "label": "string"
      }
    ],
    "id": "string",
    "label": "string"
  },
  "eventType": {
    "id": "string",
    "label": "string"
  },
  "id": "string",
  "lastTriggered": "2019-08-24T14:15:22Z",
  "maximalFrequency": "string",
  "name": "string",
  "orgId": "string",
  "relatedEntityId": "string",
  "relatedEntityType": "deployment",
  "templateId": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Responses¶

Status	Meaning	Description	Schema
201	Created	Entity notification policy created successfully.	EntityNotificationPolicyResponse

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

BearerAuth

GET /api/v2/entityNotificationPolicies/{relatedEntityType}/{relatedEntityId}/¶

List the entity notification policies that satisfy the query condition.

Code samples¶

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

Parameters

Name	In	Type	Required	Description
offset	query	integer	true	How many notification channels to skip.
limit	query	integer	true	At most this many notification channels to return.
channelId	query	string	false	Return policies with this channel.
namePart	query	string	false	Only return the notification channels whose names contain the given substring.
eventGroup	query	string	false	Return policies with this event group.
channelScope	query	string	false	Scope of the channel.
relatedEntityId	path	string	true	The id of related entity.
relatedEntityType	path	string	true	Type of related entity.

Enumerated Values¶

Parameter	Value
eventGroup	[`secure_config.all`, `comment.all`, `dataset.all`, `deployment_prediction_explanations_computation.all`, `model_deployments.critical_health`, `model_deployments.critical_frequent_health_change`, `model_deployments.frequent_health_change`, `model_deployments.health`, `inference_endpoints.health`, `model_deployments.management_agent`, `model_deployments.management_agent_health`, `prediction_request.all`, `challenger_management.all`, `challenger_replay.all`, `model_deployments.all`, `project.all`, `perma_delete_project.all`, `users_delete.all`, `applications.all`, `model_version.stage_transitions`, `model_version.all`, `batch_predictions.all`, `change_requests.all`, `insights_computation.all`, `notebook_schedule.all`, `monitoring.all`]
channelScope	[`organization`, `Organization`, `ORGANIZATION`, `entity`, `Entity`, `ENTITY`, `template`, `Template`, `TEMPLATE`]
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

Example responses¶

{
  "count": 0,
  "data": [
    {
      "active": true,
      "channel": {
        "channelType": "DataRobotCustomJob",
        "contentType": "application/json",
        "createdAt": "2019-08-24T14:15:22Z",
        "customHeaders": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "drEntities": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "emailAddress": "string",
        "id": "string",
        "languageCode": "en",
        "name": "string",
        "orgId": "string",
        "payloadUrl": "http://example.com",
        "relatedEntityId": "string",
        "relatedEntityType": "deployment",
        "secretToken": "string",
        "uid": "string",
        "updatedAt": "2019-08-24T14:15:22Z",
        "validateSsl": true
      },
      "channelId": "string",
      "channelScope": "organization",
      "created": "2019-08-24T14:15:22Z",
      "eventGroup": {
        "events": [
          {
            "id": "string",
            "label": "string"
          }
        ],
        "id": "string",
        "label": "string"
      },
      "eventType": {
        "id": "string",
        "label": "string"
      },
      "id": "string",
      "lastTriggered": "2019-08-24T14:15:22Z",
      "maximalFrequency": "string",
      "name": "string",
      "orgId": "string",
      "relatedEntityId": "string",
      "relatedEntityType": "deployment",
      "templateId": "string",
      "uid": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Entity notification policies listed successfully.	EntityNotificationPoliciesListResponse

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

BearerAuth

DELETE /api/v2/entityNotificationPolicies/{relatedEntityType}/{relatedEntityId}/{policyId}/¶

Delete the entity notification policy.

Code samples¶

curl -X DELETE https://app.datarobot.com/api/v2/entityNotificationPolicies/{relatedEntityType}/{relatedEntityId}/{policyId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
policyId	path	string	true	The id of the notification policy
relatedEntityId	path	string	true	The id of related entity.
relatedEntityType	path	string	true	Type of related entity.

Enumerated Values¶

Parameter	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

Responses¶

Status	Meaning	Description	Schema
204	No Content	Entity notification policy deleted successfully.	None

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

BearerAuth

GET /api/v2/entityNotificationPolicies/{relatedEntityType}/{relatedEntityId}/{policyId}/¶

Retrieve the entity notification policy.

Code samples¶

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

Parameters

Name	In	Type	Required	Description
policyId	path	string	true	The id of the notification policy
relatedEntityId	path	string	true	The id of related entity.
relatedEntityType	path	string	true	Type of related entity.

Enumerated Values¶

Parameter	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

Example responses¶

{
  "active": true,
  "channel": {
    "channelType": "DataRobotCustomJob",
    "contentType": "application/json",
    "createdAt": "2019-08-24T14:15:22Z",
    "customHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "drEntities": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "emailAddress": "string",
    "id": "string",
    "languageCode": "en",
    "name": "string",
    "orgId": "string",
    "payloadUrl": "http://example.com",
    "relatedEntityId": "string",
    "relatedEntityType": "deployment",
    "secretToken": "string",
    "uid": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "validateSsl": true
  },
  "channelId": "string",
  "channelScope": "organization",
  "created": "2019-08-24T14:15:22Z",
  "eventGroup": {
    "events": [
      {
        "id": "string",
        "label": "string"
      }
    ],
    "id": "string",
    "label": "string"
  },
  "eventType": {
    "id": "string",
    "label": "string"
  },
  "id": "string",
  "lastTriggered": "2019-08-24T14:15:22Z",
  "maximalFrequency": "string",
  "name": "string",
  "orgId": "string",
  "relatedEntityId": "string",
  "relatedEntityType": "deployment",
  "templateId": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Entity notification policy retrieved successfully.	EntityNotificationPolicyResponse

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

BearerAuth

PUT /api/v2/entityNotificationPolicies/{relatedEntityType}/{relatedEntityId}/{policyId}/¶

Update the entity notification policy.

Code samples¶

curl -X PUT https://app.datarobot.com/api/v2/entityNotificationPolicies/{relatedEntityType}/{relatedEntityId}/{policyId}/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶

{
  "active": true,
  "channelId": "string",
  "channelScope": "organization",
  "eventGroup": "secure_config.all",
  "eventType": "secure_config.created",
  "maximalFrequency": "string",
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
policyId	path	string	true	The id of the notification policy
relatedEntityId	path	string	true	The id of related entity.
relatedEntityType	path	string	true	Type of related entity.
body	body	EntityNotificationPolicyUpdate	false	none

Enumerated Values¶

Parameter	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

Responses¶

Status	Meaning	Description	Schema
204	No Content	Entity notification policy updated successfully.	None

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

BearerAuth

POST /api/v2/entityNotificationPoliciesFromTemplate/¶

Create a new entity notification policy from template.

Code samples¶

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

Body parameter¶

{
  "active": true,
  "name": "string",
  "relatedEntityId": "string",
  "relatedEntityType": "deployment",
  "templateId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	EntityNotificationPolicyCreateFromTemplate	false	none

Example responses¶

{
  "active": true,
  "channel": {
    "channelType": "DataRobotCustomJob",
    "contentType": "application/json",
    "createdAt": "2019-08-24T14:15:22Z",
    "customHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "drEntities": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "emailAddress": "string",
    "id": "string",
    "languageCode": "en",
    "name": "string",
    "orgId": "string",
    "payloadUrl": "http://example.com",
    "relatedEntityId": "string",
    "relatedEntityType": "deployment",
    "secretToken": "string",
    "uid": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "validateSsl": true
  },
  "channelId": "string",
  "channelScope": "organization",
  "created": "2019-08-24T14:15:22Z",
  "eventGroup": {
    "events": [
      {
        "id": "string",
        "label": "string"
      }
    ],
    "id": "string",
    "label": "string"
  },
  "eventType": {
    "id": "string",
    "label": "string"
  },
  "id": "string",
  "lastTriggered": "2019-08-24T14:15:22Z",
  "maximalFrequency": "string",
  "name": "string",
  "orgId": "string",
  "relatedEntityId": "string",
  "relatedEntityType": "deployment",
  "templateId": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Responses¶

Status	Meaning	Description	Schema
201	Created	Entity notification policy created successfully.	EntityNotificationPolicyResponse

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

BearerAuth

POST /api/v2/entityNotificationPolicyTemplates/¶

Create a new entity notification policy template.

Code samples¶

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

Body parameter¶

{
  "active": true,
  "channelId": "string",
  "eventGroup": "secure_config.all",
  "eventType": "secure_config.created",
  "maximalFrequency": "string",
  "name": "string",
  "orgId": "string",
  "relatedEntityType": "deployment"
}

Parameters

Name	In	Type	Required	Description
body	body	EntityNotificationPolicyTemplateCreate	false	none

Example responses¶

{
  "active": true,
  "channel": {
    "channelType": "DataRobotCustomJob",
    "contentType": "application/json",
    "createdAt": "2019-08-24T14:15:22Z",
    "customHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "drEntities": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "emailAddress": "string",
    "id": "string",
    "languageCode": "en",
    "name": "string",
    "orgId": "string",
    "payloadUrl": "http://example.com",
    "relatedEntityId": "string",
    "relatedEntityType": "deployment",
    "secretToken": "string",
    "uid": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "validateSsl": true
  },
  "channelId": "string",
  "channelScope": "organization",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": {
    "firstName": "string",
    "lastName": "string",
    "username": "string"
  },
  "eventGroup": {
    "events": [
      {
        "id": "string",
        "label": "string"
      }
    ],
    "id": "string",
    "label": "string"
  },
  "eventType": {
    "id": "string",
    "label": "string"
  },
  "id": "string",
  "lastTriggered": "2019-08-24T14:15:22Z",
  "maximalFrequency": "string",
  "name": "string",
  "orgId": "string",
  "relatedEntityType": "deployment",
  "relatedPoliciesCount": 0,
  "role": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Responses¶

Status	Meaning	Description	Schema
201	Created	Entity notification policy template created successfully.	EntityNotificationPolicyTemplateResponse

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

BearerAuth

GET /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/¶

List the entity notification policies templates that satisfy the query condition.

Code samples¶

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

Parameters

Name	In	Type	Required	Description
offset	query	integer	true	How many notification channels to skip.
limit	query	integer	true	At most this many notification channels to return.
channelId	query	string	false	Return policies with this channel.
namePart	query	string	false	Only return the notification channels whose names contain the given substring.
eventGroup	query	string	false	Return policies with this event group.
relatedEntityType	path	string	true	Type of related entity.

Enumerated Values¶

Parameter Value

eventGroup [secure_config.all, comment.all, dataset.all, deployment_prediction_explanations_computation.all, model_deployments.critical_health, model_deployments.critical_frequent_health_change, model_deployments.frequent_health_change, model_deployments.health, inference_endpoints.health, model_deployments.management_agent, model_deployments.management_agent_health, prediction_request.all, challenger_management.all, challenger_replay.all, model_deployments.all, project.all, perma_delete_project.all, users_delete.all, applications.all, model_version.stage_transitions, model_version.all, batch_predictions.all, change_requests.all, insights_computation.all, notebook_schedule.all, monitoring.all]

relatedEntityType [deployment, Deployment, DEPLOYMENT]

Example responses¶

{
  "count": 0,
  "data": [
    {
      "active": true,
      "channel": {
        "channelType": "DataRobotCustomJob",
        "contentType": "application/json",
        "createdAt": "2019-08-24T14:15:22Z",
        "customHeaders": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "drEntities": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "emailAddress": "string",
        "id": "string",
        "languageCode": "en",
        "name": "string",
        "orgId": "string",
        "payloadUrl": "http://example.com",
        "relatedEntityId": "string",
        "relatedEntityType": "deployment",
        "secretToken": "string",
        "uid": "string",
        "updatedAt": "2019-08-24T14:15:22Z",
        "validateSsl": true
      },
      "channelId": "string",
      "channelScope": "organization",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": {
        "firstName": "string",
        "lastName": "string",
        "username": "string"
      },
      "eventGroup": {
        "events": [
          {
            "id": "string",
            "label": "string"
          }
        ],
        "id": "string",
        "label": "string"
      },
      "eventType": {
        "id": "string",
        "label": "string"
      },
      "id": "string",
      "lastTriggered": "2019-08-24T14:15:22Z",
      "maximalFrequency": "string",
      "name": "string",
      "orgId": "string",
      "relatedEntityType": "deployment",
      "relatedPoliciesCount": 0,
      "role": "string",
      "uid": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Entity notification policies templates listed successfully.	EntityNotificationPoliciesTemplatesListResponse

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

BearerAuth

DELETE /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/¶

Delete the entity notification policy template.

Code samples¶

curl -X DELETE https://app.datarobot.com/api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
policyId	path	string	true	The id of the notification policy template
relatedEntityType	path	string	true	Type of related entity.

Enumerated Values¶

Parameter	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

Responses¶

Status	Meaning	Description	Schema
204	No Content	Entity notification policy template deleted successfully.	None

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

BearerAuth

GET /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/¶

Retrieve the entity notification policy template.

Code samples¶

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

Parameters

Name	In	Type	Required	Description
policyId	path	string	true	The id of the notification policy template
relatedEntityType	path	string	true	Type of related entity.

Enumerated Values¶

Parameter	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

Example responses¶

{
  "active": true,
  "channel": {
    "channelType": "DataRobotCustomJob",
    "contentType": "application/json",
    "createdAt": "2019-08-24T14:15:22Z",
    "customHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "drEntities": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "emailAddress": "string",
    "id": "string",
    "languageCode": "en",
    "name": "string",
    "orgId": "string",
    "payloadUrl": "http://example.com",
    "relatedEntityId": "string",
    "relatedEntityType": "deployment",
    "secretToken": "string",
    "uid": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "validateSsl": true
  },
  "channelId": "string",
  "channelScope": "organization",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": {
    "firstName": "string",
    "lastName": "string",
    "username": "string"
  },
  "eventGroup": {
    "events": [
      {
        "id": "string",
        "label": "string"
      }
    ],
    "id": "string",
    "label": "string"
  },
  "eventType": {
    "id": "string",
    "label": "string"
  },
  "id": "string",
  "lastTriggered": "2019-08-24T14:15:22Z",
  "maximalFrequency": "string",
  "name": "string",
  "orgId": "string",
  "relatedEntityType": "deployment",
  "relatedPoliciesCount": 0,
  "role": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Entity notification policy template retrieved successfully.	EntityNotificationPolicyTemplateResponse

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

BearerAuth

PUT /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/¶

Update the entity notification policy template.

Code samples¶

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

Body parameter¶

{
  "active": true,
  "channelId": "string",
  "eventGroup": "secure_config.all",
  "eventType": "secure_config.created",
  "maximalFrequency": "string",
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
policyId	path	string	true	The id of the notification policy template
relatedEntityType	path	string	true	Type of related entity.
body	body	EntityNotificationPolicyTemplateUpdate	false	none

Enumerated Values¶

Parameter	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

Responses¶

Status	Meaning	Description	Schema
204	No Content	Entity notification policy template updated successfully.	None

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

BearerAuth

GET /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/relatedPolicies/¶

Retrieve list of all policies that are created from this template and are visible for user

Code samples¶

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

Parameters

Name	In	Type	Required	Description
offset	query	integer	true	How many notification channels to skip.
limit	query	integer	true	At most this many notification channels to return.
policyId	path	string	true	The id of the notification policy template
relatedEntityType	path	string	true	Type of related entity.

Enumerated Values¶

Parameter	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

Example responses¶

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "relatedEntityId": "string",
      "relatedEntityName": "string",
      "relatedEntityType": "deployment"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	List of all policies that are created from this template and are visible for user	EntityNotificationPolicyTemplateRelatedPoliciesListResponse

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

BearerAuth

GET /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/sharedRoles/¶

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

Code samples¶

curl -X GET https://app.datarobot.com/api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/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.
policyId	path	string	true	The id of the notification policy template
relatedEntityType	path	string	true	Type of related entity.

Enumerated Values¶

Parameter	Value
shareRecipientType	[`user`, `group`, `organization`]
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

Example responses¶

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

Responses¶

Status	Meaning	Description	Schema
200	OK	The registered model's access control list.	SharingListV2Response
404	Not Found	Either the Registered Model does not exist or the user does not have permissions to view the Registered Model.	None
422	Unprocessable Entity	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/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/sharedRoles/¶

Set roles for users on this registered model.

Code samples¶

curl -X PATCH https://app.datarobot.com/api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/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
policyId	path	string	true	The id of the notification policy template
relatedEntityType	path	string	true	Type of related entity.
body	body	SharedRolesUpdate	false	none

Enumerated Values¶

Parameter	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

Responses¶

Status	Meaning	Description	Schema
204	No Content	Roles updated successfully.	None
409	Conflict	The request would leave the registered model 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/notificationChannelTemplates/¶

List the notification channel template according to the query.

Code samples¶

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

Parameters

Name	In	Type	Required	Description
offset	query	integer	true	How many notification channels to skip.
limit	query	integer	true	At most this many notification channels to return.
namePart	query	string	false	Only return the notification channels whose names contain the given substring.

Example responses¶

{
  "count": 0,
  "data": [
    {
      "channelType": "DataRobotCustomJob",
      "contentType": "application/json",
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "firstName": "string",
        "lastName": "string",
        "username": "string"
      },
      "customHeaders": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "drEntities": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "emailAddress": "string",
      "id": "string",
      "languageCode": "en",
      "lastNotificationAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "orgId": "string",
      "payloadUrl": "http://example.com",
      "policyCount": 0,
      "policyTemplatesCount": 0,
      "role": "string",
      "secretToken": "string",
      "uid": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "validateSsl": true
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Notification channel templates listed successfully.	NotificationChannelTemplatesListResponse

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

BearerAuth

POST /api/v2/notificationChannelTemplates/¶

Create a new notification channel tempate.

Code samples¶

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

Body parameter¶

{
  "channelType": "DataRobotCustomJob",
  "contentType": "application/json",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "drEntities": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "emailAddress": "string",
  "languageCode": "en",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true,
  "verificationCode": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	NotificationChannelTemplateCreate	false	none

Example responses¶

{
  "channelType": "DataRobotCustomJob",
  "contentType": "application/json",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "firstName": "string",
    "lastName": "string",
    "username": "string"
  },
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "drEntities": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "emailAddress": "string",
  "id": "string",
  "languageCode": "en",
  "lastNotificationAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "policyCount": 0,
  "policyTemplatesCount": 0,
  "role": "string",
  "secretToken": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "validateSsl": true
}

Responses¶

Status	Meaning	Description	Schema
201	Created	Notification channel template created successfully.	NotificationChannelTemplateResponse

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

BearerAuth

DELETE /api/v2/notificationChannelTemplates/{channelId}/¶

Delete the notification channel template.

Code samples¶

curl -X DELETE https://app.datarobot.com/api/v2/notificationChannelTemplates/{channelId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
channelId	path	string	true	The id of the notification channel.

Responses¶

Status	Meaning	Description	Schema
204	No Content	Notification channel template deleted successfully.	None

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

BearerAuth

GET /api/v2/notificationChannelTemplates/{channelId}/¶

Retrieve the notification channel template.

Code samples¶

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

Parameters

Name	In	Type	Required	Description
channelId	path	string	true	The id of the notification channel.

Example responses¶

{
  "channelType": "DataRobotCustomJob",
  "contentType": "application/json",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "firstName": "string",
    "lastName": "string",
    "username": "string"
  },
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "drEntities": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "emailAddress": "string",
  "id": "string",
  "languageCode": "en",
  "lastNotificationAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "policyCount": 0,
  "policyTemplatesCount": 0,
  "role": "string",
  "secretToken": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "validateSsl": true
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Notification channel template retrieved successfully.	NotificationChannelTemplateResponse

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

BearerAuth

PUT /api/v2/notificationChannelTemplates/{channelId}/¶

Update the notification channel template.

Code samples¶

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

Body parameter¶

{
  "channelType": "DataRobotCustomJob",
  "contentType": "application/json",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "drEntities": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "emailAddress": "string",
  "languageCode": "en",
  "name": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true,
  "verificationCode": "string"
}

Parameters

Name	In	Type	Required	Description
channelId	path	string	true	The id of the notification channel.
body	body	NotificationChannelWithDREntityUpdate	false	none

Responses¶

Status	Meaning	Description	Schema
204	No Content	Notification channel template updated successfully.	None
400	Bad Request	Email verification code is invalid.	None

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

BearerAuth

GET /api/v2/notificationChannelTemplates/{channelId}/policyTemplates/¶

Retrieve list of all policy templates that are using this channel and are visible for user

Code samples¶

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

Parameters

Name	In	Type	Required	Description
offset	query	integer	true	How many notification channels to skip.
limit	query	integer	true	At most this many notification channels to return.
channelId	path	string	true	The id of the notification channel.

Example responses¶

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "relatedEntityType": "deployment"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	List of all policy templates that are using this channel and are visible for user	NotificationChannelTemplateRelatedPolicyTemplateListResponse

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

BearerAuth

GET /api/v2/notificationChannelTemplates/{channelId}/relatedPolicies/¶

Retrieve list of all policies that are created from this template and are visible for user

Code samples¶

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

Parameters

Name	In	Type	Required	Description
offset	query	integer	true	How many notification channels to skip.
limit	query	integer	true	At most this many notification channels to return.
channelId	path	string	true	The id of the notification channel.

Example responses¶

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "relatedEntityId": "string",
      "relatedEntityName": "string",
      "relatedEntityType": "deployment"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	List of all policies that are created from this template and are visible for user	NotificationChannelTemplateRelatedPoliciesListResponse

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

BearerAuth

GET /api/v2/notificationChannelTemplates/{channelId}/sharedRoles/¶

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

Code samples¶

curl -X GET https://app.datarobot.com/api/v2/notificationChannelTemplates/{channelId}/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.
channelId	path	string	true	The id of the notification channel.

Enumerated Values¶

Parameter	Value
shareRecipientType	[`user`, `group`, `organization`]

Example responses¶

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

Responses¶

Status	Meaning	Description	Schema
200	OK	The channel template's access control list.	SharingListV2Response
404	Not Found	Either the channel template does not exist or the user does not have permissions to view the channel template.	None
422	Unprocessable Entity	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/notificationChannelTemplates/{channelId}/sharedRoles/¶

Set roles for users on this channel template.

Code samples¶

curl -X PATCH https://app.datarobot.com/api/v2/notificationChannelTemplates/{channelId}/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
channelId	path	string	true	The id of the notification channel.
body	body	SharedRolesUpdate	false	none

Responses¶

Status	Meaning	Description	Schema
204	No Content	Roles updated successfully.	None
409	Conflict	The request would leave the channel 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/notificationChannels/¶

List the notification channels according to the query.

Code samples¶

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

Parameters

Name	In	Type	Required	Description
offset	query	integer	true	How many notification channels to skip.
limit	query	integer	true	At most this many notification channels to return.
namePart	query	string	false	Only return the notification channels whose names contain the given substring.

Example responses¶

{
  "count": 0,
  "data": [
    {
      "channelType": "Database",
      "contentType": "application/json",
      "createdAt": "2019-08-24T14:15:22Z",
      "customHeaders": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "emailAddress": "string",
      "id": "string",
      "languageCode": "en",
      "lastNotificationAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "orgId": "string",
      "payloadUrl": "http://example.com",
      "policyCount": 0,
      "secretToken": "string",
      "uid": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "validateSsl": true
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Notification channels listed successfully.	NotificationChannelsListResponse

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

BearerAuth

POST /api/v2/notificationChannels/¶

Create a new notification channel.

Code samples¶

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

Body parameter¶

{
  "channelType": "Database",
  "contentType": "application/json",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "languageCode": "en",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true,
  "verificationCode": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	NotificationChannelCreate	false	none

Example responses¶

{
  "channelType": "Database",
  "contentType": "application/json",
  "createdAt": "2019-08-24T14:15:22Z",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "id": "string",
  "languageCode": "en",
  "lastNotificationAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "policyCount": 0,
  "secretToken": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "validateSsl": true
}

Responses¶

Status	Meaning	Description	Schema
201	Created	Notification channel created successfully.	NotificationChannelResponse

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

BearerAuth

DELETE /api/v2/notificationChannels/{channelId}/¶

Delete the notification channel.

Code samples¶

curl -X DELETE https://app.datarobot.com/api/v2/notificationChannels/{channelId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
channelId	path	string	true	The id of the notification channel.

Responses¶

Status	Meaning	Description	Schema
204	No Content	Notification channel deleted successfully.	None

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

BearerAuth

GET /api/v2/notificationChannels/{channelId}/¶

Retrieve the notification channel.

Code samples¶

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

Parameters

Name	In	Type	Required	Description
channelId	path	string	true	The id of the notification channel.

Example responses¶

{
  "channelType": "Database",
  "contentType": "application/json",
  "createdAt": "2019-08-24T14:15:22Z",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "id": "string",
  "languageCode": "en",
  "lastNotificationAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "policyCount": 0,
  "secretToken": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "validateSsl": true
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Notification channel retrieved successfully.	NotificationChannelResponse

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

BearerAuth

PUT /api/v2/notificationChannels/{channelId}/¶

Update the notification channel.

Code samples¶

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

Body parameter¶

{
  "contentType": "application/json",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "languageCode": "en",
  "name": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true,
  "verificationCode": "string"
}

Parameters

Name	In	Type	Required	Description
channelId	path	string	true	The id of the notification channel.
body	body	NotificationChannelUpdate	false	none

Responses¶

Status	Meaning	Description	Schema
204	No Content	Notification channel updated successfully.	None
400	Bad Request	Email verification code is invalid.	None

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

BearerAuth

POST /api/v2/notificationEmailChannelVerification/¶

Sending a 6 digit verification code to user's email

Code samples¶

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

Body parameter¶

{
  "channelType": "string",
  "emailAddress": "string",
  "name": "string",
  "orgId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	NotificationEmailChannelVerification	false	none

Example responses¶

{
  "notificationId": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	NotificationEmailChannelVerificationResponse

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

BearerAuth

POST /api/v2/notificationEmailChannelVerificationStatus/¶

Retrieve the status of whether admin enter code correctly

Code samples¶

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

Body parameter¶

{
  "emailAddress": "string",
  "verificationCode": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	NotificationEmailChannelVerificationStatus	false	none

Example responses¶

{
  "status": true
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	NotificationEmailChannelVerificationStatusResponse

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

BearerAuth

GET /api/v2/notificationEvents/¶

List event types and groups the user can include in notification policies. Events and groups are filtered by user permissions and event properties. It is not a complete list of all defined events; instead, it is a list of the events available to the user.

Code samples¶

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

Parameters

Name	In	Type	Required	Description
relatedEntityType	query	string	false	Type of related entity.

Enumerated Values¶

Parameter	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

Example responses¶

{
  "eventGroups": [
    {
      "events": [
        "string"
      ],
      "id": "string",
      "label": "string",
      "requireMaxFrequency": true
    }
  ],
  "events": [
    {
      "id": "string",
      "label": "string",
      "requireMaxFrequency": true
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Event types and groups selectable for notification policies	NotificationEventListResponse

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

BearerAuth

GET /api/v2/notificationLogs/¶

List the notification logs that correspond to provided conditions. Default ordering is desc by notification log timestamp

Code samples¶

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

Parameters

Name	In	Type	Required	Description
offset	query	integer	true	The number of records to skip over. Default 0
limit	query	integer	true	The number of records to return. Default to 100, minimum to 1, maximum to 1000
policyId	query	string	false	The id of the policy to filter notification logs
channelId	query	string	false	The id of the channel to filter notification logs

Example responses¶

{
  "count": 0,
  "data": [
    {
      "channelId": "string",
      "channelScope": "organization",
      "emailSubject": "string",
      "id": "string",
      "parentNotificationId": "string",
      "policyId": "string",
      "request": {
        "body": "string",
        "headers": "string",
        "url": "http://example.com"
      },
      "response": {
        "body": "string",
        "duration": 0,
        "headers": "string",
        "statusCode": "string"
      },
      "retryCount": 0,
      "status": "string",
      "timestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	NotificationLogListResponse

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

BearerAuth

GET /api/v2/notificationPolicies/¶

List the notification policies that satisfy the query condition.

Code samples¶

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

Parameters

Name	In	Type	Required	Description
offset	query	integer	true	How many notification channels to skip.
limit	query	integer	true	At most this many notification channels to return.
channelId	query	string	false	Return policies with this channel.
namePart	query	string	false	Only return the notification channels whose names contain the given substring.
eventGroup	query	string	false	Return policies with this event group.

Enumerated Values¶

Parameter Value

eventGroup [secure_config.all, comment.all, dataset.all, deployment_prediction_explanations_computation.all, model_deployments.critical_health, model_deployments.critical_frequent_health_change, model_deployments.frequent_health_change, model_deployments.health, inference_endpoints.health, model_deployments.management_agent, model_deployments.management_agent_health, prediction_request.all, challenger_management.all, challenger_replay.all, model_deployments.all, project.all, perma_delete_project.all, users_delete.all, applications.all, model_version.stage_transitions, model_version.all, batch_predictions.all, change_requests.all, insights_computation.all, notebook_schedule.all, monitoring.all]

Example responses¶

{
  "count": 0,
  "data": [
    {
      "active": true,
      "channel": {
        "channelType": "Database",
        "contentType": "application/json",
        "createdAt": "2019-08-24T14:15:22Z",
        "customHeaders": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "emailAddress": "string",
        "id": "string",
        "languageCode": "en",
        "name": "string",
        "orgId": "string",
        "payloadUrl": "http://example.com",
        "secretToken": "string",
        "uid": "string",
        "updatedAt": "2019-08-24T14:15:22Z",
        "validateSsl": true
      },
      "channelId": "string",
      "created": "2019-08-24T14:15:22Z",
      "eventGroup": {
        "events": [
          {
            "id": "string",
            "label": "string"
          }
        ],
        "id": "string",
        "label": "string"
      },
      "eventType": {
        "id": "string",
        "label": "string"
      },
      "id": "string",
      "lastTriggered": "2019-08-24T14:15:22Z",
      "name": "string",
      "orgId": "string",
      "uid": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Notification policies listed successfully.	NotificationPoliciesListResponse

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

BearerAuth

POST /api/v2/notificationPolicies/¶

Create a new notification policy.

Code samples¶

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

Body parameter¶

{
  "active": true,
  "channelId": "string",
  "eventGroup": "secure_config.all",
  "eventType": "secure_config.created",
  "name": "string",
  "orgId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	NotificationPolicyCreate	false	none

Example responses¶

{
  "active": true,
  "channel": {
    "channelType": "Database",
    "contentType": "application/json",
    "createdAt": "2019-08-24T14:15:22Z",
    "customHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "emailAddress": "string",
    "id": "string",
    "languageCode": "en",
    "name": "string",
    "orgId": "string",
    "payloadUrl": "http://example.com",
    "secretToken": "string",
    "uid": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "validateSsl": true
  },
  "channelId": "string",
  "created": "2019-08-24T14:15:22Z",
  "eventGroup": {
    "events": [
      {
        "id": "string",
        "label": "string"
      }
    ],
    "id": "string",
    "label": "string"
  },
  "eventType": {
    "id": "string",
    "label": "string"
  },
  "id": "string",
  "lastTriggered": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Responses¶

Status	Meaning	Description	Schema
201	Created	Notification policy created successfully.	NotificationPolicyResponse

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

BearerAuth

DELETE /api/v2/notificationPolicies/{policyId}/¶

Delete the notification policy.

Code samples¶

curl -X DELETE https://app.datarobot.com/api/v2/notificationPolicies/{policyId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
policyId	path	string	true	The id of the notification policy

Responses¶

Status	Meaning	Description	Schema
204	No Content	Notification policy deleted successfully.	None

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

BearerAuth

GET /api/v2/notificationPolicies/{policyId}/¶

Retrieve the notification policy.

Code samples¶

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

Parameters

Name	In	Type	Required	Description
policyId	path	string	true	The id of the notification policy

Example responses¶

{
  "active": true,
  "channel": {
    "channelType": "Database",
    "contentType": "application/json",
    "createdAt": "2019-08-24T14:15:22Z",
    "customHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "emailAddress": "string",
    "id": "string",
    "languageCode": "en",
    "name": "string",
    "orgId": "string",
    "payloadUrl": "http://example.com",
    "secretToken": "string",
    "uid": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "validateSsl": true
  },
  "channelId": "string",
  "created": "2019-08-24T14:15:22Z",
  "eventGroup": {
    "events": [
      {
        "id": "string",
        "label": "string"
      }
    ],
    "id": "string",
    "label": "string"
  },
  "eventType": {
    "id": "string",
    "label": "string"
  },
  "id": "string",
  "lastTriggered": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Notification policy retrieved successfully.	NotificationPolicyResponse

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

BearerAuth

PUT /api/v2/notificationPolicies/{policyId}/¶

Update the notification policy.

Code samples¶

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

Body parameter¶

{
  "active": true,
  "channelId": "string",
  "eventGroup": "secure_config.all",
  "eventType": "secure_config.created",
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
policyId	path	string	true	The id of the notification policy
body	body	NotificationPolicyUpdate	false	none

Responses¶

Status	Meaning	Description	Schema
204	No Content	Notification policy updated successfully.	None

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

BearerAuth

GET /api/v2/notificationPolicyMutes/¶

List the ignored notifications filtered by orgId if provided

Code samples¶

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

Parameters

Name	In	Type	Required	Description
offset	query	integer	true	The number of records to skip over. Default 0
limit	query	integer	true	The number of records to return. Default to 100, minimum to 1, maximum to 1000
entityId	query	string	false	The id of the entity to filter
orgId	query	string	false	The id of the organization that ignored notifications relate to

Example responses¶

{
  "count": 0,
  "data": [
    {
      "entityId": "string",
      "id": "string",
      "policyId": "string",
      "uid": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	NotificationPolicyMuteListResponse

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

BearerAuth

POST /api/v2/notificationPolicyMutes/¶

Create a new ignored notification

Code samples¶

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

Body parameter¶

{
  "entityId": "string",
  "policyId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	NotificationPolicyMuteCreate	false	none

Example responses¶

{
  "entityId": "string",
  "id": "string",
  "policyId": "string",
  "uid": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	NotificationPolicyMuteResponse

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

BearerAuth

DELETE /api/v2/notificationPolicyMutes/{muteId}/¶

Delete the existing notification policy mute

Code samples¶

curl -X DELETE https://app.datarobot.com/api/v2/notificationPolicyMutes/{muteId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
muteId	path	string	true	The id of the notification policy mute to delete

Responses¶

Status	Meaning	Description	Schema
200	OK	none	None

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

BearerAuth

POST /api/v2/notificationWebhookChannelTests/¶

Test the webhook notification channel.

Code samples¶

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

Body parameter¶

{
  "channelType": "Database",
  "contentType": "application/json",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true
}

Parameters

Name	In	Type	Required	Description
body	body	NotificationWebhookChannelTestCreate	false	none

Example responses¶

{
  "notificationId": "string"
}

Responses¶

Status	Meaning	Description	Schema
201	Created	The test for the webhook notification channel was created.	NotificationWebhookChannelTestId

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

BearerAuth

GET /api/v2/notificationWebhookChannelTests/{notificationId}/¶

Retrieve the status of the notification channel test.

Code samples¶

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

Parameters

Name	In	Type	Required	Description
notificationId	path	string	true	The identifier of the notification.

Example responses¶

{
  "notificationLog": {
    "channelId": "string",
    "channelScope": "organization",
    "emailSubject": "string",
    "id": "string",
    "parentNotificationId": "string",
    "policyId": "string",
    "request": "string",
    "response": "string",
    "retryCount": 0,
    "status": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "status": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	The notification status was retrieved.	NotificationWebhookChannelStatusResponse

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

BearerAuth

POST /api/v2/notifications/¶

Resends the notification

Code samples¶

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

Body parameter¶

{
  "notificationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	NotificationResend	false	none

Responses¶

Status	Meaning	Description	Schema
201	Created	none	None

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

BearerAuth

POST /api/v2/remoteEvents/¶

Post an event from a remote deployment.

Code samples¶

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

Body parameter¶

{
  "data": {
    "newModelId": "string",
    "oldModelId": "string",
    "reason": "string"
  },
  "deploymentId": "string",
  "eventType": "deploymentInfo",
  "externalNanPredictionsData": {
    "count": 0,
    "modelId": null
  },
  "message": "string",
  "moderationData": {
    "guardName": "string",
    "metricName": "string"
  },
  "orgId": "string",
  "predictionEnvironmentId": "string",
  "predictionRequestData": {
    "error_code": "string",
    "model_id": "string",
    "response_body": "string",
    "status_code": 0,
    "user_id": "string"
  },
  "spoolerChannelData": {
    "name": "string",
    "type": "asyncMemory"
  },
  "timestamp": "2019-08-24T14:15:22Z",
  "title": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	RemoteEventCreate	false	none

Example responses¶

{
  "message": "string"
}

Responses¶

Status	Meaning	Description	Schema
201	Created	The event was created.	CreateRemoteEventResponse
404	Not Found	The deployment was not found.	None
422	Unprocessable Entity	Unable to process the request instructions or failed to post the event.	None

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

BearerAuth

DELETE /api/v2/userNotifications/¶

Delete all notifications associated with the user.

Code samples¶

curl -X DELETE https://app.datarobot.com/api/v2/userNotifications/ \
  -H "Authorization: Bearer {access-token}"

Responses¶

Status	Meaning	Description	Schema
204	No Content	Notifications were deleted.	None

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

BearerAuth

GET /api/v2/userNotifications/¶

Returns list of user's notifications from latest to oldest.

Code samples¶

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

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	The number of records to skip over
limit	query	integer	false	The number of records to return
isRead	query	boolean	false	When provided, returns only read or unread notifications

Example responses¶

{
  "count": 0,
  "data": [
    {
      "callerUser": {
        "fullName": "string",
        "gravatarHash": "string",
        "inactive": true,
        "uid": "string",
        "username": "string"
      },
      "created": "2019-08-24T14:15:22Z",
      "description": "string",
      "eventType": "autopilot.complete",
      "isRead": true,
      "link": "string",
      "pushNotificationSent": true,
      "relatedComment": {
        "commentId": "string",
        "commentLink": "string",
        "entityId": "string",
        "entityType": "useCase",
        "inactive": true
      },
      "relatedDeployment": {
        "deploymentId": "string",
        "deploymentName": "string",
        "deploymentUrl": "string",
        "inactive": true,
        "modelId": "string",
        "projectId": "string",
        "userId": "string"
      },
      "relatedProject": {
        "inactive": true,
        "pid": "string",
        "projectLink": "string",
        "projectName": "string"
      },
      "relatedSecureConfig": {
        "secureConfigLink": "string",
        "secureConfigName": "string",
        "secureConfigSchemaName": "string",
        "secureConfigSchemaUuid": "string",
        "secureConfigUuid": "string"
      },
      "relatedUsersDelete": {
        "reportId": "string",
        "statusId": "string",
        "usersToDeleteCount": "string"
      },
      "sharedUsers": [
        {
          "fullName": "string",
          "gravatarHash": "string",
          "inactive": true,
          "uid": "string",
          "username": "string"
        }
      ],
      "statusId": "string",
      "title": "string",
      "tooltip": "string",
      "updated": "2019-08-24T14:15:22Z",
      "userNotificationId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	A paginated list of notifications.	UserNotificationListResponse

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

BearerAuth

PATCH /api/v2/userNotifications/¶

Mark all associated notifications with the user as read.

Code samples¶

curl -X PATCH https://app.datarobot.com/api/v2/userNotifications/ \
  -H "Authorization: Bearer {access-token}"

Responses¶

Status	Meaning	Description	Schema
204	No Content	All notification were marked as read.	None

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

BearerAuth

DELETE /api/v2/userNotifications/{userNotificationId}/¶

Delete one notification associated with the user.

Code samples¶

curl -X DELETE https://app.datarobot.com/api/v2/userNotifications/{userNotificationId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
userNotificationId	path	string	true	Unique identifier of the notification.

Responses¶

Status	Meaning	Description	Schema
204	No Content	Notification was deleted.	None

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

BearerAuth

PATCH /api/v2/userNotifications/{userNotificationId}/¶

Mark one associated notification with the user as read.

Code samples¶

curl -X PATCH https://app.datarobot.com/api/v2/userNotifications/{userNotificationId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
userNotificationId	path	string	true	Unique identifier of the notification.

Responses¶

Status	Meaning	Description	Schema
204	No Content	Notification was marked as read.	None

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

BearerAuth

Schemas¶

AccessControlV2

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

Properties¶

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

Enumerated Values¶

Property	Value
role	[`ADMIN`, `CONSUMER`, `DATA_SCIENTIST`, `EDITOR`, `OBSERVER`, `OWNER`, `READ_ONLY`, `READ_WRITE`, `USER`]
shareRecipientType	[`user`, `group`, `organization`]

ChannelCreatedByResponse

{
  "firstName": "string",
  "lastName": "string",
  "username": "string"
}

User that created template.

Properties¶

Name	Type	Required	Description
firstName	string,null	true	First Name.
lastName	string,null	true	Last Name.
username	string	true	Username.

ChannelDREntity

{
  "id": "string",
  "name": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
id	string	true		The id of DataRobot entity.
name	string	true		The name of the entity.

CreateRemoteEventResponse

{
  "message": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
message	string	true		The descriptive message about the event creation.

CreatedByResponse

{
  "firstName": "string",
  "lastName": "string",
  "username": "string"
}

User that created template.

Properties¶

Name	Type	Required	Description
firstName	string,null	true	First Name.
lastName	string,null	true	Last Name.
username	string	true	Username.

CustomerHeader

{
  "name": "string",
  "value": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
name	string	true		The name of the header.
value	string	true		The value of the header.

DREntity

{
  "id": "string",
  "name": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
id	string	true		The id of DataRobot entity.
name	string	true		The name of the entity.

EntityNotificationChannel

{
  "channelType": "DataRobotCustomJob",
  "contentType": "application/json",
  "createdAt": "2019-08-24T14:15:22Z",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "drEntities": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "emailAddress": "string",
  "id": "string",
  "languageCode": "en",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "relatedEntityId": "string",
  "relatedEntityType": "deployment",
  "secretToken": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "validateSsl": true
}

The information notification channel to be used to send the notification.

Properties¶

Name	Type	Required	Restrictions	Description
channelType	string	true		The type of the new notification channel.
contentType	string,null	true		The content type of the messages of the new notification channel.
createdAt	string(date-time)	true		The date of the notification channel creation.
customHeaders	[CustomerHeader]	true	maxItems: 100	Custom headers and their values to be sent in the new notification channel.
drEntities	[ChannelDREntity]	false	maxItems: 100 minItems: 1	The ids of DataRobot Users or Group for DataRobotUser or DataRobotGroup channel types.
emailAddress	string,null	true		The email address to be used in the new notification channel.
id	string	true		The id of the notification channel.
languageCode	string,null	true		The preferred language code.
name	string	true		The name of the new notification channel.
orgId	string,null	true		The id of organization that notification channel belongs to.
payloadUrl	string,null(uri)	true		The payload URL of the new notification channel.
relatedEntityId	string,null	false		The id of related entity.
relatedEntityType	string,null	false		Type of related entity.
secretToken	string,null	true		Secret token to be used for new notification channel.
uid	string,null	true		The identifier of the user who created the channel.
updatedAt	string,null(date-time)	true		The date when the channel was updated.
validateSsl	boolean,null	true		Defines if validate ssl or not in the notification channel.

Enumerated Values¶

Property	Value
channelType	[`DataRobotCustomJob`, `DataRobotGroup`, `DataRobotUser`, `Database`, `Email`, `InApp`, `InsightsComputations`, `MSTeams`, `Slack`, `Webhook`]
contentType	[`application/json`, `application/x-www-form-urlencoded`]
languageCode	[`en`, `es_419`, `fr`, `ja`, `ko`, `ptBR`]
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

EntityNotificationChannelCreate

{
  "channelType": "DataRobotCustomJob",
  "contentType": "application/json",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "drEntities": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "emailAddress": "string",
  "languageCode": "en",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "relatedEntityId": "string",
  "relatedEntityType": "deployment",
  "secretToken": "string",
  "validateSsl": true,
  "verificationCode": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
channelType	string	true		The type of the new notification channel.
contentType	string	false		The content type of the messages of the new notification channel.
customHeaders	[CustomerHeader]	false	maxItems: 100	Custom headers and their values to be sent in the new notification channel.
drEntities	[DREntity]	false	maxItems: 100 minItems: 1	The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.
emailAddress	string	false		The email address to be used in the new notification channel.
languageCode	string	false		The preferred language code.
name	string	true	maxLength: 100	The name of the new notification channel.
orgId	string	false		The id of organization that notification channel belongs to.
payloadUrl	string(uri)	false		The payload URL of the new notification channel.
relatedEntityId	string	true		The id of related entity.
relatedEntityType	string	true		Type of related entity.
secretToken	string	false		Secret token to be used for new notification channel.
validateSsl	boolean	false		Defines if validate ssl or not in the notification channel.
verificationCode	string	false		Required if the channel type is Email.

Enumerated Values¶

Property	Value
channelType	[`DataRobotCustomJob`, `DataRobotGroup`, `DataRobotUser`, `Database`, `Email`, `InApp`, `InsightsComputations`, `MSTeams`, `Slack`, `Webhook`]
contentType	[`application/json`, `application/x-www-form-urlencoded`]
languageCode	[`en`, `es_419`, `fr`, `ja`, `ko`, `ptBR`]
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

EntityNotificationChannelResponse

{
  "channelType": "DataRobotCustomJob",
  "contentType": "application/json",
  "createdAt": "2019-08-24T14:15:22Z",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "drEntities": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "emailAddress": "string",
  "id": "string",
  "languageCode": "en",
  "lastNotificationAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "policyCount": 0,
  "relatedEntityId": "string",
  "relatedEntityType": "deployment",
  "secretToken": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "validateSsl": true
}

Properties¶

Name	Type	Required	Restrictions	Description
channelType	string	true		The type of the new notification channel.
contentType	string,null	true		The content type of the messages of the new notification channel.
createdAt	string(date-time)	true		The date of the notification channel creation.
customHeaders	[CustomerHeader]	true	maxItems: 100	Custom headers and their values to be sent in the new notification channel.
drEntities	[DREntity]	false	maxItems: 100 minItems: 1	The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.
emailAddress	string,null	true		The email address to be used in the new notification channel.
id	string	true		The id of the notification channel.
languageCode	string,null	true		The preferred language code.
lastNotificationAt	string,null(date-time)	true		The timestamp of the last notification sent to the channel.
name	string	true		The name of the new notification channel.
orgId	string,null	true		The id of organization that notification channel belongs to.
payloadUrl	string,null(uri)	true		The payload URL of the new notification channel.
policyCount	integer	true		Count of policies assigned to the channel.
relatedEntityId	string	true		The id of related entity.
relatedEntityType	string	true		Type of related entity.
secretToken	string,null	true		Secret token to be used for new notification channel.
uid	string,null	true		The identifier of the user who created the channel.
updatedAt	string,null(date-time)	true		The date when the channel was updated.
validateSsl	boolean,null	true		Defines if validate ssl or not in the notification channel.

Enumerated Values¶

Property	Value
channelType	[`DataRobotCustomJob`, `DataRobotGroup`, `DataRobotUser`, `Database`, `Email`, `InApp`, `InsightsComputations`, `MSTeams`, `Slack`, `Webhook`]
contentType	[`application/json`, `application/x-www-form-urlencoded`]
languageCode	[`en`, `es_419`, `fr`, `ja`, `ko`, `ptBR`]
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

EntityNotificationChannelsListResponse

{
  "count": 0,
  "data": [
    {
      "channelType": "DataRobotCustomJob",
      "contentType": "application/json",
      "createdAt": "2019-08-24T14:15:22Z",
      "customHeaders": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "drEntities": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "emailAddress": "string",
      "id": "string",
      "languageCode": "en",
      "lastNotificationAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "orgId": "string",
      "payloadUrl": "http://example.com",
      "policyCount": 0,
      "relatedEntityId": "string",
      "relatedEntityType": "deployment",
      "secretToken": "string",
      "uid": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "validateSsl": true
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true		The number of channels returned.
data	[EntityNotificationChannelResponse]	true	maxItems: 1000	The notification entity channels.
next	string,null	true		URL pointing to the next page.
previous	string,null	true		URL pointing to the previous page.
totalCount	integer	true		The total number of channels that satisfy the query.

EntityNotificationPoliciesListResponse

{
  "count": 0,
  "data": [
    {
      "active": true,
      "channel": {
        "channelType": "DataRobotCustomJob",
        "contentType": "application/json",
        "createdAt": "2019-08-24T14:15:22Z",
        "customHeaders": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "drEntities": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "emailAddress": "string",
        "id": "string",
        "languageCode": "en",
        "name": "string",
        "orgId": "string",
        "payloadUrl": "http://example.com",
        "relatedEntityId": "string",
        "relatedEntityType": "deployment",
        "secretToken": "string",
        "uid": "string",
        "updatedAt": "2019-08-24T14:15:22Z",
        "validateSsl": true
      },
      "channelId": "string",
      "channelScope": "organization",
      "created": "2019-08-24T14:15:22Z",
      "eventGroup": {
        "events": [
          {
            "id": "string",
            "label": "string"
          }
        ],
        "id": "string",
        "label": "string"
      },
      "eventType": {
        "id": "string",
        "label": "string"
      },
      "id": "string",
      "lastTriggered": "2019-08-24T14:15:22Z",
      "maximalFrequency": "string",
      "name": "string",
      "orgId": "string",
      "relatedEntityId": "string",
      "relatedEntityType": "deployment",
      "templateId": "string",
      "uid": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true		The number of entity policies returned.
data	[EntityNotificationPolicyResponse]	true	maxItems: 1000	The entity notification policies.
next	string,null	true		URL pointing to the next page.
previous	string,null	true		URL pointing to the previous page.
totalCount	integer	true		The total number of entity policies that satisfy the query.

EntityNotificationPoliciesTemplatesListResponse

{
  "count": 0,
  "data": [
    {
      "active": true,
      "channel": {
        "channelType": "DataRobotCustomJob",
        "contentType": "application/json",
        "createdAt": "2019-08-24T14:15:22Z",
        "customHeaders": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "drEntities": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "emailAddress": "string",
        "id": "string",
        "languageCode": "en",
        "name": "string",
        "orgId": "string",
        "payloadUrl": "http://example.com",
        "relatedEntityId": "string",
        "relatedEntityType": "deployment",
        "secretToken": "string",
        "uid": "string",
        "updatedAt": "2019-08-24T14:15:22Z",
        "validateSsl": true
      },
      "channelId": "string",
      "channelScope": "organization",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": {
        "firstName": "string",
        "lastName": "string",
        "username": "string"
      },
      "eventGroup": {
        "events": [
          {
            "id": "string",
            "label": "string"
          }
        ],
        "id": "string",
        "label": "string"
      },
      "eventType": {
        "id": "string",
        "label": "string"
      },
      "id": "string",
      "lastTriggered": "2019-08-24T14:15:22Z",
      "maximalFrequency": "string",
      "name": "string",
      "orgId": "string",
      "relatedEntityType": "deployment",
      "relatedPoliciesCount": 0,
      "role": "string",
      "uid": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true		The number of entity policies templates returned.
data	[EntityNotificationPolicyTemplateResponse]	true	maxItems: 1000	The entity notification policies templates.
next	string,null	true		URL pointing to the next page.
previous	string,null	true		URL pointing to the previous page.
totalCount	integer	true		The total number of entity policies templates that satisfy the query.

EntityNotificationPolicyCreate

{
  "active": true,
  "channelId": "string",
  "channelScope": "organization",
  "eventGroup": "secure_config.all",
  "eventType": "secure_config.created",
  "maximalFrequency": "string",
  "name": "string",
  "orgId": "string",
  "relatedEntityId": "string",
  "relatedEntityType": "deployment"
}

Properties¶

Name	Type	Required	Restrictions	Description
active	boolean	false		Defines if the notification policy is active or not.
channelId	string	true		The id of the notification channel to be used to send the notification.
channelScope	string,null	true		Scope of the channel.
eventGroup	string	false		The group of the event that trigger the notification.
eventType	string	false		The type of the event that triggers the notification.
maximalFrequency	string,null	false		Maximal frequency between policy runs in ISO 8601 duration string.
name	string	true	maxLength: 100	The name of the new notification policy.
orgId	string	false		The id of the organization that owns the notification policy.
relatedEntityId	string	true		The id of related entity.
relatedEntityType	string	true		Type of related entity.

Enumerated Values¶

Property	Value
channelScope	[`organization`, `Organization`, `ORGANIZATION`, `entity`, `Entity`, `ENTITY`, `template`, `Template`, `TEMPLATE`]
eventGroup	[`secure_config.all`, `comment.all`, `dataset.all`, `deployment_prediction_explanations_computation.all`, `model_deployments.critical_health`, `model_deployments.critical_frequent_health_change`, `model_deployments.frequent_health_change`, `model_deployments.health`, `inference_endpoints.health`, `model_deployments.management_agent`, `model_deployments.management_agent_health`, `prediction_request.all`, `challenger_management.all`, `challenger_replay.all`, `model_deployments.all`, `project.all`, `perma_delete_project.all`, `users_delete.all`, `applications.all`, `model_version.stage_transitions`, `model_version.all`, `batch_predictions.all`, `change_requests.all`, `insights_computation.all`, `notebook_schedule.all`, `monitoring.all`]
eventType	[`secure_config.created`, `secure_config.deleted`, `secure_config.shared`, `comment.created`, `comment.updated`, `dataset.created`, `dataset.registered`, `dataset.deleted`, `datasets.deleted`, `datasetrelationship.created`, `dataset.shared`, `datasets.shared`, `misc.asset_access_request`, `misc.webhook_connection_test`, `misc.webhook_resend`, `misc.email_verification`, `monitoring.spooler_channel_base`, `monitoring.spooler_channel_red`, `monitoring.spooler_channel_green`, `monitoring.external_model_nan_predictions`, `management.deploymentInfo`, `model_deployments.None`, `model_deployments.deployment_sharing`, `model_deployments.model_replacement`, `prediction_request.None`, `prediction_request.failed`, `model_deployments.model_replacement_lifecycle`, `model_deployments.model_replacement_started`, `model_deployments.model_replacement_succeeded`, `model_deployments.model_replacement_failed`, `model_deployments.model_replacement_validation_warning`, `model_deployments.deployment_creation`, `model_deployments.deployment_deletion`, `model_deployments.service_health_yellow_from_green`, `model_deployments.service_health_yellow_from_red`, `model_deployments.service_health_red`, `model_deployments.data_drift_yellow_from_green`, `model_deployments.data_drift_yellow_from_red`, `model_deployments.data_drift_red`, `model_deployments.accuracy_yellow_from_green`, `model_deployments.accuracy_yellow_from_red`, `model_deployments.accuracy_red`, `model_deployments.health.fairness_health.green_to_yellow`, `model_deployments.health.fairness_health.red_to_yellow`, `model_deployments.health.fairness_health.red`, `model_deployments.health.custom_metrics_health.green_to_yellow`, `model_deployments.health.custom_metrics_health.red_to_yellow`, `model_deployments.health.custom_metrics_health.red`, `model_deployments.health.base.green`, `model_deployments.service_health_green`, `model_deployments.data_drift_green`, `model_deployments.accuracy_green`, `model_deployments.health.fairness_health.green`, `model_deployments.health.custom_metrics_health.green`, `model_deployments.retraining_policy_run_started`, `model_deployments.retraining_policy_run_succeeded`, `model_deployments.retraining_policy_run_failed`, `model_deployments.challenger_scoring_success`, `model_deployments.challenger_scoring_data_warning`, `model_deployments.challenger_scoring_failure`, `model_deployments.challenger_scoring_started`, `model_deployments.challenger_model_validation_warning`, `model_deployments.challenger_model_created`, `model_deployments.challenger_model_deleted`, `model_deployments.actuals_upload_failed`, `model_deployments.actuals_upload_warning`, `model_deployments.training_data_baseline_calculation_started`, `model_deployments.training_data_baseline_calculation_completed`, `model_deployments.training_data_baseline_failed`, `model_deployments.custom_model_deployment_creation_started`, `model_deployments.custom_model_deployment_creation_completed`, `model_deployments.custom_model_deployment_creation_failed`, `model_deployments.deployment_prediction_explanations_preview_job_submitted`, `model_deployments.deployment_prediction_explanations_preview_job_completed`, `model_deployments.deployment_prediction_explanations_preview_job_failed`, `model_deployments.custom_model_deployment_activated`, `model_deployments.custom_model_deployment_activation_failed`, `model_deployments.custom_model_deployment_deactivated`, `model_deployments.custom_model_deployment_deactivation_failed`, `model_deployments.prediction_processing_rate_limit_reached`, `model_deployments.prediction_data_processing_rate_limit_reached`, `model_deployments.prediction_data_processing_rate_limit_warning`, `model_deployments.actuals_processing_rate_limit_reached`, `model_deployments.actuals_processing_rate_limit_warning`, `model_deployments.deployment_monitoring_data_cleared`, `model_deployments.deployment_launch_started`, `model_deployments.deployment_launch_succeeded`, `model_deployments.deployment_launch_failed`, `model_deployments.deployment_shutdown_started`, `model_deployments.deployment_shutdown_succeeded`, `model_deployments.deployment_shutdown_failed`, `model_deployments.endpoint_update_started`, `model_deployments.endpoint_update_succeeded`, `model_deployments.endpoint_update_failed`, `model_deployments.management_agent_service_health_green`, `model_deployments.management_agent_service_health_yellow`, `model_deployments.management_agent_service_health_red`, `model_deployments.management_agent_service_health_unknown`, `model_deployments.predictions_missing_association_id`, `model_deployments.prediction_result_rows_cleand_up`, `model_deployments.batch_deleted`, `model_deployments.batch_creation_limit_reached`, `model_deployments.batch_creation_limit_exceeded`, `model_deployments.batch_not_found`, `model_deployments.predictions_encountered_for_locked_batch`, `model_deployments.predictions_encountered_for_deleted_batch`, `model_deployments.scheduled_report_generated`, `model_deployments.predictions_timeliness_health_red`, `model_deployments.actuals_timeliness_health_red`, `model_deployments.service_health_still_red`, `model_deployments.data_drift_still_red`, `model_deployments.accuracy_still_red`, `model_deployments.health.fairness_health.still_red`, `model_deployments.health.custom_metrics_health.still_red`, `model_deployments.predictions_timeliness_health_still_red`, `model_deployments.actuals_timeliness_health_still_red`, `model_deployments.service_health_still_yellow`, `model_deployments.data_drift_still_yellow`, `model_deployments.accuracy_still_yellow`, `model_deployments.health.fairness_health.still_yellow`, `model_deployments.health.custom_metrics_health.still_yellow`, `model_deployments.prediction_payload_parsing_failure`, `model_deployments.deployment_inference_server_creation_started`, `model_deployments.deployment_inference_server_creation_failed`, `model_deployments.deployment_inference_server_creation_completed`, `model_deployments.deployment_inference_server_deletion`, `model_deployments.deployment_inference_server_idle_stopped`, `entity_notification_policy_template.shared`, `notification_channel_template.shared`, `project.created`, `project.deleted`, `project.shared`, `autopilot.complete`, `autopilot.started`, `autostart.failure`, `perma_delete_project.success`, `perma_delete_project.failure`, `users_delete.preview_started`, `users_delete.preview_completed`, `users_delete.preview_failed`, `users_delete.started`, `users_delete.completed`, `users_delete.failed`, `application.created`, `application.shared`, `model_version.added`, `model_version.stage_transition_from_registered_to_development`, `model_version.stage_transition_from_registered_to_staging`, `model_version.stage_transition_from_registered_to_production`, `model_version.stage_transition_from_registered_to_archived`, `model_version.stage_transition_from_development_to_registered`, `model_version.stage_transition_from_development_to_staging`, `model_version.stage_transition_from_development_to_production`, `model_version.stage_transition_from_development_to_archived`, `model_version.stage_transition_from_staging_to_registered`, `model_version.stage_transition_from_staging_to_development`, `model_version.stage_transition_from_staging_to_production`, `model_version.stage_transition_from_staging_to_archived`, `model_version.stage_transition_from_production_to_registered`, `model_version.stage_transition_from_production_to_development`, `model_version.stage_transition_from_production_to_staging`, `model_version.stage_transition_from_production_to_archived`, `model_version.stage_transition_from_archived_to_registered`, `model_version.stage_transition_from_archived_to_development`, `model_version.stage_transition_from_archived_to_production`, `model_version.stage_transition_from_archived_to_staging`, `batch_predictions.success`, `batch_predictions.failed`, `batch_predictions.scheduler.auto_disabled`, `change_request.cancelled`, `change_request.created`, `change_request.deployment_approval_requested`, `change_request.resolved`, `change_request.proposed_changes_updated`, `change_request.pending`, `change_request.commenting_review_added`, `change_request.approving_review_added`, `change_request.changes_requesting_review_added`, `prediction_explanations_computation.None`, `prediction_explanations_computation.prediction_explanations_preview_job_submitted`, `prediction_explanations_computation.prediction_explanations_preview_job_completed`, `prediction_explanations_computation.prediction_explanations_preview_job_failed`, `monitoring.rate_limit_enforced`, `notebook_schedule.created`, `notebook_schedule.failure`, `notebook_schedule.completed`, `abstract`, `moderation.metric.creation_error`, `moderation.metric.reporting_error`, `moderation.model.moderation_started`, `moderation.model.moderation_completed`, `moderation.model.pre_score_phase_started`, `moderation.model.pre_score_phase_completed`, `moderation.model.post_score_phase_started`, `moderation.model.post_score_phase_completed`, `moderation.model.config_error`, `moderation.model.runtime_error`, `moderation.model.scoring_started`, `moderation.model.scoring_completed`, `moderation.model.scoring_error`]
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

EntityNotificationPolicyCreateFromTemplate

{
  "active": true,
  "name": "string",
  "relatedEntityId": "string",
  "relatedEntityType": "deployment",
  "templateId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
active	boolean	false		Defines if the notification policy is active or not.
name	string	true	maxLength: 100	The name of the new notification policy.
relatedEntityId	string	true		The id of related entity.
relatedEntityType	string	true		Type of related entity.
templateId	string	true		The id of template.

Enumerated Values¶

Property	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

EntityNotificationPolicyResponse

{
  "active": true,
  "channel": {
    "channelType": "DataRobotCustomJob",
    "contentType": "application/json",
    "createdAt": "2019-08-24T14:15:22Z",
    "customHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "drEntities": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "emailAddress": "string",
    "id": "string",
    "languageCode": "en",
    "name": "string",
    "orgId": "string",
    "payloadUrl": "http://example.com",
    "relatedEntityId": "string",
    "relatedEntityType": "deployment",
    "secretToken": "string",
    "uid": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "validateSsl": true
  },
  "channelId": "string",
  "channelScope": "organization",
  "created": "2019-08-24T14:15:22Z",
  "eventGroup": {
    "events": [
      {
        "id": "string",
        "label": "string"
      }
    ],
    "id": "string",
    "label": "string"
  },
  "eventType": {
    "id": "string",
    "label": "string"
  },
  "id": "string",
  "lastTriggered": "2019-08-24T14:15:22Z",
  "maximalFrequency": "string",
  "name": "string",
  "orgId": "string",
  "relatedEntityId": "string",
  "relatedEntityType": "deployment",
  "templateId": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Properties¶

Name	Type	Required	Description
active	boolean	true	Defines if the notification policy is active or not.
channel	EntityNotificationChannel	true	The information notification channel to be used to send the notification.
channelId	string	true	The id of the notification channel to be used to send the notification.
channelScope	string,null	true	Scope of the channel.
created	string,null(date-time)	true	The date when the policy was created.
eventGroup	EventGroup	true	The group of the event that trigger the notification.
eventType	EventType	true	The type of the event that triggers the notification.
id	string	true	The id of the policy.
lastTriggered	string,null(date-time)	true	The date when the last notification with the policy was triggered.
maximalFrequency	string,null	false	Maximal frequency between policy runs in ISO 8601 duration string.
name	string	true	The name of the notification policy.
orgId	string,null	true	The id of the organization that owns the notification policy.
relatedEntityId	string	true	The id of related entity.
relatedEntityType	string	true	Type of related entity.
templateId	string,null	true	The id of template.
uid	string	true	The identifier of the user who created the policy.
updatedAt	string,null(date-time)	true	The date when the policy was updated.

Enumerated Values¶

Property	Value
channelScope	[`organization`, `Organization`, `ORGANIZATION`, `entity`, `Entity`, `ENTITY`, `template`, `Template`, `TEMPLATE`]
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

EntityNotificationPolicyTemplateCreate

{
  "active": true,
  "channelId": "string",
  "eventGroup": "secure_config.all",
  "eventType": "secure_config.created",
  "maximalFrequency": "string",
  "name": "string",
  "orgId": "string",
  "relatedEntityType": "deployment"
}

Properties¶

Name	Type	Required	Restrictions	Description
active	boolean	false		Defines if the notification policy is active or not.
channelId	string	true		The id of the notification channel to be used to send the notification.
eventGroup	string	false		The group of the event that trigger the notification.
eventType	string	false		The type of the event that triggers the notification.
maximalFrequency	string,null	false		Maximal frequency between policy runs in ISO 8601 duration string.
name	string	true	maxLength: 100	The name of the new notification policy.
orgId	string	false		The id of the organization that owns the notification policy.
relatedEntityType	string	true		Type of related entity.

Enumerated Values¶

Property	Value
eventGroup	[`secure_config.all`, `comment.all`, `dataset.all`, `deployment_prediction_explanations_computation.all`, `model_deployments.critical_health`, `model_deployments.critical_frequent_health_change`, `model_deployments.frequent_health_change`, `model_deployments.health`, `inference_endpoints.health`, `model_deployments.management_agent`, `model_deployments.management_agent_health`, `prediction_request.all`, `challenger_management.all`, `challenger_replay.all`, `model_deployments.all`, `project.all`, `perma_delete_project.all`, `users_delete.all`, `applications.all`, `model_version.stage_transitions`, `model_version.all`, `batch_predictions.all`, `change_requests.all`, `insights_computation.all`, `notebook_schedule.all`, `monitoring.all`]
eventType	[`secure_config.created`, `secure_config.deleted`, `secure_config.shared`, `comment.created`, `comment.updated`, `dataset.created`, `dataset.registered`, `dataset.deleted`, `datasets.deleted`, `datasetrelationship.created`, `dataset.shared`, `datasets.shared`, `misc.asset_access_request`, `misc.webhook_connection_test`, `misc.webhook_resend`, `misc.email_verification`, `monitoring.spooler_channel_base`, `monitoring.spooler_channel_red`, `monitoring.spooler_channel_green`, `monitoring.external_model_nan_predictions`, `management.deploymentInfo`, `model_deployments.None`, `model_deployments.deployment_sharing`, `model_deployments.model_replacement`, `prediction_request.None`, `prediction_request.failed`, `model_deployments.model_replacement_lifecycle`, `model_deployments.model_replacement_started`, `model_deployments.model_replacement_succeeded`, `model_deployments.model_replacement_failed`, `model_deployments.model_replacement_validation_warning`, `model_deployments.deployment_creation`, `model_deployments.deployment_deletion`, `model_deployments.service_health_yellow_from_green`, `model_deployments.service_health_yellow_from_red`, `model_deployments.service_health_red`, `model_deployments.data_drift_yellow_from_green`, `model_deployments.data_drift_yellow_from_red`, `model_deployments.data_drift_red`, `model_deployments.accuracy_yellow_from_green`, `model_deployments.accuracy_yellow_from_red`, `model_deployments.accuracy_red`, `model_deployments.health.fairness_health.green_to_yellow`, `model_deployments.health.fairness_health.red_to_yellow`, `model_deployments.health.fairness_health.red`, `model_deployments.health.custom_metrics_health.green_to_yellow`, `model_deployments.health.custom_metrics_health.red_to_yellow`, `model_deployments.health.custom_metrics_health.red`, `model_deployments.health.base.green`, `model_deployments.service_health_green`, `model_deployments.data_drift_green`, `model_deployments.accuracy_green`, `model_deployments.health.fairness_health.green`, `model_deployments.health.custom_metrics_health.green`, `model_deployments.retraining_policy_run_started`, `model_deployments.retraining_policy_run_succeeded`, `model_deployments.retraining_policy_run_failed`, `model_deployments.challenger_scoring_success`, `model_deployments.challenger_scoring_data_warning`, `model_deployments.challenger_scoring_failure`, `model_deployments.challenger_scoring_started`, `model_deployments.challenger_model_validation_warning`, `model_deployments.challenger_model_created`, `model_deployments.challenger_model_deleted`, `model_deployments.actuals_upload_failed`, `model_deployments.actuals_upload_warning`, `model_deployments.training_data_baseline_calculation_started`, `model_deployments.training_data_baseline_calculation_completed`, `model_deployments.training_data_baseline_failed`, `model_deployments.custom_model_deployment_creation_started`, `model_deployments.custom_model_deployment_creation_completed`, `model_deployments.custom_model_deployment_creation_failed`, `model_deployments.deployment_prediction_explanations_preview_job_submitted`, `model_deployments.deployment_prediction_explanations_preview_job_completed`, `model_deployments.deployment_prediction_explanations_preview_job_failed`, `model_deployments.custom_model_deployment_activated`, `model_deployments.custom_model_deployment_activation_failed`, `model_deployments.custom_model_deployment_deactivated`, `model_deployments.custom_model_deployment_deactivation_failed`, `model_deployments.prediction_processing_rate_limit_reached`, `model_deployments.prediction_data_processing_rate_limit_reached`, `model_deployments.prediction_data_processing_rate_limit_warning`, `model_deployments.actuals_processing_rate_limit_reached`, `model_deployments.actuals_processing_rate_limit_warning`, `model_deployments.deployment_monitoring_data_cleared`, `model_deployments.deployment_launch_started`, `model_deployments.deployment_launch_succeeded`, `model_deployments.deployment_launch_failed`, `model_deployments.deployment_shutdown_started`, `model_deployments.deployment_shutdown_succeeded`, `model_deployments.deployment_shutdown_failed`, `model_deployments.endpoint_update_started`, `model_deployments.endpoint_update_succeeded`, `model_deployments.endpoint_update_failed`, `model_deployments.management_agent_service_health_green`, `model_deployments.management_agent_service_health_yellow`, `model_deployments.management_agent_service_health_red`, `model_deployments.management_agent_service_health_unknown`, `model_deployments.predictions_missing_association_id`, `model_deployments.prediction_result_rows_cleand_up`, `model_deployments.batch_deleted`, `model_deployments.batch_creation_limit_reached`, `model_deployments.batch_creation_limit_exceeded`, `model_deployments.batch_not_found`, `model_deployments.predictions_encountered_for_locked_batch`, `model_deployments.predictions_encountered_for_deleted_batch`, `model_deployments.scheduled_report_generated`, `model_deployments.predictions_timeliness_health_red`, `model_deployments.actuals_timeliness_health_red`, `model_deployments.service_health_still_red`, `model_deployments.data_drift_still_red`, `model_deployments.accuracy_still_red`, `model_deployments.health.fairness_health.still_red`, `model_deployments.health.custom_metrics_health.still_red`, `model_deployments.predictions_timeliness_health_still_red`, `model_deployments.actuals_timeliness_health_still_red`, `model_deployments.service_health_still_yellow`, `model_deployments.data_drift_still_yellow`, `model_deployments.accuracy_still_yellow`, `model_deployments.health.fairness_health.still_yellow`, `model_deployments.health.custom_metrics_health.still_yellow`, `model_deployments.prediction_payload_parsing_failure`, `model_deployments.deployment_inference_server_creation_started`, `model_deployments.deployment_inference_server_creation_failed`, `model_deployments.deployment_inference_server_creation_completed`, `model_deployments.deployment_inference_server_deletion`, `model_deployments.deployment_inference_server_idle_stopped`, `entity_notification_policy_template.shared`, `notification_channel_template.shared`, `project.created`, `project.deleted`, `project.shared`, `autopilot.complete`, `autopilot.started`, `autostart.failure`, `perma_delete_project.success`, `perma_delete_project.failure`, `users_delete.preview_started`, `users_delete.preview_completed`, `users_delete.preview_failed`, `users_delete.started`, `users_delete.completed`, `users_delete.failed`, `application.created`, `application.shared`, `model_version.added`, `model_version.stage_transition_from_registered_to_development`, `model_version.stage_transition_from_registered_to_staging`, `model_version.stage_transition_from_registered_to_production`, `model_version.stage_transition_from_registered_to_archived`, `model_version.stage_transition_from_development_to_registered`, `model_version.stage_transition_from_development_to_staging`, `model_version.stage_transition_from_development_to_production`, `model_version.stage_transition_from_development_to_archived`, `model_version.stage_transition_from_staging_to_registered`, `model_version.stage_transition_from_staging_to_development`, `model_version.stage_transition_from_staging_to_production`, `model_version.stage_transition_from_staging_to_archived`, `model_version.stage_transition_from_production_to_registered`, `model_version.stage_transition_from_production_to_development`, `model_version.stage_transition_from_production_to_staging`, `model_version.stage_transition_from_production_to_archived`, `model_version.stage_transition_from_archived_to_registered`, `model_version.stage_transition_from_archived_to_development`, `model_version.stage_transition_from_archived_to_production`, `model_version.stage_transition_from_archived_to_staging`, `batch_predictions.success`, `batch_predictions.failed`, `batch_predictions.scheduler.auto_disabled`, `change_request.cancelled`, `change_request.created`, `change_request.deployment_approval_requested`, `change_request.resolved`, `change_request.proposed_changes_updated`, `change_request.pending`, `change_request.commenting_review_added`, `change_request.approving_review_added`, `change_request.changes_requesting_review_added`, `prediction_explanations_computation.None`, `prediction_explanations_computation.prediction_explanations_preview_job_submitted`, `prediction_explanations_computation.prediction_explanations_preview_job_completed`, `prediction_explanations_computation.prediction_explanations_preview_job_failed`, `monitoring.rate_limit_enforced`, `notebook_schedule.created`, `notebook_schedule.failure`, `notebook_schedule.completed`, `abstract`, `moderation.metric.creation_error`, `moderation.metric.reporting_error`, `moderation.model.moderation_started`, `moderation.model.moderation_completed`, `moderation.model.pre_score_phase_started`, `moderation.model.pre_score_phase_completed`, `moderation.model.post_score_phase_started`, `moderation.model.post_score_phase_completed`, `moderation.model.config_error`, `moderation.model.runtime_error`, `moderation.model.scoring_started`, `moderation.model.scoring_completed`, `moderation.model.scoring_error`]
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

EntityNotificationPolicyTemplateRelatedPoliciesListResponse

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "relatedEntityId": "string",
      "relatedEntityName": "string",
      "relatedEntityType": "deployment"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true		The number of entity policies returned.
data	[EntityNotificationPolicyTemplateRelatedPolicyResponse]	true	maxItems: 1000	The entity notification policies.
next	string,null	true		URL pointing to the next page.
previous	string,null	true		URL pointing to the previous page.
totalCount	integer	true		The total number of entity policies that satisfy the query.

EntityNotificationPolicyTemplateRelatedPolicyResponse

{
  "id": "string",
  "name": "string",
  "relatedEntityId": "string",
  "relatedEntityName": "string",
  "relatedEntityType": "deployment"
}

Properties¶

Name	Type	Required	Description
id	string	true	The id of the policy.
name	string	true	The name of the notification policy.
relatedEntityId	string	true	The id of related entity.
relatedEntityName	string	true	The name of related entity.
relatedEntityType	string	true	Type of related entity.

Enumerated Values¶

Property	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

EntityNotificationPolicyTemplateResponse

{
  "active": true,
  "channel": {
    "channelType": "DataRobotCustomJob",
    "contentType": "application/json",
    "createdAt": "2019-08-24T14:15:22Z",
    "customHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "drEntities": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "emailAddress": "string",
    "id": "string",
    "languageCode": "en",
    "name": "string",
    "orgId": "string",
    "payloadUrl": "http://example.com",
    "relatedEntityId": "string",
    "relatedEntityType": "deployment",
    "secretToken": "string",
    "uid": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "validateSsl": true
  },
  "channelId": "string",
  "channelScope": "organization",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": {
    "firstName": "string",
    "lastName": "string",
    "username": "string"
  },
  "eventGroup": {
    "events": [
      {
        "id": "string",
        "label": "string"
      }
    ],
    "id": "string",
    "label": "string"
  },
  "eventType": {
    "id": "string",
    "label": "string"
  },
  "id": "string",
  "lastTriggered": "2019-08-24T14:15:22Z",
  "maximalFrequency": "string",
  "name": "string",
  "orgId": "string",
  "relatedEntityType": "deployment",
  "relatedPoliciesCount": 0,
  "role": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Properties¶

Name	Type	Required	Description
active	boolean	true	Defines if the notification policy is active or not.
channel	EntityNotificationChannel	true	The information notification channel to be used to send the notification.
channelId	string	true	The id of the notification channel to be used to send the notification.
channelScope	string	false	Scope of the channel.
created	string,null(date-time)	true	The date when the policy was created.
createdBy	CreatedByResponse	true	User that created template.
eventGroup	EventGroup	true	The group of the event that trigger the notification.
eventType	EventType	true	The type of the event that triggers the notification.
id	string	true	The id of the policy.
lastTriggered	string,null(date-time)	true	The date when the last notification with the policy was triggered.
maximalFrequency	string,null	false	Maximal frequency between policy runs in ISO 8601 duration string.
name	string	true	The name of the notification policy.
orgId	string,null	true	The id of the organization that owns the notification policy.
relatedEntityType	string	true	Type of related entity.
relatedPoliciesCount	integer	true	The total number of entity policies that are using this template.
role	string,null	true	User role on entity.
uid	string	true	The identifier of the user who created the policy.
updatedAt	string,null(date-time)	true	The date when the policy was updated.

Enumerated Values¶

Property	Value
channelScope	[`organization`, `Organization`, `ORGANIZATION`, `entity`, `Entity`, `ENTITY`, `template`, `Template`, `TEMPLATE`]
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

EntityNotificationPolicyTemplateUpdate

{
  "active": true,
  "channelId": "string",
  "eventGroup": "secure_config.all",
  "eventType": "secure_config.created",
  "maximalFrequency": "string",
  "name": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
active	boolean	false		Defines if the notification policy is active or not.
channelId	string	false		The id of the notification channel to be used to send the notification.
eventGroup	string	false		The group of the event that trigger the notification.
eventType	string	false		The type of the event that triggers the notification.
maximalFrequency	string,null	false		Maximal frequency between policy runs in ISO 8601 duration string.
name	string	false	maxLength: 100	The name of the notification policy.

Enumerated Values¶

Property Value

eventGroup [secure_config.all, comment.all, dataset.all, deployment_prediction_explanations_computation.all, model_deployments.critical_health, model_deployments.critical_frequent_health_change, model_deployments.frequent_health_change, model_deployments.health, inference_endpoints.health, model_deployments.management_agent, model_deployments.management_agent_health, prediction_request.all, challenger_management.all, challenger_replay.all, model_deployments.all, project.all, perma_delete_project.all, users_delete.all, applications.all, model_version.stage_transitions, model_version.all, batch_predictions.all, change_requests.all, insights_computation.all, notebook_schedule.all, monitoring.all]

eventType [secure_config.created, secure_config.deleted, secure_config.shared, comment.created, comment.updated, dataset.created, dataset.registered, dataset.deleted, datasets.deleted, datasetrelationship.created, dataset.shared, datasets.shared, misc.asset_access_request, misc.webhook_connection_test, misc.webhook_resend, misc.email_verification, monitoring.spooler_channel_base, monitoring.spooler_channel_red, monitoring.spooler_channel_green, monitoring.external_model_nan_predictions, management.deploymentInfo, model_deployments.None, model_deployments.deployment_sharing, model_deployments.model_replacement, prediction_request.None, prediction_request.failed, model_deployments.model_replacement_lifecycle, model_deployments.model_replacement_started, model_deployments.model_replacement_succeeded, model_deployments.model_replacement_failed, model_deployments.model_replacement_validation_warning, model_deployments.deployment_creation, model_deployments.deployment_deletion, model_deployments.service_health_yellow_from_green, model_deployments.service_health_yellow_from_red, model_deployments.service_health_red, model_deployments.data_drift_yellow_from_green, model_deployments.data_drift_yellow_from_red, model_deployments.data_drift_red, model_deployments.accuracy_yellow_from_green, model_deployments.accuracy_yellow_from_red, model_deployments.accuracy_red, model_deployments.health.fairness_health.green_to_yellow, model_deployments.health.fairness_health.red_to_yellow, model_deployments.health.fairness_health.red, model_deployments.health.custom_metrics_health.green_to_yellow, model_deployments.health.custom_metrics_health.red_to_yellow, model_deployments.health.custom_metrics_health.red, model_deployments.health.base.green, model_deployments.service_health_green, model_deployments.data_drift_green, model_deployments.accuracy_green, model_deployments.health.fairness_health.green, model_deployments.health.custom_metrics_health.green, model_deployments.retraining_policy_run_started, model_deployments.retraining_policy_run_succeeded, model_deployments.retraining_policy_run_failed, model_deployments.challenger_scoring_success, model_deployments.challenger_scoring_data_warning, model_deployments.challenger_scoring_failure, model_deployments.challenger_scoring_started, model_deployments.challenger_model_validation_warning, model_deployments.challenger_model_created, model_deployments.challenger_model_deleted, model_deployments.actuals_upload_failed, model_deployments.actuals_upload_warning, model_deployments.training_data_baseline_calculation_started, model_deployments.training_data_baseline_calculation_completed, model_deployments.training_data_baseline_failed, model_deployments.custom_model_deployment_creation_started, model_deployments.custom_model_deployment_creation_completed, model_deployments.custom_model_deployment_creation_failed, model_deployments.deployment_prediction_explanations_preview_job_submitted, model_deployments.deployment_prediction_explanations_preview_job_completed, model_deployments.deployment_prediction_explanations_preview_job_failed, model_deployments.custom_model_deployment_activated, model_deployments.custom_model_deployment_activation_failed, model_deployments.custom_model_deployment_deactivated, model_deployments.custom_model_deployment_deactivation_failed, model_deployments.prediction_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_warning, model_deployments.actuals_processing_rate_limit_reached, model_deployments.actuals_processing_rate_limit_warning, model_deployments.deployment_monitoring_data_cleared, model_deployments.deployment_launch_started, model_deployments.deployment_launch_succeeded, model_deployments.deployment_launch_failed, model_deployments.deployment_shutdown_started, model_deployments.deployment_shutdown_succeeded, model_deployments.deployment_shutdown_failed, model_deployments.endpoint_update_started, model_deployments.endpoint_update_succeeded, model_deployments.endpoint_update_failed, model_deployments.management_agent_service_health_green, model_deployments.management_agent_service_health_yellow, model_deployments.management_agent_service_health_red, model_deployments.management_agent_service_health_unknown, model_deployments.predictions_missing_association_id, model_deployments.prediction_result_rows_cleand_up, model_deployments.batch_deleted, model_deployments.batch_creation_limit_reached, model_deployments.batch_creation_limit_exceeded, model_deployments.batch_not_found, model_deployments.predictions_encountered_for_locked_batch, model_deployments.predictions_encountered_for_deleted_batch, model_deployments.scheduled_report_generated, model_deployments.predictions_timeliness_health_red, model_deployments.actuals_timeliness_health_red, model_deployments.service_health_still_red, model_deployments.data_drift_still_red, model_deployments.accuracy_still_red, model_deployments.health.fairness_health.still_red, model_deployments.health.custom_metrics_health.still_red, model_deployments.predictions_timeliness_health_still_red, model_deployments.actuals_timeliness_health_still_red, model_deployments.service_health_still_yellow, model_deployments.data_drift_still_yellow, model_deployments.accuracy_still_yellow, model_deployments.health.fairness_health.still_yellow, model_deployments.health.custom_metrics_health.still_yellow, model_deployments.prediction_payload_parsing_failure, model_deployments.deployment_inference_server_creation_started, model_deployments.deployment_inference_server_creation_failed, model_deployments.deployment_inference_server_creation_completed, model_deployments.deployment_inference_server_deletion, model_deployments.deployment_inference_server_idle_stopped, entity_notification_policy_template.shared, notification_channel_template.shared, project.created, project.deleted, project.shared, autopilot.complete, autopilot.started, autostart.failure, perma_delete_project.success, perma_delete_project.failure, users_delete.preview_started, users_delete.preview_completed, users_delete.preview_failed, users_delete.started, users_delete.completed, users_delete.failed, application.created, application.shared, model_version.added, model_version.stage_transition_from_registered_to_development, model_version.stage_transition_from_registered_to_staging, model_version.stage_transition_from_registered_to_production, model_version.stage_transition_from_registered_to_archived, model_version.stage_transition_from_development_to_registered, model_version.stage_transition_from_development_to_staging, model_version.stage_transition_from_development_to_production, model_version.stage_transition_from_development_to_archived, model_version.stage_transition_from_staging_to_registered, model_version.stage_transition_from_staging_to_development, model_version.stage_transition_from_staging_to_production, model_version.stage_transition_from_staging_to_archived, model_version.stage_transition_from_production_to_registered, model_version.stage_transition_from_production_to_development, model_version.stage_transition_from_production_to_staging, model_version.stage_transition_from_production_to_archived, model_version.stage_transition_from_archived_to_registered, model_version.stage_transition_from_archived_to_development, model_version.stage_transition_from_archived_to_production, model_version.stage_transition_from_archived_to_staging, batch_predictions.success, batch_predictions.failed, batch_predictions.scheduler.auto_disabled, change_request.cancelled, change_request.created, change_request.deployment_approval_requested, change_request.resolved, change_request.proposed_changes_updated, change_request.pending, change_request.commenting_review_added, change_request.approving_review_added, change_request.changes_requesting_review_added, prediction_explanations_computation.None, prediction_explanations_computation.prediction_explanations_preview_job_submitted, prediction_explanations_computation.prediction_explanations_preview_job_completed, prediction_explanations_computation.prediction_explanations_preview_job_failed, monitoring.rate_limit_enforced, notebook_schedule.created, notebook_schedule.failure, notebook_schedule.completed, abstract, moderation.metric.creation_error, moderation.metric.reporting_error, moderation.model.moderation_started, moderation.model.moderation_completed, moderation.model.pre_score_phase_started, moderation.model.pre_score_phase_completed, moderation.model.post_score_phase_started, moderation.model.post_score_phase_completed, moderation.model.config_error, moderation.model.runtime_error, moderation.model.scoring_started, moderation.model.scoring_completed, moderation.model.scoring_error]

EntityNotificationPolicyUpdate

{
  "active": true,
  "channelId": "string",
  "channelScope": "organization",
  "eventGroup": "secure_config.all",
  "eventType": "secure_config.created",
  "maximalFrequency": "string",
  "name": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
active	boolean	false		Defines if the notification policy is active or not.
channelId	string	false		The id of the notification channel to be used to send the notification.
channelScope	string	false		Scope of the channel.
eventGroup	string	false		The group of the event that trigger the notification.
eventType	string	false		The type of the event that triggers the notification.
maximalFrequency	string,null	false		Maximal frequency between policy runs in ISO 8601 duration string.
name	string	false	maxLength: 100	The name of the notification policy.

Enumerated Values¶

Property	Value
channelScope	[`organization`, `Organization`, `ORGANIZATION`, `entity`, `Entity`, `ENTITY`, `template`, `Template`, `TEMPLATE`]
eventGroup	[`secure_config.all`, `comment.all`, `dataset.all`, `deployment_prediction_explanations_computation.all`, `model_deployments.critical_health`, `model_deployments.critical_frequent_health_change`, `model_deployments.frequent_health_change`, `model_deployments.health`, `inference_endpoints.health`, `model_deployments.management_agent`, `model_deployments.management_agent_health`, `prediction_request.all`, `challenger_management.all`, `challenger_replay.all`, `model_deployments.all`, `project.all`, `perma_delete_project.all`, `users_delete.all`, `applications.all`, `model_version.stage_transitions`, `model_version.all`, `batch_predictions.all`, `change_requests.all`, `insights_computation.all`, `notebook_schedule.all`, `monitoring.all`]
eventType	[`secure_config.created`, `secure_config.deleted`, `secure_config.shared`, `comment.created`, `comment.updated`, `dataset.created`, `dataset.registered`, `dataset.deleted`, `datasets.deleted`, `datasetrelationship.created`, `dataset.shared`, `datasets.shared`, `misc.asset_access_request`, `misc.webhook_connection_test`, `misc.webhook_resend`, `misc.email_verification`, `monitoring.spooler_channel_base`, `monitoring.spooler_channel_red`, `monitoring.spooler_channel_green`, `monitoring.external_model_nan_predictions`, `management.deploymentInfo`, `model_deployments.None`, `model_deployments.deployment_sharing`, `model_deployments.model_replacement`, `prediction_request.None`, `prediction_request.failed`, `model_deployments.model_replacement_lifecycle`, `model_deployments.model_replacement_started`, `model_deployments.model_replacement_succeeded`, `model_deployments.model_replacement_failed`, `model_deployments.model_replacement_validation_warning`, `model_deployments.deployment_creation`, `model_deployments.deployment_deletion`, `model_deployments.service_health_yellow_from_green`, `model_deployments.service_health_yellow_from_red`, `model_deployments.service_health_red`, `model_deployments.data_drift_yellow_from_green`, `model_deployments.data_drift_yellow_from_red`, `model_deployments.data_drift_red`, `model_deployments.accuracy_yellow_from_green`, `model_deployments.accuracy_yellow_from_red`, `model_deployments.accuracy_red`, `model_deployments.health.fairness_health.green_to_yellow`, `model_deployments.health.fairness_health.red_to_yellow`, `model_deployments.health.fairness_health.red`, `model_deployments.health.custom_metrics_health.green_to_yellow`, `model_deployments.health.custom_metrics_health.red_to_yellow`, `model_deployments.health.custom_metrics_health.red`, `model_deployments.health.base.green`, `model_deployments.service_health_green`, `model_deployments.data_drift_green`, `model_deployments.accuracy_green`, `model_deployments.health.fairness_health.green`, `model_deployments.health.custom_metrics_health.green`, `model_deployments.retraining_policy_run_started`, `model_deployments.retraining_policy_run_succeeded`, `model_deployments.retraining_policy_run_failed`, `model_deployments.challenger_scoring_success`, `model_deployments.challenger_scoring_data_warning`, `model_deployments.challenger_scoring_failure`, `model_deployments.challenger_scoring_started`, `model_deployments.challenger_model_validation_warning`, `model_deployments.challenger_model_created`, `model_deployments.challenger_model_deleted`, `model_deployments.actuals_upload_failed`, `model_deployments.actuals_upload_warning`, `model_deployments.training_data_baseline_calculation_started`, `model_deployments.training_data_baseline_calculation_completed`, `model_deployments.training_data_baseline_failed`, `model_deployments.custom_model_deployment_creation_started`, `model_deployments.custom_model_deployment_creation_completed`, `model_deployments.custom_model_deployment_creation_failed`, `model_deployments.deployment_prediction_explanations_preview_job_submitted`, `model_deployments.deployment_prediction_explanations_preview_job_completed`, `model_deployments.deployment_prediction_explanations_preview_job_failed`, `model_deployments.custom_model_deployment_activated`, `model_deployments.custom_model_deployment_activation_failed`, `model_deployments.custom_model_deployment_deactivated`, `model_deployments.custom_model_deployment_deactivation_failed`, `model_deployments.prediction_processing_rate_limit_reached`, `model_deployments.prediction_data_processing_rate_limit_reached`, `model_deployments.prediction_data_processing_rate_limit_warning`, `model_deployments.actuals_processing_rate_limit_reached`, `model_deployments.actuals_processing_rate_limit_warning`, `model_deployments.deployment_monitoring_data_cleared`, `model_deployments.deployment_launch_started`, `model_deployments.deployment_launch_succeeded`, `model_deployments.deployment_launch_failed`, `model_deployments.deployment_shutdown_started`, `model_deployments.deployment_shutdown_succeeded`, `model_deployments.deployment_shutdown_failed`, `model_deployments.endpoint_update_started`, `model_deployments.endpoint_update_succeeded`, `model_deployments.endpoint_update_failed`, `model_deployments.management_agent_service_health_green`, `model_deployments.management_agent_service_health_yellow`, `model_deployments.management_agent_service_health_red`, `model_deployments.management_agent_service_health_unknown`, `model_deployments.predictions_missing_association_id`, `model_deployments.prediction_result_rows_cleand_up`, `model_deployments.batch_deleted`, `model_deployments.batch_creation_limit_reached`, `model_deployments.batch_creation_limit_exceeded`, `model_deployments.batch_not_found`, `model_deployments.predictions_encountered_for_locked_batch`, `model_deployments.predictions_encountered_for_deleted_batch`, `model_deployments.scheduled_report_generated`, `model_deployments.predictions_timeliness_health_red`, `model_deployments.actuals_timeliness_health_red`, `model_deployments.service_health_still_red`, `model_deployments.data_drift_still_red`, `model_deployments.accuracy_still_red`, `model_deployments.health.fairness_health.still_red`, `model_deployments.health.custom_metrics_health.still_red`, `model_deployments.predictions_timeliness_health_still_red`, `model_deployments.actuals_timeliness_health_still_red`, `model_deployments.service_health_still_yellow`, `model_deployments.data_drift_still_yellow`, `model_deployments.accuracy_still_yellow`, `model_deployments.health.fairness_health.still_yellow`, `model_deployments.health.custom_metrics_health.still_yellow`, `model_deployments.prediction_payload_parsing_failure`, `model_deployments.deployment_inference_server_creation_started`, `model_deployments.deployment_inference_server_creation_failed`, `model_deployments.deployment_inference_server_creation_completed`, `model_deployments.deployment_inference_server_deletion`, `model_deployments.deployment_inference_server_idle_stopped`, `entity_notification_policy_template.shared`, `notification_channel_template.shared`, `project.created`, `project.deleted`, `project.shared`, `autopilot.complete`, `autopilot.started`, `autostart.failure`, `perma_delete_project.success`, `perma_delete_project.failure`, `users_delete.preview_started`, `users_delete.preview_completed`, `users_delete.preview_failed`, `users_delete.started`, `users_delete.completed`, `users_delete.failed`, `application.created`, `application.shared`, `model_version.added`, `model_version.stage_transition_from_registered_to_development`, `model_version.stage_transition_from_registered_to_staging`, `model_version.stage_transition_from_registered_to_production`, `model_version.stage_transition_from_registered_to_archived`, `model_version.stage_transition_from_development_to_registered`, `model_version.stage_transition_from_development_to_staging`, `model_version.stage_transition_from_development_to_production`, `model_version.stage_transition_from_development_to_archived`, `model_version.stage_transition_from_staging_to_registered`, `model_version.stage_transition_from_staging_to_development`, `model_version.stage_transition_from_staging_to_production`, `model_version.stage_transition_from_staging_to_archived`, `model_version.stage_transition_from_production_to_registered`, `model_version.stage_transition_from_production_to_development`, `model_version.stage_transition_from_production_to_staging`, `model_version.stage_transition_from_production_to_archived`, `model_version.stage_transition_from_archived_to_registered`, `model_version.stage_transition_from_archived_to_development`, `model_version.stage_transition_from_archived_to_production`, `model_version.stage_transition_from_archived_to_staging`, `batch_predictions.success`, `batch_predictions.failed`, `batch_predictions.scheduler.auto_disabled`, `change_request.cancelled`, `change_request.created`, `change_request.deployment_approval_requested`, `change_request.resolved`, `change_request.proposed_changes_updated`, `change_request.pending`, `change_request.commenting_review_added`, `change_request.approving_review_added`, `change_request.changes_requesting_review_added`, `prediction_explanations_computation.None`, `prediction_explanations_computation.prediction_explanations_preview_job_submitted`, `prediction_explanations_computation.prediction_explanations_preview_job_completed`, `prediction_explanations_computation.prediction_explanations_preview_job_failed`, `monitoring.rate_limit_enforced`, `notebook_schedule.created`, `notebook_schedule.failure`, `notebook_schedule.completed`, `abstract`, `moderation.metric.creation_error`, `moderation.metric.reporting_error`, `moderation.model.moderation_started`, `moderation.model.moderation_completed`, `moderation.model.pre_score_phase_started`, `moderation.model.pre_score_phase_completed`, `moderation.model.post_score_phase_started`, `moderation.model.post_score_phase_completed`, `moderation.model.config_error`, `moderation.model.runtime_error`, `moderation.model.scoring_started`, `moderation.model.scoring_completed`, `moderation.model.scoring_error`]

EventGroup

{
  "events": [
    {
      "id": "string",
      "label": "string"
    }
  ],
  "id": "string",
  "label": "string"
}

The group of the event that trigger the notification.

Properties¶

Name	Type	Required	Restrictions	Description
events	[EventType]	true	maxItems: 1000	The events included in this group.
id	string	true		The id of the event group.
label	string	true		The display name of the event group.

EventGroupResponse

{
  "events": [
    "string"
  ],
  "id": "string",
  "label": "string",
  "requireMaxFrequency": true
}

Properties¶

Name	Type	Required	Description
events	[string]	true	Event types belonging to the group
id	string	true	Group ID
label	string	true	Group name for display
requireMaxFrequency	boolean	true	Indicates if a group requires max frequency setting.

EventResponse

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

Properties¶

Name	Type	Required	Description
id	string	true	Event type as an ID
label	string	true	Event type for display
requireMaxFrequency	boolean	true	Indicates if an event requires max frequency setting.

EventType

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

The type of the event that triggers the notification.

Properties¶

Name	Type	Required	Restrictions	Description
id	string	true		The id of the event type.
label	string	true		The display name of the event type.

ExternalNaNPredictionsEventData

{
  "count": 0,
  "modelId": null
}

External NaN Predictions event payload

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true		Number of NaN predictions by external model
modelId	string,null	true		The identifier of the model.

GrantAccessControlWithId

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

Properties¶

Name	Type	Required	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	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`]

ModerationData

{
  "guardName": "string",
  "metricName": "string"
}

Moderation event information

Properties¶

Name	Type	Required	Restrictions	Description
guardName	string	true	maxLength: 255	Name or label of the guard.
metricName	string	true	maxLength: 255	Name or label of the metric.

NotificationChannel

{
  "channelType": "Database",
  "contentType": "application/json",
  "createdAt": "2019-08-24T14:15:22Z",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "id": "string",
  "languageCode": "en",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "validateSsl": true
}

The information notification channel to be used to send the notification.

Properties¶

Name	Type	Required	Restrictions	Description
channelType	string	true		The type of the new notification channel.
contentType	string,null	true		The content type of the messages of the new notification channel.
createdAt	string(date-time)	true		The date of the notification channel creation.
customHeaders	[CustomerHeader]	true	maxItems: 100	Custom headers and their values to be sent in the new notification channel.
emailAddress	string,null	true		The email address to be used in the new notification channel.
id	string	true		The id of the notification channel.
languageCode	string,null	true		The preferred language code.
name	string	true		The name of the new notification channel.
orgId	string,null	true		The id of organization that notification channel belongs to.
payloadUrl	string,null(uri)	true		The payload URL of the new notification channel.
secretToken	string,null	true		Secret token to be used for new notification channel.
uid	string,null	true		The identifier of the user who created the channel.
updatedAt	string,null(date-time)	true		The date when the channel was updated.
validateSsl	boolean,null	true		Defines if validate ssl or not in the notification channel.

Enumerated Values¶

Property	Value
channelType	[`Database`, `Email`, `InApp`, `InsightsComputations`, `MSTeams`, `Slack`, `Webhook`]
contentType	[`application/json`, `application/x-www-form-urlencoded`]
languageCode	[`en`, `es_419`, `fr`, `ja`, `ko`, `ptBR`]

NotificationChannelCreate

{
  "channelType": "Database",
  "contentType": "application/json",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "languageCode": "en",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true,
  "verificationCode": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
channelType	string	true		The type of the new notification channel.
contentType	string	false		The content type of the messages of the new notification channel.
customHeaders	[CustomerHeader]	false	maxItems: 100	Custom headers and their values to be sent in the new notification channel.
emailAddress	string	false		The email address to be used in the new notification channel.
languageCode	string	false		The preferred language code.
name	string	true	maxLength: 100	The name of the new notification channel.
orgId	string	false		The id of organization that notification channel belongs to.
payloadUrl	string(uri)	false		The payload URL of the new notification channel.
secretToken	string	false		Secret token to be used for new notification channel.
validateSsl	boolean	false		Defines if validate ssl or not in the notification channel.
verificationCode	string	false		Required if the channel type is Email.

Enumerated Values¶

Property	Value
channelType	[`Database`, `Email`, `InApp`, `InsightsComputations`, `MSTeams`, `Slack`, `Webhook`]
contentType	[`application/json`, `application/x-www-form-urlencoded`]
languageCode	[`en`, `es_419`, `fr`, `ja`, `ko`, `ptBR`]

NotificationChannelResponse

{
  "channelType": "Database",
  "contentType": "application/json",
  "createdAt": "2019-08-24T14:15:22Z",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "id": "string",
  "languageCode": "en",
  "lastNotificationAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "policyCount": 0,
  "secretToken": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "validateSsl": true
}

Properties¶

Name	Type	Required	Restrictions	Description
channelType	string	true		The type of the new notification channel.
contentType	string,null	true		The content type of the messages of the new notification channel.
createdAt	string(date-time)	true		The date of the notification channel creation.
customHeaders	[CustomerHeader]	true	maxItems: 100	Custom headers and their values to be sent in the new notification channel.
emailAddress	string,null	true		The email address to be used in the new notification channel.
id	string	true		The id of the notification channel.
languageCode	string,null	true		The preferred language code.
lastNotificationAt	string,null(date-time)	true		The timestamp of the last notification sent to the channel.
name	string	true		The name of the new notification channel.
orgId	string,null	true		The id of organization that notification channel belongs to.
payloadUrl	string,null(uri)	true		The payload URL of the new notification channel.
policyCount	integer	true		Count of policies assigned to the channel.
secretToken	string,null	true		Secret token to be used for new notification channel.
uid	string,null	true		The identifier of the user who created the channel.
updatedAt	string,null(date-time)	true		The date when the channel was updated.
validateSsl	boolean,null	true		Defines if validate ssl or not in the notification channel.

Enumerated Values¶

Property	Value
channelType	[`Database`, `Email`, `InApp`, `InsightsComputations`, `MSTeams`, `Slack`, `Webhook`]
contentType	[`application/json`, `application/x-www-form-urlencoded`]
languageCode	[`en`, `es_419`, `fr`, `ja`, `ko`, `ptBR`]

NotificationChannelTempPolicyTemplateResponse

{
  "id": "string",
  "name": "string",
  "relatedEntityType": "deployment"
}

Properties¶

Name	Type	Required	Description
id	string	true	The id of the policy template.
name	string	true	The name of the notification policy template.
relatedEntityType	string	true	Type of related entity template.

Enumerated Values¶

Property	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

NotificationChannelTemplateCreate

{
  "channelType": "DataRobotCustomJob",
  "contentType": "application/json",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "drEntities": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "emailAddress": "string",
  "languageCode": "en",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true,
  "verificationCode": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
channelType	string	true		The type of the new notification channel.
contentType	string	false		The content type of the messages of the new notification channel.
customHeaders	[CustomerHeader]	false	maxItems: 100	Custom headers and their values to be sent in the new notification channel.
drEntities	[DREntity]	false	maxItems: 100 minItems: 1	The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.
emailAddress	string	false		The email address to be used in the new notification channel.
languageCode	string	false		The preferred language code.
name	string	true	maxLength: 100	The name of the new notification channel.
orgId	string	false		The id of organization that notification channel belongs to.
payloadUrl	string(uri)	false		The payload URL of the new notification channel.
secretToken	string	false		Secret token to be used for new notification channel.
validateSsl	boolean	false		Defines if validate ssl or not in the notification channel.
verificationCode	string	false		Required if the channel type is Email.

Enumerated Values¶

Property	Value
channelType	[`DataRobotCustomJob`, `DataRobotGroup`, `DataRobotUser`, `Database`, `Email`, `InApp`, `InsightsComputations`, `MSTeams`, `Slack`, `Webhook`]
contentType	[`application/json`, `application/x-www-form-urlencoded`]
languageCode	[`en`, `es_419`, `fr`, `ja`, `ko`, `ptBR`]

NotificationChannelTemplateRelatedPoliciesListResponse

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "relatedEntityId": "string",
      "relatedEntityName": "string",
      "relatedEntityType": "deployment"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true		The number of entity policies returned.
data	[NotificationChannelTemplateRelatedPolicyResponse]	true	maxItems: 1000	The entity notification policies.
next	string,null	true		URL pointing to the next page.
previous	string,null	true		URL pointing to the previous page.
totalCount	integer	true		The total number of entity policies that satisfy the query.

NotificationChannelTemplateRelatedPolicyResponse

{
  "id": "string",
  "name": "string",
  "relatedEntityId": "string",
  "relatedEntityName": "string",
  "relatedEntityType": "deployment"
}

Properties¶

Name	Type	Required	Description
id	string	true	The id of the policy.
name	string	true	The name of the notification policy.
relatedEntityId	string	true	The id of related entity.
relatedEntityName	string	true	The name of related entity.
relatedEntityType	string	true	Type of related entity.

Enumerated Values¶

Property	Value
relatedEntityType	[`deployment`, `Deployment`, `DEPLOYMENT`]

NotificationChannelTemplateRelatedPolicyTemplateListResponse

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "relatedEntityType": "deployment"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true		The number of entity policies returned.
data	[NotificationChannelTempPolicyTemplateResponse]	true	maxItems: 1000	The entity notification policy template.
next	string,null	true		URL pointing to the next page.
previous	string,null	true		URL pointing to the previous page.
totalCount	integer	true		The total number of entity policies that satisfy the query.

NotificationChannelTemplateResponse

{
  "channelType": "DataRobotCustomJob",
  "contentType": "application/json",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "firstName": "string",
    "lastName": "string",
    "username": "string"
  },
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "drEntities": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "emailAddress": "string",
  "id": "string",
  "languageCode": "en",
  "lastNotificationAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "policyCount": 0,
  "policyTemplatesCount": 0,
  "role": "string",
  "secretToken": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "validateSsl": true
}

Properties¶

Name	Type	Required	Restrictions	Description
channelType	string	true		The type of the new notification channel.
contentType	string,null	true		The content type of the messages of the new notification channel.
createdAt	string(date-time)	true		The date of the notification channel creation.
createdBy	ChannelCreatedByResponse	true		User that created template.
customHeaders	[CustomerHeader]	true	maxItems: 100	Custom headers and their values to be sent in the new notification channel.
drEntities	[DREntity]	false	maxItems: 100 minItems: 1	The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.
emailAddress	string,null	true		The email address to be used in the new notification channel.
id	string	true		The id of the notification channel.
languageCode	string,null	true		The preferred language code.
lastNotificationAt	string,null(date-time)	true		The timestamp of the last notification sent to the channel.
name	string	true		The name of the new notification channel.
orgId	string,null	true		The id of organization that notification channel belongs to.
payloadUrl	string,null(uri)	true		The payload URL of the new notification channel.
policyCount	integer	true		Count of policies assigned to the channel.
policyTemplatesCount	integer	true		Count of policiestemplates assigned to the channel.
role	string,null	true		User role on entity.
secretToken	string,null	true		Secret token to be used for new notification channel.
uid	string,null	true		The identifier of the user who created the channel.
updatedAt	string,null(date-time)	true		The date when the channel was updated.
validateSsl	boolean,null	true		Defines if validate ssl or not in the notification channel.

Enumerated Values¶

Property	Value
channelType	[`DataRobotCustomJob`, `DataRobotGroup`, `DataRobotUser`, `Database`, `Email`, `InApp`, `InsightsComputations`, `MSTeams`, `Slack`, `Webhook`]
contentType	[`application/json`, `application/x-www-form-urlencoded`]
languageCode	[`en`, `es_419`, `fr`, `ja`, `ko`, `ptBR`]

NotificationChannelTemplatesListResponse

{
  "count": 0,
  "data": [
    {
      "channelType": "DataRobotCustomJob",
      "contentType": "application/json",
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "firstName": "string",
        "lastName": "string",
        "username": "string"
      },
      "customHeaders": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "drEntities": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "emailAddress": "string",
      "id": "string",
      "languageCode": "en",
      "lastNotificationAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "orgId": "string",
      "payloadUrl": "http://example.com",
      "policyCount": 0,
      "policyTemplatesCount": 0,
      "role": "string",
      "secretToken": "string",
      "uid": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "validateSsl": true
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true		The number of channel templates returned.
data	[NotificationChannelTemplateResponse]	true	maxItems: 1000	The notification channel templates.
next	string,null	true		URL pointing to the next page.
previous	string,null	true		URL pointing to the previous page.
totalCount	integer	true		The total number of channel templates that satisfy the query.

NotificationChannelUpdate

{
  "contentType": "application/json",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "languageCode": "en",
  "name": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true,
  "verificationCode": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
contentType	string	false		The content type of the messages of the new notification channel.
customHeaders	[CustomerHeader]	false	maxItems: 100	Custom headers and their values to be sent in the new notification channel.
emailAddress	string	false		The email address to be used in the new notification channel.
languageCode	string	false		The preferred language code.
name	string	false	maxLength: 100	The name of the new notification channel.
payloadUrl	string(uri)	false		The payload URL of the new notification channel.
secretToken	string	false		Secret token to be used for new notification channel.
validateSsl	boolean	false		Defines if validate ssl or not in the notification channel.
verificationCode	string	false		Required if the channel type is Email.

Enumerated Values¶

Property	Value
contentType	[`application/json`, `application/x-www-form-urlencoded`]
languageCode	[`en`, `es_419`, `fr`, `ja`, `ko`, `ptBR`]

NotificationChannelWithDREntityUpdate

{
  "channelType": "DataRobotCustomJob",
  "contentType": "application/json",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "drEntities": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "emailAddress": "string",
  "languageCode": "en",
  "name": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true,
  "verificationCode": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
channelType	string	false		The type of the new notification channel.
contentType	string	false		The content type of the messages of the new notification channel.
customHeaders	[CustomerHeader]	false	maxItems: 100	Custom headers and their values to be sent in the new notification channel.
drEntities	[DREntity]	false	maxItems: 100 minItems: 1	The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.
emailAddress	string	false		The email address to be used in the new notification channel.
languageCode	string	false		The preferred language code.
name	string	false	maxLength: 100	The name of the new notification channel.
payloadUrl	string(uri)	false		The payload URL of the new notification channel.
secretToken	string	false		Secret token to be used for new notification channel.
validateSsl	boolean	false		Defines if validate ssl or not in the notification channel.
verificationCode	string	false		Required if the channel type is Email.

Enumerated Values¶

Property	Value
channelType	[`DataRobotCustomJob`, `DataRobotGroup`, `DataRobotUser`, `Database`, `Email`, `InApp`, `InsightsComputations`, `MSTeams`, `Slack`, `Webhook`]
contentType	[`application/json`, `application/x-www-form-urlencoded`]
languageCode	[`en`, `es_419`, `fr`, `ja`, `ko`, `ptBR`]

NotificationChannelsListResponse

{
  "count": 0,
  "data": [
    {
      "channelType": "Database",
      "contentType": "application/json",
      "createdAt": "2019-08-24T14:15:22Z",
      "customHeaders": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "emailAddress": "string",
      "id": "string",
      "languageCode": "en",
      "lastNotificationAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "orgId": "string",
      "payloadUrl": "http://example.com",
      "policyCount": 0,
      "secretToken": "string",
      "uid": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "validateSsl": true
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true		The number of channels returned.
data	[NotificationChannelResponse]	true	maxItems: 1000	The notification channels.
next	string,null	true		URL pointing to the next page.
previous	string,null	true		URL pointing to the previous page.
totalCount	integer	true		The total number of channels that satisfy the query.

NotificationEmailChannelVerification

{
  "channelType": "string",
  "emailAddress": "string",
  "name": "string",
  "orgId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
channelType	string	true		The type of the new notification channel
emailAddress	string	true		The email address of the recipient
name	string	true	maxLength: 100	The name of the new notification channel
orgId	string	false		The id of organization that notification channel belongs to

NotificationEmailChannelVerificationResponse

{
  "notificationId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
notificationId	string	true		The response body is the json object with notification_id in it

NotificationEmailChannelVerificationStatus

{
  "emailAddress": "string",
  "verificationCode": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
emailAddress	string	true		The email address of the recipient
verificationCode	string	true		The user entered verification code

NotificationEmailChannelVerificationStatusResponse

{
  "status": true
}

Properties¶

Name	Type	Required	Restrictions	Description
status	boolean	true		The status shows if admin entered the correct 6 digit verification code

NotificationEventListResponse

{
  "eventGroups": [
    {
      "events": [
        "string"
      ],
      "id": "string",
      "label": "string",
      "requireMaxFrequency": true
    }
  ],
  "events": [
    {
      "id": "string",
      "label": "string",
      "requireMaxFrequency": true
    }
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
eventGroups	[EventGroupResponse]	true		Selectable event groups
events	[EventResponse]	true		Selectable individual events

NotificationLog

{
  "channelId": "string",
  "channelScope": "organization",
  "emailSubject": "string",
  "id": "string",
  "parentNotificationId": "string",
  "policyId": "string",
  "request": "string",
  "response": "string",
  "retryCount": 0,
  "status": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

The notification log record.

Properties¶

Name	Type	Required	Description
channelId	string	true	The id of the channel that was used to send the notification.
channelScope	string,null	true	Scope of the channel.
emailSubject	string,null	true	The email subject of the notification.
id	string	true	The id of the notification log.
parentNotificationId	string,null	true	The id of the parent notification.
policyId	string	true	The id of the policy that was used to send the notification.
request	string,null	true	The request that was sent in the notification.
response	string,null	true	The response that was received after sending the notification.
retryCount	integer,null	true	The number of attempts to send the notification.
status	string	true	The status of the notification.
timestamp	string(date-time)	true	The date when the notification was sent.

Enumerated Values¶

Property	Value
channelScope	[`organization`, `Organization`, `ORGANIZATION`, `entity`, `Entity`, `ENTITY`, `template`, `Template`, `TEMPLATE`]

NotificationLogListDataResponse

{
  "channelId": "string",
  "channelScope": "organization",
  "emailSubject": "string",
  "id": "string",
  "parentNotificationId": "string",
  "policyId": "string",
  "request": {
    "body": "string",
    "headers": "string",
    "url": "http://example.com"
  },
  "response": {
    "body": "string",
    "duration": 0,
    "headers": "string",
    "statusCode": "string"
  },
  "retryCount": 0,
  "status": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

Properties¶

Name	Type	Required	Description
channelId	string	true	The id of the channel that was used to send the notification
channelScope	string,null	true	Scope of the channel.
emailSubject	string	true	The email subject
id	string	true	The id of the notification log
parentNotificationId	string,null	true	The ID of the parent notification
policyId	string	true	the id of the policy that was used to send the notification
request	RequestNotification	true	The request that was sent in the notification
response	ResponseNotification	true	The response that was received after sending the notification
retryCount	integer	true	The count of the retries while sending the notification
status	string,null	true	The status of the notification
timestamp	string(date-time)	true	The date and time when the notification was sent

Enumerated Values¶

Property	Value
channelScope	[`organization`, `Organization`, `ORGANIZATION`, `entity`, `Entity`, `ENTITY`, `template`, `Template`, `TEMPLATE`]

NotificationLogListResponse

{
  "count": 0,
  "data": [
    {
      "channelId": "string",
      "channelScope": "organization",
      "emailSubject": "string",
      "id": "string",
      "parentNotificationId": "string",
      "policyId": "string",
      "request": {
        "body": "string",
        "headers": "string",
        "url": "http://example.com"
      },
      "response": {
        "body": "string",
        "duration": 0,
        "headers": "string",
        "statusCode": "string"
      },
      "retryCount": 0,
      "status": "string",
      "timestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	true	Number of items returned on this page
data	[NotificationLogListDataResponse]	true	An array notification logs
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page)
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page)
totalCount	integer	false	The total number of notifications

NotificationPoliciesListResponse

{
  "count": 0,
  "data": [
    {
      "active": true,
      "channel": {
        "channelType": "Database",
        "contentType": "application/json",
        "createdAt": "2019-08-24T14:15:22Z",
        "customHeaders": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "emailAddress": "string",
        "id": "string",
        "languageCode": "en",
        "name": "string",
        "orgId": "string",
        "payloadUrl": "http://example.com",
        "secretToken": "string",
        "uid": "string",
        "updatedAt": "2019-08-24T14:15:22Z",
        "validateSsl": true
      },
      "channelId": "string",
      "created": "2019-08-24T14:15:22Z",
      "eventGroup": {
        "events": [
          {
            "id": "string",
            "label": "string"
          }
        ],
        "id": "string",
        "label": "string"
      },
      "eventType": {
        "id": "string",
        "label": "string"
      },
      "id": "string",
      "lastTriggered": "2019-08-24T14:15:22Z",
      "name": "string",
      "orgId": "string",
      "uid": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true		The number of policies returned.
data	[NotificationPolicyResponse]	true	maxItems: 1000	The notification policies.
next	string,null	true		URL pointing to the next page.
previous	string,null	true		URL pointing to the previous page.
totalCount	integer	true		The total number of policies that satisfy the query.

NotificationPolicyCreate

{
  "active": true,
  "channelId": "string",
  "eventGroup": "secure_config.all",
  "eventType": "secure_config.created",
  "name": "string",
  "orgId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
active	boolean	false		Defines if the notification policy is active or not.
channelId	string	true		The id of the notification channel to be used to send the notification.
eventGroup	string	false		The group of the event that trigger the notification.
eventType	string	false		The type of the event that triggers the notification.
name	string	true	maxLength: 100	The name of the new notification policy.
orgId	string	false		The id of the organization that owns the notification policy.

Enumerated Values¶

Property Value

eventGroup [secure_config.all, comment.all, dataset.all, deployment_prediction_explanations_computation.all, model_deployments.critical_health, model_deployments.critical_frequent_health_change, model_deployments.frequent_health_change, model_deployments.health, inference_endpoints.health, model_deployments.management_agent, model_deployments.management_agent_health, prediction_request.all, challenger_management.all, challenger_replay.all, model_deployments.all, project.all, perma_delete_project.all, users_delete.all, applications.all, model_version.stage_transitions, model_version.all, batch_predictions.all, change_requests.all, insights_computation.all, notebook_schedule.all, monitoring.all]

eventType [secure_config.created, secure_config.deleted, secure_config.shared, comment.created, comment.updated, dataset.created, dataset.registered, dataset.deleted, datasets.deleted, datasetrelationship.created, dataset.shared, datasets.shared, misc.asset_access_request, misc.webhook_connection_test, misc.webhook_resend, misc.email_verification, monitoring.spooler_channel_base, monitoring.spooler_channel_red, monitoring.spooler_channel_green, monitoring.external_model_nan_predictions, management.deploymentInfo, model_deployments.None, model_deployments.deployment_sharing, model_deployments.model_replacement, prediction_request.None, prediction_request.failed, model_deployments.model_replacement_lifecycle, model_deployments.model_replacement_started, model_deployments.model_replacement_succeeded, model_deployments.model_replacement_failed, model_deployments.model_replacement_validation_warning, model_deployments.deployment_creation, model_deployments.deployment_deletion, model_deployments.service_health_yellow_from_green, model_deployments.service_health_yellow_from_red, model_deployments.service_health_red, model_deployments.data_drift_yellow_from_green, model_deployments.data_drift_yellow_from_red, model_deployments.data_drift_red, model_deployments.accuracy_yellow_from_green, model_deployments.accuracy_yellow_from_red, model_deployments.accuracy_red, model_deployments.health.fairness_health.green_to_yellow, model_deployments.health.fairness_health.red_to_yellow, model_deployments.health.fairness_health.red, model_deployments.health.custom_metrics_health.green_to_yellow, model_deployments.health.custom_metrics_health.red_to_yellow, model_deployments.health.custom_metrics_health.red, model_deployments.health.base.green, model_deployments.service_health_green, model_deployments.data_drift_green, model_deployments.accuracy_green, model_deployments.health.fairness_health.green, model_deployments.health.custom_metrics_health.green, model_deployments.retraining_policy_run_started, model_deployments.retraining_policy_run_succeeded, model_deployments.retraining_policy_run_failed, model_deployments.challenger_scoring_success, model_deployments.challenger_scoring_data_warning, model_deployments.challenger_scoring_failure, model_deployments.challenger_scoring_started, model_deployments.challenger_model_validation_warning, model_deployments.challenger_model_created, model_deployments.challenger_model_deleted, model_deployments.actuals_upload_failed, model_deployments.actuals_upload_warning, model_deployments.training_data_baseline_calculation_started, model_deployments.training_data_baseline_calculation_completed, model_deployments.training_data_baseline_failed, model_deployments.custom_model_deployment_creation_started, model_deployments.custom_model_deployment_creation_completed, model_deployments.custom_model_deployment_creation_failed, model_deployments.deployment_prediction_explanations_preview_job_submitted, model_deployments.deployment_prediction_explanations_preview_job_completed, model_deployments.deployment_prediction_explanations_preview_job_failed, model_deployments.custom_model_deployment_activated, model_deployments.custom_model_deployment_activation_failed, model_deployments.custom_model_deployment_deactivated, model_deployments.custom_model_deployment_deactivation_failed, model_deployments.prediction_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_warning, model_deployments.actuals_processing_rate_limit_reached, model_deployments.actuals_processing_rate_limit_warning, model_deployments.deployment_monitoring_data_cleared, model_deployments.deployment_launch_started, model_deployments.deployment_launch_succeeded, model_deployments.deployment_launch_failed, model_deployments.deployment_shutdown_started, model_deployments.deployment_shutdown_succeeded, model_deployments.deployment_shutdown_failed, model_deployments.endpoint_update_started, model_deployments.endpoint_update_succeeded, model_deployments.endpoint_update_failed, model_deployments.management_agent_service_health_green, model_deployments.management_agent_service_health_yellow, model_deployments.management_agent_service_health_red, model_deployments.management_agent_service_health_unknown, model_deployments.predictions_missing_association_id, model_deployments.prediction_result_rows_cleand_up, model_deployments.batch_deleted, model_deployments.batch_creation_limit_reached, model_deployments.batch_creation_limit_exceeded, model_deployments.batch_not_found, model_deployments.predictions_encountered_for_locked_batch, model_deployments.predictions_encountered_for_deleted_batch, model_deployments.scheduled_report_generated, model_deployments.predictions_timeliness_health_red, model_deployments.actuals_timeliness_health_red, model_deployments.service_health_still_red, model_deployments.data_drift_still_red, model_deployments.accuracy_still_red, model_deployments.health.fairness_health.still_red, model_deployments.health.custom_metrics_health.still_red, model_deployments.predictions_timeliness_health_still_red, model_deployments.actuals_timeliness_health_still_red, model_deployments.service_health_still_yellow, model_deployments.data_drift_still_yellow, model_deployments.accuracy_still_yellow, model_deployments.health.fairness_health.still_yellow, model_deployments.health.custom_metrics_health.still_yellow, model_deployments.prediction_payload_parsing_failure, model_deployments.deployment_inference_server_creation_started, model_deployments.deployment_inference_server_creation_failed, model_deployments.deployment_inference_server_creation_completed, model_deployments.deployment_inference_server_deletion, model_deployments.deployment_inference_server_idle_stopped, entity_notification_policy_template.shared, notification_channel_template.shared, project.created, project.deleted, project.shared, autopilot.complete, autopilot.started, autostart.failure, perma_delete_project.success, perma_delete_project.failure, users_delete.preview_started, users_delete.preview_completed, users_delete.preview_failed, users_delete.started, users_delete.completed, users_delete.failed, application.created, application.shared, model_version.added, model_version.stage_transition_from_registered_to_development, model_version.stage_transition_from_registered_to_staging, model_version.stage_transition_from_registered_to_production, model_version.stage_transition_from_registered_to_archived, model_version.stage_transition_from_development_to_registered, model_version.stage_transition_from_development_to_staging, model_version.stage_transition_from_development_to_production, model_version.stage_transition_from_development_to_archived, model_version.stage_transition_from_staging_to_registered, model_version.stage_transition_from_staging_to_development, model_version.stage_transition_from_staging_to_production, model_version.stage_transition_from_staging_to_archived, model_version.stage_transition_from_production_to_registered, model_version.stage_transition_from_production_to_development, model_version.stage_transition_from_production_to_staging, model_version.stage_transition_from_production_to_archived, model_version.stage_transition_from_archived_to_registered, model_version.stage_transition_from_archived_to_development, model_version.stage_transition_from_archived_to_production, model_version.stage_transition_from_archived_to_staging, batch_predictions.success, batch_predictions.failed, batch_predictions.scheduler.auto_disabled, change_request.cancelled, change_request.created, change_request.deployment_approval_requested, change_request.resolved, change_request.proposed_changes_updated, change_request.pending, change_request.commenting_review_added, change_request.approving_review_added, change_request.changes_requesting_review_added, prediction_explanations_computation.None, prediction_explanations_computation.prediction_explanations_preview_job_submitted, prediction_explanations_computation.prediction_explanations_preview_job_completed, prediction_explanations_computation.prediction_explanations_preview_job_failed, monitoring.rate_limit_enforced, notebook_schedule.created, notebook_schedule.failure, notebook_schedule.completed, abstract, moderation.metric.creation_error, moderation.metric.reporting_error, moderation.model.moderation_started, moderation.model.moderation_completed, moderation.model.pre_score_phase_started, moderation.model.pre_score_phase_completed, moderation.model.post_score_phase_started, moderation.model.post_score_phase_completed, moderation.model.config_error, moderation.model.runtime_error, moderation.model.scoring_started, moderation.model.scoring_completed, moderation.model.scoring_error]

NotificationPolicyMuteCreate

{
  "entityId": "string",
  "policyId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
entityId	string	true		The id of the entity to mute the notification for
policyId	string	true		The id of the policy to mute notification for

NotificationPolicyMuteListResponse

{
  "count": 0,
  "data": [
    {
      "entityId": "string",
      "id": "string",
      "policyId": "string",
      "uid": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true		The number of items returned on this page
data	[NotificationPolicyMuteResponse]	true	maxItems: 100	A list of Notification Policy Mutes
next	string,null(uri)	true		URL pointing to the next page (if null, there is no next page)
previous	string,null(uri)	true		URL pointing to the previous page (if null, there is no previous page)
totalCount	integer	true		The total number of items returned by the query

NotificationPolicyMuteResponse

{
  "entityId": "string",
  "id": "string",
  "policyId": "string",
  "uid": "string"
}

Properties¶

Name	Type	Required	Description
entityId	string	true	The id of the entity to mute the notification for
id	string	true	The id of the notification policy mute
policyId	string	true	The id of the policy to mute notification for
uid	string	true	The uid of the notification policy mute

NotificationPolicyResponse

{
  "active": true,
  "channel": {
    "channelType": "Database",
    "contentType": "application/json",
    "createdAt": "2019-08-24T14:15:22Z",
    "customHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "emailAddress": "string",
    "id": "string",
    "languageCode": "en",
    "name": "string",
    "orgId": "string",
    "payloadUrl": "http://example.com",
    "secretToken": "string",
    "uid": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "validateSsl": true
  },
  "channelId": "string",
  "created": "2019-08-24T14:15:22Z",
  "eventGroup": {
    "events": [
      {
        "id": "string",
        "label": "string"
      }
    ],
    "id": "string",
    "label": "string"
  },
  "eventType": {
    "id": "string",
    "label": "string"
  },
  "id": "string",
  "lastTriggered": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Properties¶

Name	Type	Required	Description
active	boolean	true	Defines if the notification policy is active or not.
channel	NotificationChannel	true	The information notification channel to be used to send the notification.
channelId	string	true	The id of the notification channel to be used to send the notification.
created	string,null(date-time)	true	The date when the policy was created.
eventGroup	EventGroup	true	The group of the event that trigger the notification.
eventType	EventType	true	The type of the event that triggers the notification.
id	string	true	The id of the policy.
lastTriggered	string,null(date-time)	true	The date when the last notification with the policy was triggered.
name	string	true	The name of the notification policy.
orgId	string,null	true	The id of the organization that owns the notification policy.
uid	string	true	The identifier of the user who created the policy.
updatedAt	string,null(date-time)	true	The date when the policy was updated.

NotificationPolicyUpdate

{
  "active": true,
  "channelId": "string",
  "eventGroup": "secure_config.all",
  "eventType": "secure_config.created",
  "name": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
active	boolean	false		Defines if the notification policy is active or not.
channelId	string	false		The id of the notification channel to be used to send the notification.
eventGroup	string	false		The group of the event that trigger the notification.
eventType	string	false		The type of the event that triggers the notification.
name	string	false	maxLength: 100	The name of the notification policy.

Enumerated Values¶

Property Value

eventGroup [secure_config.all, comment.all, dataset.all, deployment_prediction_explanations_computation.all, model_deployments.critical_health, model_deployments.critical_frequent_health_change, model_deployments.frequent_health_change, model_deployments.health, inference_endpoints.health, model_deployments.management_agent, model_deployments.management_agent_health, prediction_request.all, challenger_management.all, challenger_replay.all, model_deployments.all, project.all, perma_delete_project.all, users_delete.all, applications.all, model_version.stage_transitions, model_version.all, batch_predictions.all, change_requests.all, insights_computation.all, notebook_schedule.all, monitoring.all]

eventType [secure_config.created, secure_config.deleted, secure_config.shared, comment.created, comment.updated, dataset.created, dataset.registered, dataset.deleted, datasets.deleted, datasetrelationship.created, dataset.shared, datasets.shared, misc.asset_access_request, misc.webhook_connection_test, misc.webhook_resend, misc.email_verification, monitoring.spooler_channel_base, monitoring.spooler_channel_red, monitoring.spooler_channel_green, monitoring.external_model_nan_predictions, management.deploymentInfo, model_deployments.None, model_deployments.deployment_sharing, model_deployments.model_replacement, prediction_request.None, prediction_request.failed, model_deployments.model_replacement_lifecycle, model_deployments.model_replacement_started, model_deployments.model_replacement_succeeded, model_deployments.model_replacement_failed, model_deployments.model_replacement_validation_warning, model_deployments.deployment_creation, model_deployments.deployment_deletion, model_deployments.service_health_yellow_from_green, model_deployments.service_health_yellow_from_red, model_deployments.service_health_red, model_deployments.data_drift_yellow_from_green, model_deployments.data_drift_yellow_from_red, model_deployments.data_drift_red, model_deployments.accuracy_yellow_from_green, model_deployments.accuracy_yellow_from_red, model_deployments.accuracy_red, model_deployments.health.fairness_health.green_to_yellow, model_deployments.health.fairness_health.red_to_yellow, model_deployments.health.fairness_health.red, model_deployments.health.custom_metrics_health.green_to_yellow, model_deployments.health.custom_metrics_health.red_to_yellow, model_deployments.health.custom_metrics_health.red, model_deployments.health.base.green, model_deployments.service_health_green, model_deployments.data_drift_green, model_deployments.accuracy_green, model_deployments.health.fairness_health.green, model_deployments.health.custom_metrics_health.green, model_deployments.retraining_policy_run_started, model_deployments.retraining_policy_run_succeeded, model_deployments.retraining_policy_run_failed, model_deployments.challenger_scoring_success, model_deployments.challenger_scoring_data_warning, model_deployments.challenger_scoring_failure, model_deployments.challenger_scoring_started, model_deployments.challenger_model_validation_warning, model_deployments.challenger_model_created, model_deployments.challenger_model_deleted, model_deployments.actuals_upload_failed, model_deployments.actuals_upload_warning, model_deployments.training_data_baseline_calculation_started, model_deployments.training_data_baseline_calculation_completed, model_deployments.training_data_baseline_failed, model_deployments.custom_model_deployment_creation_started, model_deployments.custom_model_deployment_creation_completed, model_deployments.custom_model_deployment_creation_failed, model_deployments.deployment_prediction_explanations_preview_job_submitted, model_deployments.deployment_prediction_explanations_preview_job_completed, model_deployments.deployment_prediction_explanations_preview_job_failed, model_deployments.custom_model_deployment_activated, model_deployments.custom_model_deployment_activation_failed, model_deployments.custom_model_deployment_deactivated, model_deployments.custom_model_deployment_deactivation_failed, model_deployments.prediction_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_warning, model_deployments.actuals_processing_rate_limit_reached, model_deployments.actuals_processing_rate_limit_warning, model_deployments.deployment_monitoring_data_cleared, model_deployments.deployment_launch_started, model_deployments.deployment_launch_succeeded, model_deployments.deployment_launch_failed, model_deployments.deployment_shutdown_started, model_deployments.deployment_shutdown_succeeded, model_deployments.deployment_shutdown_failed, model_deployments.endpoint_update_started, model_deployments.endpoint_update_succeeded, model_deployments.endpoint_update_failed, model_deployments.management_agent_service_health_green, model_deployments.management_agent_service_health_yellow, model_deployments.management_agent_service_health_red, model_deployments.management_agent_service_health_unknown, model_deployments.predictions_missing_association_id, model_deployments.prediction_result_rows_cleand_up, model_deployments.batch_deleted, model_deployments.batch_creation_limit_reached, model_deployments.batch_creation_limit_exceeded, model_deployments.batch_not_found, model_deployments.predictions_encountered_for_locked_batch, model_deployments.predictions_encountered_for_deleted_batch, model_deployments.scheduled_report_generated, model_deployments.predictions_timeliness_health_red, model_deployments.actuals_timeliness_health_red, model_deployments.service_health_still_red, model_deployments.data_drift_still_red, model_deployments.accuracy_still_red, model_deployments.health.fairness_health.still_red, model_deployments.health.custom_metrics_health.still_red, model_deployments.predictions_timeliness_health_still_red, model_deployments.actuals_timeliness_health_still_red, model_deployments.service_health_still_yellow, model_deployments.data_drift_still_yellow, model_deployments.accuracy_still_yellow, model_deployments.health.fairness_health.still_yellow, model_deployments.health.custom_metrics_health.still_yellow, model_deployments.prediction_payload_parsing_failure, model_deployments.deployment_inference_server_creation_started, model_deployments.deployment_inference_server_creation_failed, model_deployments.deployment_inference_server_creation_completed, model_deployments.deployment_inference_server_deletion, model_deployments.deployment_inference_server_idle_stopped, entity_notification_policy_template.shared, notification_channel_template.shared, project.created, project.deleted, project.shared, autopilot.complete, autopilot.started, autostart.failure, perma_delete_project.success, perma_delete_project.failure, users_delete.preview_started, users_delete.preview_completed, users_delete.preview_failed, users_delete.started, users_delete.completed, users_delete.failed, application.created, application.shared, model_version.added, model_version.stage_transition_from_registered_to_development, model_version.stage_transition_from_registered_to_staging, model_version.stage_transition_from_registered_to_production, model_version.stage_transition_from_registered_to_archived, model_version.stage_transition_from_development_to_registered, model_version.stage_transition_from_development_to_staging, model_version.stage_transition_from_development_to_production, model_version.stage_transition_from_development_to_archived, model_version.stage_transition_from_staging_to_registered, model_version.stage_transition_from_staging_to_development, model_version.stage_transition_from_staging_to_production, model_version.stage_transition_from_staging_to_archived, model_version.stage_transition_from_production_to_registered, model_version.stage_transition_from_production_to_development, model_version.stage_transition_from_production_to_staging, model_version.stage_transition_from_production_to_archived, model_version.stage_transition_from_archived_to_registered, model_version.stage_transition_from_archived_to_development, model_version.stage_transition_from_archived_to_production, model_version.stage_transition_from_archived_to_staging, batch_predictions.success, batch_predictions.failed, batch_predictions.scheduler.auto_disabled, change_request.cancelled, change_request.created, change_request.deployment_approval_requested, change_request.resolved, change_request.proposed_changes_updated, change_request.pending, change_request.commenting_review_added, change_request.approving_review_added, change_request.changes_requesting_review_added, prediction_explanations_computation.None, prediction_explanations_computation.prediction_explanations_preview_job_submitted, prediction_explanations_computation.prediction_explanations_preview_job_completed, prediction_explanations_computation.prediction_explanations_preview_job_failed, monitoring.rate_limit_enforced, notebook_schedule.created, notebook_schedule.failure, notebook_schedule.completed, abstract, moderation.metric.creation_error, moderation.metric.reporting_error, moderation.model.moderation_started, moderation.model.moderation_completed, moderation.model.pre_score_phase_started, moderation.model.pre_score_phase_completed, moderation.model.post_score_phase_started, moderation.model.post_score_phase_completed, moderation.model.config_error, moderation.model.runtime_error, moderation.model.scoring_started, moderation.model.scoring_completed, moderation.model.scoring_error]

NotificationResend

{
  "notificationId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
notificationId	string	true		The id of notification to resend.

NotificationWebhookChannelStatusResponse

{
  "notificationLog": {
    "channelId": "string",
    "channelScope": "organization",
    "emailSubject": "string",
    "id": "string",
    "parentNotificationId": "string",
    "policyId": "string",
    "request": "string",
    "response": "string",
    "retryCount": 0,
    "status": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "status": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
notificationLog	NotificationLog	true		The notification log record.
status	string	true		The status of the test notification.

NotificationWebhookChannelTestCreate

{
  "channelType": "Database",
  "contentType": "application/json",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true
}

Properties¶

Name	Type	Required	Restrictions	Description
channelType	string	true		The type of the new notification channel.
contentType	string	false		The content type of the messages of the new notification channel.
customHeaders	[CustomerHeader]	false	maxItems: 100	Custom headers and their values to be sent in the new notification channel.
emailAddress	string	false		The email address to be used in the new notification channel.
name	string	true	maxLength: 100	The name of the new notification channel.
orgId	string	false		The identifier of the organization that notification channel belongs to.
payloadUrl	string(uri)	false		The payload URL of the new notification channel.
secretToken	string	false		Secret token to be used for new notification channel.
validateSsl	boolean	false		Whether SSL will be validated in the notification channel.

Enumerated Values¶

Property	Value
channelType	[`Database`, `Email`, `InApp`, `InsightsComputations`, `MSTeams`, `Slack`, `Webhook`]
contentType	[`application/json`, `application/x-www-form-urlencoded`]

NotificationWebhookChannelTestId

{
  "notificationId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
notificationId	string	true		The identifier of the notification.

PredictionRemoteEventData

{
  "error_code": "string",
  "model_id": "string",
  "response_body": "string",
  "status_code": 0,
  "user_id": "string"
}

Prediction event payload.

Properties¶

Name	Type	Required	Description
error_code	string,null	false	The error code if any.
model_id	string,null	false	The identifier of the model.
response_body	string	true	The response body message of the prediction event.
status_code	integer	true	The response status code of the prediction event.
user_id	string,null	false	The identifier of the user that accesses the deployment.

RemoteEventCreate

{
  "data": {
    "newModelId": "string",
    "oldModelId": "string",
    "reason": "string"
  },
  "deploymentId": "string",
  "eventType": "deploymentInfo",
  "externalNanPredictionsData": {
    "count": 0,
    "modelId": null
  },
  "message": "string",
  "moderationData": {
    "guardName": "string",
    "metricName": "string"
  },
  "orgId": "string",
  "predictionEnvironmentId": "string",
  "predictionRequestData": {
    "error_code": "string",
    "model_id": "string",
    "response_body": "string",
    "status_code": 0,
    "user_id": "string"
  },
  "spoolerChannelData": {
    "name": "string",
    "type": "asyncMemory"
  },
  "timestamp": "2019-08-24T14:15:22Z",
  "title": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
data	RemoteEventData	false		Event payload.
deploymentId	string	false		The identifier of the deployment associated with the event.
eventType	string	true		The type of the event. Labels in all_lower_case are deprecated.
externalNanPredictionsData	ExternalNaNPredictionsEventData	false		External NaN Predictions event payload
message	string	false	maxLength: 16384	Descriptive message for health events.
moderationData	ModerationData	false		Moderation event information
orgId	string,null	false		The identifier of the organization associated with the event.
predictionEnvironmentId	string	false		The identifier of the prediction environment associated with the event.
predictionRequestData	PredictionRemoteEventData	false		Prediction event payload.
spoolerChannelData	SpoolerChannelEventData	false		Spooler channel event payload.
timestamp	string(date-time)	true		The time when the event occurred.
title	string	false	maxLength: 512	The title of the event.

Enumerated Values¶

Property Value

eventType [deploymentInfo, externalNaNPredictions, management.deploymentInfo, model_deployments.accuracy_green, model_deployments.accuracy_red, model_deployments.accuracy_yellow_from_green, model_deployments.data_drift_green, model_deployments.data_drift_red, model_deployments.data_drift_yellow_from_green, model_deployments.model_replacement, model_deployments.service_health_green, model_deployments.service_health_red, model_deployments.service_health_yellow_from_green, moderationMetricCreationError, moderationMetricReportingError, moderationModelConfigError, moderationModelModerationCompleted, moderationModelModerationStarted, moderationModelPostScorePhaseCompleted, moderationModelPostScorePhaseStarted, moderationModelPreScorePhaseCompleted, moderationModelPreScorePhaseStarted, moderationModelRuntimeError, moderationModelScoringCompleted, moderationModelScoringError, moderationModelScoringStarted, monitoring.external_model_nan_predictions, monitoring.spooler_channel_green, monitoring.spooler_channel_red, predictionRequestFailed, prediction_request.failed, serviceHealthChangeGreen, serviceHealthChangeRed, serviceHealthChangeYellowFromGreen, spoolerChannelGreen, spoolerChannelRed]

RemoteEventData

{
  "newModelId": "string",
  "oldModelId": "string",
  "reason": "string"
}

Event payload.

Properties¶

Name	Type	Required	Description
newModelId	string	false	The identifier of the model after replacement.
oldModelId	string	false	The identifier of the model before replacement.
reason	string	false	The explanation on why the model has been replaced.

RequestNotification

{
  "body": "string",
  "headers": "string",
  "url": "http://example.com"
}

The request that was sent in the notification

Properties¶

Name	Type	Required	Description
body	string	true	The body of the request
headers	string	true	The headers of the request
url	string,null(uri)	true	The URL of the request

ResponseNotification

{
  "body": "string",
  "duration": 0,
  "headers": "string",
  "statusCode": "string"
}

The response that was received after sending the notification

Properties¶

Name	Type	Required	Description
body	string	true	The body of the response
duration	integer	true	The duration
headers	string	true	The headers of the response
statusCode	string	true	The status code of the response

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`

SharingListV2Response

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

Properties¶

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

SpoolerChannelEventData

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

Spooler channel event payload.

Properties¶

Name	Type	Required	Restrictions	Description
name	string	true	maxLength: 512	Name or label of the spooler channel.
type	string	true		Type of the spooler channel.

Enumerated Values¶

Property	Value
type	[`asyncMemory`, `filesystem`, `kafka`, `memory`, `pubSub`, `rabbitMQ`, `sqs`]

UserNotificationListResponse

{
  "count": 0,
  "data": [
    {
      "callerUser": {
        "fullName": "string",
        "gravatarHash": "string",
        "inactive": true,
        "uid": "string",
        "username": "string"
      },
      "created": "2019-08-24T14:15:22Z",
      "description": "string",
      "eventType": "autopilot.complete",
      "isRead": true,
      "link": "string",
      "pushNotificationSent": true,
      "relatedComment": {
        "commentId": "string",
        "commentLink": "string",
        "entityId": "string",
        "entityType": "useCase",
        "inactive": true
      },
      "relatedDeployment": {
        "deploymentId": "string",
        "deploymentName": "string",
        "deploymentUrl": "string",
        "inactive": true,
        "modelId": "string",
        "projectId": "string",
        "userId": "string"
      },
      "relatedProject": {
        "inactive": true,
        "pid": "string",
        "projectLink": "string",
        "projectName": "string"
      },
      "relatedSecureConfig": {
        "secureConfigLink": "string",
        "secureConfigName": "string",
        "secureConfigSchemaName": "string",
        "secureConfigSchemaUuid": "string",
        "secureConfigUuid": "string"
      },
      "relatedUsersDelete": {
        "reportId": "string",
        "statusId": "string",
        "usersToDeleteCount": "string"
      },
      "sharedUsers": [
        {
          "fullName": "string",
          "gravatarHash": "string",
          "inactive": true,
          "uid": "string",
          "username": "string"
        }
      ],
      "statusId": "string",
      "title": "string",
      "tooltip": "string",
      "updated": "2019-08-24T14:15:22Z",
      "userNotificationId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	false	Number of items returned on this page.
data	[UserNotificationResponse]	true	An array of user's notifications.
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).
totalCount	integer	true	The total number of items across all pages.

UserNotificationRelatedCommentResponse

{
  "commentId": "string",
  "commentLink": "string",
  "entityId": "string",
  "entityType": "useCase",
  "inactive": true
}

Details about the comment related to the notification.

Properties¶

Name	Type	Required	Description
commentId	string	true	The ID of the comment
commentLink	string	false	The link to the comment.
entityId	string	true	The ID of the commented entity
entityType	string	false	The type of the commented entity.
inactive	boolean	false	True if the comment was deleted.

Enumerated Values¶

Property	Value
entityType	[`useCase`, `model`, `catalog`, `experimentContainer`]

UserNotificationRelatedDeploymentResponse

{
  "deploymentId": "string",
  "deploymentName": "string",
  "deploymentUrl": "string",
  "inactive": true,
  "modelId": "string",
  "projectId": "string",
  "userId": "string"
}

Details about the deployment related to the notification.

Properties¶

Name	Type	Required	Description
deploymentId	string	true	The ID of the deployment
deploymentName	string,null	false	Deployment's label
deploymentUrl	string	false	The link to the deployment
inactive	boolean	false	True if the deployment was deleted.
modelId	string,null	false	The ID of the related model
projectId	string,null	false	The ID of the related project
userId	string,null	false	The ID of the related user

UserNotificationRelatedProjectResponse

{
  "inactive": true,
  "pid": "string",
  "projectLink": "string",
  "projectName": "string"
}

Details about the project related to the notification.

Properties¶

Name	Type	Required	Description
inactive	boolean	false	True if the project was deleted.
pid	string	true	The ID of the project
projectLink	string	false	The link to the project.
projectName	string,null	false	Project name.

UserNotificationRelatedSecureConfigResponse

{
  "secureConfigLink": "string",
  "secureConfigName": "string",
  "secureConfigSchemaName": "string",
  "secureConfigSchemaUuid": "string",
  "secureConfigUuid": "string"
}

Details about the secure config related to the notification.

Properties¶

Name	Type	Required	Description
secureConfigLink	string	true	Link to the secure config.
secureConfigName	string	true	Name of the secure config.
secureConfigSchemaName	string	true	Type uuid of the secure config.
secureConfigSchemaUuid	string	true	Type name of the secure config.
secureConfigUuid	string	true	ID of the secure config.

UserNotificationRelatedUserResponse

{
  "fullName": "string",
  "gravatarHash": "string",
  "inactive": true,
  "uid": "string",
  "username": "string"
}

Details about the user who triggered the notification.

Properties¶

Name	Type	Required	Description
fullName	string,null	false	User's full name.
gravatarHash	string	false	User's gravatar hash.
inactive	boolean	false	True if the user was deleted.
uid	string	true	The ID of the user
username	string	false	Username of the user.

UserNotificationRelatedUsersDeleteResponse

{
  "reportId": "string",
  "statusId": "string",
  "usersToDeleteCount": "string"
}

Details about the users permanent delete.

Properties¶

Name	Type	Required	Description
reportId	string	true	The ID of the users permanent delete report
statusId	string	true	The ID of the users delete status.
usersToDeleteCount	string	true	Number of users that will be deleted.

UserNotificationResponse

{
  "callerUser": {
    "fullName": "string",
    "gravatarHash": "string",
    "inactive": true,
    "uid": "string",
    "username": "string"
  },
  "created": "2019-08-24T14:15:22Z",
  "description": "string",
  "eventType": "autopilot.complete",
  "isRead": true,
  "link": "string",
  "pushNotificationSent": true,
  "relatedComment": {
    "commentId": "string",
    "commentLink": "string",
    "entityId": "string",
    "entityType": "useCase",
    "inactive": true
  },
  "relatedDeployment": {
    "deploymentId": "string",
    "deploymentName": "string",
    "deploymentUrl": "string",
    "inactive": true,
    "modelId": "string",
    "projectId": "string",
    "userId": "string"
  },
  "relatedProject": {
    "inactive": true,
    "pid": "string",
    "projectLink": "string",
    "projectName": "string"
  },
  "relatedSecureConfig": {
    "secureConfigLink": "string",
    "secureConfigName": "string",
    "secureConfigSchemaName": "string",
    "secureConfigSchemaUuid": "string",
    "secureConfigUuid": "string"
  },
  "relatedUsersDelete": {
    "reportId": "string",
    "statusId": "string",
    "usersToDeleteCount": "string"
  },
  "sharedUsers": [
    {
      "fullName": "string",
      "gravatarHash": "string",
      "inactive": true,
      "uid": "string",
      "username": "string"
    }
  ],
  "statusId": "string",
  "title": "string",
  "tooltip": "string",
  "updated": "2019-08-24T14:15:22Z",
  "userNotificationId": "string"
}

Properties¶

Name	Type	Required	Description
callerUser	UserNotificationRelatedUserResponse	true	Details about the user who triggered the notification.
created	string(date-time)	true	The ISO 8601 formatted date and time when the notification was created.
description	string,null	true	Notification's description
eventType	string	true	The type of the notification.
isRead	boolean	true	True if the notification is already read.
link	string	true	Call-to-action link for the notification
pushNotificationSent	boolean	true	True if the notification was also sent via push notifications.
relatedComment	UserNotificationRelatedCommentResponse	false	Details about the comment related to the notification.
relatedDeployment	UserNotificationRelatedDeploymentResponse	false	Details about the deployment related to the notification.
relatedProject	UserNotificationRelatedProjectResponse	false	Details about the project related to the notification.
relatedSecureConfig	UserNotificationRelatedSecureConfigResponse	false	Details about the secure config related to the notification.
relatedUsersDelete	UserNotificationRelatedUsersDeleteResponse	false	Details about the users permanent delete.
sharedUsers	[UserNotificationRelatedUserResponse]	false	List of the user details a resource was shared with.
statusId	string	false	Asynchronous job status ID
title	string,null	true	Notification's title
tooltip	string,null	true	Notification's tooltip
updated	string(date-time)	true	The ISO 8601 formatted date and time when the notification was updated.
userNotificationId	string	true	The ID of the notification

Enumerated Values¶

Property Value

eventType [autopilot.complete, project.shared, comment.created, comment.updated, model_deployments.service_health_red, model_deployments.data_drift_red, model_deployments.accuracy_red, model_deployments.health.fairness_health.red, model_deployments.health.custom_metrics_health.red, model_deployments.predictions_timeliness_health_red, model_deployments.actuals_timeliness_health_red, misc.asset_access_request, users_delete.preview_started, users_delete.preview_completed, users_delete.preview_failed, perma_delete_project.failure, perma_delete_project.success, secure_config.shared, entity_notification_policy_template.shared, notification_channel_template.shared]