サブスクリプションのすべての可用性例外を取得
get
/crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions
リクエスト
問合せパラメータ
- 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- ExceptionPuidAltKey : 指定された例外PUIDを持つサブスクリプション可用性例外を検索
ファインダ変数:- ExceptionPuid; string; 例外の公開一意識別子。
- PrimaryKey : 指定した例外IDを持つサブスクリプション可用性例外を検索
ファインダ変数:- ExceptionId; integer; 例外の一意の識別子。
- ExceptionPuidAltKey : 指定された例外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問合せパラメータを使用してこの収集リソースをフィルタできます:
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string;レコードが作成された日付。
- ExceptionId; integer; 例外の一意の識別子。
- ExceptionName; string;例外の名前。
- ExceptionPuid; string;サブスクリプション例外の公開一意識別子。
- LastUpdateDate; string; レコードが最後に更新された日付。
- LastUpdatedBy; 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
タイプ:
ソースを表示
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-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
読取り専用:
true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日付。 -
ExceptionId: integer (int64)
例外の一意の識別子。
-
ExceptionName: string
タイトル:
Exception Name
最大長:300
例外の名前。 -
ExceptionPuid: string
タイトル:
Exception PUID
最大長:120
サブスクリプション例外の公開一意識別子。 -
LastUpdateDate: string (date-time)
読取り専用:
true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
レコードを最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
SubscriptionCoverageAvailability: array Subscription Coverage Availabilities
タイトル:
Subscription Coverage Availabilities
サブスクリプション・カバレッジ可用性リソースは、可用性スケジュールの詳細を表示するために使用されます。 可用性スケジュール・オブジェクトには、スケジュール名、タイムゾーン・コード、例外名、PUIDなどの詳細があります。
ネストされたスキーマ : サブスクリプション・カバレッジ使用可能
タイプ:
array
タイトル:
Subscription Coverage Availabilities
サブスクリプション・カバレッジ可用性リソースは、可用性スケジュールの詳細を表示するために使用されます。 可用性スケジュール・オブジェクトには、スケジュール名、タイムゾーン・コード、例外名、PUIDなどの詳細があります。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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-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
最大長:
30
OBJECTS 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
サブスクリプション・カバレッジ・ブレーク・リソースは、可用性スケジュール・ブレークの表示に使用されます。 可用性スケジュール・ブレーク・オブジェクトには、開始時間、開始分、終了時間、終了分などの詳細があります。
ソースを表示
ネストされたスキーマ : 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
休憩の開始分。