目標分割の取得
get
/crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/SalesObjectiveSplits/{ObjectiveSplitId}
リクエスト
パス・パラメータ
- ObjectiveId(required): integer(int64)
目標の一意の識別子。
- ObjectiveSplitId(required): integer(int64)
目標分割の一意の識別子。
問合せパラメータ
- 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 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : salesObjectives-SalesObjectiveSplits-item-response
タイプ:
ソースを表示
object
-
AccountId: integer (int64)
タイトル:
Account
目標に割り当てられたアカウントの一意の識別子。 -
ActualValue: integer (int64)
タイトル:
Attainment
デフォルト値:0
目標分割の実績達成値。 -
CreatedBy: string
読取り専用:
true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日付。 -
DisplayPeriodName: string
タイトル:
Period
最大長:15
目標分割期間の表示名。 -
GeographyId: integer (int64)
タイトル:
Geography
地理の一意の識別子。 -
GeographyName: string
タイトル:
Geography
最大長:255
地理の名前(JAPAC、EMEA、Americasなど)。 -
LastUpdateDate: string (date-time)
読取り専用:
true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectiveId: integer (int64)
タイトル:
Objective
目標の一意の識別子。 -
ObjectiveSplitId: integer (int64)
目標分割の一意の識別子。
-
PartyUniqueName: string
読取り専用:
true
最大長:900
アカウントの名前。 -
PeriodType: string
タイトル:
Period Type Code
最大長:30
目標分割の期間のタイプ。 -
ProdGroupName: string
タイトル:
Product Group
読取り専用:true
最大長:250
製品グループの名前。 -
ProductId: integer (int64)
タイトル:
Product Group
製品の一意の識別子。 -
TargetValue: integer (int64)
タイトル:
Target
デフォルト値:0
目標分割のターゲットの一意の識別子。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
例:
次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、目標分割を取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/child/SalesObjectiveSplits/300100091619392
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "AccountId": null, "ActualValue": 100, "CreatedBy": "SALES_ADMIN", "CreationDate": "2016-11-10T23:26:48-08:00", "GeographyId": null, "LastUpdateDate": "2016-11-10T23:26:48-08:00", "LastUpdateLogin": "4101B34432126FE8E05392D0F00A4D46", "LastUpdatedBy": "SALES_ADMIN", "ObjectiveId": 300100091619347, "ObjectiveSplitId": 300100091619392, "PeriodType": "YEAR", "DisplayPeriodName": null, "TargetValue": 10, "ProdGroupName": null, "ProdGroupId": null, "PartyUniqueName": null, "GeographyName": null, "links":[ {"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/child/SalesObjectiveSplits/300100091619392",???}, {"rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/child/SalesObjectiveSplits/300100091619392",???}, {"rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347",???} ] }