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

参加者詳細の更新

patch

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

リクエスト

パス・パラメータ

ParticipantDetailId(required): integer(int64)

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

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

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

CostCenter: string

タイトル: Cost Center

最大長: 30

詳細レコードの有効日範囲における参加者のコスト・センター。
CountryCode: string

タイトル: Country

最大長: 30

詳細レコードの有効日範囲時点での、関係者が勤務する国を表すコード。
CurrencyCode: string

タイトル: Home Currency

最大長: 30

詳細レコードの有効日範囲時点での、参加者のホーム通貨を表すコード。
EndDate: 文字列(日付)

タイトル: Effective End Date

詳細が参加者の応募を停止する日時。
participantDetailsDFF: array Participant Details Descriptive Flex Fields

タイトル: Participant Details Descriptive Flex Fields

参加者詳細付加フレックスフィールド・リソースは、参加者詳細リソースのカスタム属性の表示、作成または更新、およびそれらの検証の定義に使用されます。既存の参加者詳細フレックス・フィールドを削除するためにも使用されます。
StartDate: 文字列(日付)

タイトル: Effective Start Date

詳細レコードが参加者の応募を開始する日時。

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Home Currency",
            "maxLength":30,
            "type":"string",
            "description":"The code representing the participant's home currency, as of the effective date range of the detail record.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "StartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The date and time when the detail record starts applying for the participant.",
            "format":"date",
            "nullable":false
        },
        "CostCenter":{
            "title":"Cost Center",
            "maxLength":30,
            "type":"string",
            "description":"The participant's cost center as of the effective date range of the detail record.",
            "nullable":true
        },
        "CountryCode":{
            "title":"Country",
            "maxLength":30,
            "type":"string",
            "description":"The code representing the country where the participant works, as of the effective date range of the detail record.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "participantDetailsDFF":{
            "title":"Participant Details Descriptive Flex Fields",
            "type":"array",
            "description":"The participant details descriptive flex fields resource is used to view, create, or update custom attributes for a participant details resource and define validations for them. It is also used to delete an existing participant details flex field.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationParticipants-ParticipantDetails-participantDetailsDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "EndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The date and time when the detail stops applying for the participant.",
            "format":"date",
            "nullable":true
        }
    }
}

ネストされたスキーマ : 関係者詳細付加フレックスフィールド

タイプ: array

タイトル: Participant Details Descriptive Flex Fields

参加者詳細付加フレックスフィールド・リソースは、参加者詳細リソースのカスタム属性の表示、作成または更新、およびそれらの検証の定義に使用されます。既存の参加者詳細フレックス・フィールドを削除するためにも使用されます。

ソースを表示

Array of: object schema

{
    "title":"Participant Details Descriptive Flex Fields",
    "type":"array",
    "description":"The participant details descriptive flex fields resource is used to view, create, or update custom attributes for a participant details resource and define validations for them. It is also used to delete an existing participant details flex field.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationParticipants-ParticipantDetails-participantDetailsDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

ネストされたスキーマ : スキーマ

タイプ: 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-item-response

タイプ: object

ソースを表示

CostCenter: string

タイトル: Cost Center

最大長: 30

詳細レコードの有効日範囲における参加者のコスト・センター。
CountryCode: string

タイトル: Country

最大長: 30

詳細レコードの有効日範囲時点での、関係者が勤務する国を表すコード。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
CurrencyCode: string

タイトル: Home Currency

最大長: 30

詳細レコードの有効日範囲時点での、参加者のホーム通貨を表すコード。
EndDate: 文字列(日付)

タイトル: Effective End Date

詳細が参加者の応募を停止する日時。
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

リソース・インスタンスに関連付けられたリンク関係。
ParticipantDetailDeleteFlag: boolean

読取り専用: true

デフォルト値: false

参加者詳細を削除できるかどうかを示します。
ParticipantDetailId: integer (int64)

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

タイトル: Participant Details Descriptive Flex Fields

参加者詳細付加フレックスフィールド・リソースは、参加者詳細リソースのカスタム属性の表示、作成または更新、およびそれらの検証の定義に使用されます。既存の参加者詳細フレックス・フィールドを削除するためにも使用されます。
ParticipantId: integer (int64)

関係者の一意の識別子。
StartDate: 文字列(日付)

タイトル: Effective Start Date

詳細レコードが参加者の応募を開始する日時。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantDetailDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the participant details can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantDetailId":{
            "type":"integer",
            "description":"The unique identifier for the participant's detail record. A participant can have multiple details records without overlapping date ranges.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The date and time when the detail stops applying for the participant.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier for a participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Home Currency",
            "maxLength":30,
            "type":"string",
            "description":"The code representing the participant's home currency, as of the effective date range of the detail record.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The date and time when the detail record starts applying for the participant.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CostCenter":{
            "title":"Cost Center",
            "maxLength":30,
            "type":"string",
            "description":"The participant's cost center as of the effective date range of the detail record.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CountryCode":{
            "title":"Country",
            "maxLength":30,
            "type":"string",
            "description":"The code representing the country where the participant works, as of the effective date range of the detail record.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "participantDetailsDFF":{
            "title":"Participant Details Descriptive Flex Fields",
            "type":"array",
            "description":"The participant details descriptive flex fields resource is used to view, create, or update custom attributes for a participant details resource and define validations for them. It is also used to delete an existing participant details flex field.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationParticipants-ParticipantDetails-participantDetailsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "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"
    }
}

ネストされたスキーマ : 関係者詳細付加フレックスフィールド

タイプ: array

タイトル: Participant Details Descriptive Flex Fields

ソースを表示

Array of: object incentiveCompensationParticipants-ParticipantDetails-participantDetailsDFF-item-response

{
    "title":"Participant Details Descriptive Flex Fields",
    "type":"array",
    "description":"The participant details descriptive flex fields resource is used to view, create, or update custom attributes for a participant details resource and define validations for them. It is also used to delete an existing participant details flex field.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationParticipants-ParticipantDetails-participantDetailsDFF-item-response"
    },
    "x-cardinality":"1"
}

ネストされたスキーマ : リンク

タイプ: 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."
        }
    }
}

ネストされたスキーマ : 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"
    }
}

リンク

CountryCodeVO

操作: /fscmRestApi/resources/11.13.18.05/territoriesLOV

詳細レコードの有効日範囲時点での、関係者が勤務する国を示すコードを含む値リスト。

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

ソース属性: CountryCode;ターゲット属性: TerritoryCode
表示属性: TerritoryShortName

CurrencyCodeVO

操作: /fscmRestApi/resources/11.13.18.05/currenciesLOV

詳細レコードの有効日範囲時点での、関係者ホーム通貨を示すコードを含む値リスト。

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

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

participantDetailsDFF

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantDetails/{ParticipantDetailId}/child/participantDetailsDFF

パラメータ:

ParticipantDetailId: $request.path.ParticipantDetailId
incentiveCompensationParticipantsUniqID: $request.path.incentiveCompensationParticipantsUniqID

トップに戻る

例:

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

リクエスト本文の例

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

{
"EndDate":  "2017-05-05"
}

レスポンス本文の例

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

{
  "ParticipantDetailId": 999666333000584,
  "CostCenter": null,
  "CountryCode": "US",
  "CreatedBy": "OIC_MGR_OPERATIONS",
  "CreationDate": "2009-08-17T17:25:32-07:00",
  "CurrencyCode": "USD",
  "EndDate": "2017-05-05",
  "LastUpdateDate": "2017-05-16T07:37:47-07:00",
  "LastUpdateLogin": "4FA525997C5C6DC5E0532DD6F00A3E7B",
  "LastUpdatedBy": "OIC_MGR_OPERATIONS",
  "ParticipantId": 999666333000584,
  "StartDate": "1995-01-01",
  "ParticipantDetailDeleteFlag": false,
  "links": [
   ...
  ]
}

「トップに戻る」