この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

Folder リソース

Analytics アプリケーションまたはフォルダの表現を返す (GET) か、アプリケーションまたはフォルダを置換 (PUT) するか、更新 (PATCH) するか、削除 (DELETE) します。

リソース URL

1/wave/folders/<folder ID>

形式

JSON

使用可能なバージョン

36.0

HTTP のメソッド

GET、PUT、PATCH、DELETE

GET の要求パラメータ

パラメータ名	型	説明	必須か省略可能	使用可能なバージョン
`mobileOnlyFeaturedAssets`	Boolean	このパラメータを true に設定すると、Einstein Analytics モバイルアプリケーションで有効になっているダッシュボードのみが表示されます。	省略可能	43.0

PUT および PATCH のリクエストボディ

WaveFolderInputRepresentation

プロパティ名	型	説明	使用可能なバージョン
`applicationStatus`	ConnectWaveApplicationStatusEnum	アプリケーションの作成状況 (CancelledStatus、CompletedStatus、DataflowInProgressStatus、FailedStatus、InProgressStatus、NewStatus)。	36.0
`assetIcon`	String	新規フォルダまたはアプリケーションを最適に表すアイコンの列挙。有効な値は 1.png から 20.png です。	36.0
`attachedFiles`	AssetReferenceInputRepresentation[]	添付ファイル ID リスト	39.0
`canBeSharedExternally`	Boolean	アプリケーションをコミュニティで共有するかどうか	37.0
`defaultAsset`	AssetReferenceInputRepresentation	アプリケーションランタイムにおいてデフォルトでこのアプリケーションに提示される、レンズまたはダッシュボードの ID。	37.0
`description`	String	新規フォルダまたはアプリケーションの説明。	36.0
`featuredAssets`	Map (FeaturedAssetsInputRepresentation)	このアプリケーションで UI に使用する主要アセット。	39.0
`isPinned`	Boolean	アプリケーションが固定表示フォルダであるかどうか。	39.0
`label`	String	新規フォルダまたはアプリケーションの、ユーザに表示される名前。	36.0
`name`	String	新規フォルダまたはアプリケーションの内部 API 参照名。	36.0
`shares`	WaveFolderShareInputRepresentation[]	フォルダ共有ルール。	36.0

GET、PUT、および PATCH のレスポンスボディ

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`applicationStatus`	ConnectWaveApplicationStatusEnum	アプリケーションの作成状況 (CancelledStatus、CompletedStatus、DataflowInProgressStatus、FailedStatus、InProgressStatus、NewStatus)。	Medium、36.0	36.0
`attachedFiles`	AssetReferenceRepresentation[]	インサイトフォルダに添付されるファイルの ID	Big、39.0	39.0
`canBeSharedExternally`	Boolean	このアプリケーションをコミュニティユーザと共有できるかどうか。	Big、37.0	37.0
`defaultAsset`	AssetReferenceRepresentation	アプリケーションを AppRuntime モードで表示するときに表示されるデフォルトアセット (レンズ/ダッシュボード)。	Big、37.0	37.0
`featuredAssets`	Map (FeaturedAssetsRepresentation)	このアプリケーションで UI に使用する主要アセット。	Big、39.0	39.0
`icon`	AssetReferenceRepresentation	アセットアイコン。	Small、36.0	36.0
`isPinned`	Boolean	このアプリケーションが固定されているかどうか。	Small、39.0	39.0
`shares`	WaveFolderShareRepresentation[]	フォルダ共有リスト。	Big、36.0	36.0
`templateOptions`	TemplateOptionsRepresentation	テンプレート Analytics アプリケーションで最後に実行されたアクションで使用されたオプション。	Big、37.0	37.0
`templateSourceId`	String	フォルダまたはアプリケーションの作成に使用されるソーステンプレート ID または API 名。	Medium、36.0	36.0
`templateValues`	Map (Object)	フォルダまたはアプリケーションの作成か更新に使用されたテンプレート値 (該当する場合)。	Big、37.0	37.0
`templateVersion`	String	このアプリケーションの作成元であるテンプレートのバージョン。	Medium、37.0	37.0
`assetSharingUrl`	String	このアセットを Analytics Builder で開くための URL。ディープリンクの形式です。サーバは、urlType、assetId、orgId、loginHost を含む可能性があるリンクパラメータ、およびその他の省略可能パラメータを調べて、必要に応じて変換して対象クライアントで正しい結果を生成します。たとえば、Analytics ダッシュボードがデスクトップクライアントで開き、モバイル OS を使用している場合はモバイルで開きます。たとえば、次のような共有 URL があるとします。 `1http://{host}/analytics/application/005xx000001SvSwAAK?urlType=sharing&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com` この場合は、次のような Web URL が生成されます。 `1http://{host}/insights/web/explore.apexp#application/005xx000001SvSwAAK` iOS では、次のような URL が生成されることがあります。 `1com.salesforce.kona://application/005xx000001SvSwAAK&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com`	Small、36.0	36.0
`createdBy`	WaveUserRepresentation	アセット作成者。	Small、36.0	36.0
`createdDate`	Date	アセットが作成された時刻。	Small、36.0	36.0
`description`	String	アセットの簡単な説明。	Small、36.0	36.0
`id`	String	18 文字のアセット ID。	Small、36.0	36.0
`label`	String	アセットの表示ラベル。	Small、36.0	36.0
`lastAccessedDate`	Date	アセットが最後にアクセスされた時刻。	Small、36.0	36.0
`lastModifiedBy`	WaveUserRepresentation	アセットを最後に更新したユーザ。	Small、36.0	36.0
`lastModifiedDate`	Date	アセットが最後に変更された時刻。	Small、36.0	36.0
`name`	String	アセットの名前。	Small、36.0	36.0
`namespace`	String	アセットの名前空間。	Small、36.0	36.0
`permissions`	PermissionsRepresentation	現在のユーザの権限を表します。	Small、36.0	36.0
`type`	ConnectWaveAssetTypeEnum	アセットタイプ。値は次のとおりです。 Dashboard DataConnector Dataflow Dataset DatasetShard (internal) DatasetVersion ExternalData Folder Lens Recipe ReplicatedDataset Workflow	Small、36.0	36.0
`url`	String	アセットの定義を取得するための URL。	Small、36.0	36.0

FeaturedAssetsRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`assets`	TypedAssetReferenceRepresentation[]	主要アセットのリスト。	Small、39.0	39.0

TypedAssetReferenceRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`type`	ConnectWaveAssetTypeEnum	アセットタイプ (Dashboard、DataConnector、DataPoolEntity、DataPoolEntityVersion、Dataflow、DataflowJob、Dataset、DatasetShard、DatasetVersion、ExternalData、Folder、Lens、Recipe、ReplicatedDataset、または Workflow)。	Small、40.0	40.0

WaveFolderShareInputRepresentation

プロパティ名	型	説明	使用可能なバージョン
`accessType`	ConnectWaveAccessTypeEnum	アクセス種別 (Edit、Manage、View)。	36.0
`shareType`	ConnectWaveShareTypeEnum	共有種別 (AllCspUsers、AllPrmUsers、CustomerPortalUser、Group、Organization、PartnerUser、PortalRole、PortalRoleAndSubordinates、Role、RoleAndSubordinates、User)。	36.0
`sharedWithId`	ID	フォルダを共有するエンティティの ID。	36.0

Wave Folder Share

WaveFolderShareRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`accessType`	ConnectWaveAccessTypeEnum	ユーザのアクセス種別 (Edit、Manage、View)。	Small、36.0	36.0
`imageUrl`	String	ユーザ画像の URL。	Small、36.0	36.0
`shareType`	ConnectWaveShareTypeEnum	ユーザの共有種別。 AllCspUsers AllPrmUsers CustomerPortalUser Group Organization PartnerUser PortalRole PortalRoleAndSubordinates Role RoleAndSubordinates User	Small、36.0	36.0
`sharedWithId`	String	共有表現のあるユーザの ID。	Small、36.0	36.0
`sharedWithLabel`	String	共有ユーザ/グループ/組織の表示ラベル。	Small、36.0	36.0

FeaturedAssetsInputRepresentation

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`assets`	TypedAssetReferenceInputRepresentation[]	デフォルトの主要アセットのリスト		39.0

TypedAssetReferenceInputRepresentation

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`type`	ConnectWaveAssetTypeEnum	アセットタイプ (Dashboard、DataConnector、DataPoolEntity、DataPoolEntityVersion、Dataflow、DataflowJob、Dataset、DatasetShard、DatasetVersion、ExternalData、Folder、Lens、Recipe、ReplicatedDataset、または Workflow)。		40.0

テンプレートオプション

TemplateOptionsRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`appAction`	ConnectWaveTemplateAppActionEnum	テンプレートアプリケーションで実行された、最後のテンプレートアクション (Create または Upgrade)。	Medium、37.0	37.0
`appActionDate`	Date	最後のアクションが実行された日付/時間。	Medium、37.0	37.0
`appActionUser`	WaveUserRepresentation	最後のアクションを実行したユーザ。	Medium、37.0	37.0

レスポンスボディの例

1{
2  "applicationStatus" : "newstatus",
3  "assetIcon" : "6.png",
4  "assetIconUrl" : "https://yourInstance.salesforce.com/icons/6.png",
5  "assetSharingUrl" : "https://yourInstance.salesforce.com/application?assetId=xxx&orgId=yyy&loginHost=jsmith-ltm.yourInstance.salesforce.com&urlType=sharing",
6  "createdBy" : {
7    "id" : "005xx000001SxwEAAS",
8    "name" : "Admin User",
9    "profilePhotoUrl" : "/profilephoto/005/T"
10  },
11  "createdDate" : "2015-06-22T17:38:33.000Z",
12  "description" : "descr",
13  "icon" : {
14    "alias" : "6.png",
15    "id" : "02Ixx00000003qvEAA",
16    "url" : "/app/icons/6.png"
17  },
18  "id" : "02Ixx00000003qvEAA",
19  "label" : "A new App",
20  "lastModifiedBy" : {
21    "id" : "005xx000001SxwEAAS",
22    "name" : "Admin User",
23    "profilePhotoUrl" : "/profilephoto/005/T"
24  },
25  "lastModifiedDate" : "2015-06-22T17:38:33.000Z",
26  "name" : "A_new_App1",
27  "permissions" : {
28    "manage" : true,
29    "modify" : true,
30    "view" : true
31  },
32  "shares" : [ {
33    "accessType" : "manage",
34    "imageUrl" : "/profilephoto/00G/T",
35    "shareType" : "organization",
36    "sharedWithId" : "00Gxx000000nCDzEAM",
37    "sharedWithLabel" : "All Internal Users"
38  }, {
39    "accessType" : "manage",
40    "imageUrl" : "/profilephoto/005/T",
41    "shareType" : "user",
42    "sharedWithId" : "005xx000001SxzaAAC",
43    "sharedWithLabel" : "Integration User"
44  } ],
45  "type" : "folder",
46  "url" : "/services/data/v36.0/wave/folders/00lxx000000fmEpAAI"
47}

Analytics REST API 開発者ガイド

Folder リソース