すべての販売予測目標の取得
get
/crmRestApi/resources/11.13.18.05/salesForecastQuotas
リクエスト
問合せパラメータ
- 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
コレクションを検索するための事前定義済ファインダとして使用されます。
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します- PrimaryKey主キー別に売上予測目標を検索します。
ファインダ変数- DsQuotaId; integer;指定した目標IDの売上予測目標を検索します。
- QuotaNumberRowFinder
ファインダ変数- QuotaNumber; string;
- PrimaryKey主キー別に売上予測目標を検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- コメント、文字列。売上予測目標を説明するコメント。
- ConflictId; integer; 売上予測目標の競合ID。
- CorporateMetricValue; number;販売予測目標の企業メトリック値。
- CreatedBy; string; 売上予測目標を作成したユーザー。
- CreationDate; string; 売上予測目標が作成された日付。
- CurrencyCode;文字列。売上予測目標に入力された通貨コード。
- CurrencyConversionRate; number;販売予測目標の入力通貨から企業通貨への通貨換算レート。
- DsQuotaId; integer; 売上予測目標の目標ID。
- LastUpdateDate; string; 売上予測目標が最後に更新された日付。
- LastUpdateLogin; string; 売上予測目標を最後に更新したユーザーのログイン。
- LastUpdatedBy; string; 売上予測目標を最後に更新したユーザー。
- MetricCode;文字列。売上予測目標のメトリック・コード。
- MetricDimFiveCode; string; 売上予測目標の5番目のディメンションのメトリック・コード。
- MetricDimFourCode;文字列。売上予測目標の4番目のディメンションのメトリック・コード。
- MetricDimOneCode;文字列。売上予測目標の最初のディメンションのメトリック・コード。
- MetricDimThreeCode;文字列。売上予測目標の3番目のディメンションのメトリック・コード。
- MetricDimTwoCode; string;売上予測目標の2番目のディメンションのメトリック・コード。
- MetricDimensionFiveKey; string; 売上予測目標の5番目のディメンションのメトリック・キー。
- MetricDimensionFourKey; string; 売上予測目標の4番目のディメンションのメトリック・キー。
- MetricDimensionOneKey; string; 売上予測目標の最初のディメンションのメトリック・キー。
- MetricDimensionThreeKey; string; 売上予測目標の3番目のディメンションのメトリック・キー。
- MetricDimensionTwoKey; string;売上予測目標の2番目のディメンションのメトリック・キー。
- MetricSrcCode; string; 売上予測目標のメトリック・ソース・コード。
- MetricValue; number;販売予測目標の入力通貨でのメトリック値。
- ObjectVersionNumber; integer; 売上予測目標のオブジェクト・バージョン番号。
- QuotaNumber;文字列
- ResourceQuotaEffectiveDate; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : salesForecastQuotas
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : salesForecastQuotas-item-response
タイプ:
ソースを表示
object
-
Comments: string
最大長:
1000
販売予測目標を説明するコメント。 -
ConflictId: integer (int64)
販売予測目標の競合ID。
-
CorporateMetricValue: number
販売予測目標の企業メトリック値。
-
CreatedBy: string
読取り専用:
true
最大長:64
販売予測目標を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
販売予測目標が作成された日付。 -
CurrencyCode: string
最大長:
3
販売予測目標に入力された通貨コード。 -
CurrencyConversionRate: number
販売予測目標の入力通貨から企業通貨への通貨換算レート。
-
DsQuotaId: integer (int64)
タイトル:
Quota ID
販売予測目標の目標ID。 -
LastUpdateDate: string (date-time)
読取り専用:
true
販売予測目標が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
販売予測目標を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
販売予測目標を最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MetricCode: string
タイトル:
Target Type
最大長:100
販売予測目標のメトリック・コード。 -
MetricDimensionFiveKey: string
タイトル:
Dimension 5
最大長:300
販売予測目標の5番目のディメンションのメトリック・キー。 -
MetricDimensionFourKey: string
タイトル:
Dimension 4
最大長:300
販売予測目標の4番目のディメンションのメトリック・キー。 -
MetricDimensionOneKey: string
タイトル:
Dimension 1
最大長:300
販売予測目標の最初のディメンションのメトリック・キー。 -
MetricDimensionThreeKey: string
タイトル:
Dimension 3
最大長:300
販売予測目標の3番目のディメンションのメトリック・キー。 -
MetricDimensionTwoKey: string
タイトル:
Dimension 2
最大長:300
販売予測目標の2番目のディメンションのメトリック・キー。 -
MetricDimFiveCode: string
読取り専用:
true
最大長:100
販売予測目標の5番目のディメンションのメトリック・コード。 -
MetricDimFourCode: string
読取り専用:
true
最大長:100
販売予測目標の4番目のディメンションのメトリック・コード。 -
MetricDimOneCode: string
読取り専用:
true
最大長:100
販売予測目標の最初のディメンションのメトリック・コード。 -
MetricDimThreeCode: string
読取り専用:
true
最大長:100
販売予測目標の3番目のディメンションのメトリック・コード。 -
MetricDimTwoCode: string
読取り専用:
true
最大長:100
販売予測目標の2番目のディメンションのメトリック・コード。 -
MetricSrcCode: string
読取り専用:
true
最大長:100
販売予測目標のメトリック・ソース・コード。 -
MetricValue: number
販売予測目標の入力通貨でのメトリック値。
-
ObjectVersionNumber: 整数(int32)
販売予測目標のオブジェクト・バージョン番号。
-
QuotaNumber: string
最大長:
30
-
ResourceQuotaEffectiveDate: 文字列(日付)
タイトル:
Effective Date
販売予測目標の期間の識別に使用されるリソース目標有効日。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。