機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 目標

すべての目標の取得

get

/crmRestApi/resources/11.13.18.05/salesObjectives

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : 指定された主キー識別子を持つ目標を検索します。
      ファインダ変数:
      • ObjectiveId; integer;目標の一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AccountId; integer;アカウントの一意の識別子。
    • AccountName; string;アカウントの名前。
    • AccountNumber; string;アカウントのPuid。
    • ActualValue; integer;目標の実際の達成値。
    • BusinessPlanId; integer;ビジネス・プランの一意の識別子。
    • BusinessPlanName; string;目標のビジネス・プランの名前。
    • BusinessPlanNumber; string;ビジネス計画の代替キー識別子。
    • CreatedBy; string; レコードを作成したユーザー。
    • CreationDate; string;レコードが作成された日付。
    • CurrencyCode; string;目標に関連付けられた通貨コード。 有効な値のリストは、参照RatedCurrenciesVOで定義されます。
    • 説明;文字列;目標の説明。
    • EndDisplayPeriodName; string;目標の終了期間の表示名。 有効な値のリストは、参照SalesGLEndPeriodPickTimeListToViewAccessorで定義されます。
    • EndPeriodName; string; 目標の終了期間の内部名。
    • GeographyId; integer;地理の一意の識別子。
    • GeographyKey;文字列;地理公開一意識別子。
    • GeographyName; string;地理の名前。
    • LastUpdateDate; string;レコードが最後に更新された日付。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • Name; string;目標の名前。
    • ObjectiveId; integer;目標の一意の識別子。
    • ObjectiveNumber; string;目標の代替キー識別子。
    • ObjectiveTypeCode; string; 目標の分類方法を示すコード。 コードのリストは、LovSalesObjectiveTypeVOにあります。
    • ObjectiveTypeName; string;目標のタイプ。
    • OrigCreationDate; string;目的が外部システムで最初に作成された日付。
    • PeriodEndDate;文字列;期間終了日
    • PeriodStartDate;文字列;期間開始日
    • PeriodTypeCode; string; 目標の期間のタイプを示すコード。 有効な値のリストは、参照SalesObjectiveGLPeriodTypeViewAccessorで定義されます。
    • PeriodTypeName; string;目標の期間タイプの名前。
    • ProductGroupId; integer; Product Groupの一意の識別子。
    • ProductGroupName; string;製品グループの名前。
    • ProductGroupReferenceNumber; string; ProductGroup Reference Number。
    • StartDisplayPeriodName; string;目標の開始期間の表示名。 有効な値のリストは、参照SalesGLStartPeriodPickerTimeListViewAccessorで定義されます。
    • StartPeriodName; string; 目標の開始期間の内部名。
    • TargetValue; integer; 目標のターゲットの一意の識別子。
    • UnitOfMeasureCode; string; 目標の単位を示すコード。
    • UnitOfMeasureName; string;目標の単位。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : salesObjectives
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : salesObjectives-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 目標分割
タイプ: array
タイトル: Objective Splits
目標分割リソースは、目標分割の表示、作成、更新および削除に使用されます。 目標分割は、1つ以上のパラメータによって制限される、市場の特定のセグメントに対する測定可能なターゲットおよび実績達成を表します。
ソースを表示
ネストされたスキーマ : salesObjectives-SalesObjectiveSplits-item-response
タイプ: object
ソースを表示
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべての目標を取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives"

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
"ActualValue": null,
"BusinessPlanId": 300100089934422,
"CreatedBy": "CHANNEL_SALES_MGR",
"CreationDate": "2016-06-06T20:36:45-07:00",
"CurrencyCode": "USD",
"Description": null,
"EndPeriodName": "12-15",
"LastUpdateDate": "2016-06-06T20:37:44-07:00",
"LastUpdateLogin": "34A6975B399FB98DE0532AB0F20A0E96",
"LastUpdatedBy": "CHANNEL_SALES_MGR",
"Name": "AutoBO_05e70605485",
"ObjectiveId": 300100089934429,
"ObjectiveTypeCode": "Amount",
"PeriodTypeCode": "YEAR",
"StartPeriodName": "01-15",
"TargetValue": null,
"ObjectiveNumber": "CDRM_2004",
"OrigCreationDate": "2016-06-06T20:36:45-07:00",
"UnitOfMeasureCode": "AMOUNT",
"ObjectiveTypeName": "Amount",
"UnitOfMeasureName": "Amount",
"PeriodTypeName": "Year",
"BusinessPlanName": "AutoBP_9d570536477",
"BusinessPlanNumber": "CDRM_12029",
"StartDisplayPeriodName": "2015",
"EndDisplayPeriodName": "2015",
"UpdateFlag": true,
"DeleteFlag": true,
"links":[{"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100089934429",...]
}
...
「トップに戻る」