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

機械翻訳について

サービス・リクエスト・インタラクションの取得

get

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srInteractionReferences/{ReferenceId}

リクエスト

パス・パラメータ

ReferenceId(required): integer(int64)

サービス・リクエスト顧客対応参照の一意の識別子。
SrNumber(required): string

サービス・リクエストの識別に使用される一意の番号。サービス・リクエスト番号は、組織の要件に最適な形式に構成できます。たとえば、サービス・リクエストには、要件に応じて、サービスrequest0000012345、サービスrequest_000_12345、12345_00_serviceリクエストなどのフォーマットを設定できます。

問合せパラメータ

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のデフォルト・バージョンを選択します。

ルート・スキーマ : serviceRequests-srInteractionReferences-item-response

タイプ: object

ソースを表示

AccountPartyId: integer (int64)

タイトル: Account ID

読取り専用: true

顧客対応アカウントの一意の識別子。
AccountPartyUniqueName: string

タイトル: Account

読取り専用: true

最大長: 900

顧客対応アカウントの名前。
ChannelDisplayName: string

タイトル: Display Name

読取り専用: true

最大長: 400

表示チャネルの名前。
ChannelId: integer (int64)

タイトル: Channel ID

読取り専用: true

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

タイトル: Channel Type

読取り専用: true

最大長: 30

チャネル・タイプを示すコード。たとえば、電子メール、電話、ソーシャルなどです。受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。
ContactPartyId: integer (int64)

タイトル: Contact ID

読取り専用: true

顧客対応担当者の一意の識別子。
ContactPartyUniqueName: string

タイトル: Contact

読取り専用: true

最大長: 900

顧客対応担当者の名前。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

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

タイトル: Can Delete

読取り専用: true

顧客対応参照が削除されたかどうかを示します。
Description: string

タイトル: Description

読取り専用: true

最大長: 1000

顧客対応の簡単な説明。
DirectionCd: string

タイトル: Direction

読取り専用: true

最大長: 30

デフォルト値: ORA_SVC_INBOUND

顧客対応がインバウンドかアウトバウンドかを示すコード。
EndTime: string (date-time)

タイトル: End Time

読取り専用: true

顧客対応が終了する日時。
InteractionId: integer (int64)

タイトル: Interaction ID

読取り専用: true

顧客対応の一意の識別子。
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

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

タイトル: Original System

読取り専用: true

最大長: 255

インポートされた顧客対応の元の参照システム。
OwnerResourceId: integer (int64)

タイトル: Owner Resource ID

読取り専用: true

顧客対応を所有するエージェントの一意の識別子。
OwnerResourcePartyUniqueName: string

タイトル: Resource Name

読取り専用: true

最大長: 900

サービス・エージェントなど、顧客対応に関連付けられた内部顧客対応所有者であるリソースの名前。
ParentInteractionId: integer (int64)

タイトル: Parent Interaction ID

読取り専用: true

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

タイトル: Payload

読取り専用: true

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

タイトル: Queue ID

読取り専用: true

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

タイトル: Name

読取り専用: true

最大長: 400

インタラクション・キューの名前。
ReferenceId: integer (int64)

タイトル: Reference ID

読取り専用: true

サービス・リクエスト顧客対応参照の一意の識別子。
StartTime: string (date-time)

タイトル: Start Time

読取り専用: true

顧客対応が開始する日時。
StatusCd: string

タイトル: Status

読取り専用: true

最大長: 30

デフォルト値: ORA_SVC_OPEN

顧客対応のステータスを示すコード。受け入れられる値のリストは、参照ORA_SVC_IM_STATUS_CDで定義されます。
StripeCd: string

タイトル: Stripe Code

読取り専用: true

最大長: 30

インタラクションのアプリケーション・ストライプ。
TopLevelFlag: boolean

タイトル: Top Level

読取り専用: true

顧客対応が階層の最上位レベルの顧客対応であるかどうかを示します。
UpdateFlag: boolean

タイトル: Can Update

読取り専用: 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":"A brief description of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The date and time when the interaction ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DirectionCd":{
            "title":"Direction",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating whether the interaction is inbound or outbound.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_INBOUND",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChannelDisplayName":{
            "title":"Display Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the display channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountPartyUniqueName":{
            "title":"Account",
            "maxLength":900,
            "type":"string",
            "description":"The name of the interaction account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the interaction channel.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TopLevelFlag":{
            "title":"Top Level",
            "type":"boolean",
            "description":"Indicates if the interaction is the top level interaction in the hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the interaction reference has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "ExtnMassUpdateable":"false"
            }
        },
        "ReferenceId":{
            "title":"Reference ID",
            "type":"integer",
            "description":"The unique identifier of the service request interaction reference.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OwnerResourcePartyUniqueName":{
            "title":"Resource Name",
            "maxLength":900,
            "type":"string",
            "description":"The name of the resource who is an internal interaction owner associated with the interaction, such as a service agent.",
            "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 interaction account.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerResourceId":{
            "title":"Owner Resource ID",
            "type":"integer",
            "description":"The unique identifier of the agent who owns the interaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the interaction contact.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QueueName":{
            "title":"Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the interaction queue.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the interaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "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 status of the interaction. A list of accepted values is defined in the lookup ORA_SVC_IM_STATUS_CD.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_OPEN",
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":255,
            "type":"string",
            "description":"The original system of reference for an interaction that was imported.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The date and time when the interaction starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QueueId":{
            "title":"Queue ID",
            "type":"integer",
            "description":"The unique identifier of the interaction queue.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactPartyUniqueName":{
            "title":"Contact",
            "maxLength":900,
            "type":"string",
            "description":"The name of the interaction contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the interaction reference has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "ExtnMassUpdateable":"false"
            }
        },
        "ParentInteractionId":{
            "title":"Parent Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the parent interaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The application stripe of the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Payload":{
            "title":"Payload",
            "type":"string",
            "description":"The payload associated with the interaction.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time 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 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."
        }
    }
}

リンク

ChannelTypeCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

Eメール、電話、ソーシャルなどのチャネル・タイプの値リスト。

DirectionCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

顧客対応の方向の値リスト(インバウンドまたはアウトバウンド)。

トップに戻る

例:

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

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

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

GET crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951/child/srInteractionReferences/300100103890826
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

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

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

HTTP/1.1 200 OK
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

次の例は、レスポンス本文の内容を示しています。

{
  "ReferenceId": 300100103890826,
  "InteractionId": 300100103890825,
  "ParentInteractionId": 300100103890825,
  "TopLevelFlag": "true",
  "Description": "Sent SrMessage 300100097060036",
  "ChannelId": 2,
  "ChannelDisplayName": "E-Mail (Seeded)",
  "ChannelTypeCd": "ORA_SVC_EMAIL",
  "AccountPartyId": null,
  "AccountPartyUniqueName": null,
  "ContactPartyId": 5266,
  "ContactPartyUniqueName": "Brian Adams ",
  "QueueId": null,
  "QueueName": null,
  "OwnerResourceId": 100010025532672,
  "OwnerResourcePartyUniqueName": "Gabrielle   Lee",
  "StartTime": "2017-04-10T18:01:25+00:00",
  "EndTime": "2017-04-10T17:59:40.701+00:00",
  "StatusCd": "ORA_SVC_CLOSED",
  "OriginalSystemReference": null,
  "CreatedBy": "SALES_ADMIN",
  "CreationDate": "2017-04-10T18:01:25+00:00",
  "LastUpdatedBy": "SALES_ADMIN",
  "LastUpdateDate": "2017-04-10T18:01:26.022+00:00",
  "LastUpdateLogin": "4CD4AA2920F63908E05356C0F20AD4D2",
  "DirectionCd": "ORA_SVC_OUTBOUND",
  "StripeCd": "ORA_SVC_CRM",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951/child/srInteractionReferences/300100103890826",
      "name": "srInteractionReferences",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951/child/srInteractionReferences/300100103890826",
      "name": "srInteractionReferences",
      "kind": "item"
    },
    {
      "rel": "parent",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951",
      "name": "serviceRequests",
      "kind": "item"
    },
    {
      "rel": "enclosure",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951/child/srInteractionReferences/300100103890826/enclosure/Payload",
      "name": "Payload",
      "kind": "other"
    }
  ]
}

「トップに戻る」