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

機械翻訳について

プロファイル・オプションの取得

get

/crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/profileOptions/{OptionId}

リクエスト

パス・パラメータ

BUOrgId(required): integer(int64)

ビジネス・ユニットの一意の識別子。
OptionId(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-profileOptions-item-response

タイプ: object

ソースを表示

BUOrgId: integer (int64)

タイトル: Business Unit Organization ID

プロファイル・オプションに関連付けられたビジネス・ユニットの一意の識別子。
BusinessUnitName: string

タイトル: Business Unit

読取り専用: true

最大長: 240

プロファイル・オプションに関連付けられたビジネス・ユニットの名前。
BusinessUnitStatus: string

タイトル: Active

読取り専用: true

最大長: 30

ビジネス・ユニットのステータス(アクティブ、非アクティブなど)。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

最初にプロファイル・オプションを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

プロファイル・オプションが作成された日付。
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

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

タイトル: Service Profile Option ID

読取り専用: true

プロファイル・オプションの一意の識別子。
OptionShortName: string

タイトル: Profile Short Name

最大長: 64

プロファイル・オプションの短縮名。
ProfileDescription: string

タイトル: Description

読取り専用: true

最大長: 240

プロファイル・オプションの説明。
ProfileDisplayName: string

タイトル: Profile Display Name

読取り専用: true

最大長: 240

プロファイル・オプションの表示名。
ProfileOptionCode: string

タイトル: Profile Option Code

最大長: 80

プロファイル・オプションのタイプを示すコード。
ProfileOptionValue: string

タイトル: Business Unit Profile Value

最大長: 1000

ビジネス・ユニットのプロファイル・オプション値。
SiteProfileOptionValue: string

タイトル: Site Level Value

読取り専用: true

最大長: 1000

プロファイル・オプションのサイト・レベル値。
UseSiteValueFlag: boolean

タイトル: Use Site Value

最大長: 1

デフォルト値: true

サイト・レベルのプロファイル・オプション値をアプリケーションで使用する必要があるかどうかを示します。デフォルト値はtrueです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the profile option.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitStatus":{
            "title":"Active",
            "maxLength":30,
            "type":"string",
            "description":"The status of the business unit, such as active or inactive.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the profile option was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who first created the profile option.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfileDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the profile option.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptionShortName":{
            "title":"Profile Short Name",
            "maxLength":64,
            "type":"string",
            "description":"The short name of the profile option.",
            "nullable":false,
            "x-queryable":true
        },
        "ProfileOptionValue":{
            "title":"Business Unit Profile Value",
            "maxLength":1000,
            "type":"string",
            "description":"The profile option value for a business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionId":{
            "title":"Service Profile Option ID",
            "type":"integer",
            "description":"The unique identifier of the profile option.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProfileDisplayName":{
            "title":"Profile Display Name",
            "maxLength":240,
            "type":"string",
            "description":"The display name of the profile option.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfileOptionCode":{
            "title":"Profile Option Code",
            "maxLength":80,
            "type":"string",
            "description":"The code indicating the type of the profile option.",
            "nullable":false,
            "x-queryable":true
        },
        "UseSiteValueFlag":{
            "title":"Use Site Value",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the site level profile option value must be used by the application. The default value is true.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit Organization ID",
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the profile option.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit associated with the profile option.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "SiteProfileOptionValue":{
            "title":"Site Level Value",
            "maxLength":1000,
            "type":"string",
            "description":"The site level value of a profile option.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the profile option was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the profile option.",
            "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."
        }
    }
}

リンク

YesNoLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DYES_NO

サイト・レベルのプロファイル・オプションを使用する必要があることを示す値リスト。

トップに戻る

例:

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

レスポンス本文の例

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

{
            "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": [
					...
					]
			}

「トップに戻る」