機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. プログラム登録
  4. ノート

登録に関するノートの取得

get

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

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • 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で定義されます。
リンク
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 GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/programEnrollments/ ENRM_12345/child/Notes/300100059559515

レスポンス本文の例

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

{
NoteId: 300100059559515
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-06-30T22:50:43-07:00"
LastUpdateDate: "2015-06-30T22:50:43-07:00"
PartyId: 100010025532672
CorpCurrencyCode: "USD"
CurcyConvRateType: "Corporate"
CurrencyCode: "USD"
ContactRelationshipId: null
-links: [7]
-0: {
        ...
    }
-1: {
        ...
    }
-2: {
        ...
    }
...
}
「トップに戻る」