Subscriptions List リソース
登録のリストを返したり、登録のスケジュールを作成したりします。
- リソース URL
-
1/wave/subscriptions - 形式
- JSON
- 使用可能なバージョン
- 47.0
- HTTP のメソッド
- GET POST
- GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン type ConnectSubscriptionSourceTypeEnum コレクションを取得元の種別で絞り込みます。有効な値は、次のとおりです。 - Collection
- Dashboard
- Widget
省略可能 54.0 - Get レスポンスボディ (SubscriptionCollectionRepresentation)
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン subscriptions SubscriptionRepresentation[] 登録のコレクション。 Small、47.0 47.0 - POST のリクエストボディ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン runNow Boolean 登録を今すぐ実行するか (true)、後から実行するか (false) を示します。 必須 47.0 subscription SubscriptionInputRepresentation[] 登録の詳細。 必須 47.0 - POST レスポンスボディ (SubscriptionRepresentation)
-
SubscriptionRepresentation は、抽象 SnapshotRepresentation からプロパティを継承します。これらの基本プロパティは、SubscriptionRepresentation に、次のテーブルで明示的に定義されたプロパティと共に表示されます。
パラメータ名 型 説明 検索条件グループとバージョン 使用可能なバージョン source SubscriptionSourceRepresentation[] 登録の取得元。種別、ラベル、レコード ID など。 Small、47.0 47.0 - SubscriptionInputRepresentation
-
SubscriptionInputRepresentation は、抽象 BaseSubscriptionInputRepresentation からプロパティを継承します。これらの基本プロパティは、SubscriptionInputRepresentation に、次のテーブルで明示的に定義されたプロパティと共に表示されます。
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン schedule SubscriptionScheduleInputRepresentation[] 登録スケジュール。 必須 47.0 source SubscriptionSourceInputRepresentation[] 登録の取得元。種別、ラベル、レコード ID など。 Small、47.0 47.0