機械翻訳について

登録のノートの更新

patch

/crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Notes/{NoteId}

リクエスト

パス・パラメータ
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
リクエスト本文 - application/json ()
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ: object
ソースを表示
  • タイトル: Contact Relationship ID
    ノートが担当者に関連付けられている場合に移入される関係の一意の識別子。
  • タイトル: Corporate Currency Code
    最大長: 15
    担当者に関連付けられたノートの企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Creator Party ID
    ノート作成者の一意のパーティ識別子。
  • タイトル: Currency Conversion Rate Type
    最大長: 30
    ノートに関連付けられた通貨換算レート・タイプ。 受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
  • タイトル: Currency
    最大長: 15
    ノートに関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
  • タイトル: Title
    最大長: 500
    ユーザーが入力したノートのタイトル。
  • タイトル: Note
    実際のノートのテキスト。
  • タイトル: Type
    最大長: 30
    このコードは、ノートのタイプを示します。 有効な値のリストは、参照ZMM_NOTE_TYPEで定義されます。
  • タイトル: Related Object
    最大長: 64
    OBJECTS Metadataで定義されたソース・オブジェクトの主キー識別子(アクティビティ、商談など)。
  • タイトル: Private
    最大長: 30
    デフォルト値: INTERNAL
    内部、外部、プライベートなど、ノートの表示レベルを示すコード。 有効な値のリストは、参照ZMM_NOTE_VISIBILITYで定義されます。
トップに戻る

応答

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

デフォルトのレスポンス

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

例:

次の例は、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: {
        ...
    }
...
}

「トップに戻る」