機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 会話

すべての会話の取得

get

/crmRestApi/resources/11.13.18.05/conversations

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

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

    • ConversationByNumber指定した会話番号の会話を検索します。
      ファインダ変数
      • ConversationNumber; string;会話の代替キー識別子。
    • ConversationsByPerson指定したファインダ変数との会話を検索します。
      ファインダ変数
      • SenderOrRecipientPartyId; integer;送信者または受信者パーティの一意の識別子。
    • PrimaryKey指定した主キーとの会話を検索します。
      ファインダ変数
      • ConversationId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • BUOrgId; integer; 会話に関連付けられているビジネス・ユニット組織の一意の識別子。
    • ConversationAlternateId; string;会話の代替の一意の識別子。
    • ConversationId; integer;会話の一意の識別子。
    • ConversationNumber; string;会話の代替キー識別子。
    • ConversationSortDate; string; 会話をソートするために使用できる日付フィールド。 現在は、会話のメッセージが更新された最新の日付です。
    • ConversationStatusCd; string; OPENやCLOSEDなど、会話のステータスを示すコード。
    • ConversationStatusCdMeaning; string;オープンやクローズなどの会話のステータス。
    • ConversationTypeCd; string; 顧客やコラボレーションなど、会話のタイプを示すコード。
    • CreatedBy; string;会話を作成したユーザー。
    • CreationDate; string;会話が作成された日付。
    • LastUpdateDate; string;会話が最後に更新された日付。
    • LastUpdateLogin; string;会話を最後に更新したユーザーのログイン詳細。
    • LastUpdatedBy; string;会話を最後に更新したユーザー。
    • OriginalSystemReference; string;元のアプリケーションからの会話メッセージの一意の参照キー。
    • OriginatedConversationId; integer; 現在の会話が作成された元の会話の一意の識別子。
    • OriginatedConversationNumber; string; 現在の会話が作成された元の会話の代替キー識別子。
    • PrimaryMessageId; integer;会話のプライマリ・メッセージの一意の識別子。
    • PrimaryMessageNumber; string;会話のプライマリ・メッセージの代替キー識別子。
    • PrimaryMessageTitle; string;会話に関連付けられたプライマリ・メッセージのタイトル。
    • StripeCd; string; CRM、HRHD、ISRなど、会話のアプリケーション・ストライプを示すコード。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : 会話
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : conversations-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 会話参照
タイプ: array
タイトル: Conversation References
会話参照。
ソースを表示
ネストされたスキーマ : conversations-conversationReferences-item-response
タイプ: object
ソースを表示
  • タイトル: Conversation ID
    ビジネス・オブジェクトが関連付けられている会話の一意の識別子。
  • タイトル: Conversation Number
    最大長: 30
    ビジネス・オブジェクトが関連付けられている会話の代替キー識別子。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    会話参照を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    会話参照が作成された日付。
  • タイトル: Last Updated Date
    読取り専用: true
    会話参照が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    会話参照を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    会話参照を最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Object ID
    会話に関連付けられたビジネス・オブジェクトの一意の識別子。
  • タイトル: Object Number
    最大長: 255
    会話に関連付けられたビジネス・オブジェクトの代替キー識別子。
  • タイトル: Object Type
    最大長: 30
    会話に関連付けられているビジネス・オブジェクトのタイプを示すコード(SVC_SERVICE_REQUESTSなど)。
  • タイトル: Object Type
    読取り専用: true
    最大長: 255
    商談、サービス・リクエスト、アクティビティ、営業リードまたはアカウントなどのオブジェクト・タイプ。
  • タイトル: Reference ID
    読取り専用: true
    会話参照の一意の識別子。
  • タイトル: Reference Number
    最大長: 30
    会話参照の公開一意識別子。
「トップに戻る」