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

付加フレックスフィールドの更新

patch

/fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentsDFF/{planComponentsDFFUniqID}

リクエスト

パス・パラメータ

planComponentsDFFUniqID(required): string

これは、プラン・コンポーネント付加フレックスフィールド・リソースのコンポジット・キー(PlanComponentIdおよびOrgId ---)を構成する属性のハッシュ・キーで、プラン・コンポーネント付加フレックスフィールドのインスタンスを一意に識別するために使用されます。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、プラン・コンポーネント付加フレックスフィールドの特定のインスタンスにナビゲートするために、主キー値に対するフィルタを使用してプラン・コンポーネント付加フレックスフィールド・コレクション・リソースを問い合せる必要があります。

次に例を示します: planComponentsDFF?q=PlanComponentId=<value1>;OrgId=<value2>
planComponentsUniqID(required): string

これは、プラン・コンポーネント・リソースのコンポジット・キー(PlanComponentIdおよびOrgId)を構成する属性のハッシュ・キーで、プラン・コンポーネントのインスタンスを一意に識別するために使用されます。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、プラン・コンポーネントの特定のインスタンスに移動するために、主キー値に対するフィルタを使用してプラン・コンポーネント・コレクション・リソースを問い合せる必要があります。

次に例を示します: planComponents?q=PlanComponentId=<value1>;OrgId=<value2>

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

__FLEX_Context: string

タイトル: Context Segment

最大長: 30

このフィールドは、プラン・コンポーネントのフレックス・コンテキスト・セグメント・コードを表します。どのコンテキスト依存セグメントを表示するかを決定します。
__FLEX_Context_DisplayValue: string

タイトル: Context Segment

このフィールドは、プラン・コンポーネントのフレックス・コンテキスト・セグメント表示名を表します。どのコンテキスト依存セグメントを表示するかを決定します。

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"This field represents the flex context segment display name for the  plan component. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"This field represents the flex context segment code for the plan component. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : planComponents-planComponentsDFF-item-response

タイプ: object

ソースを表示

__FLEX_Context: string

タイトル: Context Segment

最大長: 30

このフィールドは、プラン・コンポーネントのフレックス・コンテキスト・セグメント・コードを表します。どのコンテキスト依存セグメントを表示するかを決定します。
__FLEX_Context_DisplayValue: string

タイトル: Context Segment

このフィールドは、プラン・コンポーネントのフレックス・コンテキスト・セグメント表示名を表します。どのコンテキスト依存セグメントを表示するかを決定します。
links: array Links

タイトル: Links

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

タイトル: Business Unit

ビジネス・ユニット組織の一意の識別子。
PlanComponentId: integer (int64)

ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。

{
    "type":"object",
    "properties":{
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit organisation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier for the plan component record within a business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"This field represents the flex context segment display name for the  plan component. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"This field represents the flex context segment code for the plan component. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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."
        }
    }
}

リンク

LVVO_V___FLEX_Context

操作: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

パラメータ:

ファインダ: ValidValuesFinder%3BBind_ApplicationId%3D283%2CBind_DescriptiveFlexfieldCode%3DCN_PLAN_COMPONENTS_DFF

LVVO___FLEX_Context

操作: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

パラメータ:

ファインダ: ValidValuesFinder%3BBind_ApplicationId%3D283%2CBind_DescriptiveFlexfieldCode%3DCN_PLAN_COMPONENTS_DFF

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、付加フレックスフィールドを更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/planComponents/00020000000EACED00057708000110F07F4ABECA0000000EACED0005770800000000000000CC/child/planComponentsDFF/00020000000EACED00057708000110F07F4ABECA0000000EACED0005770800000000000000CC

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{ 
"Plan__Component__DFF" : "Only valid for key sales reps"
}

レスポンス本文の例

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

{
  "PlanComponentId": 300100090511050,
  "OrgId": 204,
  "_Plan__Component__DFF": "Only valid for key sales reps",
  "usage": "Incentive",
  "status": null,
  "newDfff": null,
  "newDfffNumber": null,
  "newDfffDate": null,
  "newDfffWithNewFile": null,
  "newDff25april": null,
  "dffPc170520122852885": null,
  "dffPc170529142616148": null,
  "dffPc170606120644026": null,
  "__FLEX_Context": null,
  "__FLEX_Context_DisplayValue": null,
  "links": [
    ...
  ]
}

「トップに戻る」