機械翻訳について
  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/profileOptions

リクエスト

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

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

    • BusUnitProfileValueAltKey : 指定された代替キーを持つプロファイル・オプションを検索します。
      ファインダ変数:
      • OptionShortName; string;プロファイル・オプションの名前。
    • BusUnitProfileValueU1Key : 指定した主キーを持つプロファイル・オプションを検索します。
      ファインダ変数:
      • BUOrgId; integer; プロファイル・オプションに関連付けられたビジネス・ユニットの一意の識別子。
      • ProfileOptionCode; string; プロファイル・オプションのタイプを示すコード。
    • PrimaryKey : 指定した主キーを持つプロファイル・オプションを検索します。
      ファインダ変数:
      • OptionId; 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; プロファイル・オプションに関連付けられたビジネス・ユニットの一意の識別子。
    • BusinessUnitName; string; プロファイル・オプションに関連付けられたビジネス・ユニットの名前。
    • BusinessUnitStatus; string;アクティブまたは非アクティブなどのビジネス・ユニットのステータス。
    • CreatedBy; string; プロファイル・オプションを最初に作成したユーザー。
    • CreationDate; string; プロファイル・オプションが作成された日付。
    • LastUpdateDate; string; プロファイル・オプションが最後に更新された日付。
    • LastUpdateLogin; string; プロファイル・オプションを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; プロファイル・オプションを最後に更新したユーザー。
    • OptionId; integer; プロファイル・オプションの一意の識別子。
    • OptionShortName; string; プロファイル・オプションの短縮名。
    • ProfileDescription; string; プロファイル・オプションの説明。
    • ProfileDisplayName; string;プロファイル・オプションの表示名。
    • ProfileOptionCode; string; プロファイル・オプションのタイプを示すコード。
    • ProfileOptionValue; string;ビジネス・ユニットのプロファイル・オプション値。
    • SiteProfileOptionValue; string; プロファイル・オプションのサイト・レベルの値。
    • UseSiteValueFlag; boolean;サイト・レベルのプロファイル・オプション値をアプリケーションで使用する必要があるかどうかを示します。 デフォルト値はtrueです。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : serviceBusinessUnits-profileOptions
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : 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/300100026725086/child/profileOptions

レスポンス本文の例

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

{
    "items": [
        {
            "OptionId": 300100161414029,
            "BUOrgId": 300100026725086,
            "BusinessUnitName": "ABC Operations",
            "BusinessUnitStatus": "A",
            "ProfileOptionCode": "SVC_SR_FORWARD_TEMPLATE_NAME",
            "ProfileDisplayName": "Service Request Forward Message E-Mail Template",
            "ProfileDescription": "Specify the e-mail template for Service Request Forward messages.",
            "SiteProfileOptionValue": "DIT_QA_SERVICE_Extn_Template_Preview",
            "UseSiteValueFlag": true,
            "ProfileOptionValue": null,
            "OptionShortName": "a3afe4f8-25a9-49de-8d50-c218824e816a",
            "CreatedBy": "xuidrill2",
            "CreationDate": "2018-09-03T13:32:32.156+00:00",
            "LastUpdateDate": "2018-09-06T08:31:22+00:00",
            "LastUpdateLogin": "752FA5D5309C26B8E053773AF80AFB77",
            "LastUpdatedBy": "xInboundEmailUI1",
            "links": [
					...
					]
			},
			{
            "OptionId": 300100161414033,
            "BUOrgId": 300100026725086,
            "BusinessUnitName": "ABC Operations",
            "BusinessUnitStatus": "A",
            "ProfileOptionCode": "SVC_SR_FORWARD_TEMPLATE_NAME_HRD",
            "ProfileDisplayName": "Service Request Forward Message E-Mail HRD Template",
            "ProfileDescription": "Specify the e-mail template for Service Request Forward messages.",
            "SiteProfileOptionValue": null,
            "UseSiteValueFlag": true,
            "ProfileOptionValue": null,
            "OptionShortName": "f8bc4146-a699-413f-8305-5dd3248d0538",
            "CreatedBy": "xuidrill2",
            "CreationDate": "2018-09-03T13:36:29.018+00:00",
            "LastUpdateDate": "2018-09-03T13:36:29.044+00:00",
            "LastUpdateLogin": "74F19DCDCD8B4CDEE053773AF80ADCE9",
            "LastUpdatedBy": "xuidrill2",
            "links": [
					...
					],
			},
			...
「トップに戻る」