機械翻訳について

ノートの作成

post

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note

リクエスト

パス・パラメータ
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
  • 次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
リクエスト本文 - application/json ()
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ: object
ソースを表示
  • タイトル: Contact Relationship ID
    ノートが担当者に関連付けられている場合に移入される関係の一意の識別子。
  • タイトル: Corporate Currency Code
    最大長: 15
    担当者に関連付けられたノートの企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Creator Party ID
    ノート作成者の一意のパーティ識別子。
  • タイトル: Currency Conversion Rate Type
    最大長: 30
    ノートに関連付けられた通貨換算レート・タイプ。 受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
  • タイトル: Currency
    最大長: 15
    ノートに関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
  • 最大長: 30
    システム生成番号。 外部システム(ユーザー・キー)からも生成できます。
  • タイトル: Title
    最大長: 500
    ユーザーがノートのタイトルを指定しました。
  • タイトル: Note
    実際のノート・テキストを保存するカラム。
  • タイトル: Type
    最大長: 30
    ノートをアセットまたは修正として分類するために使用するコード。
  • タイトル: Parent Note ID
    親ノートの識別子。
  • タイトル: Related Object Type
    最大長: 30
    OBJECTS Metadataで定義されたソース・オブジェクトのタイプ(アクティビティ、商談など)を示すコード。
  • タイトル: Related Object
    最大長: 64
    OBJECTS Metadataで定義されたソース・オブジェクトの一意の識別子。アクティビティ、商談など。
  • タイトル: Private
    最大長: 30
    デフォルト値: INTERNAL
    内部や外部など、ノートの表示レベルを示すコード。
トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : opportunities-Note-item-response
タイプ: object
ソースを表示
  • タイトル: Contact Relationship ID
    ノートが担当者に関連付けられている場合に移入される関係の一意の識別子。
  • タイトル: Corporate Currency Code
    最大長: 15
    担当者に関連付けられたノートの企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    ノート・レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    ノート・レコードが作成された日時。
  • タイトル: Creator Party ID
    ノート作成者の一意のパーティ識別子。
  • タイトル: Currency Conversion Rate Type
    最大長: 30
    ノートに関連付けられた通貨換算レート・タイプ。 受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
  • タイトル: Currency
    最大長: 15
    ノートに関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
  • タイトル: Delete Indicator
    読取り専用: true
    ノートを削除するかどうかを示します。 値がYの場合、ノートを削除する必要があります。 デフォルト値はNです。
  • タイトル: Primary Email
    読取り専用: true
    最大長: 320
    ノートを作成したユーザーの電子メール・アドレス。
  • タイトル: Primary Address
    読取り専用: true
    ノートを作成したユーザーのフォーマット済み住所。
  • タイトル: Primary Phone
    読取り専用: true
    ノートを作成したユーザーの書式設定された電話番号。
  • タイトル: Last Update Date
    読取り専用: true
    ノート・データが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Note ID
    読取り専用: true
    商談のノートの一意の識別子。
  • 最大長: 30
    システム生成番号。 外部システム(ユーザー・キー)からも生成できます。
  • タイトル: Title
    最大長: 500
    ユーザーがノートのタイトルを指定しました。
  • タイトル: Note
    実際のノート・テキストを保存するカラム。
  • タイトル: Type
    最大長: 30
    ノートをアセットまたは修正として分類するために使用するコード。
  • タイトル: Parent Note ID
    親ノートの識別子。
  • タイトル: Party ID
    読取り専用: true
    ノートが関連付けられているパーティの一意の識別子。
  • タイトル: Author
    読取り専用: true
    最大長: 360
    商談に関連付けられているパーティの名前。
  • タイトル: Related Object Type
    最大長: 30
    OBJECTS Metadataで定義されたソース・オブジェクトのタイプ(アクティビティ、商談など)を示すコード。
  • タイトル: Related Object
    最大長: 64
    OBJECTS Metadataで定義されたソース・オブジェクトの一意の識別子。アクティビティ、商談など。
  • タイトル: Update Indicator
    読取り専用: true
    ノートを更新できるかどうかを示します。 値がYの場合は、ノートを更新できます。 デフォルト値はNです。
  • タイトル: Private
    最大長: 30
    デフォルト値: INTERNAL
    内部や外部など、ノートの表示レベルを示すコード。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する投稿リクエストを発行して、商談を作成する方法を示しています。 cURLの詳細については、cURLを使用するを参照してください。

cURLコマンド

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/

ノート:

POSTメソッドを使用して、アセットを持つ商談を作成できます。 REST APIを使用してアセットを持つ商談を作成すると、そのアセットに関連するアカウントからアカウント詳細が移入されます。

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

Content-Type: {
"Name" : "Major Application Upgrade"
}

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

Content-Type: {
BudgetAvailableDate: null
BudgetedFlag: false
PrimaryOrganizationId: 204
ChampionFlag: false
CreatedBy: "SALES_ADMIN"
CreationDate: "2015-06-04T03:08:27-07:00"
CurrencyCode: "USD"
SalesMethodId: 100000012430001
SalesStageId: 100000012430007
Name: "Major Application Upgrade"
OptyId: 300100111705686
OptyNumber: "CDRM_332708"
OwnerResourcePartyId: 3807
StatusCode: "OPEN"
PrimaryRevenueId: 300100111705687
SalesMethod: "Standard Sales Process"
SalesStage: "01 - Qualification"
DescriptionText: "Looking for the Right Contacts, Characteristics, Determining the Need, Budget and Sponsor"
AverageDaysAtStage: 30
MaximumDaysInStage: 800
PhaseCd: "QUALIFICATION-DISCOVERY"
QuotaFactor: 3
RcmndWinProb: 0
StageStatusCd: "OPEN"
StgOrder: 1
EffectiveDate: "2015-06-24"
Revenue: 0
WinProb: 0
PartyName1: "Charles Taylor"
DownsideAmount: 0
UpsideAmount: 0
EmailAddress: "firstname_lastname@orcl.com"
ExpectAmount: 0
ForecastOverrideCode: "CRITERIA"
SalesChannelCd: "ZPM_DIRECT_CHANNEL_TYPES"
...
}

例 - 例- 既存の商談に対する複数の売上明細の作成

次の例は、既存の商談に対して複数の売上明細を作成する方法を示しています。

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
  "parts": [
  {
  "id": "part1",
  "path": "opportunities/CDRM_107474/child/ChildRevenue",
  "operation": "create",
  "payload": {
   "ProdGroupId": 999997826071065,
"UnitPrice": 600,
"Quantity": 2
  }
  },
  {
  "id": "part2",
  "path": "opportunities/CDRM_107474/child/ChildRevenue ",
  "operation": "create",
  "payload": {
 "ProdGroupId": 999997826071065,
"UnitPrice": 700,
"Quantity": 3
  }
  }
  ]
}

前述のサンプル・ペイロードでは、CDRM_107474はopty番号です。

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
"parts": [
{
"id": "part1",
  "path": "opportunities/CDRM_107474/child/ChildRevenue",
  "operation": "create",
"payload" : {
{
RevnId: 300100111705696
BUOrgId: 204
CommitFlag: false
CostAmount: 0
ResourcePartyId: 100010025532672
DownsideAmount: 0
ExpectAmount: 0
MarginAmount: 0
OptyId: 300100111705686
RevnAmount: 400
RevnAmountCurcyCode: "USD"
UpsideAmount: 0
WinProb: 0
PrimaryFlag: false
...
}
},
},
{
"id": "part2",
"path": "opportunities/CDRM_107474/child/ChildRevenue",
"operation": "create",
"payload" : {
RevnId: 300100111705697
BUOrgId: 204
CommitFlag: false
CostAmount: 0
ResourcePartyId: 100010025532672
DownsideAmount: 0
ExpectAmount: 0
MarginAmount: 0
OptyId: 300100111705686
RevnAmount: 400
RevnAmountCurcyCode: "USD"
UpsideAmount: 0
WinProb: 0
PrimaryFlag: false
...
}
}

...
}
}
]
}

複数の売上明細がある商談の作成

次の例は、複数の売上明細を含む新しい商談を作成する方法を示しています。

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

Request
{
 "Name": "Pinnacle Server Opportunities",
  "ChildRevenue":
[
  {
 "ProdGroupId": 999997826071065,
"UnitPrice": 100,
"Quantity": 1
},
{
"ProdGroupId": 999997826071065,
 "UnitPrice": 100,
 "Quantity": 1
}
]
}

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
BudgetAvailableDate: null
BudgetedFlag: false
PrimaryOrganizationId: 204
ChampionFlag: false
CreatedBy: "SALES_ADMIN"
CreationDate: "2015-06-04T03:08:27-07:00"
CurrencyCode: "USD"
SalesMethodId: 100000012430001
SalesStageId: 100000012430007
Name: "Pinnacle Server Opportunities"
OptyId: 300100111705686
OptyNumber: "CDRM_332708"
OwnerResourcePartyId: 3807
StatusCode: "OPEN"
PrimaryRevenueId: 300100111705687
SalesMethod: "Standard Sales Process"
SalesStage: "01 - Qualification"
...
"ChildRevenue": [
    {
      "RevnId": 300100182390421,
      "TargetPartyId": null,
      "CustomerAccountId": null,
      "BUOrgId": 204,
      "Comments": null,
      "CommitFlag": false,
      "OptyEffectiveDate": "2019-12-25",
      "CostAmount": 0,
      "ResourcePartyId": 100010025532672,
      "DownsideAmount": 0,
      "ExpectAmount": 0,
      "MarginAmount": 0,
      "OptyId": 300100182390419,
      "UnitPrice": 100,
      "InventoryItemId": null,
      "InventoryOrgId": null,
      "Quantity": 1,
      "Discount": null,
      "RevnAmount": 100,
      "RevnAmountCurcyCode": "USD",
      "TypeCode": null,
      "UpsideAmount": 100,
      "WinProb": 0,
      "UOMCode": null,
      
     ...
    },
    {
      "RevnId": 300100182390422,
      "TargetPartyId": null,
      "CustomerAccountId": null,
      "BUOrgId": 204,
      "Comments": null,
      "CommitFlag": false,
      "OptyEffectiveDate": "2019-12-25",
      "CostAmount": 0,
      "ResourcePartyId": 100010025532672,
      "DownsideAmount": 0,
      "ExpectAmount": 0,
      "MarginAmount": 0,
      "OptyId": 300100182390419,
      "UnitPrice": 100,
      "InventoryItemId": null,
      "InventoryOrgId": null,
      "Quantity": 1,
      "Discount": null,
      "RevnAmount": 100,
      "RevnAmountCurcyCode": "USD",
      "TypeCode": null,
      "UpsideAmount": 100,
      "WinProb": 0,
      "UOMCode": null,
      
      ...
    }
  ]
}
「トップに戻る」