Analytics REST API Developer Guide

Working with the Analytics REST API
Analytics REST API Reference
Analytics REST API Resources Overview
Wave Resource
Annotations List Resource
Annotation Resource
Charts Geodata List Resource
Charts Geodata Resource
Charts Geodata File List Resource
Charts Maps List Resource
Charts Maps Resource
Dashboards List Resource
Dashboard Resource
Dashboard Image Resource
Dashboard Saved Views List Resource
Dashboard Saved Views Resource
Dashboard Saved Views Initial Resource
Data Connector Resource
Data Connectors List Resource
Data Connector Ingest Resource
Data Connector Source Objects List Resource
Data Connector Source Object Resource
Data Connector Source Object Data Preview Resource
Data Connector Source Object Fields Resource
Data Connector Status Resource
Data Connector Types Resource
Dataflow Jobs List Resource
Dataflow Job Resource
Dataflows List Resource
Dataflow Resource
Datasets List Resource
Dataset Resource
Dependencies Resource
Features Configuration Resource
Folders List Resource
Folder Resource
Lenses List Resource
Lens Resource
Lens File Resource
Lens File Metadata Resource
Query Resource
Recipes List Resource
Recipe Resource
Recipe File Resource
Recipe Notification Resource
Replicated Dataset Resource
Replicated Datasets List Resource
Replicated Dataset Fields Resource
Schedule Resource
Security Coverage Dataset Version Resource
Security Coverage Object Resource
Templates List Resource
Template Resource
Template Configuration Resource
Template Release Notes Resource
Trended Reports List Resource
Trended Reports Resource
Dataset Versions List Resource
Dataset Version Resource
Dataset Version File Resource
XMD List Resource
XMD Resource
Asset XMD Resource
Additional Analytics REST API Resources
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Recipe Notification Resource

Returns a Data Prep recipe job notification, creates, or updates a Data Prep recipe job notification.
Resource URL
Formats
JSON
Available Version
49.0
HTTP Methods
GET PUT
GET Response Body (RecipeNotificationInputRepresentation)
Property Name Type Description Required or Optional Available Version
long​Running​Alert​In​Mins Integer The number of minutes that a recipe can run before sending an alert. Required 49.0
notification​Level Connect​Email​Notification​Level​Enum Valid types of email notification levels you can set. Valid values are:
  • Always
  • Failures
  • Never
  • Warnings
 Required 49.0
PUT Request Body (RecipeNotificationInputRepresentation)
Property Name Type Description Required or Optional Available Version
long​Running​Alert​In​Mins Integer The number of minutes that a recipe can run before sending an alert. Required 49.0
notification​Level Connect​Email​Notification​Level​Enum Valid types of email notification levels you can set. Valid values are:
  • Always
  • Failures
  • Never
  • Warnings
 Required 49.0

The following JSON shows how to update an existing recipe notification.

PUT Response Body (RecipeNotificationRepresentation)
Property Name Type Description Filter Group and Version Available Version
long​Running​Alert​In​Mins Integer The number of minutes that a recipe can run before sending an alert. Small, 49.0 49.0
notification​Level Connect​Email​Notification​Level​Enum Valid types of email notification levels you can set. Valid values are:
  • Always
  • Failures
  • Never
  • Warnings
 Small, 49.0 49.0