チャネルの取得
get
/crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/channels/{ChannelId}
リクエスト
パス・パラメータ
- BUOrgId(required): integer(int64)
ビジネス・ユニットの一意の識別子。
- ChannelId(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のデフォルト・バージョンを選択します。
ルート・スキーマ : serviceBusinessUnits-channels-item-response
タイプ:
ソースを表示
object-
AccessToken: string
タイトル:
Access Token最大長:400ソーシャル・チャネルに使用されるアクセス・トークン。 -
AccountName: string
タイトル:
Account Name最大長:400チャネルに関連付けられているアカウントの名前。 -
APIId: string
タイトル:
API最大長:400チャネルAPIの一意の識別子。 -
APIPassword: string
タイトル:
API Password最大長:400チャネルAPIのパスワード。 -
APIVersion: string
タイトル:
API Version最大長:400チャネルのAPIバージョン。 -
AuthenticationURL: string
タイトル:
Authentication URL最大長:1000チャネルを認証するためのURL。 -
AuthorizationURL: string
タイトル:
Authorization URL最大長:1000チャネルを認可するURL。 -
AuthToken: string
タイトル:
Authorization Token最大長:400ソーシャル・チャネルに使用される認可トークン。 -
BUOrgId: integer (int64)
タイトル:
Business Unit IDチャネルに関連付けられたビジネス・ユニットの一意の識別子。 -
BusinessUnitName: string
タイトル:
Business Unit Name最大長:255チャネルに関連付けられているビジネス・ユニットの名前。 -
ChannelId: integer (int64)
タイトル:
Channel読取り専用:trueチャネルの一意の識別子。 -
ChannelShortName: string
タイトル:
Channel Code最大長:450チャネルの短縮名。 -
ChannelTypeCd: string
タイトル:
Channel Type最大長:30通信チャネルのタイプを示すコード。 -
ChannelTypeCdLovSwitcher: string
読取り専用:
trueチャネル・タイプ値リスト・ピッカーの名前。 -
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:64チャネルを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date読取り専用:trueチャネルが作成された日付。 -
CustomerTypeCd: string
タイトル:
Customer Type最大長:30チャネルにメッセージを送信する必要がある顧客のタイプ(消費者、ビジネス、両方など)。 -
DeleteFlag: boolean
読取り専用:
trueチャネルが削除されたかどうかを示します。 -
DisplayName: string
タイトル:
Display Name最大長:400チャネルの表示名。 -
EnabledFlag: boolean
タイトル:
Active最大長:1デフォルト値:trueチャネルがアクティブかどうかを示します。 -
EndPoint: string
タイトル:
Endpoint最大長:1000チャネルのエンドポイント。 -
IncludeSenderEmailFlag: boolean
タイトル:
Include Sender Email最大長:1デフォルト値:false送信者のEメール・アドレスをアウトバウンド・メッセージに含める必要があるかどうかを示します。 -
IncludeSenderNameFlag: boolean
タイトル:
Include Sender Name最大長:1デフォルト値:false送信者の名前をアウトバウンド・メッセージに含める必要があるかどうかを示します。 -
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リソース・インスタンスに関連付けられたリンク関係。 -
MultipleMatchesActionCd: string
タイトル:
If Multiple Matches Found for Sender最大長:30選択なしや最初の一致の選択など、メッセージ送信者に対して複数の一致が見つかった場合にアプリケーションが実行する処理。 -
NetworkTypeCd: string
タイトル:
Network最大長:30ソーシャル・ネットワークのタイプを示すコード。 -
NoMatchActionCd: string
タイトル:
If No Matches Found for Sender最大長:30なしや担当者の作成など、メッセージ送信者に対して一致が見つからない場合にアプリケーションが実行する処理。 -
OpenSrCount: integer
読取り専用:
true削除もクローズもされていないサービス・リクエストの数。 -
OriginalSystemReference: string
タイトル:
Original System最大長:255インポートされたチャネルの元の参照システム。 -
Port: string
タイトル:
Port最大長:10チャネルに関連付けられたポート。 -
PrivatePToPAllowedFlag: boolean
タイトル:
Private Conversation Allowed最大長:1デフォルト値:trueチャネルでプライベート・メッセージを許可するかどうかを示します。 -
PurposeCd: string
タイトル:
Purpose最大長:30サポート、営業、照会などのチャネルの目的。 -
RefreshToken: string
タイトル:
Refresh Token最大長:400ソーシャル・チャネルに使用されるリフレッシュ・トークン。 -
SourceCd: string
タイトル:
Source Code最大長:30デフォルト値:ORA_SVC_ADMIN_UIチャネル作成のソース・インタフェース。 -
StripeCd: string
タイトル:
Stripe Code最大長:30チャネルのアプリケーション・ストライプを示すコード。 -
TokenAccessURL: string
タイトル:
Token Access URL最大長:1000チャネル・トークンにアクセスするためのURL。 -
TokenRequestURL: string
タイトル:
Token Request URL最大長:1000チャネルでトークン・リクエストを渡すURL。 -
UpdateFlag: boolean
読取り専用:
trueチャネルが更新されたかどうかを示します。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
リンク
- BusinessUnitLOV
-
ビジネス・ユニットの一意の識別子を含む値リスト。
- ChannelTypeCdLOV
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_CHANNEL_TYPE_CD
ORA_SVC_CHAT、ORA_SVC_EMAILなどのチャネル・タイプを示す値リスト。 - ファインダ:
- CustomerTypeCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_CUSTOMER_TYPE_CD
ORA_SVC_BUSINESS、ORA_SVC_CONSUMER、ORA_SVC_BOTHなど、チャネルに関連付けられた顧客タイプを示す値リスト。 - ファインダ:
- MultipleMatchesActionCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_MULT_MATCHES_ACTION_CD
メッセージの送信者に複数の一致が見つかった場合にアプリケーションが実行する処理を示す値リスト。 - ファインダ:
- NetworkTypeCdLOV
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DHZ_INSTANT_MESSENGER_TYPE
TWITTER、FACEBOOK、ORA_HZ_YOUTUBEなどのソーシャル・ネットワーク・タイプを示す値リスト。 - ファインダ:
- NoMatchActionCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_NO_MATCH_ACTION_CD
メッセージの送信者に一致が見つからない場合にアプリケーションが実行する処理を示す値リスト。 - ファインダ:
- PurposeCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_CHANNEL_PURPOSE
SUPPORT、SALESなどのチャネルを使用する目的を示す値リスト。 - ファインダ:
- SourceCdLOV
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_SOURCE_CD
管理者UIなど、チャネル作成のソースを示す値リスト。 - ファインダ:
- StripeCdLOV
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD
ORA_SVC_CRM、ORA_SVC_HRHD、ORA_SVC_ISRなど、アプリケーション・ストライプを示す値リスト。 - ファインダ:
- YesNoLOV
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DYES_NO
チャネルを使用してメッセージを送信するときにユーザーのEメールを含める必要があるかどうかを示す値リスト。 - ファインダ:
例:
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行してチャネルを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceBusinessUnits/204/child/channels/1
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{
"ChannelId": 1,
"ChannelTypeCd": "ORA_SVC_WEB",
"NetworkTypeCd": null,
"AccountName": "Web",
"DisplayName": "Web",
"PrivatePToPAllowedFlag": true,
"OriginalSystemReference": null,
"EnabledFlag": true,
"CreatedBy": "SEED_DATA_FROM_APPLICATION",
"CreationDate": "2015-07-09T10:14:09+00:00",
"LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
"LastUpdateDate": "2018-06-05T21:09:25.432+00:00",
"LastUpdateLogin": "-1",
"EndPoint": null,
"Port": null,
"APIVersion": null,
"APIId": null,
"APIPassword": null,
"AuthenticationURL": null,
"AuthorizationURL": null,
"TokenRequestURL": null,
"TokenAccessURL": null,
"AccessToken": null,
"RefreshToken": null,
"AuthToken": null,
"OpenSrCount": null,
"ChannelTypeCdLovSwitcher": "LOV_ChannelTypeCd",
"StripeCd": "ORA_SVC_CRM",
"BUOrgId": 204,
"BusinessUnitName": "Vision Operations",
"UpdateFlag": true,
"DeleteFlag": true,
"links": [
...
]
}