機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 値リスト
  4. サービス・ビジネス・ユニット
  5. チャネル

すべてのチャネルの取得

get

/crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/channels

リクエスト

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

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

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

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

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

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

    • ChannelEnabledFinder : すべてのアクティブなチャネルを検索します。
      ファインダ変数:
      • ChannelVOChannelShortNameAltKey : 指定された代替キーを持つチャネルを検索します。
        ファインダ変数:
        • ChannelShortName; string.
      • DefaultChannelByTypeFinder : 指定された代替キーを使用してチャネルを検索します。
        ファインダ変数:
        • AccountName; string;チャネルに関連付けられたアカウントの名前。
        • ChannelTypeCd; string;チャネルのタイプを示すコード。
      • EnabledChannelByBUAndStripeAndTypeFinder : アプリケーション・ストライプ、ビジネス・ユニットおよびチャネル・タイプの組合せに対して有効なチャネルを検索します。
        ファインダ変数:
        • BUOrgId; string;検索をフィルタするビジネス・ユニット。
        • ChannelTypeCd; string; 検索をフィルタするチャネル・タイプ。
        • StripeCd; string; 検索をフィルタ処理するアプリケーション・ストライプ。
      • PrimaryKey : 指定された主キーを使用してチャネルを検索します。
        ファインダ変数:
        • ChannelId; integer;チャネルの一意の識別子。
    • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
    • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

      例:
      self,canonical
    • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
    • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
    • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
    • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

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

      次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
      • APIId; string;チャネルAPIの一意の識別子。
      • APIPassword; string; チャネルAPIのパスワード。
      • APIVersion; string;チャネルのAPIバージョン。
      • AccessToken; string;ソーシャル・チャネルに使用されるアクセス・トークン。
      • AccountName; string;チャネルに関連付けられたアカウントの名前。
      • AuthToken; string;ソーシャル・チャネルに使用される認可トークン。
      • AuthenticationURL; string; チャネルを認証するためのURL。
      • AuthorizationURL; string;チャネルの認可のURL。
      • BUOrgId; integer;チャネルに関連付けられたビジネス・ユニットの一意の識別子。
      • BusinessUnitName; string;チャネルに関連付けられたビジネス・ユニットの名前。
      • ChannelId; integer;チャネルの一意の識別子。
      • ChannelShortName; string;チャネルの短縮名。
      • ChannelTypeCd; string; 通信チャネルのタイプを示すコード。
      • CreatedBy; string;チャネルを作成したユーザー。
      • CreationDate; string;チャネルが作成された日付。
      • CustomerTypeCd; string; コンシューマ、ビジネス、両方など、チャネルにメッセージを送信する必要がある顧客のタイプ。
      • DisplayName; string;チャネルの表示名。
      • EnabledFlag; boolean;チャネルがアクティブかどうかを示します。
      • EndPoint; string;チャネルのエンドポイント。
      • IncludeSenderEmailFlag; boolean;送信者の電子メール・アドレスをアウトバウンド・メッセージに含めるかどうかを示します。
      • IncludeSenderNameFlag; boolean;送信者の名前をアウトバウンド・メッセージに含めるかどうかを示します。
      • LastUpdateDate; string; チャネルが最後に更新された日付。
      • LastUpdateLogin; string;チャネルを最後に更新したユーザーのログイン。
      • LastUpdatedBy; string; チャネルを最後に更新したユーザー。
      • MultipleMatchesActionCd; string;メッセージ送信者に対して複数の一致が見つかった場合(Select NoneやSelect First Matchなど)、アプリケーションが実行するアクション。
      • NetworkTypeCd; string; ソーシャル・ネットワークのタイプを示すコード。
      • NoMatchActionCd; string; メッセージ送信者に対して一致が見つからない場合(NothingやCreate Contactなど)にアプリケーションが実行するアクション。
      • OpenSrCount; integer;削除もクローズもされていないサービス・リクエストの数。
      • OriginalSystemReference; string;インポートされたチャネルの元の参照システム。
      • Port; string;チャネルに関連付けられたポート。
      • PrivatePToPAllowedFlag; boolean;チャネルがプライベート・メッセージを許可するかどうかを示します。
      • PurposeCd; string; サポート、販売、照会などのチャネルの目的。
      • RefreshToken; string;ソーシャル・チャネルに使用されるリフレッシュ・トークン。
      • SourceCd; string; チャネル作成のソース・インタフェース。
      • StripeCd; string; チャネルのアプリケーション・ストライプを示すコード。
      • TokenAccessURL; string;チャネル・トークンにアクセスするためのURL。
      • TokenRequestURL; string;チャネルでトークン・リクエストを渡すURL。
    • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
    ヘッダー・パラメータ
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

    トップに戻る

    応答

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

    デフォルトのレスポンス

    次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
    ヘッダー
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
    本文( )
    ルート・スキーマ : serviceBusinessUnits-channels
    タイプ: object
    ソースを表示
    ネストされたスキーマ : アイテム
    タイプ: array
    タイトル: Items
    コレクション内のアイテム。
    ソースを表示
    ネストされたスキーマ : serviceBusinessUnits-channels-item-response
    タイプ: object
    ソースを表示
    • タイトル: Access Token
      最大長: 400
      ソーシャル・チャネルに使用されるアクセス・トークン。
    • タイトル: Account Name
      最大長: 400
      チャネルに関連付けられているアカウントの名前。
    • タイトル: API
      最大長: 400
      チャネルAPIの一意の識別子。
    • タイトル: API Password
      最大長: 400
      チャネルAPIのパスワード。
    • タイトル: API Version
      最大長: 400
      チャネルのAPIバージョン。
    • タイトル: Authentication URL
      最大長: 1000
      チャネルを認証するためのURL。
    • タイトル: Authorization URL
      最大長: 1000
      チャネルを認可するURL。
    • タイトル: Authorization Token
      最大長: 400
      ソーシャル・チャネルに使用される認可トークン。
    • タイトル: Business Unit ID
      チャネルに関連付けられたビジネス・ユニットの一意の識別子。
    • タイトル: Business Unit Name
      最大長: 255
      チャネルに関連付けられているビジネス・ユニットの名前。
    • タイトル: Channel
      読取り専用: true
      チャネルの一意の識別子。
    • タイトル: Channel Code
      最大長: 450
      チャネルの短縮名。
    • タイトル: Channel Type
      最大長: 30
      通信チャネルのタイプを示すコード。
    • 読取り専用: true
      チャネル・タイプ値リスト・ピッカーの名前。
    • タイトル: Created By
      読取り専用: true
      最大長: 64
      チャネルを作成したユーザー。
    • タイトル: Creation Date
      読取り専用: true
      チャネルが作成された日付。
    • タイトル: Customer Type
      最大長: 30
      チャネルにメッセージを送信する必要がある顧客のタイプ(消費者、ビジネス、両方など)。
    • 読取り専用: true
      チャネルが削除されたかどうかを示します。
    • タイトル: Display Name
      最大長: 400
      チャネルの表示名。
    • タイトル: Active
      最大長: 1
      デフォルト値: true
      チャネルがアクティブかどうかを示します。
    • タイトル: Endpoint
      最大長: 1000
      チャネルのエンドポイント。
    • タイトル: Include Sender Email
      最大長: 1
      デフォルト値: false
      送信者のEメール・アドレスをアウトバウンド・メッセージに含める必要があるかどうかを示します。
    • タイトル: Include Sender Name
      最大長: 1
      デフォルト値: false
      送信者の名前をアウトバウンド・メッセージに含める必要があるかどうかを示します。
    • タイトル: Last Updated Date
      読取り専用: true
      チャネルが最後に更新された日付。
    • タイトル: Last Updated By
      読取り専用: true
      最大長: 64
      チャネルを最後に更新したユーザー。
    • タイトル: Last Update Login
      読取り専用: true
      最大長: 32
      チャネルを最後に更新したユーザーのログイン。
    • Links
    • タイトル: If Multiple Matches Found for Sender
      最大長: 30
      選択なしや最初の一致の選択など、メッセージ送信者に対して複数の一致が見つかった場合にアプリケーションが実行する処理。
    • タイトル: Network
      最大長: 30
      ソーシャル・ネットワークのタイプを示すコード。
    • タイトル: If No Matches Found for Sender
      最大長: 30
      なしや担当者の作成など、メッセージ送信者に対して一致が見つからない場合にアプリケーションが実行する処理。
    • 読取り専用: true
      削除もクローズもされていないサービス・リクエストの数。
    • タイトル: Original System
      最大長: 255
      インポートされたチャネルの元の参照システム。
    • タイトル: Port
      最大長: 10
      チャネルに関連付けられたポート。
    • タイトル: Private Conversation Allowed
      最大長: 1
      デフォルト値: true
      チャネルでプライベート・メッセージを許可するかどうかを示します。
    • タイトル: Purpose
      最大長: 30
      サポート、営業、照会などのチャネルの目的。
    • タイトル: Refresh Token
      最大長: 400
      ソーシャル・チャネルに使用されるリフレッシュ・トークン。
    • タイトル: Source Code
      最大長: 30
      デフォルト値: ORA_SVC_ADMIN_UI
      チャネル作成のソース・インタフェース。
    • タイトル: Stripe Code
      最大長: 30
      チャネルのアプリケーション・ストライプを示すコード。
    • タイトル: Token Access URL
      最大長: 1000
      チャネル・トークンにアクセスするためのURL。
    • タイトル: Token Request URL
      最大長: 1000
      チャネルでトークン・リクエストを渡すURL。
    • 読取り専用: true
      チャネルが更新されたかどうかを示します。
    トップに戻る

    例:

    次の例は、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

    レスポンス本文の例

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

    {
    "items": [
        {
            "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": [
					...
					]
			},
			{
            "ChannelId": 2,
            "ChannelTypeCd": "ORA_SVC_EMAIL",
            "NetworkTypeCd": null,
            "AccountName": "E-Mail",
            "DisplayName": "E-Mail",
            "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.451+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": [
					...
			},
			...
    「トップに戻る」