登録のノートの更新
patch
/crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Notes/{NoteId}
リクエスト
パス・パラメータ
- EnrollmentNumber(required): string
プログラム登録の代替キー識別子。
- NoteId(required): integer(int64)
担当者に関連付けられたノートの一意の識別子。 これはノート表の主キーです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- 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で定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
NoteTitle: string
タイトル:
Title
最大長:500
ユーザーが入力したノートのタイトル。 -
NoteTxt: 文字列(バイト)
タイトル:
Note
実際のノートのテキスト。 -
NoteTypeCode: string
タイトル:
Type
最大長:30
このコードは、ノートのタイプを示します。 有効な値のリストは、参照ZMM_NOTE_TYPEで定義されます。 -
SourceObjectId: string
タイトル:
Related Object
最大長:64
OBJECTS Metadataで定義されたソース・オブジェクトの主キー識別子(アクティビティ、商談など)。 -
VisibilityCode: string
タイトル:
Private
最大長:30
デフォルト値:INTERNAL
内部、外部、プライベートなど、ノートの表示レベルを示すコード。 有効な値のリストは、参照ZMM_NOTE_VISIBILITYで定義されます。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : programEnrollments-Notes-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
このコードは、ノートのタイプを示します。 有効な値のリストは、参照ZMM_NOTE_TYPEで定義されます。 -
ParentNoteId: integer (int64)
タイトル:
Parent Note ID
親ノートの一意の識別子。 -
PartyId: integer (int64)
タイトル:
Party ID
読取り専用:true
ノートが関連付けられている担当者の一意の識別子。 住所が関連付けられている担当者レコードを一意に識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。 -
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
内部、外部、プライベートなど、ノートの表示レベルを示すコード。 有効な値のリストは、参照ZMM_NOTE_VISIBILITYで定義されます。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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}
ノートのタイプ(GENERAL、REFERENCE、SPECIALなど)の値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: NoteTypeCode;ターゲット属性: MappedLookupCode
- 表示属性: 意味
- ファインダ:
- NoteVisibilityLookupVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BBindLookupType%3DZMM_NOTE_VISIBILITY
PRIVATE、INTERNAL、EXTERNALなど、ノートの表示レベルの値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: VisibilityCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- RatedCurrenciesVA
-
USDやINRなど、ノートに関連付けられた企業通貨コードで、標準、3文字のISO-4217通貨コードとして表されます。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: CurrencyCode;ターゲット属性: CurrencyCode
- 表示属性: CurrencyCode
例:
次の例は、cURLを使用してRESTリソースに対するパッチ・リクエストを発行することによって、登録のノートを更新する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/programEnrollments/ ENRM_12345/child/Notes/300100059559803
リクエスト本文の例
次に、JSON形式のリクエスト本文の例を示します。
{ "Notes": [ { "NoteTxt": "VGVzdCBOb3RlIFVzaW5nIFJlc3QgMTE=" } ] }
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{ NoteId: 300100059559803 SourceObjectCode: "PROGRAMENROLLMENTS" SourceObjectId: "300100000408620" PartyName: "Gabrielle Lee" NoteTypeCode: "GENERAL" VisibilityCode: "INTERNAL" CreatorPartyId: 100010025532672 NoteAttributeCategory: null NoteAttributeUid1: null NoteAttributeUid2: null NoteAttributeUid3: null NoteAttributeUid4: null NoteAttributeUid5: null CreatedBy: "CHANNEL_OPERATIONS_MANAGER" CreationDate: "2015-07-02T01:58:19-07:00" LastUpdateDate: "2015-07-02T01:58:19-07:00" PartyId: 100010025532672 CorpCurrencyCode: "USD" CurcyConvRateType: "Corporate" CurrencyCode: "USD" ContactRelationshipId: null -links: [7] -0: { ... } -1: { ... } -2: { ... } ... }