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

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

patch

/fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantDetails/{ParticipantDetailId}/child/participantDetailsDFF/{ParticipantDetailId2}

リクエスト

パス・パラメータ

ParticipantDetailId(required): integer(int64)

参加者の詳細レコードの一意の識別子。関係者は、日付範囲が重複することなく、複数の詳細レコードを持つことができます。
ParticipantDetailId2(required): integer(int64)

このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。例: products?q=InventoryItemId=
incentiveCompensationParticipantsUniqID(required): string

これは、参加者リソースのコンポジット・キーを構成し、参加者のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは参加者の特定のインスタンスに移動してハッシュ・キーを取得するために、Participantsコレクション・リソースを問い合せる必要があります。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

__FLEX_Context: string

タイトル: Context Value

最大長: 30

関係者詳細のフレックス・コンテキスト・セグメント・コード。どのコンテキスト依存セグメントを表示するかを決定します。
__FLEX_Context_DisplayValue: string

タイトル: Context Value

関係者詳細のフレックス・コンテキスト・セグメント表示名。どのコンテキスト依存セグメントを表示するかを決定します。
ParticipantDetailId: integer (int64)

参加者の詳細レコードの一意の識別子。関係者は、日付範囲が重複することなく、複数の詳細レコードを持つことができます。

{
    "type":"object",
    "properties":{
        "ParticipantDetailId":{
            "type":"integer",
            "description":"The unique identifier for the participant's detail record. A participant can have multiple detail records without overlapping date ranges.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"The flex context segment display name for the participant details. 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":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"The flex context segment code for the participant details. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "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":"HIDDEN"
            },
            "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のデフォルト・バージョンを選択します。

ルート・スキーマ : incentiveCompensationParticipants-ParticipantDetails-participantDetailsDFF-item-response

タイプ: object

ソースを表示

__FLEX_Context: string

タイトル: Context Value

最大長: 30

関係者詳細のフレックス・コンテキスト・セグメント・コード。どのコンテキスト依存セグメントを表示するかを決定します。
__FLEX_Context_DisplayValue: string

タイトル: Context Value

関係者詳細のフレックス・コンテキスト・セグメント表示名。どのコンテキスト依存セグメントを表示するかを決定します。
links: array Links

タイトル: Links

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

参加者の詳細レコードの一意の識別子。関係者は、日付範囲が重複することなく、複数の詳細レコードを持つことができます。

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParticipantDetailId":{
            "type":"integer",
            "description":"The unique identifier for the participant's detail record. A participant can have multiple detail records without overlapping date ranges.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"The flex context segment display name for the participant details. 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":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"The flex context segment code for the participant details. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "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":"HIDDEN"
            },
            "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_PARTICIPANT_DETAIL_DFF

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: __FLEX_Context_DisplayValue;ターゲット属性: 名前
表示属性: 名前、説明

LVVO___FLEX_Context

操作: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

パラメータ:

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

関係者詳細のフレックス・コンテキスト・セグメント・コードを含む値リスト。どのコンテキスト依存セグメントを表示するかを決定します。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: __FLEX_Context;ターゲット属性: ContextCode
表示属性: 名前

トップに戻る

例:

次の例は、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/incentiveCompensationParticipants/999666333000023/child/ParticipantDetails/999666333000023/child/participantDetailsDFF/999666333000023

リクエスト本文の例

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

{
"ParticipantDetailsDff2": 100
}

レスポンス本文の例

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

{
  "ParticipantDetailId": 999666333000023,
  "ParticipantDetailsDff1": null,
  "ParticipantDetailsDff2": 100,
  "ParticipantDetailsDff3": null,
  "ParticipantDetailsDff4Date": null,
  "__FLEX_Context": null,
  "__FLEX_Context_DisplayValue": null,
  "links": [
    ...
  ]
}

「トップに戻る」