Analytics REST API 開発者ガイド
jDataset リソース
- リソース URL
-
1/wave/datasets/<datasetIdOrApiName> - 形式
- JSON
- 使用可能なバージョン
- 36.0
- HTTP のメソッド
- GET DELETE PATCH
- GET レスポンスボディ (DatasetRepresentation)
-
DatasetRepresentation は、抽象 BaseWaveAssetRepresentation からプロパティを継承します。これらの基本プロパティは、DatasetRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン clientShardsUrl String データセットシャードの URL。 Small、36.0 36.0 currentVersionCreatedBy WaveUserRepresentation 現在のバージョンのデータセットの作成者。filterGroup 入力パラメータが Supplemental に設定されている場合にのみ返されます。 Supplemental、36.0 36.0 currentVersionCreatedDate Date 現在のバージョンのデータセットが作成された時刻 (ISO8601 日付形式)。filterGroup 入力パラメータが Supplemental に設定されている場合にのみ返されます。 Supplemental、36.0 36.0 currentVersionId ID 現在のデータセットバージョンの 18 文字の ID。 Small、36.0 36.0 currentVersionLastModifiedBy WaveUserRepresentation 現在のバージョンのデータセットを最後に更新したユーザ。filterGroup 入力パラメータが Supplemental に設定されている場合にのみ返されます。 Supplemental、36.0 36.0 currentVersionLastModifiedDate Date 現在のバージョンのデータセットが最後に変更された時刻 (ISO8601 日付形式)。filterGroup 入力パラメータが Supplemental に設定されている場合にのみ返されます。 Supplemental、36.0 36.0 currentVersionTotalRows Integer データセット内の行の合計数。 Supplemental、42.0 42.0 currentVersionUrl String 現在のデータセットバージョンの URL。 Small、36.0 36.0 dataRefreshDate Date このデータセットが最後に更新された時刻。 Small、40.0 40.0 datasetType ConnectWaveDatasetTypeEnum データセットの種別。有効な値は、次のとおりです。 - Default
- Live
- Trended
Small、41.0 41.0 folder AssetReferenceRepresentation このデータセットが保存されているフォルダへの参照。 Small、36.0 36.0 lastQueriedDate Date このデータセットが最後に照会された時刻。 Small、39.0 39.0 liveConnection LiveConnectionRepresentation データセットのライブ接続の詳細。 Small、50.0 50.0 userXmd XmdRepresentation 関連付けられたユーザ XMD。 Medium、36.0 36.0 versionsUrl String データセットバージョンの URL。 Small、36.0 36.0 - PATCH リクエストボディ (DatasetInputRepresentation)
-
DatasetInputRepresentation は、抽象 BaseAssetInputRepresentation からプロパティを継承します。これらの基本プロパティは、DatasetInputRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン currentVersionId ID 廃止 このデータセットの現在のバージョンの 18 文字の ID。 省略可能 36.0 ～ 40.0 datasetType ConnectWaveDatasetTypeEnum データセットの種別。有効な値は、次のとおりです。 - Default
- Live
- Trended
必須 50.0 folder ID データセットが含まれるフォルダの 18 文字の ID。 省略可能 36.0 liveConnection LiveConnectionInputRepresentation データセットのライブ接続の詳細。 省略可能 50.0 userXmd XmdInputRepresentation このデータセットに関連付けられたユーザ XMD。 省略可能 39.0 次の JSON は、既存のデータセットの説明を編集する方法を示しています。
1{ 2 "description": "This is my dataset", 3 "label": "Test Dataset" 4} - PATCH レスポンスボディ (DatasetRepresentation)
-
DatasetRepresentation は、抽象 BaseWaveAssetRepresentation からプロパティを継承します。これらの基本プロパティは、DatasetRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン clientShardsUrl String データセットシャードの URL。 Small、36.0 36.0 currentVersionCreatedBy WaveUserRepresentation 現在のバージョンのデータセットの作成者。filterGroup 入力パラメータが Supplemental に設定されている場合にのみ返されます。 Supplemental、36.0 36.0 currentVersionCreatedDate Date 現在のバージョンのデータセットが作成された時刻 (ISO8601 日付形式)。filterGroup 入力パラメータが Supplemental に設定されている場合にのみ返されます。 Supplemental、36.0 36.0 currentVersionId ID 現在のデータセットバージョンの 18 文字の ID。 Small、36.0 36.0 currentVersionLastModifiedBy WaveUserRepresentation 現在のバージョンのデータセットを最後に更新したユーザ。filterGroup 入力パラメータが Supplemental に設定されている場合にのみ返されます。 Supplemental、36.0 36.0 currentVersionLastModifiedDate Date 現在のバージョンのデータセットが最後に変更された時刻 (ISO8601 日付形式)。filterGroup 入力パラメータが Supplemental に設定されている場合にのみ返されます。 Supplemental、36.0 36.0 currentVersionTotalRows Integer データセット内の行の合計数。 Supplemental、42.0 42.0 currentVersionUrl String 現在のデータセットバージョンの URL。 Small、36.0 36.0 dataRefreshDate Date このデータセットが最後に更新された時刻。 Small、40.0 40.0 datasetType ConnectWaveDatasetTypeEnum データセットの種別。有効な値は、次のとおりです。 - Default
- Live
- Trended
Small、41.0 41.0 folder AssetReferenceRepresentation このデータセットが保存されているフォルダへの参照。 Small、36.0 36.0 lastQueriedDate Date このデータセットが最後に照会された時刻。 Small、39.0 39.0 liveConnection LiveConnectionRepresentation データセットのライブ接続の詳細。 Small、50.0 50.0 userXmd XmdRepresentation 関連付けられたユーザ XMD。 Medium、36.0 36.0 versionsUrl String データセットバージョンの URL。 Small、36.0 36.0 - LiveConnectionRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン connectionLabel String ライブ接続の表示ラベル。 Small、50.0 50.0 connectionName String ライブ接続の API 参照名。 Small、50.0 50.0 sourceObjectName String ライブ接続の接続元オブジェクト名。 Small、50.0 50.0 - LiveConnectionInputRepresentation
-
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン connectionName String ライブ接続の API 参照名。 必須 50.0 sourceObjectName String ライブ接続の接続元オブジェクト名。 必須 50.0