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

すべてのアクティビティ目標の取得

get

/crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityObjectives

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • ActivityObjectiveAltKeyFinder : 代替キーを使用してアクティビティ目標を検索します。
      ファインダ変数:
      • ActivityObjective; string;アクティビティの目的。
      • ActyActivityNumber; string;アクティビティ目標の代替キー識別子。
    • ActivityObjectivesViewAltKey : 代替キーを使用してアクティビティ目標を検索します。
      ファインダ変数:
      • ObjectiveId; integer;目標の一意の識別子。
    • 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ActivityId; integer; 親アクティビティの一意の識別子。
    • ActivityNumber; string; アクティビティの一意の番号。 外部ソースから番号を生成することもできます。
    • ActivityObjective; string;アクティビティの目的。
    • ActyActivityNumber; string; アクティビティの一意の番号。 外部ソースから番号を生成することもできます。
    • AttributeCategory; string; アクティビティに関連付けられた属性カテゴリ。
    • CompletedFlag; boolean。アクティビティ目標が完了したかどうかを示します。 Trueの場合、アクティビティは完了しています。
    • ConflictId; integer; アクティビティ目標における競合の一意の識別子。
    • CorpCurrencyCode;文字列;活動担当者に関連付けられた企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CreatedBy; string; アクティビティ目標を作成したユーザー。
    • CreationDate; string; アクティビティ目標が作成された日時。
    • CurcyConvRateType;文字列;活動担当者に関連付けられた通貨換算レート・タイプ。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
    • CurrencyCode; string;通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • LastUpdateDate; string; アクティビティ目標が最後に更新された日時。
    • LastUpdateLogin; string; アクティビティ目標を最後に更新したユーザーのログイン詳細。
    • LastUpdatedBy; string; アクティビティ目標を最後に更新したユーザー。
    • ObjectiveCode; string; アクティビティの目標を示すコード。 有効な値のリストは、参照ORA_ZMM_ACTIVITY_OBJECTIVEで定義されます。
    • ObjectiveFreefmtText; string; アクティビティの目標を説明するテキスト領域。
    • ObjectiveId; integer;目標の一意の識別子。
    • RecurSeriesId; integer;シリーズのインスタンスをリンクするシリーズの一意の識別子。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : activities-ActivityObjectives
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : activities-ActivityObjectives-item-response
タイプ: object
ソースを表示
  • タイトル: Activity ID
    親活動の一意の識別子。
  • 最大長: 64
    アクティビティの一意の番号。 外部ソースから番号を生成することもできます。
  • 最大長: 255
    活動の目標。
  • タイトル: Activity Number
    最大長: 64
    アクティビティの一意の番号。 外部ソースから番号を生成することもできます。
  • 最大長: 30
    アクティビティに関連付けられた属性カテゴリ。
  • タイトル: Complete
    最大長: 1
    アクティビティ目標が完了したかどうかを示します。 Trueの場合、アクティビティは完了しています。
  • デフォルト値: 0
    アクティビティ目標の競合の一意の識別子。
  • 最大長: 15
    活動担当者に関連付けられた企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • 読取り専用: true
    最大長: 64
    アクティビティ目標を作成したユーザー。
  • 読取り専用: true
    活動目標が作成された日時。
  • 最大長: 30
    活動担当者に関連付けられた通貨換算レート・タイプ。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
  • 最大長: 15
    通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • 読取り専用: true
    アクティビティ目標が最後に更新された日時。
  • 読取り専用: true
    最大長: 64
    アクティビティ目標を最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    アクティビティ目標を最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Objective
    最大長: 30
    アクティビティの目的を示すコード。 有効な値のリストは、参照ORA_ZMM_ACTIVITY_OBJECTIVEで定義されます。
  • タイトル: Objective Text
    最大長: 80
    活動の目標を説明するテキスト・エリア。
  • タイトル: Objective ID
    目標の一意の識別子。
  • シリーズのインスタンスをリンクするシリーズの一意の識別子。
トップに戻る

例:

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

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167267/child/ActivityObjectives

レスポンス本文の例

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

{
"items": [1]
0:  {
"ActivityId": 300100091331227
"ObjectiveCode": "DEMO_PRODUCT"
"ObjectiveFreefmtText": "NEW_OBJ1235"
"ObjectiveId": 300100091331231
"AttributeCategory": null
"CreationDate": "2016-08-24T00:02:57-07:00"
"CreatedBy": "SALES_ADMIN"
"LastUpdateDate": "2016-08-24T00:21:53-07:00"
"LastUpdatedBy": "SALES_ADMIN"
"LastUpdateLogin": "3ACBFC03100C5FB5E053780CF10AE876"
"ObjectVersionNumber": 2
"ConflictId": 0
"CompletedFlag": false
"ActivityNumber": null
"RecurSeriesId": null
"ObjectiveCompletedFlag": "false"
"CorpCurrencyCode": "EUR"
"CurcyConvRateType": "Corporate"
"CurrencyCode": "EUR"
"links": [5]
0:  {
"rel": "self"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167267/child/ActivityObjectives/300100091331231"
"name": "ActivityObjectives"
"kind": "item"
}-
1:  {
"rel": "canonical"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167267/child/ActivityObjectives/300100091331231"
"name": "ActivityObjectives"
"kind": "item"
}-
2:  {
"rel": "parent"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167267"
"name": "activities"
"kind": "item"
}-
3:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167267/child/ActivityObjectives/300100091331231/lov/ObjectiveLookup"
"name": "ObjectiveLookup"
"kind": "collection"
}-
4:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167267/child/ActivityObjectives/300100091331231/lov/RatedCurrenciesVA"
"name": "RatedCurrenciesVA"
"kind": "collection"
}-
-
}-
-
"count": 1
"hasMore": false
"limit": 25
"offset": 0
"links": [1]
0:  {
"rel": "self"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167267/child/ActivityObjectives"
"name": "ActivityObjectives"
"kind": "collection"
}-
-
}
「トップに戻る」