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

機械翻訳について

すべてのチャネル・コミュニケーションを取得

get

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/channelCommunication

リクエスト

パス・パラメータ

MessageId(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
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

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

使用可能なファインダ名および対応するファインダ変数を次に示します:
- PrimaryKey : IDを使用してサービス・リクエスト・メッセージ・チャネル通信を検索します。
  ファインダ変数:
  - ViaId; integer; ファインダ・サービスにパラメータとして渡されたIDを介したサービス・リクエスト・メッセージ・チャネル通信。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

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

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

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

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

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

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- ChannelAccountName; string; チャネルに関連付けられたアカウント名。たとえば、電子メールの場合、アカウント名は、support@abc.comなどのサポート用のインバウンド・メールボックスになります。
- ChannelDisplayName; string;チャネルの表示名。
- ChannelId; integer;チャネルの一意の識別子。
- ChannelShortName; string;チャネルの公開一意識別子。
- ChannelTypeCd; string; チャネル・タイプを示すコード。たとえば、電子メール、電話、ソーシャルなどです。受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。
- CollabId; string;対応するネットワークのコラボレーション・ネットワーク・ユーザーの一意の識別子。この例として、ユーザーのユーザーIDが不足しています。
- CollabName; string;コラボレーション・ネットワーク上の外部ユーザーのユーザー名。
- CollabResourceId; integer; 内部ユーザーが通信しているコラボレーション・ネットワーク・ユーザーの一意の識別子。
- ContactPointId; integer;通信している担当者の担当者レコードの一意の識別子。担当者は、特定の通信チャネルに対する担当者の識別子です。たとえば、Eメール・チャネルの担当者はEメール・アドレスで、Twitterの個人の担当者はTwitterハンドルです。
- CreatedBy; string;通信チャネルを作成したユーザー。
- CreationDate; string;通信チャネルが作成された日時。
- InboundObjectId; integer; サービス・リクエスト・メッセージを作成したインバウンド・オブジェクトの一意の識別子。
- LastUpdateDate; string;通信チャネルが最後に更新された日時。
- LastUpdateLogin; string;通信チャネルを最後に更新したユーザーに関連付けられたセッション・ログイン。
- LastUpdatedBy; string; 通信チャネルを最後に更新したユーザー。
- MessageNumber; string; サービス・リクエスト・メッセージの公開一意識別子。
- NetworkTypeCd; string; ポストのソーシャル・ネットワークを示すコード。たとえば、Facebook、Twitterです。受け入れられる値のリストは、参照HZ_INSTANT_MESSENGER_TYPEで定義されます。
- ObjectId; integer;オブジェクトの一意の識別子。オブジェクト・タイプに応じて、チャネル通信に関連付けられているサービス・リクエストIDまたはサービス・リクエスト・メッセージIDを示します。
- ObjectTypeCd; string; チャネル通信レコードがサービス・リクエストに関連付けられているか、サービス・リクエスト・メッセージに関連付けられているかを示すコード。受け入れられる値のリストは、参照ORA_SVC_CHANNEL_OBJECT_TYPE_CDで定義されます。
- PartyId; integer;通信している個人の一意のパーティ識別子。
- PartyName; string;通信している個人のパーティ名。ユーザーには、内部リソースまたは顧客担当者を指定できます。
- PartyNumber; string; サービス・リクエスト・メッセージに関連付けられている担当者の公開一意識別子。
- PartyViaEndPoint; string; Party_ID所有者との通信に使用されるエンドポイント。たとえば、Eメール・アドレスや電話番号などです。 Party_IDがNULLで、PartyViaEndPointがNULLでない場合、エンドポイントはアドホック・パーティに属します。
- PostIdentifier; string; サービス・リクエストまたはサービス・リクエスト・メッセージの作成に使用されたソーシャル・メディア投稿レコードの一意の識別子。
- ResourceId; integer; サービス・リクエストに関連付けられたリソースの一意の識別子。これは、内部ユーザーが通信しているコラボレーション・ネットワーク・ユーザーを識別できる外部キーです。
- ResourceTypeCd; string; USER、PUBLIC_CHANNEL、PRIVATE_CHANNELなどのコラボレイティブ・ネットワーク・ユーザーのタイプを示すコード。受け入れられる値のリストは、参照ORA_SVC_COLLAB_RES_TYPE_CDで定義されます。
- RoutingCd; string; メッセージがエンドポイントを経由してルーティングされた方法を示すコード。たとえば、エンドポイントが電子メール・アドレスである場合、受信者がTO、CCまたはBCC受信者のいずれであるかがフィールドに表示されます。受け入れられる値のリストは、参照ORA_SVC_CHANNEL_ROUTING_CDで定義されます。
- ViaId; integer;チャネル通信の一意の識別子。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

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-messages-channelCommunication

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

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

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-messages-channelCommunication-item-response"
            }
        }
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object serviceRequests-messages-channelCommunication-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-messages-channelCommunication-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"
    }
}

ネストされたスキーマ : serviceRequests-messages-channelCommunication-item-response

タイプ: object

ソースを表示

ChannelAccountName: string

タイトル: Account Name

読取り専用: true

最大長: 400

チャネルに関連付けられたアカウント名。たとえば、電子メールの場合、アカウント名は、support@abc.comなどのサポート用のインバウンド・メールボックスになります。
ChannelDisplayName: string

タイトル: Display Name

最大長: 400

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

タイトル: Channel ID

チャネルの一意の識別子。
ChannelShortName: string

タイトル: Channel Short Name

最大長: 450

チャネルのパブリック一意識別子。
ChannelTypeCd: string

タイトル: Channel Type

読取り専用: true

最大長: 30

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

タイトル: Collaboration ID

読取り専用: true

最大長: 255

対応するネットワークのコラボレーション・ネットワーク・ユーザーの一意の識別子。この例として、ユーザーのユーザーIDが不足しています。
CollabName: string

タイトル: Resource Name

読取り専用: true

最大長: 400

コラボレーション・ネットワーク上の外部ユーザーのユーザー名です。
CollabResourceId: integer (int64)

タイトル: Collaboration Resource Identifier

内部ユーザーが通信しているコラボレーション・ネットワーク・ユーザーの一意の識別子。
ContactPointId: integer (int64)

タイトル: Contact Point ID

連絡中の担当者の担当者レコードの一意の識別子。担当者は、特定の通信チャネルに対する担当者の識別子です。たとえば、Eメール・チャネルの担当者はEメール・アドレスで、Twitterの個人の担当者はTwitterハンドルです。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

通信チャネルを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

通信チャネルが作成された日時。
InboundObjectId: integer (int64)

タイトル: Inbound Message Object Identifier

サービス・リクエスト・メッセージを作成したインバウンド・オブジェクトの一意の識別子。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

通信チャネルが最後に更新された日時。
LastUpdatedBy: string

タイトル: Updated By

読取り専用: true

最大長: 64

通信チャネルを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Update Login

読取り専用: true

最大長: 32

通信チャネルを最後に更新したユーザーに関連付けられたセッション・ログイン。
links: array Links

タイトル: Links

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

タイトル: Message Number

読取り専用: true

最大長: 30

サービス・リクエスト・メッセージの公開一意識別子。
NetworkTypeCd: string

タイトル: Network

読取り専用: true

最大長: 30

ポストのソーシャル・ネットワークを示すコード。たとえば、Facebook、Twitterです。受け入れられる値のリストは、参照HZ_INSTANT_MESSENGER_TYPEで定義されます。
ObjectId: integer (int64)

タイトル: Object ID

オブジェクトの一意の識別子。オブジェクト・タイプに応じて、チャネル通信に関連付けられているサービス・リクエストIDまたはサービス・リクエスト・メッセージIDを示します。
ObjectTypeCd: string

タイトル: Object Type

読取り専用: true

最大長: 30

デフォルト値: SVC_SR_MESSAGES

チャネル通信レコードがサービス・リクエストに関連付けられているか、サービス・リクエスト・メッセージに関連付けられているかを示すコード。受け入れられる値のリストは、参照ORA_SVC_CHANNEL_OBJECT_TYPE_CDで定義されます。
PartyId: integer (int64)

タイトル: Party ID

連絡中の個人の一意のパーティ識別子。
PartyName: string

タイトル: Party Name

読取り専用: true

最大長: 360

連絡中の個人のパーティ名。ユーザーには、内部リソースまたは顧客担当者を指定できます。
PartyNumber: string

タイトル: Party Number

読取り専用: true

最大長: 30

サービス・リクエスト・メッセージに関連付けられている担当者の公開一意識別子。
PartyViaEndPoint: string

タイトル: Party Endpoint

最大長: 1000

Party_ID所有者との通信に使用されるエンドポイント。たとえば、Eメール・アドレスや電話番号などです。 Party_IDがNULLで、PartyViaEndPointがNULLでない場合、エンドポイントはアドホック・パーティに属します。
PersonId: integer (int64)

タイトル: Person ID

サービス・リクエストの担当者である個人の一意の識別子。
PostIdentifier: string

タイトル: Post Identifier

最大長: 1000

サービス・リクエストまたはサービス・リクエスト・メッセージの作成に使用されたソーシャル・メディア・ポスト・レコードの一意の識別子。
ResourceId: integer (int64)

タイトル: Resource ID

読取り専用: true

サービス・リクエストに関連付けられたリソースの一意の識別子。これは、内部ユーザーが通信しているコラボレーション・ネットワーク・ユーザーを識別できる外部キーです。
ResourceTypeCd: string

タイトル: Resource Type

読取り専用: true

最大長: 30

USER、PUBLIC_CHANNEL、PRIVATE_CHANNELなど、コラボレイティブ・ネットワーク・ユーザーのタイプを示すコード。受け入れられる値のリストは、参照ORA_SVC_COLLAB_RES_TYPE_CDで定義されます。
RoutingCd: string

タイトル: Routing Code

最大長: 30

エンドポイントを介したメッセージのルーティング方法を示すコード。たとえば、エンドポイントが電子メール・アドレスである場合、受信者がTO、CCまたはBCC受信者のいずれであるかがフィールドに表示されます。受け入れられる値のリストは、参照ORA_SVC_CHANNEL_ROUTING_CDで定義されます。
ViaId: integer (int64)

タイトル: ID

読取り専用: true

チャネル通信の一意の識別子。

{
    "type":"object",
    "properties":{
        "ChannelAccountName":{
            "title":"Account Name",
            "maxLength":400,
            "type":"string",
            "description":"The account name associated with the channel. For example, for email, an account name would be the inbound mailbox for support like support@abc.com.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the communication channel was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NetworkTypeCd":{
            "title":"Network",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the service request message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ViaId":{
            "title":"ID",
            "type":"integer",
            "description":"The unique identifier of the channel communication.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CollabId":{
            "title":"Collaboration ID",
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the collaboration network user in the corresponding network. An example of this is the slack user Id. of a user.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelDisplayName":{
            "title":"Display Name",
            "maxLength":400,
            "type":"string",
            "description":"The display name of the channel.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":360,
            "type":"string",
            "description":"The party name of the person who is being communicated with. The user can be an internal resource or a customer contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CollabName":{
            "title":"Resource Name",
            "maxLength":400,
            "type":"string",
            "description":"The user name of the external user on the collaboration network.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceTypeCd":{
            "title":"Resource Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the collaborative network user, such as USER, PUBLIC_CHANNEL, or PRIVATE_CHANNEL. A list of accepted values is defined in the lookup ORA_SVC_COLLAB_RES_TYPE_CD.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoutingCd":{
            "title":"Routing Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_ROUTING_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactPointId":{
            "title":"Contact Point ID",
            "type":"integer",
            "description":"The unique identifier of the contact point record of the contact who is being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address and the contact point of a person for twitter would be the twitter handle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD.",
            "nullable":false,
            "readOnly":true,
            "default":"SVC_SR_MESSAGES",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "title":"Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the communication channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the communication channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object. Depending on the object type, indicates the service request id or the service request message id associated with the channel communication.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PostIdentifier":{
            "title":"Post Identifier",
            "maxLength":1000,
            "type":"string",
            "description":"The unique identifier of the social media post record that was used to create the service request or the service request message.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyViaEndPoint":{
            "title":"Party Endpoint",
            "maxLength":1000,
            "type":"string",
            "description":"The endpoint used to communicate with the Party_ID owner. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to an adhoc party.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"ChannelViaEO.PartyViaEndPoint",
                "protectionObjectTitle":"Party Endpoint",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Party Endpoint"
            },
            "x-queryable":true
        },
        "InboundObjectId":{
            "title":"Inbound Message Object Identifier",
            "type":"integer",
            "description":"The unique identifier of the inbound object that resulted in the creation of the service request message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the contact associated with the service request message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the person who is being communicated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identifier of the person who is a contact on the service request.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource associated with the service request. This is a foreign key that can identify the collaboration network user the internal users are communicating with.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CollabResourceId":{
            "title":"Collaboration Resource Identifier",
            "type":"integer",
            "description":"The unique identifier of the collaboration network user that the internal users are communicating with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChannelShortName":{
            "title":"Channel Short Name",
            "maxLength":450,
            "type":"string",
            "description":"The public unique identifier of the channel.",
            "nullable":false,
            "x-queryable":true
        },
        "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-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the communication channel was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the communication channel.",
            "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."
        }
    }
}

トップに戻る

例:

次の例は、RESTリソースに対してGETリクエストを発行して、すべてのチャネル通信を取得する方法を示しています。

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

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

GET /crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication HTTP/1.1
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

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

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

HTTP/1.1 200: OK
Date: Wed, 16 Nov 2016 14:07:22 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

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

{
"items": [
  
{
"ViaId": 300100093738732,
"ObjectTypeCd": "SVC_SR_MESSAGES",
"ObjectId": 300100092588985,
"ChannelId": 1,
"ChannelTypeCd": "ORA_SVC_WEB",
"ChannelAccountName": "Web",
"ChannelDisplayName": "Web-Updated",
"PartyViaEndPoint": null,
"PostIdentifier": null,
"RoutingCd": null,
"PartyId": null,
"PartyName": null,
"ContactPointId": null,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2016-11-16T05:52:27-08:00",
"LastUpdatedBy": "SALES_ADMIN",
"LastUpdateDate": "2016-11-16T05:52:27-08:00",
"LastUpdateLogin": "416A6650DC4C12CCE05307B3F20A5EFF",
"links": [
  
{
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication/300100093738732",
"name": "channelCommunication",
"kind": "item",
"properties": 
{
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
}
,
  
{
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication/300100093738732",
"name": "channelCommunication",
"kind": "item"
}
,
  
{
"rel": "parent",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985",
"name": "messages",
"kind": "item"
}
,
  
{
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication/300100093738732/lov/RoutingCdLookup",
"name": "RoutingCdLookup",
"kind": "collection"
}
,
  
{
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication/300100093738732/lov/ChannelLOV",
"name": "ChannelLOV",
"kind": "collection"
}
],
}
,
  
{
"ViaId": 300100093739406,
"ObjectTypeCd": "SVC_SR_MESSAGES",
"ObjectId": 300100092588985,
"ChannelId": 1,
"ChannelTypeCd": "ORA_SVC_WEB",
"ChannelAccountName": "Web",
"ChannelDisplayName": "Web-Updated",
"PartyViaEndPoint": null,
"PostIdentifier": null,
"RoutingCd": null,
"PartyId": null,
"PartyName": null,
"ContactPointId": null,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2016-11-16T06:05:27-08:00",
"LastUpdatedBy": "SALES_ADMIN",
"LastUpdateDate": "2016-11-16T06:05:27-08:00",
"LastUpdateLogin": "416A6650DC4C12CCE05307B3F20A5EFF",
"links": [
  
{
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication/300100093739406",
"name": "channelCommunication",
"kind": "item",
"properties": 
{
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
}
,
  
{
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication/300100093739406",
"name": "channelCommunication",
"kind": "item"
}
,
  
{
"rel": "parent",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985",
"name": "messages",
"kind": "item"
}
,
  
{
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication/300100093739406/lov/RoutingCdLookup",
"name": "RoutingCdLookup",
"kind": "collection"
}
,
  
{
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication/300100093739406/lov/ChannelLOV",
"name": "ChannelLOV",
"kind": "collection"
}
],
}
],
"count": 2,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
  
{
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication",
"name": "channelCommunication",
"kind": "collection"
}
],
}

「トップに戻る」