Analytics REST API Developer Guide
jNewer Version Available
Folder Resource
- Resource URL
-
1/wave/folders/<folderID> - Formats
- JSON
- Available Version
- 36.0
- HTTP Methods
- GET DELETE PATCH PUT
- GET Request Parameters
-
Parameter Name Type Description Required or Optional Available Version mobileOnlyFeaturedAssets Boolean Filters the collection of folders to show only dashboards that are enabled for the Einstein Analytics mobile app. Optional 43.0 To get the application log for the folder, use the filterGroup request parameter with the Supplemental value in the GET request.
1/wave/folders/<folderID>?filterGroup=Supplemental - GET Response Body (WaveFolderRepresentation)
-
WaveFolderRepresentation inherits properties from the abstract BaseWaveAssetRepresentation. These base properties appear in WaveFolderRepresentation alongside the properties defined explicitly in the following table.
Property Name Type Description Filter Group and Version Available Version appLog AppLogRepresentation The application log from the creation or upgrade of the application. Supplemental, 49.0 49.0 applicationStatus ConnectWaveApplicationStatusEnum The creation status of application. Valid values are: - CancelledStatus
- CompletedStatus
- DataflowInProgressStatus
- FailedStatus
- InProgressStatus
- NewStatus
Medium, 36.0 36.0 attachedFiles AssetReferenceRepresentation[] The id's of the files attached to the insights folder Big, 39.0 39.0 canBeSharedExternally Boolean Indicates whether this app can be shared with community users or not. Big, 37.0 37.0 defaultAsset AssetReferenceRepresentation The default dashboard or lens that is presented when the app is viewed in App Runtime mode. Big, 37.0 37.0 featuredAssets Map<String, FeaturedAssetsRepresentation> The map of featured assets for this application to be used in the UI. Big, 39.0 39.0 icon AssetReferenceRepresentation The asset icon. Small, 36.0 36.0 isPinned Boolean Indicates whether this app is pinned or not. Small, 39.0 39.0 shares WaveFolderShareRepresentation[] The folder shares list. Big, 36.0 36.0 templateOptions TemplateOptionsRepresentation The options used on the last action performed on a templated Analytics application. Big, 37.0 37.0 templateSourceId String The source template ID or api name used to create the folder or application. Medium, 36.0 36.0 templateValues Map<String, Object> The map of template values used to create or update the folder or application. Large, 37.0 37.0 templateVersion String The version of the template this application was created from. Medium, 37.0 37.0 - PUT and PATCH Request Body (BaseWaveFolderInputRepresentation)
-
Property Name Type Description Required or Optional Available Version assetIcon String The icon enumeration that best represents the new folder or application. Valid values are 1.png through 20.png. Optional 36.0 description String The description of the folder or application. Optional 36.0 label String The user-facing name of the folder or application. Optional 36.0 name String The internal API name of the new folder or application. Optional 36.0 - PUT and PATCH Response Body (WaveFolderRepresentation)
-
Property Name Type Description Filter Group and Version Available Version appLog AppLogRepresentation The application log from the creation or upgrade of the application. Supplemental, 49.0 49.0 applicationStatus ConnectWaveApplicationStatusEnum The creation status of application. Valid values are: - CancelledStatus
- CompletedStatus
- DataflowInProgressStatus
- FailedStatus
- InProgressStatus
- NewStatus
Medium, 36.0 36.0 attachedFiles AssetReferenceRepresentation[] The id's of the files attached to the insights folder Big, 39.0 39.0 canBeSharedExternally Boolean Indicates whether this app can be shared with community users or not. Big, 37.0 37.0 defaultAsset AssetReferenceRepresentation The default dashboard or lens that is presented when the app is viewed in App Runtime mode. Big, 37.0 37.0 featuredAssets Map<String, FeaturedAssetsRepresentation> The map of featured assets for this application to be used in the UI. Big, 39.0 39.0 icon AssetReferenceRepresentation The asset icon. Small, 36.0 36.0 isPinned Boolean Indicates whether this app is pinned or not. Small, 39.0 39.0 shares WaveFolderShareRepresentation[] The folder shares list. Big, 36.0 36.0 templateOptions TemplateOptionsRepresentation The options used on the last action performed on a templated Analytics application. Big, 37.0 37.0 templateSourceId String The source template ID or api name used to create the folder or application. Medium, 36.0 36.0 templateValues Map<String, Object> The map of template values used to create or update the folder or application. Large, 37.0 37.0 templateVersion String The version of the template this application was created from. Medium, 37.0 37.0 -
- FeaturedAssetsRepresentation
-
Property Name Type Description Filter Group and Version Available Version assets TypedAssetReferenceRepresentation[] The list of featured assets. Small, 39.0 39.0 - TypedAssetReferenceRepresentation
-
Property Name Type Description Filter Group and Version Available Version type ConnectWaveAssetTypeEnum The asset type. Valid types are: - Component
- Dashboard
- DashboardSnapshot
- DataConnector
- Dataflow
- DataflowJob
- Dataset
- DatasetShard
- DatasetVersion
- ExternalData
- Folder
- Lens
- Recipe
- ReplicatedDataset
- Story
- Workflow
Small, 40.0 40.0 -
Property Name Type Description Filter Group and Version Available Version accessType ConnectWaveAccessTypeEnum The access type. Valid values are: - Edit
- Manage
- View
Small, 36.0 36.0 imageUrl String The URL of the user image. Small, 36.0 36.0 shareType ConnectWaveShareTypeEnum The share type. Valid values are: - AllCspUsers
- AllPrmUsers
- CustomerPortalUser
- Group
- Organization
- PartnerUser
- PortalRole
- PortalRoleAndSubordinates
- Role
- RoleAndSubordinates
- User
Small, 36.0 36.0 sharedWithId String The ID of the user with the share representation. Small, 36.0 36.0 sharedWithLabel String The label for the shared user, group, or org. Small, 36.0 36.0 - TemplateOptionsRepresentation
-
Property Name Type Description Filter Group and Version Available Version appAction ConnectWaveTemplateAppActionEnum The last template action performed on the templated application. Valid values are: - Create
- Decouple
- Overlay
- Upgrade
Medium, 37.0 37.0 appActionDate Date The date and time the last action was performed. Medium, 37.0 37.0 appActionUser WaveUserRepresentation The user that performed the last action. Medium, 37.0 37.0
- AppLogRepresentation
-
Property Name Type Description Filter Group and Version Available Version message String A log message entry. Supplemental, 49.0 49.0 - FeaturedAssetsInputRepresentation
-
Property Name Type Description Required or Optional Available Version assets TypedAssetReferenceInputRepresentation[] The list of default featured assets Required 39.0 - TypedAssetReferenceInputRepresentation
-
Property Name Type Description Required or Optional Available Version type ConnectWaveAssetTypeEnum The asset type. Valid types are: - Component
- Dashboard
- DashboardSnapshot
- DataConnector
- Dataflow
- DataflowJob
- Dataset
- DatasetShard
- DatasetVersion
- ExternalData
- Folder
- Lens
- Recipe
- ReplicatedDataset
- Story
- Workflow
Required 40.0 -
Property Name Type Description Required or Optional Available Version accessType ConnectWaveAccessTypeEnum The access type. Valid values are: - Edit
- Manage
- View
Required 36.0 shareType ConnectWaveShareTypeEnum The share type. Valid values are: - AllCspUsers
- AllPrmUsers
- CustomerPortalUser
- Group
- Organization
- PartnerUser
- PortalRole
- PortalRoleAndSubordinates
- Role
- RoleAndSubordinates
- User
Required 36.0 sharedWithId ID The ID of the entity that the folder is shared with. Required 36.0