ノートの作成
post
/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note
リクエスト
パス・パラメータ
- PartyNumber(required): string
世帯パーティの一意のプライマリ識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERは、属性値をシステム生成にできるか、作成中にユーザー指定にできるかを制御します。 「設定およびメンテナンス」作業領域、「取引先コミュニティ共通プロファイル・オプションの管理」タスクを使用して、この属性の値をレビューおよび更新します。 非アクティブなレコードは更新できません。
ヘッダー・パラメータ
- 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最大長:30OBJECTS Metadataで定義されたソース・オブジェクトのタイプ(アクティビティ、商談など)を示すコード。 -
SourceObjectId: string
タイトル:
Related Object最大長:64OBJECTS 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のデフォルト・バージョンを選択します。
ルート・スキーマ : households-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最大長:30OBJECTS Metadataで定義されたソース・オブジェクトのタイプ(アクティビティ、商談など)を示すコード。 -
SourceObjectId: string
タイトル:
Related Object最大長:64OBJECTS 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}
一般や公式など、ノートを分類するためのノート・タイプ・コードの値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: NoteTypeCode;ターゲット属性: MappedLookupCode
- 表示属性: 意味
- ファインダ:
- NoteVisibilityLookupVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BBindLookupType%3DZMM_NOTE_VISIBILITY
外部や内部など、ノートの表示レベルの値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: VisibilityCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- RatedCurrenciesVA
-
USドルやインド・ルピーなど、企業通貨コードの値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: CurrencyCode;ターゲット属性: CurrencyCode
- 表示属性: CurrencyCode
例:
cURLコマンド
次の例は、cURLを使用してRESTリソースにポスト・リクエストを発行してノートを作成する方法を示しています。
curl -u <username:password> \ -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households/CDRM_8034/child/Note
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています。
{
"NoteTxt": "aabbbsVGVzdCBOb3RlIFVzaW5nIFJlc3QgMT",
"VisibilityCode": "INTERNAL",
"NoteTypeCode": "GENERAL",
"CreatorPartyId": "100010025532672"
}
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{
"NoteId": "300100057743154",
"VisibilityCode": "INTERNAL",
"NoteTypeCode": "GENERAL",
"CreatorPartyId": "100010025532672",
"PartyName": "Gabrielle Lee",
"SourceObjectCode": "SALES_PARTY",
"SourceObjectId": "300100014465229",
"PartyId": "100010025532672",
...
}