すべてのサブスクリプションの可用性スケジュールを取得
get
                    /crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions/{ExceptionPuid}/child/SubscriptionCoverageAvailability
リクエスト
パス・パラメータ
                -  ExceptionPuid(required): string 
                    サブスクリプション例外の公開一意識別子。
 
問合せパラメータ
                    -  dependency: string 
                            このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> -  expand: string 
                            このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
 -  fields: string 
                            このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 -  finder: string 
                            コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- AvailabilityPuidAltKey : 指定したスケジュールPUIDを持つサブスクリプション可用性スケジュールを検索
ファインダ変数:- AvailabilityPuid; string;可用性の公開一意識別子。
 
 - PrimaryKey : 指定したスケジュールIDを持つサブスクリプション可用性スケジュールを検索
ファインダ変数:- AvailabilityId; integer;可用性の一意の識別子。
 
 
 - AvailabilityPuidAltKey : 指定したスケジュールPUIDを持つサブスクリプション可用性スケジュールを検索
 -  limit: integer 
                            このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
 -  links: string 
                            このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
 -  offset: integer 
                            リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
 -  onlyData: boolean 
                            リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
 -  orderBy: string 
                            このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
 -  q: string 
                            この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- 可用性、文字列、可用性の名前。
 - AvailabilityCode; string;可用性のコード。
 - AvailabilityHours; string; サブスクリプションの可用性時間。
 - AvailabilityId; integer;可用性の一意の識別子。
 - AvailabilityPuid; string;可用性の公開一意識別子。
 - AvailableDayMeaning; string; サブクリティカル・カバレッジが使用可能な日。
 - BreakTime; string;サブスクリプションに関連付けられたブレーク時間。
 - CreatedBy; string; レコードを作成したユーザー。
 - CreationDate; string;レコードが作成された日付。
 - 期間;整数;イベントの期間。
 - EndDate; string;イベントの終了日。
 - EndHour; number;サブスクリプションの終了時間。
 - EndMinute; number;サブスクリプションの終了時間(分)。
 - EventDay; string;イベントの日付。
 - EventName; string;イベントの名前。
 - FriYn; string; サブスクリプション・カバレッジが金曜日に使用可能かどうかを示します。
 - LastUpdateDate; string; レコードが最後に更新された日付。
 - LastUpdatedBy; string; レコードを最後に更新したユーザー。
 - MonYn; string; 月曜日にサブスクリプション・カバレッジが使用可能かどうかを示します。
 - MonthCode; string;週に関連付けられた月のコード。
 - ObjectCode; string; OBJECTS Metadataで定義されているオブジェクトのコード。
 - ObjectId; integer;オブジェクトの一意の識別子。
 - OneTimeFlag; boolean。イベントが単発イベントかどうかを示します。
 - OptionCode; string; イベントに関連するオプション・コード。
 - SatYn; string;サブスクリプション・カバレッジが土曜日に使用可能かどうかを示します。
 - SelectedDays; object;サブスクリプションに対して選択された日。
 - StartDate; string;イベントの開始日。
 - StartHour; number;サブスクリプションの開始時間。
 - StartMinute; number;サブスクリプションの開始分。
 - SunYn; string;サブスクリプション・カバレッジが日曜日に使用可能かどうかを示します。
 - ThuYn; string; サブスクリプション・カバレッジが木曜日に使用可能かどうかを示します。
 - TueYn; string; サブスクリプション・カバレッジが火曜日に使用可能かどうかを示します。
 - WedYn; string;サブスクリプション・カバレッジが水曜日に使用可能かどうかを示します。
 - WeekCode; string;週に関連付けられた週のコード。
 
 -  totalResults: boolean 
                            "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
 
ヘッダー・パラメータ
                    -  Metadata-Context: 
                            REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
 -  REST-Framework-Version: 
                            RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
 
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
                - application/json
 
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
                            
                                ヘッダー
                                -  Metadata-Context(required): 
                                        REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
 -  REST-Framework-Version(required): 
                                        RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
 
ルート・スキーマ : subscriptionCoverageExceptions-SubscriptionCoverageAvailability
    
    	タイプ: 
    	
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        ソースを表示
        object- 
                 count(required): integer 
                
                現在の範囲で返されたリソース・インスタンスの数。
 - 
                 hasMore(required): boolean 
                
                サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
 - 
                 items: array   Items 
                
                タイトル:
Itemsコレクション内のアイテム。 - 
                 limit(required): integer 
                
                サーバーで使用される実際のページング・サイズ。
 - 
                 links(required): array   Links 
                
                タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 - 
                 offset(required): integer 
                
                現在のページで使用されるオフセット値。
 - 
                 totalResults: integer 
                
                "?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
 
ネストされたスキーマ : subscriptionCoverageExceptions-SubscriptionCoverageAvailability-item-response
    
    	タイプ: 
    	
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        ソースを表示
        object- 
                 Availability: string 
                
                タイトル:
Availability最大長:1000可用性の名前。 - 
                 AvailabilityCode: string 
                
                タイトル:
Hours最大長:30可用性のコード。 - 
                 AvailabilityHours: string 
                
                サブスクリプションの可用性時間。
 - 
                 AvailabilityId: integer (int64) 
                
                可用性の一意の識別子。
 - 
                 AvailabilityPuid: string 
                
                最大長:
120可用性の公開一意識別子。 - 
                 AvailableDay: string 
                
                タイトル:
Daysサブスクリプションの使用可能な日。 - 
                 AvailableDayMeaning: string 
                
                サブクリッション・カバレッジが使用可能な日。
 - 
                 BreakTime: string 
                
                タイトル:
Breakサブスクリプションに関連付けられた休憩時間。 - 
                 CreatedBy: string 
                
                読取り専用:
true最大長:64レコードを作成したユーザー。 - 
                 CreationDate: string (date-time) 
                
                読取り専用:
trueレコードが作成された日付。 - 
                期間: 整数(int32)
                
                タイトル:
Durationイベントの期間。 - 
                EndDate: 文字列(日付)
                
                イベントの終了日。
 - 
                 EndHour: number 
                
                サブスクリプションの終了時間。
 - 
                 EndMinute: number 
                
                サブスクリプションの終了時間(分)。
 - 
                 EventDay: string 
                
                タイトル:
Date最大長:300イベントの日。 - 
                 EventName: string 
                
                タイトル:
Event最大長:300イベントの名前。 - 
                 FriYn: string 
                
                最大長:
1サブスクリプション・カバレッジが金曜日に使用可能かどうかを示します。 - 
                 LastUpdateDate: string (date-time) 
                
                読取り専用:
trueレコードが最後に更新された日付。 - 
                 LastUpdatedBy: string 
                
                読取り専用:
true最大長:64レコードを最後に更新したユーザー。 - 
                 links: array   Links 
                
                タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 - 
                 MonthCode: string 
                
                最大長:
30週に関連付けられた月のコード。 - 
                 MonYn: string 
                
                最大長:
1サブスクリプション・カバレッジが月曜日に使用可能かどうかを示します。 - 
                 ObjectCode: string 
                
                最大長:
30OBJECTS Metadataで定義されたオブジェクトのコード。 - 
                 ObjectId: integer (int64) 
                
                オブジェクトの一意の識別子。
 - 
                 OneTimeFlag: boolean 
                
                タイトル:
Once最大長:1イベントが単発イベントかどうかを示します。 - 
                 OptionCode: string 
                
                最大長:
30イベントに関連付けられたオプション・コード。 - 
                 SatYn: string 
                
                最大長:
1サブスクリプション・カバレッジが土曜日に使用可能かどうかを示します。 - 
                 SelectedDays: object   SelectedDays 
                
                サブスクリプションに対して選択した日数。
 - 
                StartDate: 文字列(日付)
                
                イベントの開始日。
 - 
                 StartHour: number 
                
                サブスクリプションの開始時間。
 - 
                 StartMinute: number 
                
                サブスクリプションの開始分。
 - 
                 SubscriptionCoverageBreak: array   Subscription Coverage Breaks 
                
                タイトル:
Subscription Coverage Breaksサブスクリプション・カバレッジ・ブレーク・リソースは、可用性スケジュール・ブレークの表示に使用されます。 可用性スケジュール・ブレーク・オブジェクトには、開始時間、開始分、終了時間、終了分などの詳細があります。 - 
                 SunYn: string 
                
                最大長:
1サブスクリプション・カバレッジが日曜日に使用可能かどうかを示します。 - 
                 ThuYn: string 
                
                最大長:
1サブスクリプション・カバレッジが木曜日に使用可能かどうかを示します。 - 
                 TueYn: string 
                
                最大長:
1サブスクリプション・カバレッジが火曜日に使用可能かどうかを示します。 - 
                 WedYn: string 
                
                最大長:
1サブスクリプション・カバレッジが水曜日に使用可能かどうかを示します。 - 
                 WeekCode: string 
                
                最大長:
30週に関連付けられた週のコード。 
ネストされたスキーマ : SelectedDays
    
    	タイプ: 
    	
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectサブスクリプションに対して選択した日数。
    
    
    
    
    
    
    
    
    
    
    
ネストされたスキーマ : サブスクリプション・カバレッジ・ブレーク
    
    	
    	タイプ: 
    
    
    
    arrayタイトル: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Subscription Coverage Breaksサブスクリプション・カバレッジ・ブレーク・リソースは、可用性スケジュール・ブレークの表示に使用されます。 可用性スケジュール・ブレーク・オブジェクトには、開始時間、開始分、終了時間、終了分などの詳細があります。 
    
    
    
    
    
        ソースを表示
        
        
    
    
    
    
    
    
    
ネストされたスキーマ : リンク
    
    	タイプ: 
    	
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        ソースを表示
        object- 
                 href: string 
                
                タイトル:
hyperlink reference関連リソースへのURI。 - 
                 kind: string 
                
                タイトル:
kind許可された値:[ "collection", "item", "describe", "other" ]関連リソースの種類。 - 
                 name: string 
                
                タイトル:
name関連リソースへのリンクの名前。 - 
                 properties: object   properties 
                
                
 - 
                 rel: string 
                
                タイトル:
relation許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]リソース・インスタンスとの関係の名前。 例: self. 
ネストされたスキーマ : properties
    
    	タイプ: 
    	
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        ソースを表示
        object- 
                 changeIndicator: string 
                
                リソース・インスタンスのインジケータまたはETag値を変更します。
 
ネストされたスキーマ : subscriptionCoverageExceptions-SubscriptionCoverageAvailability-SubscriptionCoverageBreak-item-response
    
    	タイプ: 
    	
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        ソースを表示
        object- 
                 AvailabilityId: integer (int64) 
                
                可用性の一意の識別子。
 - 
                 BreakId: integer (int64) 
                
                休憩の一意の識別子
 - 
                 BreakPuid: string 
                
                最大長:
120休憩の公開一意識別子。 - 
                 CreatedBy: string 
                
                読取り専用:
true最大長:64レコードを作成したユーザー。 - 
                 CreationDate: string (date-time) 
                
                読取り専用:
trueレコードが作成された日付。 - 
                 EndHour: number 
                
                休憩の終了時間。
 - 
                 EndMinute: number 
                
                休憩の終了分。
 - 
                 LastUpdateDate: string (date-time) 
                
                読取り専用:
trueレコードが最後に更新された日付。 - 
                 LastUpdatedBy: string 
                
                読取り専用:
true最大長:64レコードを最後に更新したユーザー。 - 
                 links: array   Links 
                
                タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 - 
                 ObjectCode: string 
                
                最大長:
30オブジェクトに関連付けられたコード。 - 
                 StartHour: number 
                
                休憩の開始時間。
 - 
                 StartMinute: number 
                
                休憩の開始分。