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

すべてのサービス・ビジネス・ユニットの取得

get

/crmRestApi/resources/11.13.18.05/serviceBusinessUnits

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • PrimaryKey : 指定された主キーを持つサービス・ビジネス・ユニットを検索します。
      ファインダ変数:
      • BUOrgId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • BUOrgId; integer;ビジネス・ユニットの一意の識別子。
    • BusinessUnitId; integer;ビジネス・ユニットの一意の識別子。
    • BusinessUnitName; string;ビジネス・ユニットの名前。
    • 名前、文字列、ビジネス・ユニットの名前。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : serviceBusinessUnits
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : serviceBusinessUnits-item-response
タイプ: object
ソースを表示
  • タイトル: Business Unit ID
    読取り専用: true
    ビジネス・ユニットの一意の識別子。
  • 読取り専用: true
    ビジネス・ユニットの一意の識別子。
  • タイトル: Business Unit
    読取り専用: true
    最大長: 240
    ビジネス・ユニットの名前。
  • Categories
    タイトル: Categories
    カテゴリ・リソースは、ビジネス・ユニットに関連付けられたカテゴリを表示するために使用されます。 カテゴリは、サービス・リクエストのグループ化に使用されます。
  • Channels
    タイトル: Channels
    チャネル・リソースは、ビジネス・ユニットに関連付けられたチャネルの表示に使用されます。 顧客の声を聞き、応答するために使用されるチャネル。
  • Business Unit Lookups
    タイトル: Business Unit Lookups
    参照セットが使用可能な参照リソースは、ビジネス・ユニットに関連付けられた参照の表示に使用されます。
  • Links
  • 読取り専用: true
    ビジネス・ユニットの名前。
  • Profile Options
    タイトル: Profile Options
    プロファイル・オプション・リソースは、サービス・リクエスト・レスポンスの製品カタログ使用状況やEメール・テンプレートなど、ビジネス・ユニットに関連付けられたプロファイル・オプションを表示するために使用されます。
ネストされたスキーマ : カテゴリ
タイプ: array
タイトル: Categories
カテゴリ・リソースは、ビジネス・ユニットに関連付けられたカテゴリを表示するために使用されます。 カテゴリは、サービス・リクエストのグループ化に使用されます。
ソースを表示
ネストされたスキーマ : チャネル
タイプ: array
タイトル: Channels
チャネル・リソースは、ビジネス・ユニットに関連付けられたチャネルの表示に使用されます。 顧客の声を聞き、応答するために使用されるチャネル。
ソースを表示
ネストされたスキーマ : ビジネス・ユニット参照
タイプ: array
タイトル: Business Unit Lookups
参照セットが使用可能な参照リソースは、ビジネス・ユニットに関連付けられた参照の表示に使用されます。
ソースを表示
ネストされたスキーマ : プロファイル・オプション
タイプ: array
タイトル: Profile Options
プロファイル・オプション・リソースは、サービス・リクエスト・レスポンスの製品カタログ使用状況やEメール・テンプレートなど、ビジネス・ユニットに関連付けられたプロファイル・オプションを表示するために使用されます。
ソースを表示
ネストされたスキーマ : serviceBusinessUnits-categories-item-response
タイプ: object
ソースを表示
  • タイトル: Business Unit ID
    読取り専用: true
    カテゴリに関連付けられたビジネス・ユニットの一意の識別子。
  • タイトル: Category ID
    読取り専用: true
    カテゴリの一意の識別子。
  • タイトル: Category Name
    読取り専用: true
    最大長: 400
    カテゴリの名前。
  • タイトル: Category Short Name
    読取り専用: true
    最大長: 240
    カテゴリの短縮名。 この値は、CategoryNameから自動生成されます。 必要に応じて、名前を編集して一意の値にすることができます。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    カテゴリを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    カテゴリが作成された日時。
  • タイトル: Visible in Customer Self-Service
    読取り専用: true
    最大長: 1
    カテゴリが顧客セルフサービス・ポータルに表示されるかどうかを示します。
  • タイトル: Enabled
    読取り専用: true
    最大長: 1
    カテゴリが使用可能かどうかを示します。 有効な場合、値はY、それ以外の場合はNです。
  • タイトル: Last Updated Date
    読取り専用: true
    カテゴリが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    カテゴリを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    行を最後に更新したユーザーに関連付けられたセッション・ログイン。
  • Links
  • タイトル: Original System
    読取り専用: true
    最大長: 255
    カテゴリのインポート元のシステムへの参照(インポートされている場合)。
  • タイトル: Parent Category ID
    読取り専用: true
    親カテゴリの一意の識別子。 カテゴリがルート・カテゴリの場合、値はNULLです。
  • タイトル: Stripe Code
    読取り専用: true
    最大長: 30
    サービス・リクエスト・カテゴリのアプリケーション・ストライプを示すコード。
ネストされたスキーマ : 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
    チャネルが更新されたかどうかを示します。
ネストされたスキーマ : serviceBusinessUnits-fndSetEnabledLookups-item-response
タイプ: object
ソースを表示
  • タイトル: Business Unit ID
    読取り専用: true
    ビジネス・ユニットの一意の識別子。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    参照セットを作成したユーザーが参照を使用可能にします。
  • タイトル: Creation Date
    読取り専用: true
    参照セットが使用可能な参照が作成された日付。
  • タイトル: Description
    読取り専用: true
    最大長: 240
    参照セットが使用可能な参照値の摘要。
  • タイトル: Display Sequence
    読取り専用: true
    参照セットが使用可能な参照値の表示順序。
  • タイトル: End Date
    読取り専用: true
    参照セットが使用可能な参照が非アクティブになる日付。
  • タイトル: Last Updated Date
    読取り専用: true
    最終参照セット使用可能参照が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    参照セットが使用可能な参照を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    参照セットが使用可能な参照を最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Lookup Code
    読取り専用: true
    最大長: 30
    参照セットが使用可能な参照のプロパティを示すコード。
  • タイトル: Lookup Type
    読取り専用: true
    最大長: 30
    参照セットが使用可能な参照のタイプ。
  • タイトル: Meaning
    読取り専用: true
    最大長: 80
    参照セットが使用可能な参照の表示値。
  • タイトル: Set ID
    読取り専用: true
    参照に関連付けられている参照セットの一意の識別子。
  • タイトル: Start Date
    読取り専用: true
    参照セットが使用可能な参照がアクティブになる日付。
ネストされたスキーマ : serviceBusinessUnits-profileOptions-item-response
タイプ: object
ソースを表示
  • タイトル: Business Unit Organization ID
    プロファイル・オプションに関連付けられたビジネス・ユニットの一意の識別子。
  • タイトル: Business Unit
    読取り専用: true
    最大長: 240
    プロファイル・オプションに関連付けられたビジネス・ユニットの名前。
  • タイトル: Active
    読取り専用: true
    最大長: 30
    ビジネス・ユニットのステータス(アクティブ、非アクティブなど)。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    最初にプロファイル・オプションを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    プロファイル・オプションが作成された日付。
  • タイトル: Last Updated Date
    読取り専用: true
    プロファイル・オプションが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    プロファイル・オプションを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    プロファイル・オプションを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Service Profile Option ID
    読取り専用: true
    プロファイル・オプションの一意の識別子。
  • タイトル: Profile Short Name
    最大長: 64
    プロファイル・オプションの短縮名。
  • タイトル: Description
    読取り専用: true
    最大長: 240
    プロファイル・オプションの説明。
  • タイトル: Profile Display Name
    読取り専用: true
    最大長: 240
    プロファイル・オプションの表示名。
  • タイトル: Profile Option Code
    最大長: 80
    プロファイル・オプションのタイプを示すコード。
  • タイトル: Business Unit Profile Value
    最大長: 1000
    ビジネス・ユニットのプロファイル・オプション値。
  • タイトル: Site Level Value
    読取り専用: true
    最大長: 1000
    プロファイル・オプションのサイト・レベル値。
  • タイトル: Use Site Value
    最大長: 1
    デフォルト値: true
    サイト・レベルのプロファイル・オプション値をアプリケーションで使用する必要があるかどうかを示します。 デフォルト値はtrueです。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのサービス・ビジネス・ユニットを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceBusinessUnits

レスポンス本文の例

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

{
    "items": [
        {
            "BUOrgId": 204,
            "BusinessUnitName": "Vision Operations",
            "BusinessUnitId": 204,
            "Name": "Vision Operations",
            "links": [
					...
					]
			},
			{
            "BUOrgId": 300100026725086,
            "BusinessUnitName": "ABC Operations",
            "BusinessUnitId": 300100026725086,
            "Name": "ABC Operations",
            "links": [
					...
					]
			},
			...
「トップに戻る」