Overview
Configuration is provided for establishing connections with the Salesforce Reports and Dashboards API services. The configuration is used in the REST Connection Manager. To find what is your service instance, please check the Salesforce documentation page here.
Setup
Press icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to Salesforce CRM Analytics REST API using COZYROC's REST Connection Manager.
Congratulations! You have now established a connection to your Salesforce CRM Analytics instance.
In this guide, we will show how to read data from the Salesforce CRM Analytics service resource using the COZYROC REST Source component.
In this guide, we will show how to write data to the Salesforce CRM Analytics service resource using the COZYROC REST Destination component.
Configuration
Base URL address: https://[instance].my.salesforce.com/services/data/v57.0
.
- User
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (3600 - 300) * 1000}}
.The authentication has the following user-defined parameters:
- Scope: https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_tokens_scopes.htm&type=5
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.mc-app-development.meta/mc-app-development/integration-app-auth-code.htm.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/folders
.
The result is extracted from:{{=response.folders}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_folders_create.htm.
- [Read single] action
-
Endpoint URL address:
/folders/{{=Analytics.UI.FolderEditor.getValue(parameters)}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- folder_id: Required. Specify folder identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_folders_ops.htm.
- [Create] action
-
Endpoint URL address:
/folders
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_folders_create.htm.
- [Update] action
-
Endpoint URL address:
/folders/{{=item.id}}
.
The action uses PATCH method.Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_folders_ops.htm.
- [Delete] action
-
Endpoint URL address:
/folders/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_folders_ops.htm.
The resource includes the fields from the FolderT template.
- ancestors
Template: LongText. A composite field.
- depth
Data type: DT_I4
- shareRecipientsUrl
Template: LongText.
- sharesUrl
Template: LongText.
- supportedShareTypes
Template: LongText. A composite field.
- folder_recipient
The gathered value is processed with
{{=connection.resourceManager['Report-Dashboard Folder | Share Recipient'].getData({ parameters: ['folder_id=' + item.id, 'shareType=' + parameters.get('shareType', 'User')] })}}
expression. Field components:- An array.
-
Uses template:
FolderShareT
.
- share
The gathered value is processed with
{{=connection.resourceManager['Report-Dashboard Folder | Share'].getData({ parameters: ['folder_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
FolderShareT
.
- children
The gathered value is processed with
{{=connection.resourceManager['Report-Dashboard Folder | Children'].getData({ parameters: ['folder_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
FolderT
.
- settings
Template: LongText. A composite field. The value is gathered from
/folders/{{=item.id}}/settings
address. The gathered value is processed with{{=response.settings}}
expression. The value is sent to/folders/{{=item.id}}/settings
address.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/folders/{{=Analytics.UI.FolderEditor.getValue(parameters)}}/children
.
The result is extracted from:{{=response.folders}}
.The action has the following user-defined parameters:
- folder_id: Required. Specify folder identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_folders_children.htm.
The resource includes the fields from the FolderT template.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/folders/{{=Analytics.UI.FolderEditor.getValue(parameters)}}/shares
.
The result is extracted from:{{=response.shares}}
.The action has the following user-defined parameters:
- folder_id: Required. Specify folder identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_folders_shares.htm.
- [Read single] action
-
Endpoint URL address:
/folders/{{=Analytics.UI.FolderEditor.getValue(parameters)}}/shares
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- folder_id: Required. Specify folder identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_folders_shares_by_id.htm.
- [Create] action
-
Endpoint URL address:
/folders/{{=item.folder_id}}/shares
.The following request parameters will be automatically processed:
-
application/json:
{{={ shares: item } }}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_folders_shares.htm.
-
application/json:
- [Update] action
-
Endpoint URL address:
/folders/{{=item.folder_id}}/shares
.The following request parameters will be automatically processed:
-
application/json:
{{={ shares: item } }}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_folders_shares_by_id.htm.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/folders/{{=item.folder_id}}/shares
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_folders_shares_by_id.htm.
The resource includes the fields from the FolderShareT template.
- folder_id
A key field. Template: ShortText.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/folders/{{=Analytics.UI.FolderEditor.getValue(parameters)}}/share-recipients
.
The result is extracted from:{{=response.folders}}
.The action has the following user-defined parameters:
- folder_id: Required. Specify folder identifier.
- shareType: Required. Specify folder identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_folders_share_recipients.htm.
- shareWithId
A key field. Template: ShortText.
- imageColor
Template: ShortText.
- imageUrl
Template: LongText.
- shareType
Template: ShortText.
- shareWithLabel
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/analytics/reports
.
The result is paginated.Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/sforce_analytics_rest_api_recentreportslist.htm.
- [Read recent] action
-
Endpoint URL address:
/analytics/report-types/{{=Analytics.UI.ReportTypeEditor.getValue(parameters)}}/recent-reports
.The action has the following user-defined parameters:
- reportType: Required. Specify the report type.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_reporttypes_reference_recently_created.htm.
- [Create] action
-
Endpoint URL address:
/analytics/reports
.The following request parameters will be automatically processed:
-
application/json:
{{={ reportMetadata: { name: item.name, reportType:{ type: item.type } } } }}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_report_example_post_report.htm.
-
application/json:
- [Update] action
-
Endpoint URL address:
/analytics/reports
.The following request parameters will be automatically processed:
-
application/json:
{{={ reportMetadata: item } }}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/sforce_analytics_rest_api_save_report.htm.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/analytics/reports/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/sforce_analytics_rest_api_delete_report.htm.
- id
A key field. Template: ShortText.
- describeUrl
Template: LongText.
- fieldsUrl
Template: LongText.
- instancesUrl
Template: LongText.
- name
Template: ShortText.
- type
Template: ShortText.
- folderId
Template: ShortText.
- createdByUser
Template: ShortText.
- createdDate
Template: DateTime. A read-only field.
- url
Template: LongText.
- xlxs
Data type: DT_IMAGE The value is gathered from
/analytics/reports/{{=item.id}}
address.- instances
The value is gathered from
/analytics/reports/{{=item.id}}/instances
address. Field components:- An array.
- Contains the following components: id, requestDate, status, url, ownerId, queryable, hasDetailRows, completionDate.
Based on resource template NoPagination.
- [Read] action
-
The result is extracted from:{{=Analytics.getReportData(parameters, Analytics.getReportQuery(parameters))}}
.The action has the following user-defined parameters:
- report_id: Required. Specify the id of the report.
- timeout: Specify the timeout in seconds.
- reportType: Required. Specify the report type in JSON format (e.g) {"label": "Accounts","type": "AccountList"}
- aggregates: Optional. Specify comma separated strings (e.g) a!Amount,RowCount
- reportFilters: Optional. Specify chart in JSON format (e.g) [{"column":"AMOUNT". "filterType": "fieldToField"}.......]
- chart: Optional. Specify chart in JSON format (e.g) [{"chartType":"type". "title": "title"}.......]
- sortBy: Optional. Specify chart in JSON format (e.g) [{"sortColumn":"Account_ID". "sortOrder": "Asc"}]
- crossFilters: Optional. Specify crossFilters in JSON format (e.g) [{"relatedEntity":"relatedEntity"}.......]
- groupingsAcross: Optional. Specify groupingsAcross in JSON format (e.g) [{"name":"name"}.......]
- groupingsDown: Optional. Specify groupingsDown in JSON format (e.g) [{"name":"name"}.......]
- customDetailFormula: Optional. Specify customDetailFormula in JSON format (e.g) [{"formula":"formula"}.......]
- customDetailFormula: Optional. Specify customDetailFormula in JSON format (e.g) [{"formula":"formula"}.......]
- standardDateFilter: Optional. Specify comma separated strings.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/sforce_analytics_rest_api_getreportrundata.htm.
- [External]
-
The external fields URL address:
/analytics/reports/{{=Analytics.UI.ReportEditor.getValue(parameters)}}
. The external fields list is extracted from:{{=_.map( response.reportExtendedMetadata.detailColumnInfo, function(v, k) { return _.extend({ name: k }, v); } )}}
.- {{=external.name}}
Template: {{=Analytics.getFieldTemplate(external.dataType)}}.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/analytics/notifications
.The action has the following user-defined parameters:
- source: Required. Specify folder identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_notifications_reference_list.htm.
- [Read single] action
-
Endpoint URL address:
/analytics/notifications/{{=parameters.notification_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- notification_id: Required. Specify notification identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_notification_example_get_notifications.htm.
- [Create] action
-
Endpoint URL address:
/analytics/notifications
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_notification_example_post_notifications.htm.
- [Update] action
-
Endpoint URL address:
/analytics/notifications/{{=item.id}}
.
The action uses PUT method.Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_notification_example_put_notifications.htm.
- [Delete] action
-
Endpoint URL address:
/analytics/notifications/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_notification_example_delete_notifications.htm.
- id
A key field. Template: ShortText.
- active
Data type: DT_BOOL
- createdDate
Template: DateTime. A read-only field.
- deactivateOnTrigger
Data type: DT_BOOL
- lastModifiedDate
Template: DateTime. A read-only field.
- name
Template: ShortText.
- recordId
Template: ShortText.
- schedule
Template: ScheduleT. Field components:
-
Uses template:
ShortText
. - Contains the following components: details, frequency.
-
Uses template:
- owner
Template: ScheduleT. Field components:
-
Uses template:
ShortText
. - Contains the following components: name, id.
-
Uses template:
- source
Template: ShortText.
- thresholds
Field components:
- An array.
- Contains the following components: actions, conditions, type.
- configuration
Field components:
-
Uses template:
ShortText
. - Contains the following components: anchor, datasets, dimensions, filter, query, urlFragment, widgetType, isTrackOnWaveHome.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/analytics/report-types
.
The result is extracted from:{{=_.flatten(_.pluck(response, 'reportTypes'))}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_reporttypes_reference_list.htm.
- [Read single] action
-
Endpoint URL address:
/analytics/reportTypes/{{=Analytics.UI.ReportTypeEditor.getValue(parameters)}}
.
The result is extracted from:{{=[response.reportMetadata]}}
.The action has the following user-defined parameters:
- reportType: Required. Specify the report type.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_reporttypes_reference_reporttype.htm.
- [Read current-user] action
-
Endpoint URL address:
/analytics/report-types/recent/by-user
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_reporttypes_reference_recently_used.htm.
- [Update] action
-
Endpoint URL address:
/analytics/reports/show-hide-report_type
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_reporttypes_reference_hide_unhide.htm.
- id
A key field. Template: ShortText.
- describeUrl
Template: LongText.
- description
Template: LongText.
- isCustomReportType
Data type: DT_BOOL
- isHidden
Data type: DT_BOOL
- isHistorical
Data type: DT_BOOL
- label
Template: ShortText.
- supportsJoinedFormat
Data type: DT_BOOL
- type
Template: ShortText.
- aggregates
Template: LongText. A composite field.
- chart
Template: ShortText.
- crossFilters
Template: LongText. A composite field.
- currency
Template: ShortText.
- dashboardSetting
Template: ShortText.
- description
Template: LongText.
- detailColumns
Template: LongText. A composite field.
- developerName
Template: ShortText.
- division
Template: ShortText.
- folderId
Template: ShortText.
- groupingsAcross
Template: LongText. A composite field.
- groupingsDown
Template: LongText. A composite field.
- hasDetailRows
Data type: DT_BOOL
- hasRecordCount
Data type: DT_BOOL
- historicalSnapshotDates
Template: LongText. A composite field.
- templateId
Template: ShortText.
- hidden
Data type: DT_BOOL
- name
Template: ShortText.
- presentationOptions
Field components:
- Contains the following components: hasStackedSummaries.
- reportBooleanFilter
Template: ShortText.
- reportFilters
Template: LongText. A composite field.
- reportFormat
Template: ShortText.
- reportType
Field components:
-
Uses template:
ShortText
. - Contains the following components: label, type.
-
Uses template:
- scope
Template: ShortText.
- showGrandTotal
Data type: DT_BOOL
- showSubtotals
Data type: DT_BOOL
- sortBy
Template: LongText. A composite field.
- standardDateFilter
Field components:
-
Uses template:
ShortText
. - Contains the following components: column, durationValue, endDate, startDate.
-
Uses template:
- standardFilters
Template: ShortText.
- supportsRoleHierarchy
Data type: DT_BOOL
- userOrHierarchyFilterId
Template: ShortText.
Based on resource template WaveOffsetPagination.
- [Read] action
-
Endpoint URL address:
/collections
.
The result is extracted from:{{=response.collections}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections.htm.
- [Read single] action
-
Endpoint URL address:
/collections/{{=Analytics.UI.CollectionEditor.getValue(parameters)}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- collection_id: Required. Specify the collection identifier.
Documentation: https://www.zoho.com/books/api/v3/currency/#get-a-currency.
- [Create] action
-
Endpoint URL address:
/collections
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections.htm.
- [Update] action
-
Endpoint URL address:
/collections
.
- [Delete] action
-
Endpoint URL address:
/collections
.
- id
A key field. Template: ShortText.
- assetSharingUrl
Template: LongText.
- collectionType
Template: ShortText.
- color
Template: ShortText.
- createdBy
Template: WaveUserT.
- createdDate
Template: DateTime. A read-only field.
- description
Template: ShortText.
- isPinned
Data type: DT_BOOL
- isVisible
Data type: DT_BOOL
- itemsUrl
Template: LongText.
- label
Template: ShortText.
- lastModifiedBy
Template: WaveUserT.
- lastModifiedDate
Template: DateTime. A read-only field.
- name
Template: ShortText.
- permissions
Template: PermissionT.
- pinnedBy
Template: ShortText.
- pins
Field components:
- An array.
- Contains the following components: id, pinnedFor, type.
- shares
Field components:
- An array.
-
Uses template:
ShareT
.
- type
Template: ShortText.
- url
Template: LongText.
- items
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Collection | Item'].getData({ parameters: ['collection_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
ItemT
.
Based on resource template WaveOffsetPagination.
- [Read] action
-
Endpoint URL address:
/collections/{{=Analytics.UI.CollectionEditor.getValue(parameters)}}/items
.
The result is extracted from:{{=response.collectionItems}}
.The action has the following user-defined parameters:
- collection_id: Required. Specify the collection identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_items.htm.
- [Create] action
-
Endpoint URL address:
/collections/{{=item.collection_id}}/items
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_items.htm.
- [Update] action
-
Endpoint URL address:
/collections/{{=item.collection_id}}/items
.
The action uses PATCH method.The following request parameters will be automatically processed:
-
application/json:
{{={ items: [item] } }}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_items.htm.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/collections/{{=item.collection_id}}/items/{{=item.collectionItemId}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_item.htm.
The resource includes the fields from the ItemT template.
- collection_id
Template: ShortText.
Based on resource template WaveTokenPagination.
- [Read] action
-
Endpoint URL address:
/dashboards
.
The result is extracted from:{{=response.dashboards}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards.htm.
- [Read single] action
-
Endpoint URL address:
/dashboards/{{=parameters.dashboard_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- dashboard_id: Required. Specify the dashboard identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id.htm.
- [Create] action
-
Endpoint URL address:
/dashboards
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards.htm.
- [Update] action
-
Endpoint URL address:
/dashboards/{{=item.id}}
.
The action uses PATCH method.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id.htm.
- [Delete] action
-
Endpoint URL address:
/dashboards/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id.htm.
- id
A key field. Template: ShortText.
- allowPreview
Data type: DT_BOOL
- description
Template: LongText.
- assetSharingUrl
Template: ShortText.
- createdBy
Template: WaveUserT.
- createdDate
Template: DateTime. A read-only field.
- datasets
Field components:
- An array.
-
Uses template:
AssetReferenceT
.
- dateVersion
Data type: DT_I4
- files
Field components:
- An array.
-
Uses template:
FileT
.
- folder
Template: BaseFolderT.
- historiesUrl
Template: ShortText.
- label
Template: ShortText.
- lastAccessedDate
Template: ShortText.
- lastModifiedBy
Template: WaveUserT.
- lastModifiedDate
Template: ShortText.
- mobileDisabled
Data type: DT_BOOL
- name
Template: ShortText.
- permissions
Template: PermissionT.
- refreshDate
Template: ShortText.
- templateAssetSourceName
Template: ShortText.
- templateSourceId
Template: ShortText.
- type
Template: ShortText.
- url
Template: ShortText.
- visibility
Template: ShortText.
- clonedTemplateOrigin
Template: ShortText.
- currentHistoryId
Template: ShortText.
- dateVersion
Template: ShortText.
- historyLabel
Template: ShortText.
- mobileDisabled
Data type: DT_BOOL
- type
Template: ShortText.
- visibility
Template: ShortText.
- history
A read-only field. The value is gathered from
/dashboards/{{=item.id}}/histories
address. The gathered value is processed with{{=response.histories}}
expression. Field components:- An array.
-
Uses template:
HistoryT
.
- publisher
A read-only field. The value is gathered from
/dashboards/{{=item.id}}/publishers
address. The gathered value is processed with{{=response.publishers}}
expression. Field components:- An array.
- Contains the following components: id, assetId, publisherUser.
- action
Template: ShortText. Field components:
- Contains the following components: add_publisher, remove_publisher.
Based on resource template WaveNoPagination.
- [Read single] action
-
Endpoint URL address:
/dashboards/image/{{=parameters.imageFqn}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- imageFqn: Required. Specify the imageFqn.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_image_imagefqn.htm.
The resource includes the fields from the AssetReferenceT template.
- content
Data type: DT_IMAGE The value is gathered from
{{=item.url}}
address.
Based on resource template WaveNoPagination.
- [Read] action
-
Endpoint URL address:
/dataConnectors
.
The result is extracted from:{{=response.dataConnectors}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards.htm.
- [Read single] action
-
Endpoint URL address:
/dataConnectors/{{=parameters.dataConnector_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- dataConnector_id: Required. Specify the data connector identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid.htm.
- [Create] action
-
Endpoint URL address:
/dataConnectors
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors.htm.
- [Update] action
-
Endpoint URL address:
/dataConnectors/{{=item.id}}
.
The action uses PATCH method.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid.htm.
- [Delete] action
-
Endpoint URL address:
/dataConnectors/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid.htm.
The resource includes the fields from the DataConnectorT template.
- sourceObjects
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Data Connector | Source Object'].getData({ parameters: ['dataConnector_id=' + item.id], batchSize: 200 })}}
expression. Field components:- An array.
-
Uses template:
SourceObjectT
.
- status
A read-only field. The value is gathered from
/dataConnectors/{{=item.id}}/status
address. The gathered value is processed with{{=response.sourceObjects}}
expression. Field components:- An array.
- Contains the following components: message, status, url.
- action
Template: ShortText. Field components:
- Contains the following components: ingest.
Based on resource template WaveNoPagination.
- [Read] action
-
Endpoint URL address:
/dataflows
.
The result is extracted from:{{=response.dataflows}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflows.htm.
- [Read single] action
-
Endpoint URL address:
/dataflows/{{=Analytics.UI.DataflowEditor.getValue(parameters)}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- dataflow_id: Required. Specify the dataflow job identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflows_id.htm.
- [Create] action
-
Endpoint URL address:
/dataflows
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflows_id.htm.
- [Update] action
-
Endpoint URL address:
/dataflows/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflows_id.htm.
- id
A key field. Template: ShortText.
- createdBy
Template: WaveUserT.
- createdDate
Template: DateTime. A read-only field.
- definition
Template: LongText. A composite field.
- emailNotificationLevel
Template: ShortText.
- historiesUrl
Template: LongText.
- label
Template: ShortText.
- lastModifiedBy
Template: WaveUserT.
- lastModifiedDate
Template: DateTime. A read-only field.
- name
Template: ShortText.
- type
Template: ShortText.
- url
Template: LongText.
- dataflowId
Template: ShortText.
- historyId
Template: ShortText.
- historyLabel
Template: ShortText.
- schedule
Template: ScheduleT. The value is gathered from
/asset/{{=item.id}}/schedule
address.- action
Template: ShortText. Field components:
-
Uses template:
ActionT
. - Contains the following components: startDataflowJob, stopDataflowJob, schedule.
-
Uses template:
Based on resource template WaveTokenPagination.
- [Read] action
-
Endpoint URL address:
/dataflowjobs
.
The result is extracted from:{{=response.dataflowjobs}}
.The action has the following user-defined parameters:
- dataflowId: Filters the collection to only contain dataflow jobs tied to this specific dataflow. Optional.
- jobTypes: Filters the collection to only contain dataflow jobs for specified job types. Optional.
- licenseType: Filters the collection by the Analytics license type. Optional.
- status: Filters the collection to only contain dataflow jobs with a specific runtime status. Optional.
The following request parameters will be automatically processed:
-
dataflowId:
{{=parameters.get('dataflowId') && Analytics.UI.DataflowEditor.getValue(parameters)}}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs.htm.
- [Read single] action
-
Endpoint URL address:
/dataflowjobs/{{=parameters.dataflowJob_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- dataflowJob_id: Required. Specify the dataflow job identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_id.htm.
- id
A key field. Template: ShortText.
- createdDate
Template: DateTime. A read-only field.
- executedDate
Template: DateTime. A read-only field.
- jobType
Template: ShortText.
- label
Template: ShortText.
- licenseAttributes
Field components:
-
Uses template:
ShortText
. - Contains the following components: type.
-
Uses template:
- nodesUrl
Template: ShortText.
- progress
Data type: DT_R8
- retryCount
Data type: DT_I4
- startDate
Template: DateTime.
- status
Template: ShortText.
- type
Template: ShortText.
- url
Template: LongText.
- waitTime
Data type: DT_I4
- duration
Data type: DT_I4
- endDate
Template: DateTime.
- message
Template: ShortText.
- command
Template: ShortText.
- dataflowId
Template: ShortText.
- nextRunDate
Template: ShortText.
- outputNodes
Template: EnsureNodeArrayT.
- transformNodes
Template: EnsureNodeArrayT.
- inputNodes
Template: EnsureNodeArrayT.
- source
Template: AssetReferenceT.
- syncDataFlows
A read-only field. The gathered value is processed with
{{=utils.ensureArray(value && value.dataflows)}}
expression. Field components:- An array.
- Contains the following components: definition, emailNotificationLevel, historiesUrl, nextScheduledDate, scheduledAttributes.
- nodes
A read-only field. The value is gathered from
/dataflowjobs/{{=item.id}}/nodes
address. The gathered value is processed with{{=response.nodes}}
expression. Field components:- An array.
- Contains the following components: id, duration, inputRows, label, name, nodeType, outputRows, startDate, status, type, url.
Based on resource template WaveTokenPagination.
- [Read] action
-
Endpoint URL address:
/datasets
.
The result is extracted from:{{=response.datasets}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets.htm.
- [Read single] action
-
Endpoint URL address:
/datasets/{{=Analytics.UI.DatasetEditor.getValue(parameters)}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- dataset: Required. Specify the dataset identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataset_id.htm.
- [Create] action
-
Endpoint URL address:
/datasets
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets.htm.
- [Update] action
-
Endpoint URL address:
/datasets/{{=item.id}}
.
The action uses PATCH method.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataset_id.htm.
- [Delete] action
-
Endpoint URL address:
/datasets/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataset_id.htm.
- id
A key field. Template: ShortText.
- clientShardsUrl
Template: LongText.
- createdBy
Template: WaveUserT.
- createdDate
Template: DateTime. A read-only field.
- currentVersionId
Template: ShortText.
- currentVersionTotalRowCount
Data type: DT_I4
- currentVersionUrl
Template: LongText.
- dataRefreshDate
Template: DateTime.
- datasetType
Template: ShortText.
- folder
Template: BaseFolderT.
- label
Template: ShortText.
- lastAccessedDate
Template: ShortText.
- lastModifiedBy
Template: WaveUserT.
- lastModifiedDate
Template: DateTime.
- lastQueriedDate
Template: DateTime.
- name
Template: ShortText.
- permissions
Template: PermissionT.
- type
Template: ShortText.
- url
Template: ShortText.
- versionsUrl
Template: LongText.
- visibility
Template: ShortText.
- liveConnection
Field components:
-
Uses template:
ShortText
. - Contains the following components: connectionName, sourceObjectName.
-
Uses template:
Based on resource template WaveNoPagination.
- [Read] action
-
Endpoint URL address:
/datasets/{{=Analytics.UI.DatasetEditor.getValue(parameters)}}/versions
.
The result is extracted from:{{=response.versions}}
.The action has the following user-defined parameters:
- dataset: Required. Specify the dataset identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_id_versions.htm.
- [Read single] action
-
Endpoint URL address:
/datasets/{{=Analytics.UI.DatasetEditor.getValue(parameters)}}/versions/{{=parameters.version_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- dataset: Required. Specify the dataset identifier.
- version_id: Required. Specify the version identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_id_versions_id.htm.
- [Create] action
-
Endpoint URL address:
/datasets/{{=item.dataset_id}}/versions
.The following request parameters will be automatically processed:
-
application/json:
{{={ sourceVersion: item } }}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_id_versions.htm.
-
application/json:
- [Update] action
-
Endpoint URL address:
/datasets/{{=item.dataset_id}}/versions/{{=item.id}}
.
The action uses PATCH method.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_id_versions_id.htm.
- id
A key field. Template: ShortText.
- createdBy
Template: WaveUserT.
- createdDate
Template: DateTime. A read-only field.
- dataset
Template: AssetReferenceT.
- files
Field components:
- An array.
-
Uses template:
FileT
.
- lastModifiedBy
Template: WaveUserT.
- lastModifiedDate
Template: DateTime. A read-only field.
- permissions
Template: PermissionT.
- securityCoverageUrl
Template: ShortText.
- totalRowCount
Data type: DT_I4
- type
Template: ShortText.
- url
Template: LongText.
- description
Template: LongText.
- name
Template: ShortText.
- predicate
Template: ShortText.
- label
Template: ShortText.
- isComplete
Data type: DT_BOOL
- predicate
Template: ShortText.
- totalRows
Data type: DT_I4
- sharingSource
Template: AssetReferenceT.
- xmdMain
Field components:
-
Uses template:
WaveUserT
. - Contains the following components: createdBy, createdDate, dataset, dates, derivedDimensions, derivedMeasures, dimensions, language, lastModifiedBy, lastModifiedDate, measures, organizations, showDetailsDefaultFields, type, url.
-
Uses template:
- xmdsUrl
Template: LongText.
- dataset_id
A key field. Template: ShortText.
- security_coverage
A read-only field. The value is gathered from
/wave/security/coverage/datasets/{{=Analytics.UI.DatasetEditor.getValue(parameters)}}/versions/{{=item.id}}
address. The gathered value is processed with{{=response.datasetVersion}}
expression. Field components:-
Uses template:
ShortText
. - Contains the following components: id, dataset, url.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/eclair/geodata
.
The result is extracted from:{{=response.geoData}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_geodata.htm.
- [Read single] action
-
Endpoint URL address:
/eclair/geodata/{{=parameters.eclairChart_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- eclairChart_id: Required. Specify the eclair chart identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_geodata_id.htm.
- [Create] action
-
Endpoint URL address:
/eclair/geodata
.The following request parameters will be automatically processed:
-
geoDataFile:
{{=item.geoDataFile}}
-
application/json:
{{={ geoDataObject: item } }}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_geodata.htm.
-
geoDataFile:
- [Update] action
-
Endpoint URL address:
/eclair/geodata/{{=item.id}}
.
The action uses PATCH method.The following request parameters will be automatically processed:
-
geoDataFile:
{{=item.geoDataFile}}
-
application/json:
{{={ geoDataObject: item } }}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_geodata_id.htm.
-
geoDataFile:
- [Delete] action
-
Endpoint URL address:
/eclair/geodata/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_geodata_id.htm.
The resource includes the fields from the GeoDataT template.
- geoDataFile
Data type: DT_IMAGE The value is gathered from
/eclair/geodata/{{=item.id}}/file
address.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/eclair/maps
.
The result is extracted from:{{=response.geoData}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_maps.htm.
- [Read single] action
-
Endpoint URL address:
/eclair/maps/{{=parameters.eclairMap_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- eclairMap_id: Required. Specify the eclair map identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_maps_id.htm.
- [Create] action
-
Endpoint URL address:
/eclair/maps
.The following request parameters will be automatically processed:
-
application/json:
{{={ geoMapObject: item } }}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_maps.htm.
-
application/json:
- [Update] action
-
Endpoint URL address:
/eclair/maps/{{=item.id}}
.
The action uses PATCH method.The following request parameters will be automatically processed:
-
application/json:
{{={ geoMapObject: item } }}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_maps_id.htm.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/eclair/maps/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_maps_id.htm.
The resource includes the fields from the AssetReferenceT template.
- projection
Template: ShortText.
- geoData
Template: GeoDataT.
- createdDate
Template: DateTime. A read-only field.
- createdBy
Template: WaveUserT.
- boundingBox
Field components:
-
Uses template:
ShortText
. - Contains the following components: bottom, left, right, top.
-
Uses template:
Based on resource template WaveTokenPagination.
- [Read] action
-
Endpoint URL address:
/folders
.
The result is extracted from:{{=response.folders}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders.htm.
- [Read single] action
-
Endpoint URL address:
/folders/{{=parameters.folder_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- folder_id: Required. Specify the folder identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id.htm.
- [Create] action
-
Endpoint URL address:
/folders
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders.htm.
- [Update] action
-
Endpoint URL address:
/folders/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id.htm.
- [Delete] action
-
Endpoint URL address:
/folders/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id.htm.
The resource includes the fields from the BaseWaveAssetT template.
- applicationStatus
Template: ShortText.
- attachedFiles
Field components:
- An array.
-
Uses template:
AssetReferenceT
.
- appLog
Template: AppLogT.
- canBeSharedExternally
Data type: DT_BOOL
- defaultAsset
Template: AssetReferenceT.
- featuredAssets
Template: FeaturedAssetT.
- icon
Template: AssetReferenceT.
- installationHistoryUrl
Template: ShortText.
- isPinned
Data type: DT_BOOL
- lastModifiedDate
Template: ShortText.
- name
Template: ShortText.
- shares
Field components:
- An array.
-
Uses template:
ShareT
.
- templateOptions
Template: TemplateOptionsT.
- templateSourceId
Template: ShortText.
- templateValues
Template: NameValueT.
- templateVersion
Template: ShortText.
- usageUrl
Template: LongText.
- schedule
Template: ScheduleT. The gathered value is processed with
{{=value && value.dataRefreshSchedule}}
expression.
Based on resource template WaveNoPagination.
- [Read] action
-
Endpoint URL address:
/folders/{{=Analytics.UI.FolderEditor.getValue(parameters)}}/schedule
.
The result is extracted from:{{=response.dataRefreshSchedule}}
.The action has the following user-defined parameters:
- folder_id: Required. Specify the folder identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id_schedule.htm.
- [Update] action
-
Endpoint URL address:
/folders/{{=item.folder_id}}/schedule
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id_schedule.htm.
- [Delete] action
-
Endpoint URL address:
/folders/{{=item.folder_id}}/schedule
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id_schedule.htm.
The resource includes the fields from the ScheduleT template.
- folder_id
A key field. Template: ShortText.
Based on resource template WaveNoPagination.
- [Read] action
-
Endpoint URL address:
/limits
.
The result is extracted from:{{=response.limits}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_limits.htm.
- current
Data type: DT_R8
- interval
Template: ShortText.
- licenseAttributes
Template: ShortText.
- max
Data type: DT_I8
- threshold
Data type: DT_I8
- type
Template: ShortText.
Based on resource template WaveTokenPagination.
- [Read] action
-
Endpoint URL address:
/lenses
.
The result is extracted from:{{=response.lenses}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses.htm.
- [Read single] action
-
Endpoint URL address:
/lenses/{{=parameters.lens_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- lens_id: Required. Specify the lens identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id.htm.
- [Create] action
-
Endpoint URL address:
/lenses
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses.htm.
- [Update] action
-
Endpoint URL address:
/lenses/{{=item.id}}
.
The action uses PATCH method.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id.htm.
- [Delete] action
-
Endpoint URL address:
/lenses/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id.htm.
- id
A key field. Template: ShortText.
- allowPreview
Data type: DT_BOOL
- assetSharingUrl
Template: ShortText.
- createdBy
Template: WaveUserT.
- createdDate
Template: DateTime. A read-only field.
- dataset
Template: AssetReferenceT.
- dateVersion
Data type: DT_I4
- description
Template: LongText.
- filesUrl
Template: ShortText.
- folder
Template: AssetReferenceT.
- historiesUrl
Template: LongText.
- label
Template: ShortText.
- lastAccessedDate
Template: DateTime.
- lastModifiedBy
Template: WaveUserT.
- lastModifiedDate
Template: DateTime.
- name
Template: ShortText.
- permissions
Template: PermissionT.
- refreshDate
Template: DateTime.
- templateAssetSourceName
Template: ShortText.
- templateSourceId
Template: ShortText.
- type
Template: ShortText.
- url
Template: LongText.
- visibility
Template: ShortText.
- visualizationType
Template: ShortText.
- datasets
Field components:
- An array.
-
Uses template:
AssetReferenceT
.
- files
Field components:
- An array.
-
Uses template:
FileT
.
- state
Field components:
- Contains the following components: aggregateflex, options, query.
Based on resource template WaveNoPagination.
- [Read] action
-
Endpoint URL address:
/replicatedDatasets
.
The result is extracted from:{{=response.replicatedDatasets}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets.htm.
- [Read single] action
-
Endpoint URL address:
/replicatedDatasets/{{=parameters.replicatedDataset_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- replicatedDataset_id: Required. Specify the replicated dataset identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets_id.htm.
- [Create] action
-
Endpoint URL address:
/replicatedDatasets
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets.htm.
- [Update] action
-
Endpoint URL address:
/replicatedDatasets/{{=item.id}}
.
The action uses PATCH method.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets_id.htm.
- [Delete] action
-
Endpoint URL address:
/replicatedDatasets/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets_id.htm.
- id
A key field. Template: ShortText.
- advancedProperties
Template: PropertiesT.
- connectionMode
Template: ShortText.
- connector
Template: DataConnectorT.
- createdBy
Template: WaveUserT.
- createdDate
Template: DateTime. A read-only field.
- datasetId
Template: ShortText.
- connectorId
Template: ShortText.
- connectionMode
Template: ShortText.
- fieldCount
Data type: DT_I4
- fieldsUrl
Template: ShortText.
- filterApplied
Data type: DT_BOOL
- fullRefresh
Data type: DT_BOOL
- label
Template: ShortText.
- passThroughFilter
Template: ShortText.
- lastModifiedBy
Template: WaveUserT.
- lastModifiedDate
Template: ShortText.
- lastRefreshedDate
Template: ShortText.
- name
Template: ShortText.
- replicationDataflowId
Template: ShortText.
- sourceObjectName
Template: ShortText.
- status
Template: ShortText.
- supportedConnectionModes
Template: LongText. A composite field.
- type
Template: ShortText.
- url
Template: ShortText.
- uuid
Template: ShortText.
- fields
The value is gathered from
/replicatedDatasets/{{=item.id}}/fields
address. The gathered value is processed with{{=response.fields}}
expression. Field components:- An array.
- Contains the following components: fieldType, label, name, skipped, format.
Based on resource template WaveOffsetPagination.
- [Read] action
-
Endpoint URL address:
/recipes
.
The result is extracted from:{{=response.recipes}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipes.htm.
- [Read single] action
-
Endpoint URL address:
/recipes/{{=parameters.recipe_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- recipe_id: Required. Specify the recipe identifier.
- format: Required. Specify the format.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipes_id.htm.
- [Create] action
-
Endpoint URL address:
/recipes
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflows_id.htm.
- [Update] action
-
Endpoint URL address:
/recipes/{{=item.id}}
.
The action uses PATCH method.The following request parameters will be automatically processed:
-
application/json:
{{={ recipeObject: item} }}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipes_id.htm.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/recipes/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipes_id.htm.
- id
A key field. Template: ShortText.
- conversionDetails
Field components:
- An array.
- Contains the following components: message, nodeName, severity, conversionDetailId.
- createdBy
Template: WaveUserT.
- dataset
Template: AssetReferenceT.
- createdDate
Template: DateTime. A read-only field.
- dataflowLastUpdate
Template: ShortText.
- enableEditorValidation
Data type: DT_BOOL
- fileUrl
Template: LongText.
- format
Template: ShortText.
- licenseType
Template: ShortText.
- historiesUrl
Template: LongText.
- label
Template: ShortText.
- validationContext
Template: ShortText.
- lastModifiedBy
Template: WaveUserT.
- lastModifiedDate
Template: DateTime. A read-only field.
- licenseAttributes
Field components:
-
Uses template:
ShortText
. - Contains the following components: type.
-
Uses template:
- name
Template: ShortText.
- nextScheduledDate
Template: ShortText.
- publishingTarget
Template: DateTime.
- recipeDefinition
Template: NameValueT.
- scheduleAttributes
Template: ScheduleT.
- scheduleType
Template: ShortText.
- status
Template: ShortText.
- targetDataflowId
Template: ShortText.
- type
Template: ShortText.
- url
Template: ShortText.
- schedule
Template: ShortText.
- validationDetails
Field components:
- An array.
- Contains the following components: message, nodeName, nodeType, severity, validationAction, validationCode.
- recipeFile
Data type: DT_IMAGE The value is gathered from
/recipes/{{=item.id}}/file
address.- scheduleDetails
Template: ScheduleT. A read-only field. The value is gathered from
/asset/{{=item.id}}/schedule
address.- history
A read-only field. The value is gathered from
/recipes/{{=item.id}}/histories
address. The gathered value is processed with{{=response.histories}}
expression. Field components:- An array.
-
Uses template:
HistoryT
.
- notification
A read-only field. The value is gathered from
/recipes/{{=item.id}}/notification
address. Field components:-
Uses template:
ShortText
. - Contains the following components: notificationLevel, longRunningAlertInMins, recipe.
-
Uses template:
- action
Template: ShortText. Field components:
-
Uses template:
ActionT
. - Contains the following components: startRecipe, stopRecipe, schedule, notification.
-
Uses template:
Based on resource template WaveOffsetPagination.
- [Read] action
-
Endpoint URL address:
/recipe-configurations
.
The result is extracted from:{{=response.configurations}}
.
- [Read single] action
-
Endpoint URL address:
/recipes-configurations/{{=parameters.recipe_configuration_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- recipe_configuration_id: Required. Specify the recipe-configuration identifier.
- [Create] action
-
Endpoint URL address:
/recipe-configurations
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflows_id.htm.
- [Update] action
-
Endpoint URL address:
/recipes-configurations/{{=item.id}}
.
The action uses PATCH method.
- [Delete] action
-
Endpoint URL address:
/recipes-configurations/{{=item.id}}
.
- id
A key field. Template: ShortText.
- createdBy
Template: WaveUserT.
- dataset
Template: AssetReferenceT.
- createdDate
Template: DateTime. A read-only field.
- assetSharingUrl
Template: LongText.
- description
Template: LongText.
- label
Template: ShortText.
- lastModifiedBy
Template: WaveUserT.
- lastAccessedDate
Template: DateTime. A read-only field.
- lastModifiedDate
Template: DateTime. A read-only field.
- name
Template: ShortText.
- namesapce
Template: ShortText.
- permissions
Template: PermissionT.
- type
Template: ShortText.
- url
Template: LongText.
- fiscalType
Template: ShortText.
- isDefault
Data type: DT_BOOL
Based on resource template WaveNoPagination.
- [Read] action
-
Endpoint URL address:
/query
.
The result is extracted from:{{=response.results.records}}
.
The action uses POST method.
The result is paginated.The action has the following user-defined parameters:
- dataset: Required. Specify the dataset.
- statement: Required. Specify the query statement statement.
The following request parameters will be automatically processed:
-
application/json:
{{=Analytics.queryDatasetPagination(parameters)}}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_query.htm.
- [External]
-
The external fields URL address:
/query
. The external fields list is extracted from:{{=_.flatten(_.pluck(response.results.metadata, 'columns'))}}
.- {{=external.columnLabel}}
Template: {{=Analytics.getFieldTemplate(external.columnType)}}.
Based on resource template WaveNoPagination.
- [Read] action
-
Endpoint URL address:
/subscriptions
.
The result is extracted from:{{=response.subscriptions}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions.htm.
- [Read single] action
-
Endpoint URL address:
/subscriptions/{{=parameters.subscription_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- subscription_id: Required. Specify the subscription identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid.htm.
- [Create] action
-
Endpoint URL address:
/subscriptions
.The following request parameters will be automatically processed:
-
application/json:
{{={ runNow: item.runNow, subscription: _.omit(item, 'runNow') } }}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflows_id.htm.
-
application/json:
- [Update] action
-
Endpoint URL address:
/subscriptions/{{=item.id}}
.
The action uses PATCH method.The following request parameters will be automatically processed:
-
application/json:
{{={ runNow: item.runNow, subscription: _.omit(item, 'runNow') } }}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid.htm.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/subscriptions/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid.htm.
- id
A key field. Template: ShortText.
- type
Template: ShortText.
- runNow
Data type: DT_BOOL
- source
Field components:
-
Uses template:
ShortText
. - Contains the following components: type, details.
-
Uses template:
- schedule
Template: ScheduleT. Field components:
- Contains the following components: details.
Based on resource template WaveNoPagination.
- [Read] action
-
Endpoint URL address:
/templates
.
The result is extracted from:{{=response.templates}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates.htm.
- [Read single] action
-
Endpoint URL address:
/templates/{{=parameters.template_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- template_id: Required. Specify the template identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_id.htm.
- [Create] action
-
Endpoint URL address:
/templates
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates.htm.
- [Update] action
-
Endpoint URL address:
/templates/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_id.htm.
- [Delete] action
-
Endpoint URL address:
/templates/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_id.htm.
- id
A key field. Template: ShortText.
- assetVersion
Data type: DT_R8
- configurationUrl
Template: LongText.
- createdBy
Template: WaveUserT.
- createdDate
Template: DateTime. A read-only field.
- recipeIds
Template: LongText. A composite field.
- customAttributes
Field components:
- An array.
- Contains the following components: label, values.
- description
Template: LongText.
- folderSource
Template: ShortText.
- icons
Field components:
-
Uses template:
BadgeT
. - Contains the following components: appBadge, templateBadge, templatePreviews.
-
Uses template:
- dataflow
Template: AssetReferenceT.
- folderSource
Template: AssetReferenceT.
- label
Template: ShortText.
- lastModifiedBy
Template: WaveUserT.
- lastModifiedDate
Template: DateTime. A read-only field.
- name
Template: ShortText.
- namespace
Template: ShortText.
- releaseInfo
Field components:
-
Uses template:
LongText
. - Contains the following components: notesUrl, templateVersion.
-
Uses template:
- tags
Template: LongText. A composite field.
- templateType
Template: ShortText.
- url
Template: LongText.
- videos
Template: LongText. A composite field.
- configuration
A read-only field. The value is gathered from
/templates/{{=item.id}}/configuration
address. Field components:-
Uses template:
ShortText
. - Contains the following components: id, layout, name, namespace, variables, ui.
-
Uses template:
- release_notes
A read-only field. The value is gathered from
/templates/{{=item.id}}/lint
address. Field components:-
Uses template:
ShortText
. - Contains the following components: id, notes, name, namespace.
-
Uses template:
- action
Template: ShortText. Field components:
- Contains the following components: validation.
Based on resource template WaveNoPagination.
- [Read] action
-
Endpoint URL address:
/trendedreports
.
The result is extracted from:{{=response.trendedreports}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_trendedreports.htm.
- [Read single] action
-
Endpoint URL address:
/trendedreports/{{=parameters.trendedReport_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- trendedReport_id: Required. Specify the trended report identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_trendedtreports_id.htm.
- [Create] action
-
Endpoint URL address:
/trendedreports
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_trendedreports.htm.
- [Update] action
-
Endpoint URL address:
/trendedreports/{{=item.id}}
.
The action uses PATCH method.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_trendedtreports_id.htm.
- [Delete] action
-
Endpoint URL address:
/trendedreports/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_trendedtreports_id.htm.
- id
A key field. Template: ShortText.
- apexHooksClass
Template: AssetReferenceT.
- dashboard
Template: AssetReferenceT.
- dataset
Template: AssetReferenceT.
- report
Template: AssetReferenceT.
- url
Template: LongText.
- schedule
Template: ScheduleT. Field components:
-
Uses template:
TimeT
. - Contains the following components: notificationLevel.
-
Uses template:
- content
Data type: DT_IMAGE The value is gathered from
{{=new Uri(connection.serverHost).authority() + item.url}}
address.
Based on resource template WaveNoPagination.
- [Read] action
-
Endpoint URL address:
/watchlist
.
The result is extracted from:{{=response.watchlistSnapshots.snapshotItems}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist.htm.
- [Read single] action
-
Endpoint URL address:
/watchlist/{{=parameters.watchlist_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- watchlist_id: Required. Specify the watchlist identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist_id.htm.
- [Create] action
-
Endpoint URL address:
/watchlist
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist.htm.
- [Update] action
-
Endpoint URL address:
/watchlist/{{=item.id}}
.
The action uses PATCH method.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist.htm.
- id
A key field. Template: ShortText.
- scheduleId
Template: ShortText.
- createdDate
Template: DateTime. A read-only field.
- lastModifiedDate
Template: DateTime. A read-only field.
- snapshotDashboardId
Template: ShortText.
- sourceId
Template: ShortText.
- schedule
Template: ScheduleT. Field components:
- Contains the following components: details.
- destinationLink
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, namesapce, pageName, savedViewId, widgetId, driftState.
-
Uses template:
- watchlistWidgetItem
Template: WatchlistWidgetItemT.
- lastRunInfo
Template: lastRunInfoT.
- sourceDashoard
Field components:
-
Uses template:
ShortText
. - Contains the following components: version.
-
Uses template:
- parameters
Template: ParametersT.
- watchlistItems
Field components:
- An array.
- Contains the following components: scheduleId, watchlistWidgetItem.
- driftState
Template: ShortText.
- stepId
Template: ShortText.
- watchlistWidgetItem
Field components:
- An array.
-
Uses template:
WatchlistWidgetItemT
.
- datarows
Field components:
- An array.
- Contains the following components: snapshotDate, snapshotDateLabel.
- lastRunInfo
Template: lastRunInfoT.
Based on resource template WaveOffsetPagination.
- [Read] action
-
Endpoint URL address:
/auto-install-requests
.
The result is extracted from:{{=response.requests}}
.The following request parameters will be automatically processed:
-
pageSize:
{{=parameters.batchSize}}
-
limit:
{{=undefined}}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_autoinstallrequests.htm.
-
pageSize:
- [Read single] action
-
Endpoint URL address:
/auto-install-requests/{{=parameters.request_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- request_id: Required. Specify the request identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_autoinstallrequests_id.htm.
- [Create] action
-
Endpoint URL address:
/auto-install-requests
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist.htm.
- [Update] action
-
Endpoint URL address:
/auto-install-requests/{{=item.id}}
.
The action uses PATCH method.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_autoinstallrequests_id.htm.
- [Delete] action
-
Endpoint URL address:
/auto-install-requests/{{=item.id}}
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_autoinstallrequests_id.htm.
- id
A key field. Template: ShortText.
- createdBy
Template: WaveUserT.
- createdDate
Template: DateTime. A read-only field.
- failedReason
Template: ShortText.
- folderId
Template: ShortText.
- folderLabel
Template: ShortText.
- lastModifiedBy
Template: WaveUserT.
- lastModifiedDate
Template: DateTime. A read-only field.
- requestDetailsUrl
Template: LongText.
- requestLog
Data type: DT_WSTR ( length 4000 )
- requestName
Template: ShortText.
- requestStatus
Template: ShortText.
- requestType
Template: ShortText.
- templateApiName
Template: ShortText.
- templateApiId
Template: ShortText.
- templateVersion
Template: ShortText.
- url
Template: LongText.
- appFromRequest
Field components:
- An array.
-
Uses template:
BaseWaveAssetT
. - Contains the following components: appLog, applicationStatus, attachedFiles, canBeSharedExternally, defaultAsset, icon, featuredAssets, installationHistoryUrl, isPinned, schedule, shares, templateSourceId, templateVersion, templateValues, templateOptions.
- configurations
Field components:
- An array.
- Contains the following components: parentRequestIds, appConfiguration.
Based on resource template WaveNoPagination.
- [Read] action
-
Endpoint URL address:
/annotations
.
The result is extracted from:{{=response.annotations}}
.The action has the following user-defined parameters:
- assetId: Required. Specify the asset identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_annotations.htm.
- [Read single] action
-
Endpoint URL address:
/annotations/{{=parameters.annotation_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- annotation_id: Required. Specify the annotation identifier.
Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_annotations_id.htm.
- [Create] action
-
Endpoint URL address:
/auto-install-requests
.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist.htm.
- [Update] action
-
Endpoint URL address:
/auto-install-requests/{{=item.id}}
.
The action uses PATCH method.Documentation: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_annotations_id.htm.
- id
A key field. Template: ShortText.
- subscriptionId
Template: ShortText.
- url
Template: ShortText.
- asset
Template: AssetReferenceT.
- anchor
Template: ShortText.
- feedElement
Template: AssetReferenceT.
- resolved
Data type: DT_BOOL
- [Read] action
-
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Upsert] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
Based on resource template NoPagination.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}}
-
pageSize:
{{=parameters.batchSize}}
-
page:
Based on resource template NoPagination.
Based on resource template WaveNoPagination.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}}
-
limit:
{{=parameters.batchSize}}
-
_includeUserParameters:
{{=parameters}}
-
offset:
- [Read single] action
-
The result is paginated.
Based on resource template Base.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 4000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Numeric
Data type: DT_R8
- Boolean
Data type: DT_BOOL
- Number
Data type: DT_I4
- WaveUserT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, profilePhotoUrl.
-
Uses template:
- PermissionT
Field components:
- Contains the following components: create, manage, modify, view.
- BaseWaveAssetT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, assetSharingUrl, createdBy, createdDate, description, label, lastAccessedDate, lastModifiedBy, name, permissions, type, url.
-
Uses template:
- BaseFolderT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, label, name.
-
Uses template:
- FolderT
Template: BaseFolderT. Field components:
-
Uses template:
LongText
. - Contains the following components: childrenUrl, parentId, type, url.
-
Uses template:
- FileT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, contentType, fileLength, length, fileName, lastModifiedDate, createdDate, url, name, createdBy.
-
Uses template:
- ItemT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, assetSharingUrl, assetType, collectionItemId, createdBy, createdDate, files, folder, label, lastModifiedBy, lastModifiedDate, permissions, type.
-
Uses template:
- url
Template: LongText.
- HistoryT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, label, createdBy, createdDate, historyUrl, previewUrl, revertUrl, isCurrent, status.
-
Uses template:
- EnsureNodeArrayT
The gathered value is processed with
{{=utils.ensureArray(value && value.nodes)}}
expression. Field components:- An array.
- Contains the following components: columnCount, errorMessage, label, name, endDate, outputRowCount, outputSizeInBytes, rowCount, sizeInBytes, status.
- GeoDataT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, label, name, type, namespace.
-
Uses template:
- ShareT
Field components:
-
Uses template:
ShortText
. - Contains the following components: accessType, imageUrl, shareType, sharedWithId, sharedWithLabel.
-
Uses template:
- AssetReferenceT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, label, name, namespace, type, url, description.
-
Uses template:
- BadgeT
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, namespace, url.
-
Uses template:
- lastRunInfoT
Field components:
-
Uses template:
DateTime
. - Contains the following components: lastRunDate, lastRunStatus.
-
Uses template:
- ParametersT
Field components:
- Contains the following components: shouldIncrease.
- WatchlistWidgetItemT
Field components:
-
Uses template:
ShortText
. - Contains the following components: driftState, id, sortOrder, sourceDashboardId, widgetId, driftState, parameters.
-
Uses template:
- TimeT
Field components:
- Contains the following components: hour, minute, timeZone.
- FolderShareT
Field components:
-
Uses template:
ShortText
. - Contains the following components: shareId, accessType, imageColor, imageUrl, shareType, sharedWithId, sharedWithLabel, url.
-
Uses template:
- ScheduleT
Field components:
-
Uses template:
ShortText
. - Contains the following components: assetId, daysOfWeek, frequency, nextScheduledDate, nextScheduledRun, time.
-
Uses template:
- NameValueT
The gathered value is processed with
{{=_.map(value, function(v, k) { return { name: k, value: v }; })}}
expression. Field components:- An array.
- Contains the following components: name, value.
- FeaturedAssetT
Field components:
- Contains the following components: default.
- AppLogT
Field components:
-
Uses template:
LongText
. - Contains the following components: message.
-
Uses template:
- PropertiesT
Field components:
- An array.
- Contains the following components: name, value.
- DataConnectorT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, connectionProperties, connectorHandler, connectorType, createdBy, createdDate, description, ingestionSchedule, label, lastModifiedBy, connectionProperties, lastModifiedDate, name, type, scope, url.
-
Uses template:
- SourceObjectT
Field components:
-
Uses template:
DataConnectorT
. - Contains the following components: dataConnector, dataPreviewUrl, fieldsUrl, name, replicated, url.
-
Uses template:
- TemplateOptionsT
Field components:
-
Uses template:
ShortText
. - Contains the following components: appAction, appActionDate, appActionUser, dynamicOptions.
-
Uses template:
- SourceFilterT
Field components:
-
Uses template:
ShortText
. - Contains the following components: cogrouptype, name, filters, groups, columns, filters, groups, name.
-
Uses template:
- ActionT
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.