ノートの作成
post
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note
リクエスト
パス・パラメータ
- OptyNumber(required): string
商談の一意の代替識別子。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
ContactRelationshipId: integer (int64)
タイトル:
Contact Relationship ID
ノートが担当者に関連付けられている場合に移入される関係の一意の識別子。 -
CorpCurrencyCode: string
タイトル:
Corporate Currency Code
最大長:15
担当者に関連付けられたノートの企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CreatorPartyId: integer (int64)
タイトル:
Creator Party ID
ノート作成者の一意のパーティ識別子。 -
CurcyConvRateType: string
タイトル:
Currency Conversion Rate Type
最大長:30
ノートに関連付けられた通貨換算レート・タイプ。 受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
CurrencyCode: string
タイトル:
Currency
最大長:15
ノートに関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
NoteNumber: string
最大長:
30
システム生成番号。 外部システム(ユーザー・キー)からも生成できます。 -
NoteTitle: string
タイトル:
Title
最大長:500
ユーザーがノートのタイトルを指定しました。 -
NoteTxt: 文字列(バイト)
タイトル:
Note
実際のノート・テキストを保存するカラム。 -
NoteTypeCode: string
タイトル:
Type
最大長:30
ノートをアセットまたは修正として分類するために使用するコード。 -
ParentNoteId: integer (int64)
タイトル:
Parent Note ID
親ノートの識別子。 -
SourceObjectCode: string
タイトル:
Related Object Type
最大長:30
OBJECTS Metadataで定義されたソース・オブジェクトのタイプ(アクティビティ、商談など)を示すコード。 -
SourceObjectId: string
タイトル:
Related Object
最大長:64
OBJECTS Metadataで定義されたソース・オブジェクトの一意の識別子。アクティビティ、商談など。 -
VisibilityCode: string
タイトル:
Private
最大長:30
デフォルト値:INTERNAL
内部や外部など、ノートの表示レベルを示すコード。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : opportunities-Note-item-response
タイプ:
ソースを表示
object
-
ContactRelationshipId: integer (int64)
タイトル:
Contact Relationship ID
ノートが担当者に関連付けられている場合に移入される関係の一意の識別子。 -
CorpCurrencyCode: string
タイトル:
Corporate Currency Code
最大長:15
担当者に関連付けられたノートの企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
ノート・レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
ノート・レコードが作成された日時。 -
CreatorPartyId: integer (int64)
タイトル:
Creator Party ID
ノート作成者の一意のパーティ識別子。 -
CurcyConvRateType: string
タイトル:
Currency Conversion Rate Type
最大長:30
ノートに関連付けられた通貨換算レート・タイプ。 受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
CurrencyCode: string
タイトル:
Currency
最大長:15
ノートに関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
DeleteFlag: boolean
タイトル:
Delete Indicator
読取り専用:true
ノートを削除するかどうかを示します。 値がYの場合、ノートを削除する必要があります。 デフォルト値はNです。 -
EmailAddress: string
タイトル:
Primary Email
読取り専用:true
最大長:320
ノートを作成したユーザーの電子メール・アドレス。 -
FormattedAddress: string
タイトル:
Primary Address
読取り専用:true
ノートを作成したユーザーのフォーマット済み住所。 -
FormattedPhoneNumber: string
タイトル:
Primary Phone
読取り専用:true
ノートを作成したユーザーの書式設定された電話番号。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
ノート・データが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
NoteId: integer (int64)
タイトル:
Note ID
読取り専用:true
商談のノートの一意の識別子。 -
NoteNumber: string
最大長:
30
システム生成番号。 外部システム(ユーザー・キー)からも生成できます。 -
NoteTitle: string
タイトル:
Title
最大長:500
ユーザーがノートのタイトルを指定しました。 -
NoteTxt: 文字列(バイト)
タイトル:
Note
実際のノート・テキストを保存するカラム。 -
NoteTypeCode: string
タイトル:
Type
最大長:30
ノートをアセットまたは修正として分類するために使用するコード。 -
ParentNoteId: integer (int64)
タイトル:
Parent Note ID
親ノートの識別子。 -
PartyId: integer (int64)
タイトル:
Party ID
読取り専用:true
ノートが関連付けられているパーティの一意の識別子。 -
PartyName: string
タイトル:
Author
読取り専用:true
最大長:360
商談に関連付けられているパーティの名前。 -
SourceObjectCode: string
タイトル:
Related Object Type
最大長:30
OBJECTS Metadataで定義されたソース・オブジェクトのタイプ(アクティビティ、商談など)を示すコード。 -
SourceObjectId: string
タイトル:
Related Object
最大長:64
OBJECTS Metadataで定義されたソース・オブジェクトの一意の識別子。アクティビティ、商談など。 -
UpdateFlag: boolean
タイトル:
Update Indicator
読取り専用:true
ノートを更新できるかどうかを示します。 値がYの場合は、ノートを更新できます。 デフォルト値はNです。 -
VisibilityCode: string
タイトル:
Private
最大長:30
デフォルト値:INTERNAL
内部や外部など、ノートの表示レベルを示すコード。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
リンク
- NoteSourceTypeVA
-
パラメータ:
- ファインダ:
NoteTypeFinder%3BBindSourceObjectCode%3D{SourceObjectCode}
ノート・タイプ・リソースは、ノート・タイプの表示に使用されます。 - ファインダ:
- NoteVisibilityLookupVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BBindLookupType%3DZMM_NOTE_VISIBILITY
表示コード - ファインダ:
- RatedCurrenciesVA
-
通貨
例:
次の例は、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, ... } ] }