機械翻訳について

すべての子インタラクションの取得

get

/crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions

リクエスト

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

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

    • InteractionRowFinderById : 顧客対応識別子との顧客対応を検索します。
      ファインダ変数:
      • BindInteractionId; integer;相互作用の一意の識別子。
      • BindStripeCd; string; 相互作用に関連付けられたストライプ・コード。
    • InteractionRowFinderByMediaItemId : 関連メディア・アイテム識別子で子顧客対応を検索します。
      ファインダ変数:
      • BindMediaItemId; string;インタラクションに関連付けられたメディア・アイテム識別子。
    • InteractionRowFinderByObject : オブジェクトに関連付けられた顧客対応を検索します。
      ファインダ変数:
      • ObjectId; integer;オブジェクトの一意の識別子。
      • ObjectTypeCd; string; オブジェクトのタイプを示すコード。
    • InteractionRowFinderByOwnerCustomerTime : 所有者識別子、顧客識別子および時間別の顧客対応を検索します。
      ファインダ変数:
      • BindAccountPartyId; integer; 顧客対応に関連付けられているアカウントの一意の識別子。
      • BindContactPartyId; integer; 顧客対応に関連付けられている担当者の一意の識別子。
      • BindCreationDate; string;参照が作成された日時。
      • BindInteractionId; integer;相互作用の一意の識別子。
      • BindLastUpdateDate; string;顧客対応が最後に更新された日付。
      • BindOwnerResourceId; integer; インタラクションの所有者の一意の識別子。
      • BindStatusCd; string;子インタラクションのステータス・コード。
    • InteractionRowFinderByOwnerCustomerTimeObject : 所有者識別子、顧客識別子、時間およびオブジェクトなど、指定された主キーとの子顧客対応を検索
      ファインダ変数:
      • BindAccountPartyId; integer; 子顧客対応に関連付けられたアカウントの一意の識別子。
      • BindContactPartyId; integer; 子顧客対応に関連付けられた担当者の一意の識別子。
      • BindCreationDate; string;参照が作成された日時。
      • BindInteractionId; integer;子インタラクションの一意の識別子。
      • BindLastUpdateDate; string;子顧客対応が最後に更新された日付。
      • BindOwnerResourceId; integer; 子インタラクションの所有者の一意の識別子。
      • BindStatusCd; string;子インタラクションのステータス・コード。
      • ObjectId; integer; 子相互作用オブジェクトの一意の識別子。
      • ObjectTypeCd; string; 相互作用参照に存在するオブジェクトのタイプを示すコード。
    • OpenChildInteractionRowFinderByChannelCustomerOwner : チャネルおよび顧客別のオープンな子顧客対応を検索します。
      ファインダ変数:
      • BindAccountPartyId; integer; 顧客対応に関連付けられているアカウントの一意の識別子。
      • BindChannelId; integer;インタラクション・チャネルの一意の識別子。
      • BindContactPartyId; integer; 顧客対応に関連付けられている担当者の一意の識別子。
      • BindOwnerResourceId; integer; インタラクションの所有者の一意の識別子。
      • BindParentInteractionId; integer;親顧客対応の一意の識別子。
    • PrimaryKey : 指定された主キーとの子相互作用を検索します。
      ファインダ変数:
      • InteractionId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AccountPartyId; integer; 顧客対応に関連付けられているアカウントの一意の識別子。
    • AccountPartyNumber; string; アカウント識別子の代替キー。
    • AccountPartyUniqueName; string;顧客対応に関連付けられているアカウントの一意のアカウント名。
    • AgentHTTPSessionId; string; httpセッションの一意の識別子。
    • ChannelDisplayName; string;対話チャネルの名前。
    • ChannelId; integer;インタラクション・チャネルの一意の識別子。
    • ChannelShortName; string;インタラクション・チャネルの短縮名。
    • ChannelTypeCd; string; インタラクション・チャネルのタイプを示すコード。
    • ContactPartyId; integer; 顧客対応に関連付けられている担当者の一意の識別子。
    • ContactPartyNumber; string; 担当者パーティの代替キー識別子。
    • ContactPartyUniqueName; string;顧客対応に関連付けられている担当者の一意の担当者名。
    • CreatedBy; string;顧客対応を作成したユーザー。
    • CreationDate; string;顧客対応が作成された日時。
    • 説明;文字列;子インタラクションの説明。
    • DirectionCd; string; 相互作用がインバウンドかアウトバウンドかを示すコード。 デフォルト値はORA_SVC_INBOUNDで、インバウンド相互作用を示します。 値は、アウトバウンド・インタラクションのORA_SVC_OUTBOUNDです。
    • EndTime; string; 相互作用が終了した時間。
    • InteractionId; integer;相互作用の一意の識別子。
    • InteractionNumber; string;相互作用の代替キー識別子。
    • LastUpdateDate; string;顧客対応が最後に更新された日付。
    • LastUpdateLogin; string;顧客対応を最後に更新したユーザーのセッション・ログイン。
    • LastUpdatedBy; string;顧客対応を最後に更新したユーザー。
    • ManuallyLoggedFlag; boolean;顧客対応が手動で作成されたかどうかを示します。 手動で作成された値はY、それ以外の場合はNです。
    • MarketingReferenceId; integer; マーケティング・システム・デプロイメント番号への参照を格納するために使用される一意の識別子。
    • MediaItemId; string;メディア・アイテムの一意の識別子。
    • OriginalSystemReference; string;顧客対応で使用されるシステム参照。
    • OwnerResourceId; integer; インタラクションの所有者の一意の識別子。
    • OwnerResourcePartyNumber; string;顧客対応の所有者の代替キー識別子。
    • OwnerResourcePartyUniqueName; string;インタラクションの所有者の一意の名前。
    • ParentInteractionId; integer;親顧客対応の一意の識別子。
    • ParentInteractionNumber; string;親相互作用を表す代替キー識別子。
    • QueueId; integer;相互作用キューの一意の識別子。
    • QueueName; string;相互作用キューの名前。
    • QueueNumber; string;キューの代替キー識別子。
    • SourceCd; string; 子相互作用オブジェクト内にソース・コード参照を格納するために使用される一意の識別子。
    • StartTime; string;インタラクションが開始された時間。
    • StatusCd; string;顧客対応の現在のステータスを示すコード。 有効な値のリストは、参照ORA_SVC_IM_STATUS_CDで定義されます。
    • StripeCd; string; インタラクションのストライプを示すコード。 有効な値のリストは、参照ORA_SVC_STRIPE_CDで定義されます。
    • SubstatusCd; string;顧客対応のサブステータスを示すコード。 有効な値のリストは、参照ORA_SVC_IM_CLOSED_SUBSTATUS_CDで定義されます。
    • TopLevelFlag; boolean;インタラクションがトップ・レベルかどうかを示します。 親顧客対応識別子が顧客対応識別子と同じ場合、顧客対応は最上位レベルです。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : interactions-childInteractions
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : interactions-childInteractions-item-response
タイプ: object
ソースを表示
  • タイトル: Account ID
    顧客対応に関連付けられたアカウントの一意の識別子。
  • タイトル: Account Number
    読取り専用: true
    最大長: 30
    勘定科目識別子の代替キー。
  • タイトル: Account
    読取り専用: true
    最大長: 900
    顧客対応に関連付けられているアカウントの一意のアカウント名。
  • タイトル: Session ID
    最大長: 100
    HTTPセッションの一意の識別子。
  • タイトル: Channel Display Name
    読取り専用: true
    最大長: 400
    相互作用チャネルの名前。
  • タイトル: Channel ID
    インタラクション・チャネルの一意の識別子。
  • タイトル: Channel Code
    読取り専用: true
    最大長: 450
    インタラクション・チャネルの短縮名。
  • タイトル: Channel Type
    最大長: 30
    相互作用チャネルのタイプを示すコード。
  • タイトル: Contact ID
    顧客対応に関連付けられている担当者の一意の識別子。
  • タイトル: Contact Number
    読取り専用: true
    最大長: 30
    担当者パーティの代替キー識別子。
  • タイトル: Contact
    読取り専用: true
    最大長: 900
    顧客対応に関連付けられている担当者の一意の担当者名。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    顧客対応を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    顧客対応が作成された日時。
  • 読取り専用: true
    顧客対応を現在のユーザーが削除できるかどうかを示します。 デフォルト値はfalseです。
  • タイトル: Description
    最大長: 1000
    子顧客対応の摘要。
  • タイトル: Direction
    最大長: 30
    デフォルト値: ORA_SVC_INBOUND
    顧客対応がインバウンドかアウトバウンドかを示すコード。 デフォルト値はORA_SVC_INBOUNDで、インバウンド相互作用を示します。 値は、アウトバウンド・インタラクションのORA_SVC_OUTBOUNDです。
  • タイトル: End Interaction
    これにより、顧客対応ステータスをクローズ済に変更せずに、終了時間属性(現在の時間)が設定されます。 デフォルト値はfalseです。
  • タイトル: End Time
    顧客対応が終了した時間。
  • タイトル: Interaction ID
    読取り専用: true
    顧客対応の一意の識別子。
  • タイトル: Interaction Number
    最大長: 30
    顧客対応の代替キー識別子。
  • タイトル: Last Updated Date
    読取り専用: true
    顧客対応が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    顧客対応を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    顧客対応を最後に更新したユーザーのセッション・ログイン。
  • Links
  • 最大長: 1
    顧客対応が手動で作成されたかどうかを示します。 手動で作成された値はY、それ以外の場合はNです。
  • タイトル: Marketing Reference ID
    マーケティング・システム・デプロイメント番号への参照を格納するために使用される一意の識別子。
  • タイトル: Media Item ID
    最大長: 80
    メディア・アイテムの一意の識別子。
  • タイトル: Original System
    最大長: 255
    顧客対応で使用されるシステム参照。
  • タイトル: Owner Resource ID
    顧客対応の所有者の一意の識別子。
  • タイトル: Resource Number
    読取り専用: true
    最大長: 30
    顧客対応の所有者の代替キー識別子。
  • タイトル: Resource Name
    読取り専用: true
    最大長: 900
    顧客対応の所有者の一意の名前。
  • タイトル: Parent Interaction ID
    親顧客対応の一意の識別子。
  • タイトル: Interaction Number
    読取り専用: true
    最大長: 30
    親顧客対応の代替キー識別子。
  • タイトル: Payload
    顧客対応に関連付けられたペイロード。
  • タイトル: Queue ID
    インタラクション・キューの一意の識別子。
  • タイトル: Queue Name
    読取り専用: true
    最大長: 400
    インタラクション・キューの名前。
  • タイトル: Queue Number
    最大長: 30
    キューの代替キー識別子。
  • タイトル: Source CD
    最大長: 30
    子顧客対応オブジェクト内にソース・コード参照を格納するために使用される一意の識別子。
  • タイトル: Start Interaction
    デフォルト値: true
    顧客対応がすでに開始されている場合に開始する必要があるかどうかを示します。 デフォルト値はTrueです。
  • タイトル: Start Time
    顧客対応が開始した時間。
  • タイトル: Status
    最大長: 30
    デフォルト値: ORA_SVC_OPEN
    顧客対応の現在のステータスを示すコード。 有効な値のリストは、参照ORA_SVC_IM_STATUS_CDで定義されます。
  • タイトル: Stripe Code
    最大長: 30
    顧客対応のストライプを示すコード。 有効な値のリストは、参照ORA_SVC_STRIPE_CDで定義されます。
  • タイトル: Substatus Code
    最大長: 30
    顧客対応のサブステータスを示すコード。 有効な値のリストは、参照ORA_SVC_IM_CLOSED_SUBSTATUS_CDで定義されます。
  • タイトル: Top Level
    読取り専用: true
    顧客対応がトップ・レベルかどうかを示します。 親顧客対応識別子が顧客対応識別子と同じ場合、顧客対応は最上位レベルです。
  • 読取り専用: true
    顧客対応を現在のユーザーが更新できるかどうかを示します。 ユーザーが顧客対応を更新するためのアクセス権を持っている場合、デフォルト値はtrueです。
トップに戻る

例:

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

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

GET /crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

HTTP/1.1 200: OK
Date: Fri, 03 Mar 2017 07:54:53 GMT
Server : Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourcecollection+json
Content-Language: en

応答本文の例

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

{
  "items" : [ {
    "InteractionId" : 300100097737929,
    "ParentInteractionId" : 300100096307925,
    "TopLevelFlag" : "false",
    "Description" : "Sent SrMessage",
    "ChannelId" : 100100052667990,
    "ChannelDisplayName" : "Social (Seeded)",
    "ChannelTypeCd" : "ORA_SVC_SOCIAL",
    "AccountPartyId" : null,
    "AccountPartyUniqueName" : null,
    "ContactPartyId" : null,
    "ContactPartyUniqueName" : null,
    "QueueId" : null,
    "QueueName" : null,
    "OwnerResourceId" : null,
    "OwnerResourcePartyUniqueName" : null,
    "StartTime" : "2017-03-06T01:15:09-08:00",
    "EndTime" : null,
    "StatusCd" : "ORA_SVC_OPEN",
    "OriginalSystemReference" : null,
    "CreatedBy" : "SALES_ADMIN",
    "CreationDate" : "2017-03-06T01:15:09-08:00",
    "LastUpdatedBy" : "SALES_ADMIN",
    "LastUpdateDate" : "2017-03-06T01:21:31-08:00",
    "LastUpdateLogin" : "4A0BD041F81345D7E05307B3F20ACD5E",
    "DirectionCd" : "ORA_SVC_INBOUND",
    "StripeCd" : "ORA_SVC_CRM",
    "MediaItemId" : null,
    "SubstatusCd" : null,
    "NotifyFlag" : null,
    "UpdateFlag" : "true",
    "DeleteFlag" : "true",
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions/300100097737929",
      "name" : "childInteractions",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions/300100097737929",
      "name" : "childInteractions",
      "kind" : "item"
    }, {
      "rel" : "parent",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925",
      "name" : "interactions",
      "kind" : "item"
    }, {
      "rel" : "lov",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions/300100097737929/lov/DirectionCdLookup",
      "name" : "DirectionCdLookup",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions/300100097737929/lov/StatusCdLookup",
      "name" : "StatusCdLookup",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions/300100097737929/lov/ChannelIdByChannelType",
      "name" : "ChannelIdByChannelType",
      "kind" : "collection"
    }, {
      "rel" : "enclosure",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions/300100097737929/enclosure/Payload",
      "name" : "Payload",
      "kind" : "other"
    } ]
  }, {
    "InteractionId" : 300100097734217,
    "ParentInteractionId" : 300100096307925,
    "TopLevelFlag" : "false",
    "Description" : "Created through Rest from Omnichannel Scrum-11",
    "ChannelId" : 1,
    "ChannelDisplayName" : "Web (Seeded)",
    "ChannelTypeCd" : "ORA_SVC_WEB",
    "AccountPartyId" : 300100097727798,
    "AccountPartyUniqueName" : "Autorun_CreatedNewTestAccount_2017/03/05 05-49-07",
    "ContactPartyId" : 300100097727803,
    "ContactPartyUniqueName" : "InteractionAutorun_CreatedNewTestContact 2017/03/05 05-49-07",
    "QueueId" : null,
    "QueueName" : null,
    "OwnerResourceId" : 300100075378742,
    "OwnerResourcePartyUniqueName" : "autouisvr1 svc",
    "StartTime" : "2017-03-05T22:38:51-08:00",
    "EndTime" : null,
    "StatusCd" : "ORA_SVC_OPEN",
    "OriginalSystemReference" : null,
    "CreatedBy" : "SALES_ADMIN",
    "CreationDate" : "2017-03-05T22:38:51-08:00",
    "LastUpdatedBy" : "SALES_ADMIN",
    "LastUpdateDate" : "2017-03-05T22:38:51-08:00",
    "LastUpdateLogin" : "49EC867130CA77BBE05307B3F20A2170",
    "DirectionCd" : "ORA_SVC_INBOUND",
    "StripeCd" : "ORA_SVC_CRM",
    "MediaItemId" : null,
    "SubstatusCd" : null,
    "NotifyFlag" : null,
    "UpdateFlag" : "true",
    "DeleteFlag" : "true",
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions/300100097734217",
      "name" : "childInteractions",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D626
    ...
  }
...
}
「トップに戻る」