To perform a POST, PATCH, or PUT request, pass query parameters
or create a request body formatted in either XML or JSON. This chapter
lists the request bodies. The query parameters are listed with each
resource.
To create a JSON request body, specify the properties of the request body in JSON format.
This is an example of a Comment request
body.
{
"body" : "Let's look for a new solution."
}
If a request body is top-level, it has a root XML tag listed. To create an XML request body, nest the properties as XML tags inside the root XML tag.
This is the same Analytics request body in XML
format:
<comment> <body>Let's look for a new solution.</body> </comment>
-
Action Input
The action for a rule or macro to perform during a JSON transformation. -
Advanced Property Value Input
An advanced property name and value pair. -
Analytics App Setting Collection Input
The collection of Analytics app settings. -
Analytics App Setting Input
A setting for an Analytics app. -
Analytics Asset Collection Query Input
The query parameters used to request a collection of Analytics assets. -
Analytics Asset Filter Input
A filter for the Analtyics asset collection parameters. -
Annotation Input
An Analytics annotation. -
Asset Archival Input
The assets to archive or restore, and the target archival state. -
Asset Archival Reference Input
A reference to a single CRM Analytics asset to archive or restore. -
Asset Reference Input
An Analytics asset reference. -
Asset Revert History Input
The Analytics asset history to use for a revert request. -
Auto-Install App Configuration Input
The configuration for an auto-install app. -
Auto-Install Configuration Input
The configuration for a auto-install app. -
Auto-Install Request Insert Input
The insert for an auto-install request. -
Auto-Install Request Update Input
The update for an auto-install request. -
Base Asset Input
The base Analytics asset input. -
Base Asset Reference Input
The base Analytics asset. -
Base Auto-Install Request Input
The base auto-install request input. -
Base Notification Action Configuration Input
The base Analytics notification action configuration. -
Base Subscription Input
The base subscription request input. -
Base Wave Folder Input
The base Analytics folder asset. -
Collaboration Room Notification Recipient Input
The Slack recipient of a notification. -
Collection Subscription Source Input
The collection subscription source. -
Component Saved View Input
The saved view for an Analytics component. -
Component Saved View State Input
The state for an Analytics component saved view. -
Conditional Formatting Property Input
A property for conditional formatting of Xmd dimensions and measures. -
Constant Input
The definition of a constant for JSON transformation rules. -
Daily Schedule Input
Specify a daily schedule for an Analytics asset. -
Daily Scheduled Item Input
The daily schedule for a data refresh. -
Dashboard Input
An Analytics dashboard. -
Dashboard Saved View Data Source State Input
The data source state for an Analytics dashboard saved view. -
Dashboard Saved View Filter Input
A filter for an Analytics dashboard saved view. -
Dashboard Saved View Input
A saved view for an Analytics dashboard. -
Dashboard Saved View State Input
The state for an Analytics dashboard saved view. -
Dashboard Saved View Step Metadata Input
The step metadata for an Analytics dashboard saved view. -
Dashboard Saved View Step State Input
The step state for an Analytics dashboard saved view. -
Dashboard Subscription Source Input
The dashboard subscription source. -
Dashboard Widget Item Input
The base dashboard widget item. -
Data Cloud Extended Metadata Input
The extended metadata (Xmd) for a Data 360 object data source for Analytics. -
Data Cloud Field Extended Metadata Input
The extended metadata (Xmd) for a field in Data 360 object. -
Data Cloud Field Value Input
A customized display value for a data object field. -
Data Connector Input
An Analytics data connector. -
Data Connector Property Input
A property for an Analytics data connector. -
Dataflow Input
An Analytics dataflow. -
Dataflow Job Input
An Analytics dataflow job. -
Dataset Input
An Analytics dataset. -
Dataset Version Input
A specific version of an Analytics dataset. -
Event Based Schedule Input
Specify an event-driven schedule for an Analytics asset. -
Featured Assets Input
A feaatured assets for an Analytics app. -
Geo Data Input
The geo data used by a map. -
Hourly Schedule Input
Specify a sub-daily schedule for an Analytics asset. -
Json Transformation Input
The JSON request to perform transformation rules on. -
Lens Input
An Analytics lens. -
Lens State Input
The state for an Analytics lens. -
License Attributes Input
The Analytics license attributes. -
Live Connection Input
The connection details of an Analytics live dataset. -
Macro Input
A macro to use for a JSON transformation rule. -
Map Bounding Box Input
A bounding box of a map.. -
Map Input
A map for an Eclair chart. -
Mapped SDM Input
A mapped Tableau Next semantic model. -
Minutely Schedule Input
Specify a sub-hourly schedule for an Analytics asset. -
Monthly Relative Schedule Input
Specify a monthly schedule for an Analytics asset where the day are relative to their location in the week. -
Monthly Specific Schedule Input
Specify a monthly schedule for an Analytics asset where the days are fixed by numerical date. -
Notification Action Input
A notification action for an Analytics subscription. -
Post To Slack Notification Action Configuration Input
The notification action configuration for posting to Slack. -
Replicated Dataset Input
An Analytics replicated dataset, also know as a connected object. -
Replicated Field Collection Input
A collection of fields for an Analytics replicated dataset, also known as a connected object. -
Replicated Field Input
A field for an Analytics replicated dataset, also known as a connected object. -
Restore Dataset Version Input
A specific version to restore an Analytics dataset to. -
Rule Definition Input
A rule definition to use for a JSON transformation. -
Rule Input
A rule for a JSON Transformation rule definition. -
SAQL Query Input
An Analytics query written in SAQL or SQL. -
Schedule Details Input
The base Analytics schedule details. -
Schedule Input
A schedule on which to execute some type of Analytics asset. -
Scheduled Item Input
The base schedule for a data refresh. -
Scheduled Time Input
The base schedule for a data refresh. -
Scheduled Timezone Input
The information for a schedule time zone. -
Send To Email Notification Action Configuration Input
The notification action configuration for sending an email. -
Slack Reference Input
The reference for a Slack entity. -
Source Details Input
The abstract source details for a subscription. -
Source Object Data Input
The request to retrieve data from a source object given a list of fields and advanced properties. -
Subscription Daily Schedule Input
The daily schedule on which to execute an Analytics subscription. -
Subscription Input
An Analytics subscription. -
Subscription Schedule Input
An Analytics subscription input. -
Subscription Source Input
The subscription source. -
Subscription Weekly Schedule Input
The weekly schedule on which to execute an Analytics subscription. -
Subscription Widget Input
An Analytics widget subscription inherits properties from the base Dashboard Widget Item Input. -
Template Input
An Analytics template. -
Template Options Input
The template options used to upgrade a templated Analytics app. -
Template Validate Input
The input to validate an Analytics template. -
Time Input
The time at which something should happen, usually in relation to an Analytics schedule. -
Trended Report Input
An Analytics trended report. -
Typed Asset Reference Input
A typed Analytics asset reference. -
Visual Parameters Input
A visual parameters for an Analytics watchlist item. -
Watchlist Input
An Analytics watchlist. -
Watchlist Item Input
An Analytics watchlist item. -
Watchlist Item Metadata Input
The metadata for an Analytics watchlist item. -
Watchlist Schedule Input
An Analytics watchlist schedule. -
Wave Collection Input
A collection of Analytics resources. -
Wave Collection Item Bulk Add Input
Bulk items to add to a collection of Analytics resources. -
Wave Collection Item Input
An item in a collection of Analytics resources. -
Wave Collection Item List Input
A list of items in a collection of Analytics resources. -
Wave Collection Pin Input
The pinning rules for an Analytics collection. -
Wave Folder Input
An Analytics folder. This implements BaseWaveFolderInput. -
Wave Folder Schedule Input
An Analytics folder schedule. -
Wave Folder Share Input
An Analytics folder sharing rule. -
Wave Folder Template Input
A templated Analytics folder. This implements BaseWaveFolderInput. -
Weekly Schedule Input
Specify a weekly schedule for an Analytics asset. -
Weekly Scheduled Item Input
The weekly schedule for a data refresh. -
Widget Subscription Source Input
The widget subscription source. -
Base Xmd Dimension Custom Action Input
The base custon action for an Xmd dimension. -
Base Xmd Dimension Input
The base Xmd dimension for dimensions and derived dimensions. -
Base Xmd Measure Input
The base Xmd measure for measures and derived measures. -
Xmd Currency Settings Input
The extended metadata (Xmd) for currency settings of a currency field. -
Xmd Dataset Input
The extended metadata (Xmd) for an Analytics dataset. -
Xmd Date Field Input
The extended metadata (Xmd) for the formatting of a date field. -
Xmd Date Input
The extended metadata (Xmd) for a date. -
Xmd Derived Dimension Custom Action Input
A custom action for an Xmd derived dimension. -
Xmd Derived Dimension Input
The extended metadata (Xmd) for a derived dimension in an Analytics dataset. -
Xmd Derived Dimension Member Input
The extended metadata (Xmd) for a member of a derived dimension in an Analytics dataset. -
Xmd Derived Dimension Salesforce Action Input
The extended metadata (Xmd) for a Saleforce Action for a derived dimension in an Analytics dataset. -
Xmd Derived Measure Format Input
The extended metadata (Xmd) for the format of a derived measure in an Analytics dataset. -
Xmd Derived Measure Input
The extended metadata (Xmd) for a derived measure in an Analytics dataset. -
Xmd Dimension Custom Action Input
A custom action for an Xmd dimension. -
Xmd Dimension Input
The extended metadata (Xmd) for a dimension in an Analytics dataset. -
Xmd Dimension Member Input
The extended metadata (Xmd) for a member linked to a dimension in an Analytics dataset. -
Xmd Dimension Salesforce Action Input
The extended metadata (Xmd) for a Saleforce Action for a dimension in an Analytics dataset. -
Xmd Input
The extended metadata (Xmd) for an Analytics dataset version. -
Xmd Measure Format Input
The extended metadata (Xmd) for the format of a measure in an Analytics dataset. -
Xmd Measure Input
The extended metadata (Xmd) for a measure in an Analytics dataset. -
Xmd Organization Input
The extended metadata (Xmd) for an organization in an Analytics dataset.