機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 世帯
  4. ノート

すべてのノートの取得

get

/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note

リクエスト

パス・パラメータ
  • 世帯パーティの一意のプライマリ識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERは、属性値をシステム生成にできるか、作成中にユーザー指定にできるかを制御します。 「設定およびメンテナンス」作業領域、「取引先コミュニティ共通プロファイル・オプションの管理」タスクを使用して、この属性の値をレビューおよび更新します。 非アクティブなレコードは更新できません。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : 指定されたノート識別子を持つノートを検索します。
      ファインダ変数:
      • NoteId; integer;一意のノート識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ContactRelationshipId; integer; ノートが担当者に関連付けられている場合に移入される関係の一意の識別子。
    • CreatedBy; string; レコードを作成したユーザー。
    • CreationDate; string; レコードが作成された日時。
    • CreatorPartyId; integer; ノートを作成したユーザーの一意の識別子。
    • EmailAddress; string; ノートを作成したユーザーの電子メール・アドレス。
    • LastUpdateDate; string; レコードが最後に更新された日時。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • NoteId; integer;ノートの一意の識別子。 これはノート表の主キーです。
    • NoteNumber; string; ノートの代替の一意の識別子。 システム生成または外部システムからのユーザー・キー。
    • NoteTitle; string; ユーザーが入力したノートのタイトル。
    • NoteTxt; string; 実際のノート・テキストを格納する列。
    • NoteTypeCode; string; ノートをアセットまたは調整として分類するために使用されるコード。
    • ParentNoteId; integer; 親ノートの一意の識別子。
    • PartyId; integer;パーティの一意の識別子。
    • PartyName; string;ノートの作成者の名前。
    • SourceObjectCode; string; OBJECTS Metadataで定義されているソース・オブジェクトのタイプを示すコード(アクティビティ、商談など)。
    • SourceObjectId; string; OBJECTS Metadataで定義されたソース・オブジェクトの一意の識別子(アクティビティ、商談など)。
    • VisibilityCode; string;ノートの表示レベルを指定します。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : households-Note
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : households-Note-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
    ノートをアセットまたは修正として分類するために使用するコード。
  • タイトル: Parent Note ID
    親ノートの一意の識別子。
  • タイトル: Party ID
    読取り専用: true
    パーティの一意の識別子。
  • タイトル: Author
    読取り専用: true
    最大長: 360
    ノートの作成者の名前。
  • タイトル: Related Object Type
    最大長: 30
    OBJECTS Metadataで定義されたソース・オブジェクトのタイプ(アクティビティ、商談など)を示すコード。
  • タイトル: Related Object
    最大長: 64
    OBJECTS Metadataで定義された、アクティビティ、商談など、ソース・オブジェクトの一意の識別子。
  • タイトル: Update Indicator
    読取り専用: true
    ノートを更新できるかどうかを示します。 値がYの場合は、ノートを更新できます。 デフォルト値はNです。
  • タイトル: Private
    最大長: 30
    デフォルト値: INTERNAL
    ノートの表示レベルを指定します。
トップに戻る

例:

cURLコマンド

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行して、すべてのノートを取得する方法を示しています。 

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households/CDRM_8034/child/Note

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "NoteId": 300100057743146,
    "SourceObjectCode": "SALES_PARTY",
    "NoteTxt": "aabVGVzdCBOb3RlIFVzaW5nIFJlc3QgMTA=",
    "VisibilityCode": "INTERNAL",
    "NoteTypeCode": "GENERAL",
    "CreatorPartyId": "100010025532672",
    ...
	}
「トップに戻る」