Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

インタラクションの取得

get

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

リクエスト

パス・パラメータ

InteractionId(required): integer(int64)

顧客対応の一意の識別子。

問合せパラメータ

dependency: string

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

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

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

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

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

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : interactions-item-response

タイプ: object

ソースを表示

AccountPartyId: integer (int64)

タイトル: Account ID

顧客対応に関連付けられたアカウントの一意の識別子。
AccountPartyNumber: string

タイトル: Account Number

読取り専用: true

最大長: 30

勘定科目識別子の代替キー。
AccountPartyUniqueName: string

タイトル: Account

読取り専用: true

最大長: 900

顧客対応に関連付けられているアカウントの一意のアカウント名。
AgentHTTPSessionId: string

タイトル: Session ID

最大長: 100

HTTPセッションの一意の識別子。
ChannelDisplayName: string

タイトル: Channel Display Name

読取り専用: true

最大長: 400

相互作用チャネルの名前。
ChannelId: integer (int64)

タイトル: Channel ID

インタラクション・チャネルの一意の識別子。
ChannelShortName: string

タイトル: Channel Code

読取り専用: true

最大長: 450

インタラクション・チャネルの短縮名。
ChannelTypeCd: string

タイトル: Channel Type

最大長: 30

相互作用チャネルのタイプを示すコード。
childInteractions: array Child Interactions

タイトル: Child Interactions

子顧客対応リソースは、現在の顧客対応に関連付けられているすべての子顧客対応を表示、作成および更新するために使用されます。
ContactPartyId: integer (int64)

タイトル: Contact ID

顧客対応に関連付けられている担当者の一意の識別子。
ContactPartyNumber: string

タイトル: Contact Number

読取り専用: true

最大長: 30

担当者パーティの代替キー識別子。
ContactPartyUniqueName: string

タイトル: Contact

読取り専用: true

最大長: 900

顧客対応に関連付けられている担当者の一意の担当者名。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

顧客対応を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

顧客対応が作成された日時。
DeleteFlag: boolean

読取り専用: true

顧客対応を現在のユーザーが削除できるかどうかを示します。デフォルト値はfalseです。
Description: string

タイトル: Description

最大長: 1000

子顧客対応の摘要。
DirectionCd: string

タイトル: Direction

最大長: 30

デフォルト値: ORA_SVC_INBOUND

顧客対応がインバウンドかアウトバウンドかを示すコード。デフォルト値はORA_SVC_INBOUNDで、インバウンド相互作用を示します。値は、アウトバウンド・インタラクションのORA_SVC_OUTBOUNDです。
EndInteractionFlag: boolean

タイトル: End Interaction

これにより、顧客対応ステータスをクローズ済に変更せずに、終了時間属性(現在の時間)が設定されます。デフォルト値はfalseです。
EndTime: string (date-time)

タイトル: End Time

顧客対応が終了した時間。
InteractionId: integer (int64)

タイトル: Interaction ID

読取り専用: true

顧客対応の一意の識別子。
InteractionNumber: string

タイトル: Interaction Number

最大長: 30

顧客対応の代替キー識別子。
InteractionParticipants: array Interaction Participants

タイトル: Interaction Participants

顧客対応関係者リソースは、顧客対応(通常はweb会議)の関係者を表示、作成および更新するために使用されます。
interactionReferences: array Interaction References

タイトル: Interaction References

顧客対応参照リソースは、顧客対応と別のビジネス・オブジェクト(サービス・リクエストなど)間の関連を表示、作成および更新するために使用されます。サポートされるビジネス・オブジェクトとそのコードは、アクティビティ(ZMM_ACTIVITIES)、商談(MOO_OPTY)、作業オーダー(SVC_WORK_ORDERS)、サービス・リクエスト(SVC_SERVICE_REQUESTS)およびリード(MKL_LM_LEADS)です。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

顧客対応が最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

顧客対応を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

顧客対応を最後に更新したユーザーのセッション・ログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ManuallyLoggedFlag: boolean

最大長: 1

顧客対応が手動で作成されたかどうかを示します。手動で作成された値はY、それ以外の場合はNです。
MarketingReferenceId: integer (int64)

タイトル: Marketing Reference ID

マーケティング・システム・デプロイメント番号への参照を格納するために使用される一意の識別子。
MediaItemId: string

タイトル: Media Item ID

最大長: 80

メディア・アイテムの一意の識別子。
OriginalSystemReference: string

タイトル: Original System

最大長: 255

顧客対応で使用されるシステム参照。
OwnerResourceId: integer (int64)

タイトル: Owner Resource ID

顧客対応の所有者の一意の識別子。
OwnerResourcePartyNumber: string

タイトル: Resource Number

読取り専用: true

最大長: 30

顧客対応の所有者の代替キー識別子。
OwnerResourcePartyUniqueName: string

タイトル: Resource Name

読取り専用: true

最大長: 900

顧客対応の所有者の一意の名前。
ParentInteractionId: integer (int64)

タイトル: Parent Interaction ID

親顧客対応の一意の識別子。
ParentInteractionNumber: string

タイトル: Interaction Number

読取り専用: true

最大長: 30

親顧客対応の代替キー識別子。
ペイロード: 文字列(バイト)

タイトル: Payload

顧客対応に関連付けられたペイロード。
QueueId: integer (int64)

タイトル: Queue ID

インタラクション・キューの一意の識別子。
QueueName: string

タイトル: Queue Name

読取り専用: true

最大長: 400

インタラクション・キューの名前。
QueueNumber: string

タイトル: Queue Number

最大長: 30

キューの代替キー識別子。
SourceCd: string

タイトル: Source CD

最大長: 30

子顧客対応オブジェクト内にソース・コード参照を格納するために使用される一意の識別子。
StartInteractionFlag: boolean

タイトル: Start Interaction

デフォルト値: true

顧客対応がすでに開始されている場合に開始する必要があるかどうかを示します。デフォルト値はTrueです。
StartTime: string (date-time)

タイトル: Start Time

顧客対応が開始した時間。
StatusCd: string

タイトル: Status

最大長: 30

デフォルト値: ORA_SVC_OPEN

顧客対応の現在のステータスを示すコード。有効な値のリストは、参照ORA_SVC_IM_STATUS_CDで定義されます。
StripeCd: string

タイトル: Stripe Code

最大長: 30

顧客対応のストライプを示すコード。有効な値のリストは、参照ORA_SVC_STRIPE_CDで定義されます。
SubstatusCd: string

タイトル: Substatus Code

最大長: 30

顧客対応のサブステータスを示すコード。有効な値のリストは、参照ORA_SVC_IM_CLOSED_SUBSTATUS_CDで定義されます。
TopLevelFlag: boolean

タイトル: Top Level

読取り専用: true

顧客対応がトップ・レベルかどうかを示します。親顧客対応識別子が顧客対応識別子と同じ場合、顧客対応は最上位レベルです。
UpdateFlag: boolean

読取り専用: true

顧客対応を現在のユーザーが更新できるかどうかを示します。ユーザーが顧客対応を更新するためのアクセス権を持っている場合、デフォルト値はtrueです。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the interaction was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the child interaction.",
            "nullable":true,
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The time when the interaction ended.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DirectionCd":{
            "title":"Direction",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating whether the interaction is inbound or outbound. The default value is ORA_SVC_INBOUND, indicating inbound interactions. The value is ORA_SVC_OUTBOUND for outbound interactions.",
            "nullable":false,
            "default":"ORA_SVC_INBOUND",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InteractionParticipants":{
            "title":"Interaction Participants",
            "type":"array",
            "description":"The interaction participant resource is used to view, create, and update participants in an interaction, usually a web conference.",
            "items":{
                "$ref":"#/components/schemas/interactions-InteractionParticipants-item-response"
            }
        },
        "ChannelDisplayName":{
            "title":"Channel Display Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the interaction channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MediaItemId":{
            "title":"Media Item ID",
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier for the media item.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountPartyUniqueName":{
            "title":"Account",
            "maxLength":900,
            "type":"string",
            "description":"The unique account name of the account associated with the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartInteractionFlag":{
            "title":"Start Interaction",
            "type":"boolean",
            "description":"Indicates if the interaction should be started if it hasn???t already been started. The default value is True.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the interaction channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ChannelTypeCd"
                ]
            },
            "x-queryable":true
        },
        "OwnerResourcePartyNumber":{
            "title":"Resource Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the owner of the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCd":{
            "title":"Source CD",
            "maxLength":30,
            "type":"string",
            "description":"A unique identifier used to store a source code reference within the child interaction object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "interactionReferences":{
            "title":"Interaction References",
            "type":"array",
            "description":"The interaction references resource is used to view, create, and update the association between an interaction and another business object, for example Service Requests. The supported business objects and their codes are Activities (ZMM_ACTIVITIES), Opportunities (MOO_OPTY), Work Orders (SVC_WORK_ORDERS), Service Requests (SVC_SERVICE_REQUESTS), and Leads (MKL_LM_LEADS).",
            "items":{
                "$ref":"#/components/schemas/interactions-interactionReferences-item-response"
            }
        },
        "AccountPartyNumber":{
            "title":"Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key for the account identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionNumber":{
            "title":"Interaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the interaction.",
            "nullable":false,
            "x-queryable":true
        },
        "SubstatusCd":{
            "title":"Substatus Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the sub-status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_CLOSED_SUBSTATUS_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TopLevelFlag":{
            "title":"Top Level",
            "type":"boolean",
            "description":"Indicates whether an interaction is top level or not. An interaction is top level if the parent interaction identifier is the same as the interaction identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the interaction can be updated by the current user. The default value is true if the user has access to update the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerResourcePartyUniqueName":{
            "title":"Resource Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique name of the owner of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccountPartyId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account associated with the interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerResourceId":{
            "title":"Owner Resource ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact associated with the interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QueueName":{
            "title":"Queue Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the interaction queue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManuallyLoggedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the interaction was manually created. If manually created, the value is Y, else the value is N.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgentHTTPSessionId":{
            "title":"Session ID",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier for the http session.",
            "nullable":true,
            "x-queryable":true
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the interaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the current status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_STATUS_CD.",
            "nullable":false,
            "default":"ORA_SVC_OPEN",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":255,
            "type":"string",
            "description":"The system reference used by the interaction.",
            "nullable":true,
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The time when the interaction started.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StartInteractionFlag"
                ]
            },
            "x-queryable":true
        },
        "QueueId":{
            "title":"Queue ID",
            "type":"integer",
            "description":"The unique identifier of the interaction queue.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentInteractionNumber":{
            "title":"Interaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the parent interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndInteractionFlag":{
            "title":"End Interaction",
            "type":"boolean",
            "description":"This will set the Endtime attribute  ( to the current time) without changing the interaction status to closed. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPartyUniqueName":{
            "title":"Contact",
            "maxLength":900,
            "type":"string",
            "description":"The unique contact name of the contact associated with the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the interaction can be deleted by the current user. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the contact party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentInteractionId":{
            "title":"Parent Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the parent interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QueueNumber":{
            "title":"Queue Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the queue.",
            "nullable":false,
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the stripe of the interaction. A list of valid values is defined in the lookup ORA_SVC_STRIPE_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "childInteractions":{
            "title":"Child Interactions",
            "type":"array",
            "description":"The child interaction resource is used to view, create, and update all the child interactions associated with the current interaction.",
            "items":{
                "$ref":"#/components/schemas/interactions-childInteractions-item-response"
            }
        },
        "Payload":{
            "title":"Payload",
            "type":"string",
            "description":"The payload associated with the interaction.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ChannelShortName":{
            "title":"Channel Code",
            "maxLength":450,
            "type":"string",
            "description":"The interaction channel short name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MarketingReferenceId":{
            "title":"Marketing Reference ID",
            "type":"integer",
            "description":"A unique identifier used to store a reference to a marketing system deployment number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the interaction channel.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the interaction was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 子顧客対応

タイプ: array

タイトル: Child Interactions

子顧客対応リソースは、現在の顧客対応に関連付けられているすべての子顧客対応を表示、作成および更新するために使用されます。

ソースを表示

Array of: object interactions-childInteractions-item-response

{
    "title":"Child Interactions",
    "type":"array",
    "description":"The child interaction resource is used to view, create, and update all the child interactions associated with the current interaction.",
    "items":{
        "$ref":"#/components/schemas/interactions-childInteractions-item-response"
    }
}

ネストされたスキーマ : 顧客対応関係者

タイプ: array

タイトル: Interaction Participants

顧客対応関係者リソースは、顧客対応(通常はweb会議)の関係者を表示、作成および更新するために使用されます。

ソースを表示

Array of: object interactions-InteractionParticipants-item-response

{
    "title":"Interaction Participants",
    "type":"array",
    "description":"The interaction participant resource is used to view, create, and update participants in an interaction, usually a web conference.",
    "items":{
        "$ref":"#/components/schemas/interactions-InteractionParticipants-item-response"
    }
}

ネストされたスキーマ : 顧客対応参照

タイプ: array

タイトル: Interaction References

顧客対応参照リソースは、顧客対応と別のビジネス・オブジェクト(サービス・リクエストなど)間の関連を表示、作成および更新するために使用されます。サポートされるビジネス・オブジェクトとそのコードは、アクティビティ(ZMM_ACTIVITIES)、商談(MOO_OPTY)、作業オーダー(SVC_WORK_ORDERS)、サービス・リクエスト(SVC_SERVICE_REQUESTS)およびリード(MKL_LM_LEADS)です。

ソースを表示

Array of: object interactions-interactionReferences-item-response

{
    "title":"Interaction References",
    "type":"array",
    "description":"The interaction references resource is used to view, create, and update the association between an interaction and another business object, for example Service Requests. The supported business objects and their codes are Activities (ZMM_ACTIVITIES), Opportunities (MOO_OPTY), Work Orders (SVC_WORK_ORDERS), Service Requests (SVC_SERVICE_REQUESTS), and Leads (MKL_LM_LEADS).",
    "items":{
        "$ref":"#/components/schemas/interactions-interactionReferences-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : interactions-childInteractions-item-response

タイプ: object

ソースを表示

AccountPartyId: integer (int64)

タイトル: Account ID

顧客対応に関連付けられたアカウントの一意の識別子。
AccountPartyNumber: string

タイトル: Account Number

読取り専用: true

最大長: 30

勘定科目識別子の代替キー。
AccountPartyUniqueName: string

タイトル: Account

読取り専用: true

最大長: 900

顧客対応に関連付けられているアカウントの一意のアカウント名。
AgentHTTPSessionId: string

タイトル: Session ID

最大長: 100

HTTPセッションの一意の識別子。
ChannelDisplayName: string

タイトル: Channel Display Name

読取り専用: true

最大長: 400

相互作用チャネルの名前。
ChannelId: integer (int64)

タイトル: Channel ID

インタラクション・チャネルの一意の識別子。
ChannelShortName: string

タイトル: Channel Code

読取り専用: true

最大長: 450

インタラクション・チャネルの短縮名。
ChannelTypeCd: string

タイトル: Channel Type

最大長: 30

相互作用チャネルのタイプを示すコード。
ContactPartyId: integer (int64)

タイトル: Contact ID

顧客対応に関連付けられている担当者の一意の識別子。
ContactPartyNumber: string

タイトル: Contact Number

読取り専用: true

最大長: 30

担当者パーティの代替キー識別子。
ContactPartyUniqueName: string

タイトル: Contact

読取り専用: true

最大長: 900

顧客対応に関連付けられている担当者の一意の担当者名。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

顧客対応を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

顧客対応が作成された日時。
DeleteFlag: boolean

読取り専用: true

顧客対応を現在のユーザーが削除できるかどうかを示します。デフォルト値はfalseです。
Description: string

タイトル: Description

最大長: 1000

子顧客対応の摘要。
DirectionCd: string

タイトル: Direction

最大長: 30

デフォルト値: ORA_SVC_INBOUND

顧客対応がインバウンドかアウトバウンドかを示すコード。デフォルト値はORA_SVC_INBOUNDで、インバウンド相互作用を示します。値は、アウトバウンド・インタラクションのORA_SVC_OUTBOUNDです。
EndInteractionFlag: boolean

タイトル: End Interaction

これにより、顧客対応ステータスをクローズ済に変更せずに、終了時間属性(現在の時間)が設定されます。デフォルト値はfalseです。
EndTime: string (date-time)

タイトル: End Time

顧客対応が終了した時間。
InteractionId: integer (int64)

タイトル: Interaction ID

読取り専用: true

顧客対応の一意の識別子。
InteractionNumber: string

タイトル: Interaction Number

最大長: 30

顧客対応の代替キー識別子。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

顧客対応が最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

顧客対応を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

顧客対応を最後に更新したユーザーのセッション・ログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ManuallyLoggedFlag: boolean

最大長: 1

顧客対応が手動で作成されたかどうかを示します。手動で作成された値はY、それ以外の場合はNです。
MarketingReferenceId: integer (int64)

タイトル: Marketing Reference ID

マーケティング・システム・デプロイメント番号への参照を格納するために使用される一意の識別子。
MediaItemId: string

タイトル: Media Item ID

最大長: 80

メディア・アイテムの一意の識別子。
OriginalSystemReference: string

タイトル: Original System

最大長: 255

顧客対応で使用されるシステム参照。
OwnerResourceId: integer (int64)

タイトル: Owner Resource ID

顧客対応の所有者の一意の識別子。
OwnerResourcePartyNumber: string

タイトル: Resource Number

読取り専用: true

最大長: 30

顧客対応の所有者の代替キー識別子。
OwnerResourcePartyUniqueName: string

タイトル: Resource Name

読取り専用: true

最大長: 900

顧客対応の所有者の一意の名前。
ParentInteractionId: integer (int64)

タイトル: Parent Interaction ID

親顧客対応の一意の識別子。
ParentInteractionNumber: string

タイトル: Interaction Number

読取り専用: true

最大長: 30

親顧客対応の代替キー識別子。
ペイロード: 文字列(バイト)

タイトル: Payload

顧客対応に関連付けられたペイロード。
QueueId: integer (int64)

タイトル: Queue ID

インタラクション・キューの一意の識別子。
QueueName: string

タイトル: Queue Name

読取り専用: true

最大長: 400

インタラクション・キューの名前。
QueueNumber: string

タイトル: Queue Number

最大長: 30

キューの代替キー識別子。
SourceCd: string

タイトル: Source CD

最大長: 30

子顧客対応オブジェクト内にソース・コード参照を格納するために使用される一意の識別子。
StartInteractionFlag: boolean

タイトル: Start Interaction

デフォルト値: true

顧客対応がすでに開始されている場合に開始する必要があるかどうかを示します。デフォルト値はTrueです。
StartTime: string (date-time)

タイトル: Start Time

顧客対応が開始した時間。
StatusCd: string

タイトル: Status

最大長: 30

デフォルト値: ORA_SVC_OPEN

顧客対応の現在のステータスを示すコード。有効な値のリストは、参照ORA_SVC_IM_STATUS_CDで定義されます。
StripeCd: string

タイトル: Stripe Code

最大長: 30

顧客対応のストライプを示すコード。有効な値のリストは、参照ORA_SVC_STRIPE_CDで定義されます。
SubstatusCd: string

タイトル: Substatus Code

最大長: 30

顧客対応のサブステータスを示すコード。有効な値のリストは、参照ORA_SVC_IM_CLOSED_SUBSTATUS_CDで定義されます。
TopLevelFlag: boolean

タイトル: Top Level

読取り専用: true

顧客対応がトップ・レベルかどうかを示します。親顧客対応識別子が顧客対応識別子と同じ場合、顧客対応は最上位レベルです。
UpdateFlag: boolean

読取り専用: true

顧客対応を現在のユーザーが更新できるかどうかを示します。ユーザーが顧客対応を更新するためのアクセス権を持っている場合、デフォルト値はtrueです。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the interaction was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the child interaction.",
            "nullable":true,
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The time when the interaction ended.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DirectionCd":{
            "title":"Direction",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating whether the interaction is inbound or outbound. The default value is ORA_SVC_INBOUND, indicating inbound interactions. The value is ORA_SVC_OUTBOUND for outbound interactions.",
            "nullable":false,
            "default":"ORA_SVC_INBOUND",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChannelDisplayName":{
            "title":"Channel Display Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the interaction channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MediaItemId":{
            "title":"Media Item ID",
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier for the media item.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountPartyUniqueName":{
            "title":"Account",
            "maxLength":900,
            "type":"string",
            "description":"The unique account name of the account associated with the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartInteractionFlag":{
            "title":"Start Interaction",
            "type":"boolean",
            "description":"Indicates if the interaction should be started if it hasn???t already been started. The default value is True.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the interaction channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ChannelTypeCd"
                ]
            },
            "x-queryable":true
        },
        "OwnerResourcePartyNumber":{
            "title":"Resource Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the owner of the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCd":{
            "title":"Source CD",
            "maxLength":30,
            "type":"string",
            "description":"A unique identifier used to store a source code reference within the child interaction object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key for the account identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionNumber":{
            "title":"Interaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the interaction.",
            "nullable":false,
            "x-queryable":true
        },
        "SubstatusCd":{
            "title":"Substatus Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the sub-status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_CLOSED_SUBSTATUS_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TopLevelFlag":{
            "title":"Top Level",
            "type":"boolean",
            "description":"Indicates whether an interaction is top level or not. An interaction is top level if the parent interaction identifier is the same as the interaction identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the interaction can be updated by the current user. The default value is true if the user has access to update the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerResourcePartyUniqueName":{
            "title":"Resource Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique name of the owner of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccountPartyId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account associated with the interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerResourceId":{
            "title":"Owner Resource ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact associated with the interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QueueName":{
            "title":"Queue Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the interaction queue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManuallyLoggedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the interaction was manually created. If manually created, the value is Y, else the value is N.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgentHTTPSessionId":{
            "title":"Session ID",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier for the http session.",
            "nullable":true,
            "x-queryable":true
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the interaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the current status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_STATUS_CD.",
            "nullable":false,
            "default":"ORA_SVC_OPEN",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":255,
            "type":"string",
            "description":"The system reference used by the interaction.",
            "nullable":true,
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The time when the interaction started.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StartInteractionFlag"
                ]
            },
            "x-queryable":true
        },
        "QueueId":{
            "title":"Queue ID",
            "type":"integer",
            "description":"The unique identifier of the interaction queue.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentInteractionNumber":{
            "title":"Interaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the parent interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndInteractionFlag":{
            "title":"End Interaction",
            "type":"boolean",
            "description":"This will set the Endtime attribute  ( to the current time) without changing the interaction status to closed. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPartyUniqueName":{
            "title":"Contact",
            "maxLength":900,
            "type":"string",
            "description":"The unique contact name of the contact associated with the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the interaction can be deleted by the current user. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the contact party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentInteractionId":{
            "title":"Parent Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the parent interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QueueNumber":{
            "title":"Queue Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the queue.",
            "nullable":false,
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the stripe of the interaction. A list of valid values is defined in the lookup ORA_SVC_STRIPE_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Payload":{
            "title":"Payload",
            "type":"string",
            "description":"The payload associated with the interaction.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ChannelShortName":{
            "title":"Channel Code",
            "maxLength":450,
            "type":"string",
            "description":"The interaction channel short name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MarketingReferenceId":{
            "title":"Marketing Reference ID",
            "type":"integer",
            "description":"A unique identifier used to store a reference to a marketing system deployment number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the interaction channel.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the interaction was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : interactions-InteractionParticipants-item-response

タイプ: object

ソースを表示

ContactPartyId: integer (int64)

タイトル: Contact Party ID

参加者が担当者の場合は、担当者のPartyId。
ContactPartyNumber: string

タイトル: Contact Party Number

読取り専用: true

最大長: 30

参加者が担当者の場合は、担当者のパーティ番号。
ContactPartyUniqueName: string

タイトル: Contact Unique Name

読取り専用: true

最大長: 900

参加者が担当者の場合は、担当者の一意の名前。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

関係者を追加したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

参加者が追加された日付。
DurationMinutes: 整数(int32)

タイトル: Minutes

参加者が会議に参加していた分数。会議に参加、削除および参加できます。
Email: string

タイトル: Email

最大長: 128

参加者のEメール。
EndTime: string (date-time)

タイトル: End Time

参加者が顧客対応を終了した時間。
InteractionId: integer (int64)

タイトル: Interaction ID

参加者が属するインタラクションの顧客対応ID。
InteractionParticipantId: integer (int64)

タイトル: Participant ID

読取り専用: true

この参加者の自動生成された番号と主キー。
InteractionParticipantNumber: string

タイトル: Participant Number

最大長: 30

顧客対応関係者の公開一意識別子。
Json: 文字列(バイト)

タイトル: JSON

カスタマイズに使用されるJSON文字列。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

参加者が最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

参加者を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

参加者を更新する最後のユーザーのシステム・ログイン参照。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ObjectVersionNumber: 整数(int32)

タイトル: Object Version Number

参加者レコードのバージョン。
OriginalSystemReference: string

タイトル: Original System Reference

最大長: 255

レコードがインポートされた場合の元のシステム参照を指定します。
ParticipantName: string

タイトル: Name

最大長: 128

web会議からの名前。 Fusionデータと必ずしも結び付けられるわけではありません。
ParticipantTypeCd: string

タイトル: Participant Type Code

最大長: 30

参加者のタイプ。値は参照ORA_SVC_PARTICIPANT_TYPE_CDから取得されます。
Phone: string

タイトル: Phone

最大長: 128

参加者の電話番号。
ResourcePartyId: integer (int64)

タイトル: Resource Party ID

参加者がリソースの場合のリソースのパーティID。
ResourcePartyNumber: string

タイトル: Resource Party Number

読取り専用: true

最大長: 30

参加者がリソースであった場合のリソースのパーティ番号。
ResourcePartyUniqueName: string

タイトル: Resource Unique Name

読取り専用: true

最大長: 900

参加者がリソースであった場合のリソースの一意の名前。
StartTime: string (date-time)

タイトル: Start Time

参加者が顧客対応に参加した時間。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the participant was added.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Email":{
            "title":"Email",
            "maxLength":128,
            "type":"string",
            "description":"The email of the participant.",
            "nullable":true,
            "x-queryable":true
        },
        "InteractionParticipantId":{
            "title":"Participant ID",
            "type":"integer",
            "description":"The auto-generated number and primary key for this participant.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The time when the participant left the interaction.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Name",
            "maxLength":128,
            "type":"string",
            "description":"The name from the web conference. Does not necessarily tie to Fusion data.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantTypeCd":{
            "title":"Participant Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of participant. The value is sourced from the lookup ORA_SVC_PARTICIPANT_TYPE_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InteractionParticipantNumber":{
            "title":"Participant Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier for the Interaction Participant.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version of the participant record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Phone":{
            "title":"Phone",
            "maxLength":128,
            "type":"string",
            "description":"The phone number of the participant.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Resource Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The party number of the resource if the participant was a resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContactPartyId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"The PartyId of the contact if the participant is a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who added the participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The interaction id of the interaction to which the participant belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DurationMinutes":{
            "title":"Minutes",
            "type":"integer",
            "description":"The number of minutes the participant was on the conference. You can join, drop, and rejoin the conference.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System Reference",
            "maxLength":255,
            "type":"string",
            "description":"Specifies the original system reference if record was imported.",
            "nullable":true,
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The time when the participant joined the interaction.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Json":{
            "title":"JSON",
            "type":"string",
            "description":"The JSON String used for customization.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPartyUniqueName":{
            "title":"Contact Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique name of the contact if the participant was a contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Contact Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The party number of the contact if the participant was a contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourcePartyUniqueName":{
            "title":"Resource Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique name of the resource if the participant was a resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourcePartyId":{
            "title":"Resource Party ID",
            "type":"integer",
            "description":"The party Id of the resource if the participant is a resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the participant was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The system login reference of the last user to update the participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : interactions-interactionReferences-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

参照を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

参照が作成された日時。
DeleteFlag: boolean

読取り専用: true

顧客対応参照を現在のユーザーが削除できるかどうかを示します。デフォルト値はfalseです。
InteractionId: integer (int64)

タイトル: Interaction ID

顧客対応参照の一意の識別子。
InteractionNumber: string

タイトル: Interaction Number

最大長: 30

顧客対応の代替キー識別子。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

参照が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

参照を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

参照を最後に更新したユーザーのセッション・ログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ObjectId: integer (int64)

タイトル: Object ID

顧客対応参照に関連付けられたオブジェクトの一意の識別子。
ObjectNumber: string

タイトル: Reference Number

読取り専用: true

最大長: 255

顧客対応参照に関連付けられたオブジェクトの代替キー識別子。
ObjectTypeCd: string

タイトル: Object Type

最大長: 30

顧客対応参照に存在するオブジェクトのタイプを示すコード。有効な値のリストは、参照ORA_SVC_IM_REF_OBJECT_TYPE_CDで定義されます。
ReferenceId: integer (int64)

タイトル: Reference ID

読取り専用: true

外部システムとの統合に使用される一意の識別子。
UpdateFlag: boolean

読取り専用: true

顧客対応参照を現在のユーザーが更新できるかどうかを示します。ユーザーが顧客対応参照を更新するアクセス権を持っている場合、デフォルト値はtrueです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the reference was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the interaction reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectNumber":{
            "title":"Reference Number",
            "maxLength":255,
            "type":"string",
            "description":"The alternate key identifier of the object associated with the interaction reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated with the interaction reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the interaction reference can be deleted by the current user. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InteractionNumber":{
            "title":"Interaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the interaction.",
            "nullable":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the interaction reference can be updated by the current user. The default value is true if the user has access to update the interaction reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReferenceId":{
            "title":"Reference ID",
            "type":"integer",
            "description":"The unique identifier used for integration with external systems.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the object present in the interaction reference. A list of valid values is defined in the lookup ORA_SVC_IM_REF_OBJECT_TYPE_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the reference was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

リンク

ChannelIdByChannelType

操作: /crmRestApi/resources/11.13.18.05/channels

パラメータ:

ファインダ: DefaultChannelByTypeFinder%3BChannelTypeCd%3D{ChannelTypeCd}

チャネル・タイプを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: ChannelTypeCd;ターゲット属性: ChannelTypeCd
表示属性: ChannelTypeCd

DirectionCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_IM_DIRECTION_CD

相互作用の方向を示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: DirectionCd;ターゲット属性: LookupCode
表示属性: 意味

InteractionParticipants

操作: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants

パラメータ:

InteractionId: $request.path.InteractionId

顧客対応関係者リソースは、顧客対応(通常はweb会議)の関係者を表示、作成および更新するために使用されます。

SourceCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_INTERACT_SOURCE_CD

顧客対応ソースを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: SourceCd;ターゲット属性: LookupCode
表示属性: 意味

StatusCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_IM_STATUS_CD

顧客対応ステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: StatusCd;ターゲット属性: LookupCode
表示属性: 意味

StripeCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD

相互作用ストライプを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: StripeCd;ターゲット属性: LookupCode
表示属性: 意味

SubStatusCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_IM_CLOSED_SUBSTATUS_CD

顧客対応サブステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: SubstatusCd;ターゲット属性: LookupCode
表示属性: 意味

YesNoLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DYES_NO

顧客対応が手動で作成されたかどうかを示す値リスト(Y、Nなど)。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: ManuallyLoggedFlag;ターゲット属性: LookupCode
表示属性: 意味

childInteractions

操作: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions

パラメータ:

InteractionId: $request.path.InteractionId

子顧客対応リソースは、現在の顧客対応に関連付けられているすべての子顧客対応を表示、作成および更新するために使用されます。

interactionReferences

操作: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences

パラメータ:

InteractionId: $request.path.InteractionId

トップに戻る

例:

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

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

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

GET /crmRestApi/resources/11.13.18.05/interactions/300100096307925

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

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

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形式のレスポンス本文の例を示します。

{
  "InteractionId" : 300100096307925,
  "ParentInteractionId" : 300100096307925,
  "TopLevelFlag" : "true",
  "Description" : "Sent SrMessage 300100096307628",
  "ChannelId" : 300100092273686,
  "ChannelDisplayName" : "ditdevacisvcfib_qa.extservice.incoming",
  "ChannelTypeCd" : "ORA_SVC_EMAIL",
  "AccountPartyId" : null,
  "AccountPartyUniqueName" : null,
  "ContactPartyId" : null,
  "ContactPartyUniqueName" : null,
  "QueueId" : null,
  "QueueName" : null,
  "OwnerResourceId" : null,
  "OwnerResourcePartyUniqueName" : null,
  "StartTime" : "2017-02-20T04:09:17-08:00",
  "EndTime" : "2017-02-20T04:09:17-08:00",
  "StatusCd" : "ORA_SVC_CLOSED",
  "OriginalSystemReference" : null,
  "CreatedBy" : "FUSION_APPS_CRM_ESS_APPID",
  "CreationDate" : "2017-02-20T04:09:17-08:00",
  "LastUpdatedBy" : "FUSION_APPS_CRM_ESS_APPID",
  "LastUpdateDate" : "2017-02-20T04:09:17-08:00",
  "LastUpdateLogin" : "48F584F941357435E05307B3F20AB8E8",
  "DirectionCd" : "ORA_SVC_OUTBOUND",
  "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",
    "name" : "interactions",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
    }
  }, {
    "rel" : "canonical",
    "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/lov/DirectionCdLookup",
    "name" : "DirectionCdLookup",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/lov/StatusCdLookup",
    "name" : "StatusCdLookup",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/lov/ChannelIdByChannelType",
    "name" : "ChannelIdByChannelType",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions",
    "name" : "childInteractions",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences",
    "name" : "interactionReferences",
    "kind" : "collection"
  }, {
    "rel" : "enclosure",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/enclosure/Payload",
    "name" : "Payload",
    "kind" : "other"
  } ]
}

「トップに戻る」