機械翻訳について

ノートの作成

post

/crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/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
    ノートに関連付けられたノートの企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Creator Party ID
    ノートを作成または作成した個人の一意の識別子。
  • タイトル: Currency Conversion Rate Type
    最大長: 30
    ユーザー入力通貨と、ノートに関連付けられたCRM企業通貨コードとの間の換算レートを導出するために使用される通貨換算レート・タイプ。
  • タイトル: Currency
    最大長: 15
    通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • 最大長: 30
    ノートの代替一意識別子。 システム生成または外部システムからのユーザー・キー。
  • タイトル: Title
    最大長: 500
    ユーザーが入力したノートのタイトル。
  • タイトル: Note
    ノート・テキストを格納する列。
  • タイトル: Type
    最大長: 30
    ノートのタイプを示すコード。 たとえば、一般や参照です。
  • タイトル: Parent Note ID
    親ノートの一意の識別子。
  • タイトル: Related Object Type
    最大長: 30
    オブジェクトのメタデータに定義されているソース・オブジェクトのソース・オブジェクト・コード。
  • タイトル: Related Object
    最大長: 64
    アクティビティや商談など、オブジェクトのメタデータに定義されているソース・オブジェクトの一意の識別子。
  • タイトル: Private
    最大長: 30
    デフォルト値: INTERNAL
    非公開、内部、外部など、ノートの表示レベルを示すコード。
トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : deals-Note-item-response
タイプ: object
ソースを表示
  • タイトル: Contact Relationship ID
    担当者とノート間の関係の一意の識別子。 この値は、ノートが担当者に関連付けられている場合に移入されます。
  • タイトル: Corporate Currency Code
    最大長: 15
    ノートに関連付けられたノートの企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    ノートを作成したユーザーの一意の識別子。
  • タイトル: Creation Date
    読取り専用: true
    行が作成された日時。
  • タイトル: Creator Party ID
    ノートを作成または作成した個人の一意の識別子。
  • タイトル: Currency Conversion Rate Type
    最大長: 30
    ユーザー入力通貨と、ノートに関連付けられたCRM企業通貨コードとの間の換算レートを導出するために使用される通貨換算レート・タイプ。
  • タイトル: Currency
    最大長: 15
    通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照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
    オブジェクトのメタデータに定義されているソース・オブジェクトのソース・オブジェクト・コード。
  • タイトル: Related Object
    最大長: 64
    アクティビティや商談など、オブジェクトのメタデータに定義されているソース・オブジェクトの一意の識別子。
  • タイトル: Update Indicator
    読取り専用: true
    ノートを更新できるかどうかを示します。 値がYの場合は、ノートを更新できます。 デフォルト値はNです。
  • タイトル: Private
    最大長: 30
    デフォルト値: INTERNAL
    非公開、内部、外部など、ノートの表示レベルを示すコード。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する投稿リクエストを発行することによって、ディール登録のノートを作成する方法を示しています。

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

リクエスト本文の例

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

{
 "NoteTxt" : "Tm90ZSBjcmVhdGVkIHRocm91Z2ggUkVTVCBBUEkgbmVlZHMgdG8gYmUgZW5jb2RlZCBpbnRvIGJhc2UgNjQh",
 "NoteTypeCode": "GENERAL",
 "VisibilityCode": "EXTERNAL"
}

レスポンス本文の例

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

{
  "NoteId": 300100091097514,
  "SourceObjectCode": "DEAL",
  "SourceObjectId": "300100091082863",
  "PartyName": "Channel_Sales_Mgr_ENT1 CSM",
  "NoteTypeCode": "GENERAL",
  "VisibilityCode"": "EXTERNAL",
  "CreatorPartyId": 100010038017909,
  "CreatedBy": "CHANNEL_SALES_MANAGER",
  "CreationDate": "2016-08-16T16:20:52-07:00",
  "LastUpdateDate": "2016-08-16T16:20:52-07:00",
  "PartyId": 100010038017909,
  "CorpCurrencyCode": "USD",
  ...
}
「トップに戻る」