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

機械翻訳について

参加者ヘッダーの作成

post

/fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants

リクエスト

ヘッダー・パラメータ

Effective-Of:

このヘッダーは文字列値を受け入れます。この文字列は、セミコロンで区切られた=のリストです。有効日範囲操作の実行に使用されます。受け入れられるパラメータは、RangeMode、RangeSpan、RangeStartDate、RangeEndDate、RangeStartSequenceおよびRangeEndSequenceです。パラメータ値は常に文字列です。 RangeModeに指定できる値は、SET_LOGICAL_START、SET_LOGICAL_END、END_DATE、SET_EFFECTIVE_START、SET_EFFECTIVE_END、REPLACE_CORRECTION、REPLACE_UPDATE、RECONCILE_CORRECTION、CORRECTION、RECONCILE_UPDATE、UPDATE、ZAPおよびDELETE_CHANGESです。 RangeSpanに指定できる値は、PHYSICAL_ROW_END_DATEおよびLOGICAL_ROW_END_DATEです。 RangeStartDateおよびRangeEndDateの値は、yyyy-MM-dd形式の日付の文字列表現である必要があります。 RangeStartSequenceおよびRangeEndSequenceの値は、解析時に正の整数が生成されるように文字列である必要があります。
Metadata-Context:

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

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

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

application/json

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

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

タイプ: object

ソースを表示

ActiveFlag: boolean

タイトル: Active

最大長: 1

デフォルト値: true

参加者がアクティブかどうかを示します。可能な値は、アクティブでない場合はFALSE、アクティブの場合はTRUEです。デフォルト値はTRUEです。
AnalystId: integer (int64)

タイトル: Analyst Identifier

この関係者に割り当てられたアナリストの一意の識別子。
AnalystName: string

タイトル: Analyst

最大長: 360

参加者に割り当てられたアナリストの名前。
CompensationEndDate: 文字列(日付)

タイトル: Compensation End Date

参加者がアクティブな参加者でなくなった場合でも、その参加者に支払われることのできる最終日。この日付に基づいて支払シートが生成され、参加者の終了日を超えて延長される場合があります。
CostCenter: string

タイトル: Cost Center

詳細レコードの有効日範囲における参加者のコスト・センター。値が関係者ヘッダーの転記操作で渡されると、コスト・センターが関係者詳細レコードにデフォルト設定されます。
CountryCode: string

タイトル: Country

詳細レコードの有効日範囲時点での、関係者が勤務する国を表すコード。値が参加者ヘッダー転記操作で渡されると、国コードは参加者詳細レコードにデフォルトになります。
CurrencyCode: string

タイトル: Home Currency

詳細レコードの有効日範囲時点での、参加者のホーム通貨を表すコード。値が参加者ヘッダー転記操作で渡されると、参加者詳細レコードにホーム通貨がデフォルト設定されます。
EndDate: 文字列(日付)

タイトル: Active End Date

参加者が非アクティブになる日時。
HoldPaymentFlag: boolean

タイトル: Hold payment

最大長: 1

デフォルト値: false

支払バッチの支払時に、参加者の支払の支払を停止するかどうかを示します。デフォルト値はfalseです。
HoldReason: string

タイトル: Hold Reason

最大長: 30

支払が保留されている理由を示します。可能な値には、支払係争のDISPUTE、休職のLEAVE、参加者が退職したときにTERMINATEDが含まれます。許容可能な値のリストは、参照CN_HOLD_REASON_CODEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
OrgId(required): integer (int64)

タイトル: Business Unit

ビジネス・ユニットの一意の識別子。
ParticipantDetails: array Participant Details

タイトル: Participant Details

関係者詳細リソースは、コスト・センター、事業所など、関係者の詳細を表示、作成および更新するために使用されます。
ParticipantFirstName: string

タイトル: Participant First Name

最大長: 150

参加者の名。
ParticipantId: integer (int64)

タイトル: Participant Identifier

関係者の一意の識別子。
ParticipantLastName: string

タイトル: Participant Last Name

最大長: 150

参加者の姓。
ParticipantName: string

タイトル: Participant Name

最大長: 360

インセンティブ報酬の関係者の名前。
ParticipantRoles: array Participant Roles

タイトル: Participant Roles

関係者ロール・リソースを使用して、関係者に関連付けられたロール(営業担当や営業マネージャなど)を表示、作成、更新および削除します。
participantsDFF: array Participants Descriptive Flex Fields

タイトル: Participants Descriptive Flex Fields

関係者付加フレックスフィールド・リソースは、関係者リソースのカスタム属性を表示、作成または更新し、検証を定義するために使用されます。既存の参加者フレックス・フィールドの削除にも使用されます。
ParticipantType(required): string

タイトル: Type

最大長: 60

参加者が管理者(ツールの更新を担当)であるか、営業チーム・メンバー(販売実績の取得が可能)であるかを示します取り得る値には、管理者用のANALYSTと営業チーム・メンバー用のPARTICIPANTがあります。受理可能な値のリストは、参照CN_PARTICIPANT_TYPEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
PartyId: integer (int64)

タイトル: Party Identifier

取引先コミュニティ・モデルのパーティ・レコードの一意の識別子。
PartyNumber: string

タイトル: Party Number

最大長: 30

関係者に関連付けられたパーティのユーザー定義値。パーティは、パートナ、営業担当、ベンダー、リソースまたは従業員です。 HRからの従業員の場合、パーティ番号には(IDではなく)従業員番号が保持されます。顧客の場合、パーティ番号には顧客番号(IDではなく)が保持されます。
PartyOriginalSystem: string

タイトル: Party Original System

最大長: 60

取引先コミュニティ・モデルの参加者パーティ・レコードの名前。
PartyOriginalSystemId: string

タイトル: Party Original System ID

最大長: 60

取引先コミュニティ・モデルの関係者パーティ・レコードの一意の識別子。
PayeeOnlyFlag: boolean

タイトル: Payee Only

最大長: 1

参加者が別の参加者のプランに受取人として割り当てられており、自分のプランを持っていないかどうかを示します。デフォルト値はtrueです。
StartDate: 文字列(日付)

タイトル: Active Start Date

参加者がアクティブになる日時。
WorkerNumber: string

タイトル: Worker Number

最大長: 30

人事管理によって割り当てられた従業員番号です。

{
    "required":[
        "OrgId",
        "ParticipantType"
    ],
    "type":"object",
    "properties":{
        "PartyOriginalSystemId":{
            "title":"Party Original System ID",
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for the participant party record in the Trading Community Model.",
            "nullable":true
        },
        "ParticipantRoles":{
            "title":"Participant Roles",
            "type":"array",
            "description":"The participant roles resource is used to view, create, update, and delete a role associated with a participant, such as a sales representative or a sales manager.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationParticipants-ParticipantRoles-item-post-request"
            }
        },
        "ParticipantFirstName":{
            "title":"Participant First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the participant.",
            "nullable":true
        },
        "ParticipantName":{
            "title":"Participant Name",
            "maxLength":360,
            "type":"string",
            "description":"The name  of the participant in incentive compensation.",
            "nullable":true
        },
        "ParticipantId":{
            "title":"Participant Identifier",
            "type":"integer",
            "description":"The unique identifier for a participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CurrencyCode":{
            "title":"Home Currency",
            "type":"string",
            "description":"The code representing the participant's home currency, as of the effective date range of the detail record. The home currency will be default in the participant detail record, when the value is passed in the participant header post operation.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Active Start Date",
            "type":"string",
            "description":"The date and time when the participant becomes active.",
            "format":"date",
            "nullable":false
        },
        "PayeeOnlyFlag":{
            "title":"Payee Only",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the participant is assigned as a payee to another participant's plan, and does not have his own plan. The default value is true.",
            "nullable":true
        },
        "CostCenter":{
            "title":"Cost Center",
            "type":"string",
            "description":"The participant's cost center as of the effective date range of the detail record. The cost center will be default in the participant detail record, when the value is passed in the participant header post operation.",
            "nullable":true,
            "x-queryable":false
        },
        "AnalystId":{
            "title":"Analyst Identifier",
            "type":"integer",
            "description":"The unique identifier of the analyst assigned to this participant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "participantsDFF":{
            "title":"Participants Descriptive Flex Fields",
            "type":"array",
            "description":"The participant descriptive flex fields resource is used to view, create, or update custom attributes for a participant resource and define validations for them. It is also used to delete an existing participant flex field.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationParticipants-participantsDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "CompensationEndDate":{
            "title":"Compensation End Date",
            "type":"string",
            "description":"The date up to which the participant may be paid even if he is no longer an active participant. The application generates paysheets based on this date, which may extend out beyond the participant's end date.",
            "format":"date",
            "nullable":true
        },
        "ParticipantDetails":{
            "title":"Participant Details",
            "type":"array",
            "description":"The participant details resource is used to view, create, and update the details of a participant, such as the cost center, location, etc.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationParticipants-ParticipantDetails-item-post-request"
            }
        },
        "PartyOriginalSystem":{
            "title":"Party Original System",
            "maxLength":60,
            "type":"string",
            "description":"The name of the participant party record in the Trading Community Model.",
            "nullable":true
        },
        "ParticipantType":{
            "title":"Type",
            "maxLength":60,
            "type":"string",
            "description":"Indicates whether the participant is an administrator (responsible for updating tools) or a sales team member (capable of getting sales credit.) Possible values include ANALYST for Administrator, and PARTICIPANT for Sales Team member. A list of acceptable values is defined in the lookup CN_PARTICIPANT_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CountryCode":{
            "title":"Country",
            "type":"string",
            "description":"The code representing the country where the participant works, as of the effective date range of the detail record. The country code will be default in the participant detail record, when the value is passed in the participant header post operation.",
            "nullable":true,
            "x-queryable":false
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the participant is active or not. Possible values include FALSE for not active, and TRUE for active. The default value is TRUE.",
            "nullable":false,
            "default":true
        },
        "EndDate":{
            "title":"Active End Date",
            "type":"string",
            "description":"The date and time when the participant becomes inactive.",
            "format":"date",
            "nullable":true
        },
        "HoldPaymentFlag":{
            "title":"Hold payment",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether to stop paying the participant's payments when the payment batch is paid. The default value is false.",
            "nullable":false,
            "default":false
        },
        "AnalystName":{
            "title":"Analyst",
            "maxLength":360,
            "type":"string",
            "description":"The name of the analyst assigned to the participant.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "HoldReason":{
            "title":"Hold Reason",
            "maxLength":30,
            "type":"string",
            "description":"Indicates why the payment is on hold. Possible values include DISPUTE for payment dispute, LEAVE for leave of absence, and TERMINATED when the participant is terminated. A list of acceptable values is defined in the lookup CN_HOLD_REASON_CODE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The user-defined value of the party associated with the participant. A party can be a partner, a salesperson, a vendor, a resource, or an employee. In the case of an employee from HR, the party number might hold the employee number (not ID). In the case of a customer, the party number might hold the customer number (not ID).",
            "nullable":true
        },
        "PartyId":{
            "title":"Party Identifier",
            "type":"integer",
            "description":"The unique identifier for the party record in the Trading Community Model.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WorkerNumber":{
            "title":"Worker Number",
            "maxLength":30,
            "type":"string",
            "description":"The Employee number assigned by Human Resources.",
            "nullable":true
        },
        "ParticipantLastName":{
            "title":"Participant Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the participant.",
            "nullable":true
        }
    }
}

ネストされたスキーマ : 参加者詳細

タイプ: array

タイトル: Participant Details

関係者詳細リソースは、コスト・センター、事業所など、関係者の詳細を表示、作成および更新するために使用されます。

ソースを表示

Array of: object schema

{
    "title":"Participant Details",
    "type":"array",
    "description":"The participant details resource is used to view, create, and update the details of a participant, such as the cost center, location, etc.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationParticipants-ParticipantDetails-item-post-request"
    }
}

ネストされたスキーマ : 参加者ロール

タイプ: array

タイトル: Participant Roles

関係者ロール・リソースを使用して、関係者に関連付けられたロール(営業担当や営業マネージャなど)を表示、作成、更新および削除します。

ソースを表示

Array of: object schema

{
    "title":"Participant Roles",
    "type":"array",
    "description":"The participant roles resource is used to view, create, update, and delete a role associated with a participant, such as a sales representative or a sales manager.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationParticipants-ParticipantRoles-item-post-request"
    }
}

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

タイプ: array

タイトル: Participants Descriptive Flex Fields

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

ソースを表示

Array of: object schema

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

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

タイプ: object

ソースを表示

CostCenter: string

タイトル: Cost Center

最大長: 30

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

タイトル: Country

最大長: 30

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

タイトル: Home Currency

最大長: 30

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

タイトル: Effective End Date

詳細が参加者の応募を停止する日時。
ParticipantDetailId: integer (int64)

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

タイトル: Participant Details Descriptive Flex Fields

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

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

タイトル: Effective Start Date

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

{
    "required":[
        "CurrencyCode",
        "ParticipantId",
        "StartDate"
    ],
    "type":"object",
    "properties":{
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier for a participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
        },
        "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"
            }
        },
        "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-post-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-post-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"
                }
            }
        }
    }
}

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

タイプ: object

ソースを表示

EndDateActive: 文字列(日付)

タイトル: Role End Date

その参加者のロール割当が終了する日付。書式はyyyy-mm-ddです。
ParticipantId: integer (int64)

タイトル: Participant Identifier

参加者レコードの一意の識別子。
ParticipantRoleId: integer (int64)

タイトル: Participant Role ID

関係者ロールの一意の識別子。
PreserveRoleAssignmentFlag: boolean

タイトル: Preserve Assignment

ロール割当を保持するかどうか、およびロール割当の自動プロセスによる更新を防止するかどうかを示します。取り得る値には、更新を防止するためにTRUEが含まれます。ロールが関係者に手動で追加された場合、割当の保持はTrueに設定され、更新を許可する場合はFALSEに設定されます。
RoleId: integer (int64)

タイトル: Role ID

関係者レコードに割り当てられたロールの一意の識別子。
StartDateActive: 文字列(日付)

タイトル: Role Start Date

関係者のロール割当が開始する日付。これは必須フィールドです。書式はyyyy-mm-ddです。

{
    "type":"object",
    "properties":{
        "ParticipantId":{
            "title":"Participant Identifier",
            "type":"integer",
            "description":"The unique identifier of the participant record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StartDateActive":{
            "title":"Role Start Date",
            "type":"string",
            "description":"The date when the role assignment starts for a participant. This is a mandatory field. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false
        },
        "EndDateActive":{
            "title":"Role End Date",
            "type":"string",
            "description":"The date when the role assignment ends for that participant. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true
        },
        "PreserveRoleAssignmentFlag":{
            "title":"Preserve Assignment",
            "type":"boolean",
            "description":"Indicates whether to keep the role assignment and to prevent update by the automatic the role assignment process. Possible values include TRUE to prevent update. In cases where the Role is added manually to participants, the Preserve Assignment is set as True, and FALSE to allow update.",
            "nullable":true
        },
        "ParticipantRoleId":{
            "title":"Participant Role ID",
            "type":"integer",
            "description":"The unique identifier for the participant role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "RoleId":{
            "title":"Role ID",
            "type":"integer",
            "description":"The unique identifier for a role assigned to a participant record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        }
    }
}

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

タイプ: object

ソースを表示

__FLEX_Context: string

タイトル: Context Segment

最大長: 30

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

タイトル: Context Segment

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

タイトル: Participant Identifier

関係者の一意の識別子。

{
    "type":"object",
    "properties":{
        "ParticipantId":{
            "title":"Participant Identifier",
            "type":"integer",
            "description":"The unique identifier for a participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The flex context segment display name for the participant. 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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"The flex context segment code for the participant. 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":"LOV"
            },
            "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-item-response

タイプ: object

ソースを表示

ActiveFlag: boolean

タイトル: Active

最大長: 1

デフォルト値: true

参加者がアクティブかどうかを示します。可能な値は、アクティブでない場合はFALSE、アクティブの場合はTRUEです。デフォルト値はTRUEです。
AnalystId: integer (int64)

タイトル: Analyst Identifier

この関係者に割り当てられたアナリストの一意の識別子。
AnalystName: string

タイトル: Analyst

最大長: 360

参加者に割り当てられたアナリストの名前。
CompensationEndDate: 文字列(日付)

タイトル: Compensation End Date

参加者がアクティブな参加者でなくなった場合でも、その参加者に支払われることのできる最終日。この日付に基づいて支払シートが生成され、参加者の終了日を超えて延長される場合があります。
CostCenter: string

タイトル: Cost Center

詳細レコードの有効日範囲における参加者のコスト・センター。値が関係者ヘッダーの転記操作で渡されると、コスト・センターが関係者詳細レコードにデフォルト設定されます。
CountryCode: string

タイトル: Country

詳細レコードの有効日範囲時点での、関係者が勤務する国を表すコード。値が参加者ヘッダー転記操作で渡されると、国コードは参加者詳細レコードにデフォルトになります。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

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

タイトル: Home Currency

詳細レコードの有効日範囲時点での、参加者のホーム通貨を表すコード。値が参加者ヘッダー転記操作で渡されると、参加者詳細レコードにホーム通貨がデフォルト設定されます。
EmailAddress: string

タイトル: Email Address

読取り専用: true

最大長: 320

参加者のEメール・アドレス。
EndDate: 文字列(日付)

タイトル: Active End Date

参加者が非アクティブになる日時。
HoldPaymentFlag: boolean

タイトル: Hold payment

最大長: 1

デフォルト値: false

支払バッチの支払時に、参加者の支払の支払を停止するかどうかを示します。デフォルト値はfalseです。
HoldReason: string

タイトル: Hold Reason

最大長: 30

支払が保留されている理由を示します。可能な値には、支払係争のDISPUTE、休職のLEAVE、参加者が退職したときにTERMINATEDが含まれます。許容可能な値のリストは、参照CN_HOLD_REASON_CODEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
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

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

タイトル: Business Unit

ビジネス・ユニットの一意の識別子。
ParticipantDeleteFlag: boolean

読取り専用: true

デフォルト値: false

関係者を削除できるかどうかを示します。
ParticipantDetails: array Participant Details

タイトル: Participant Details

関係者詳細リソースは、コスト・センター、事業所など、関係者の詳細を表示、作成および更新するために使用されます。
ParticipantFirstName: string

タイトル: Participant First Name

最大長: 150

参加者の名。
ParticipantId: integer (int64)

タイトル: Participant Identifier

関係者の一意の識別子。
ParticipantLastName: string

タイトル: Participant Last Name

最大長: 150

参加者の姓。
ParticipantName: string

タイトル: Participant Name

最大長: 360

インセンティブ報酬の関係者の名前。
ParticipantRoles: array Participant Roles

タイトル: Participant Roles

関係者ロール・リソースを使用して、関係者に関連付けられたロール(営業担当や営業マネージャなど)を表示、作成、更新および削除します。
participantsDFF: array Participants Descriptive Flex Fields

タイトル: Participants Descriptive Flex Fields

関係者付加フレックスフィールド・リソースは、関係者リソースのカスタム属性を表示、作成または更新し、検証を定義するために使用されます。既存の参加者フレックス・フィールドの削除にも使用されます。
ParticipantType: string

タイトル: Type

最大長: 60

参加者が管理者(ツールの更新を担当)であるか、営業チーム・メンバー(販売実績の取得が可能)であるかを示します取り得る値には、管理者用のANALYSTと営業チーム・メンバー用のPARTICIPANTがあります。受理可能な値のリストは、参照CN_PARTICIPANT_TYPEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
PartyId: integer (int64)

タイトル: Party Identifier

取引先コミュニティ・モデルのパーティ・レコードの一意の識別子。
PartyNumber: string

タイトル: Party Number

最大長: 30

関係者に関連付けられたパーティのユーザー定義値。パーティは、パートナ、営業担当、ベンダー、リソースまたは従業員です。 HRからの従業員の場合、パーティ番号には(IDではなく)従業員番号が保持されます。顧客の場合、パーティ番号には顧客番号(IDではなく)が保持されます。
PartyOriginalSystem: string

タイトル: Party Original System

最大長: 60

取引先コミュニティ・モデルの参加者パーティ・レコードの名前。
PartyOriginalSystemId: string

タイトル: Party Original System ID

最大長: 60

取引先コミュニティ・モデルの関係者パーティ・レコードの一意の識別子。
PayeeOnlyFlag: boolean

タイトル: Payee Only

最大長: 1

参加者が別の参加者のプランに受取人として割り当てられており、自分のプランを持っていないかどうかを示します。デフォルト値はtrueです。
PersonNumber: string

タイトル: Person Number

読取り専用: true

最大長: 30

企業との関係に関係なく、アプリケーション内の個人を一意に識別するFusion HCM固有の識別子。国別識別子コンポーネントとの関連はありません。
StartDate: 文字列(日付)

タイトル: Active Start Date

参加者がアクティブになる日時。
WorkerNumber: string

タイトル: Worker Number

最大長: 30

人事管理によって割り当てられた従業員番号です。

{
    "type":"object",
    "properties":{
        "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
        },
        "PartyOriginalSystemId":{
            "title":"Party Original System ID",
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for the participant party record in the Trading Community Model.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantRoles":{
            "title":"Participant Roles",
            "type":"array",
            "description":"The participant roles resource is used to view, create, update, and delete a role associated with a participant, such as a sales representative or a sales manager.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationParticipants-ParticipantRoles-item-response"
            }
        },
        "ParticipantFirstName":{
            "title":"Participant First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the participant.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Participant Name",
            "maxLength":360,
            "type":"string",
            "description":"The name  of the participant in incentive compensation.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "title":"Participant Identifier",
            "type":"integer",
            "description":"The unique identifier for a participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Home Currency",
            "type":"string",
            "description":"The code representing the participant's home currency, as of the effective date range of the detail record. The home currency will be default in the participant detail record, when the value is passed in the participant header post operation.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Active Start Date",
            "type":"string",
            "description":"The date and time when the participant becomes active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PayeeOnlyFlag":{
            "title":"Payee Only",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the participant is assigned as a payee to another participant's plan, and does not have his own plan. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "CostCenter":{
            "title":"Cost Center",
            "type":"string",
            "description":"The participant's cost center as of the effective date range of the detail record. The cost center will be default in the participant detail record, when the value is passed in the participant header post operation.",
            "nullable":true,
            "x-queryable":false
        },
        "AnalystId":{
            "title":"Analyst Identifier",
            "type":"integer",
            "description":"The unique identifier of the analyst assigned to this participant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "participantsDFF":{
            "title":"Participants Descriptive Flex Fields",
            "type":"array",
            "description":"The participant descriptive flex fields resource is used to view, create, or update custom attributes for a participant resource and define validations for them. It is also used to delete an existing participant flex field.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationParticipants-participantsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "CompensationEndDate":{
            "title":"Compensation End Date",
            "type":"string",
            "description":"The date up to which the participant may be paid even if he is no longer an active participant. The application generates paysheets based on this date, which may extend out beyond the participant's end date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantDetails":{
            "title":"Participant Details",
            "type":"array",
            "description":"The participant details resource is used to view, create, and update the details of a participant, such as the cost center, location, etc.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationParticipants-ParticipantDetails-item-response"
            }
        },
        "PartyOriginalSystem":{
            "title":"Party Original System",
            "maxLength":60,
            "type":"string",
            "description":"The name of the participant party record in the Trading Community Model.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParticipantType":{
            "title":"Type",
            "maxLength":60,
            "type":"string",
            "description":"Indicates whether the participant is an administrator (responsible for updating tools) or a sales team member (capable of getting sales credit.) Possible values include ANALYST for Administrator, and PARTICIPANT for Sales Team member. A list of acceptable values is defined in the lookup CN_PARTICIPANT_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country",
            "type":"string",
            "description":"The code representing the country where the participant works, as of the effective date range of the detail record. The country code will be default in the participant detail record, when the value is passed in the participant header post operation.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"The Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component.",
            "nullable":true,
            "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
        },
        "ParticipantDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the participant can be removed.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the participant is active or not. Possible values include FALSE for not active, and TRUE for active. The default value is TRUE.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Active End Date",
            "type":"string",
            "description":"The date and time when the participant becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "HoldPaymentFlag":{
            "title":"Hold payment",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether to stop paying the participant's payments when the payment batch is paid. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email Address",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the participant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "AnalystName":{
            "title":"Analyst",
            "maxLength":360,
            "type":"string",
            "description":"The name of the analyst assigned to the participant.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "HoldReason":{
            "title":"Hold Reason",
            "maxLength":30,
            "type":"string",
            "description":"Indicates why the payment is on hold. Possible values include DISPUTE for payment dispute, LEAVE for leave of absence, and TERMINATED when the participant is terminated. A list of acceptable values is defined in the lookup CN_HOLD_REASON_CODE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The user-defined value of the party associated with the participant. A party can be a partner, a salesperson, a vendor, a resource, or an employee. In the case of an employee from HR, the party number might hold the employee number (not ID). In the case of a customer, the party number might hold the customer number (not ID).",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party Identifier",
            "type":"integer",
            "description":"The unique identifier for the party record in the Trading Community Model.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkerNumber":{
            "title":"Worker Number",
            "maxLength":30,
            "type":"string",
            "description":"The Employee number assigned by Human Resources.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantLastName":{
            "title":"Participant Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the participant.",
            "nullable":true,
            "x-queryable":true
        },
        "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

関係者詳細リソースは、コスト・センター、事業所など、関係者の詳細を表示、作成および更新するために使用されます。

ソースを表示

Array of: object incentiveCompensationParticipants-ParticipantDetails-item-response

{
    "title":"Participant Details",
    "type":"array",
    "description":"The participant details resource is used to view, create, and update the details of a participant, such as the cost center, location, etc.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationParticipants-ParticipantDetails-item-response"
    }
}

ネストされたスキーマ : 参加者ロール

タイプ: array

タイトル: Participant Roles

関係者ロール・リソースを使用して、関係者に関連付けられたロール(営業担当や営業マネージャなど)を表示、作成、更新および削除します。

ソースを表示

Array of: object incentiveCompensationParticipants-ParticipantRoles-item-response

{
    "title":"Participant Roles",
    "type":"array",
    "description":"The participant roles resource is used to view, create, update, and delete a role associated with a participant, such as a sales representative or a sales manager.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationParticipants-ParticipantRoles-item-response"
    }
}

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

タイプ: array

タイトル: Participants Descriptive Flex Fields

ソースを表示

Array of: object incentiveCompensationParticipants-participantsDFF-item-response

{
    "title":"Participants Descriptive Flex Fields",
    "type":"array",
    "description":"The participant descriptive flex fields resource is used to view, create, or update custom attributes for a participant resource and define validations for them. It is also used to delete an existing participant flex field.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationParticipants-participantsDFF-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-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"
}

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

ネストされたスキーマ : incentiveCompensationParticipants-ParticipantRoles-item-response

タイプ: object

ソースを表示

AccessType: string

タイトル: Access Type

読取り専用: true

最大長: 30

デフォルト値: INDIVIDUAL

マネージャや個人など、アクセス・タイプを表す参照コード。可能な値には、参加者アクセスが個人であることを指定するINDIVIDUALと、参加者アクセスがマネージャであることを指定するMANAGERがあります。デフォルト値はINDIVIDUALです。許容可能な値のリストは、参照CN_ACCESS_TYPEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
EndDateActive: 文字列(日付)

タイトル: Role End Date

その参加者のロール割当が終了する日付。書式はyyyy-mm-ddです。
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

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

タイトル: Participant Identifier

参加者レコードの一意の識別子。
ParticipantRoleId: integer (int64)

タイトル: Participant Role ID

関係者ロールの一意の識別子。
PreserveRoleAssignmentFlag: boolean

タイトル: Preserve Assignment

ロール割当を保持するかどうか、およびロール割当の自動プロセスによる更新を防止するかどうかを示します。取り得る値には、更新を防止するためにTRUEが含まれます。ロールが関係者に手動で追加された場合、割当の保持はTrueに設定され、更新を許可する場合はFALSEに設定されます。
RoleId: integer (int64)

タイトル: Role ID

関係者レコードに割り当てられたロールの一意の識別子。
RoleName: string

タイトル: Role Name

読取り専用: true

最大長: 60

ロールの名前。
StartDateActive: 文字列(日付)

タイトル: Role Start Date

関係者のロール割当が開始する日付。これは必須フィールドです。書式はyyyy-mm-ddです。

{
    "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
        },
        "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
        },
        "ParticipantRoleId":{
            "title":"Participant Role ID",
            "type":"integer",
            "description":"The unique identifier for the participant role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RoleId":{
            "title":"Role ID",
            "type":"integer",
            "description":"The unique identifier for a role assigned to a participant record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantId":{
            "title":"Participant Identifier",
            "type":"integer",
            "description":"The unique identifier of the participant record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Role Start Date",
            "type":"string",
            "description":"The date when the role assignment starts for a participant. This is a mandatory field. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"Role End Date",
            "type":"string",
            "description":"The date when the role assignment ends for that participant. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PreserveRoleAssignmentFlag":{
            "title":"Preserve Assignment",
            "type":"boolean",
            "description":"Indicates whether to keep the role assignment and to prevent update by the automatic the role assignment process. Possible values include TRUE to prevent update. In cases where the Role is added manually to participants, the Preserve Assignment is set as True, and FALSE to allow update.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccessType":{
            "title":"Access Type",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that represents the access type, such as manager or individual. Possible values include INDIVIDUAL which specifies that the participant access is individual, and MANAGER which specifies that the participant access is manager. The default value is INDIVIDUAL.  A list of acceptable values is defined in the lookup CN_ACCESS_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"INDIVIDUAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "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"
    }
}

ネストされたスキーマ : incentiveCompensationParticipants-participantsDFF-item-response

タイプ: object

ソースを表示

__FLEX_Context: string

タイトル: Context Segment

最大長: 30

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

タイトル: Context Segment

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

タイトル: Links

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

タイトル: Participant Identifier

関係者の一意の識別子。

{
    "type":"object",
    "properties":{
        "ParticipantId":{
            "title":"Participant Identifier",
            "type":"integer",
            "description":"The unique identifier for a participant.",
            "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"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The flex context segment display name for the participant. 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":"LOV"
            },
            "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":"The flex context segment code for the participant. 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":"LOV"
            },
            "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"
    }
}

リンク

BusinessUnitPVO

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV

ビジネス・ユニットの一意の識別子を含む値リスト。

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