ノートの更新
patch
/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Note/{NoteId}
リクエスト
パス・パラメータ
- NoteId(required): integer(int64)
リードに関連付けられたノートの一意の識別子。 これはノート表の主キーです。
- leadsUniqID(required): string
これは、営業リード・リソースの複合キーを構成し、営業リードのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、営業リードの特定のインスタンスに移動してハッシュ・キーを取得するために、営業リード・コレクション・リソースを問い合せる必要があります。
ヘッダー・パラメータ
- 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ノートのタイプを示すコード。 参照NoteSourceTypeVAで定義された有効な値のリスト。 -
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のデフォルト・バージョンを選択します。
ルート・スキーマ : leads-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ノートのタイプを示すコード。 参照NoteSourceTypeVAで定義された有効な値のリスト。 -
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最大長: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}
ノート・タイプ・リソースは、ノート・タイプの表示に使用されます。 - ファインダ:
- NoteVisibilityLookupVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BBindLookupType%3DZMM_NOTE_VISIBILITY
表示コード - ファインダ:
- RatedCurrenciesVA
-
通貨
例:
次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによってノートを更新する方法を示しています。
curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100078823017/child/Note
リクエスト本文の例
次に、JSON形式のリクエスト本文の例を示します。
{
"CurrencyCode": "GBP",
"NoteTxt": "Tm90ZSB1cGRhdGVkIGZyb20gUkVTVA=="
}
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{
"NoteId": 300100078823026,
"SourceObjectCode": "LEAD",
"SourceObjectId": "300100078823017",
"PartyName": "Gabrielle Lee",
"NoteTypeCode": "GENERAL",
"VisibilityCode": "EXTERNAL",
"CreatorPartyId": 100010025532672,
"NoteAttributeCategory": null,
"NoteAttributeUid1": null,
"NoteAttributeUid2": null,
"NoteAttributeUid3": null,
"NoteAttributeUid4": null,
"NoteAttributeUid5": null,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2016-04-11T20:10:57+00:00",
"LastUpdateDate": "2016-04-11T20:15:36+00:00",
"PartyId": 100010025532672,
"CorpCurrencyCode": "USD",
"CurcyConvRateType": "Corporate",
"CurrencyCode": "GBP",
"ContactRelationshipId": null,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100078823017/child/Note/300100078823026",
"name": "Note",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100078823017/child/Note/300100078823026",
"name": "Note",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100078823017",
"name": "leads",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100078823017/child/Note/300100078823026/lov/NoteVisibilityLookupVA",
"name": "NoteVisibilityLookupVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100078823017/child/Note/300100078823026/lov/RatedCurrenciesVA",
"name": "RatedCurrenciesVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100078823017/child/Note/300100078823026/lov/NoteSourceTypeVA",
"name": "NoteSourceTypeVA",
"kind": "collection"
},
{
"rel": "enclosure",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100078823017/child/Note/300100078823026/enclosure/NoteTxt",
"name": "NoteTxt",
"kind": "other"
}
]
}