Jump to

• Request
• Response

Create a participant header

post

/fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants

Request

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are 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 and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the participant is active or not. Possible values include FALSE for not active, and TRUE for active. The default value is TRUE.
• AnalystId: integer (int64)
  Title: Analyst Identifier

  The unique identifier of the analyst assigned to this participant.
• AnalystName: string
  Title: Analyst

  Maximum Length: 360

  The name of the analyst assigned to the participant.
• CompensationEndDate: string (date)
  Title: Compensation End Date

  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.
• CostCenter: string
  Title: Cost Center

  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.
• CountryCode: string
  Title: Country

  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.
• CurrencyCode: string
  Title: Home Currency

  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.
• EndDate: string (date)
  Title: Active End Date

  The date and time when the participant becomes inactive.
• HoldPaymentFlag: boolean
  Title: Hold payment

  Maximum Length: 1

  Default Value: false

  Indicates whether to stop paying the participant's payments when the payment batch is paid. The default value is false.
• HoldReason: string
  Title: Hold Reason

  Maximum Length: 30

  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.
• OrgId(required): integer (int64)
  Title: Business Unit

  The unique identifier of the business unit.
• ParticipantDetails: array Participant Details
  Title: Participant Details

  The participant details resource is used to view, create, and update the details of a participant, such as the cost center, location, etc.
• ParticipantFirstName: string
  Title: Participant First Name

  Maximum Length: 150

  The first name of the participant.
• ParticipantId: integer (int64)
  Title: Participant Identifier

  The unique identifier for a participant.
• ParticipantLastName: string
  Title: Participant Last Name

  Maximum Length: 150

  The last name of the participant.
• ParticipantName: string
  Title: Participant Name

  Maximum Length: 360

  The name of the participant in incentive compensation.
• ParticipantRoles: array Participant Roles
  Title: Participant Roles

  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.
• participantsDFF: array Participants Descriptive Flex Fields
  Title: Participants Descriptive Flex Fields

  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.
• ParticipantType(required): string
  Title: Type

  Maximum Length: 60

  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.
• PartyId: integer (int64)
  Title: Party Identifier

  The unique identifier for the party record in the Trading Community Model.
• PartyNumber: string
  Title: Party Number

  Maximum Length: 30

  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).
• PartyOriginalSystem: string
  Title: Party Original System

  Maximum Length: 60

  The name of the participant party record in the Trading Community Model.
• PartyOriginalSystemId: string
  Title: Party Original System ID

  Maximum Length: 60

  The unique identifier for the participant party record in the Trading Community Model.
• PayeeOnlyFlag: boolean
  Title: Payee Only

  Maximum Length: 1

  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.
• StartDate: string (date)
  Title: Active Start Date

  The date and time when the participant becomes active.
• WorkerNumber: string
  Title: Worker Number

  Maximum Length: 30

  The Employee number assigned by Human Resources.

{
    "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
        }
    }
}

Nested Schema : Participant Details

Type: array

Title: Participant Details

The participant details resource is used to view, create, and update the details of a participant, such as the cost center, location, etc.

Show Source

• 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"
    }
}

Nested Schema : Participant Roles

Type: array

Title: Participant Roles

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.

Show Source

• 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"
    }
}

Nested Schema : Participants Descriptive Flex Fields

Type: array

Title: Participants Descriptive Flex Fields

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.

Show Source

• 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"
}

Nested Schema : schema

Type: object

Show Source

• CostCenter: string
  Title: Cost Center

  Maximum Length: 30

  The participant's cost center as of the effective date range of the detail record.
• CountryCode: string
  Title: Country

  Maximum Length: 30

  The code representing the country where the participant works, as of the effective date range of the detail record.
• CurrencyCode(required): string
  Title: Home Currency

  Maximum Length: 30

  The code representing the participant's home currency, as of the effective date range of the detail record.
• EndDate: string (date)
  Title: Effective End Date

  The date and time when the detail stops applying for the participant.
• ParticipantDetailId: integer (int64)
  The unique identifier for the participant's detail record. A participant can have multiple details records without overlapping date ranges.
• participantDetailsDFF: array Participant Details Descriptive Flex Fields
  Title: Participant Details Descriptive Flex Fields

  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.
• ParticipantId(required): integer (int64)
  The unique identifier for a participant.
• StartDate(required): string (date)
  Title: Effective Start Date

  The date and time when the detail record starts applying for the participant.

{
    "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
        }
    }
}

Nested Schema : Participant Details Descriptive Flex Fields

Type: array

Title: Participant Details Descriptive Flex Fields

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.

Show Source

• 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"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  The flex context segment code for the participant details. It determines which context-sensitive segments are displayed.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  The flex context segment display name for the participant details. It determines which context-sensitive segments are displayed.
• ParticipantDetailId: integer (int64)
  The unique identifier for the participant's detail record. A participant can have multiple detail records without overlapping date ranges.

{
    "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_IsDiscriminator":"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"
                }
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• EndDateActive: string (date)
  Title: Role End Date

  The date when the role assignment ends for that participant. The format is yyyy-mm-dd.
• ParticipantId: integer (int64)
  Title: Participant Identifier

  The unique identifier of the participant record.
• ParticipantRoleId: integer (int64)
  Title: Participant Role ID

  The unique identifier for the participant role.
• PreserveRoleAssignmentFlag: boolean
  Title: Preserve Assignment

  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.
• RoleId: integer (int64)
  Title: Role ID

  The unique identifier for a role assigned to a participant record.
• StartDateActive: string (date)
  Title: Role Start Date

  The date when the role assignment starts for a participant. This is a mandatory field. The format is 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"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  The flex context segment code for the participant. It determines which context-sensitive segments are displayed.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  The flex context segment display name for the participant. It determines which context-sensitive segments are displayed.
• ParticipantId: integer (int64)
  Title: Participant Identifier

  The unique identifier for a participant.

{
    "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_IsDiscriminator":"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"
                }
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : incentiveCompensationParticipants-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the participant is active or not. Possible values include FALSE for not active, and TRUE for active. The default value is TRUE.
• AnalystId: integer (int64)
  Title: Analyst Identifier

  The unique identifier of the analyst assigned to this participant.
• AnalystName: string
  Title: Analyst

  Maximum Length: 360

  The name of the analyst assigned to the participant.
• CompensationEndDate: string (date)
  Title: Compensation End Date

  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.
• CostCenter: string
  Title: Cost Center

  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.
• CountryCode: string
  Title: Country

  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.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• CurrencyCode: string
  Title: Home Currency

  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.
• EmailAddress: string
  Title: Email Address

  Read Only: true

  Maximum Length: 320

  The email address of the participant.
• EndDate: string (date)
  Title: Active End Date

  The date and time when the participant becomes inactive.
• HoldPaymentFlag: boolean
  Title: Hold payment

  Maximum Length: 1

  Default Value: false

  Indicates whether to stop paying the participant's payments when the payment batch is paid. The default value is false.
• HoldReason: string
  Title: Hold Reason

  Maximum Length: 30

  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.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrgId: integer (int64)
  Title: Business Unit

  The unique identifier of the business unit.
• ParticipantDeleteFlag: boolean
  Read Only: true

  Default Value: false

  Indicates whether the participant can be removed.
• ParticipantDetails: array Participant Details
  Title: Participant Details

  The participant details resource is used to view, create, and update the details of a participant, such as the cost center, location, etc.
• ParticipantFirstName: string
  Title: Participant First Name

  Maximum Length: 150

  The first name of the participant.
• ParticipantId: integer (int64)
  Title: Participant Identifier

  The unique identifier for a participant.
• ParticipantLastName: string
  Title: Participant Last Name

  Maximum Length: 150

  The last name of the participant.
• ParticipantName: string
  Title: Participant Name

  Maximum Length: 360

  The name of the participant in incentive compensation.
• ParticipantRoles: array Participant Roles
  Title: Participant Roles

  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.
• participantsDFF: array Participants Descriptive Flex Fields
  Title: Participants Descriptive Flex Fields

  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.
• ParticipantType: string
  Title: Type

  Maximum Length: 60

  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.
• PartyId: integer (int64)
  Title: Party Identifier

  The unique identifier for the party record in the Trading Community Model.
• PartyNumber: string
  Title: Party Number

  Maximum Length: 30

  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).
• PartyOriginalSystem: string
  Title: Party Original System

  Maximum Length: 60

  The name of the participant party record in the Trading Community Model.
• PartyOriginalSystemId: string
  Title: Party Original System ID

  Maximum Length: 60

  The unique identifier for the participant party record in the Trading Community Model.
• PayeeOnlyFlag: boolean
  Title: Payee Only

  Maximum Length: 1

  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.
• PersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  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.
• StartDate: string (date)
  Title: Active Start Date

  The date and time when the participant becomes active.
• WorkerNumber: string
  Title: Worker Number

  Maximum Length: 30

  The Employee number assigned by Human Resources.

{
    "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
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Participant Details

Type: array

Title: Participant Details

The participant details resource is used to view, create, and update the details of a participant, such as the cost center, location, etc.

Show Source

• 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"
    }
}

Nested Schema : Participant Roles

Type: array

Title: Participant Roles

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.

Show Source

• 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"
    }
}

Nested Schema : Participants Descriptive Flex Fields

Type: array

Title: Participants Descriptive Flex Fields

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.

Show Source

• 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"
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: 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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : incentiveCompensationParticipants-ParticipantDetails-item-response

Type: object

Show Source

• CostCenter: string
  Title: Cost Center

  Maximum Length: 30

  The participant's cost center as of the effective date range of the detail record.
• CountryCode: string
  Title: Country

  Maximum Length: 30

  The code representing the country where the participant works, as of the effective date range of the detail record.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• CurrencyCode: string
  Title: Home Currency

  Maximum Length: 30

  The code representing the participant's home currency, as of the effective date range of the detail record.
• EndDate: string (date)
  Title: Effective End Date

  The date and time when the detail stops applying for the participant.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantDetailDeleteFlag: boolean
  Read Only: true

  Default Value: false

  Indicates whether the participant details can be deleted.
• ParticipantDetailId: integer (int64)
  The unique identifier for the participant's detail record. A participant can have multiple details records without overlapping date ranges.
• participantDetailsDFF: array Participant Details Descriptive Flex Fields
  Title: Participant Details Descriptive Flex Fields

  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.
• ParticipantId: integer (int64)
  The unique identifier for a participant.
• StartDate: string (date)
  Title: Effective Start Date

  The date and time when the detail record starts applying for the participant.

{
    "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
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Participant Details Descriptive Flex Fields

Type: array

Title: Participant Details Descriptive Flex Fields

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.

Show Source

• 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"
}

Nested Schema : incentiveCompensationParticipants-ParticipantDetails-participantDetailsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  The flex context segment code for the participant details. It determines which context-sensitive segments are displayed.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  The flex context segment display name for the participant details. It determines which context-sensitive segments are displayed.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantDetailId: integer (int64)
  The unique identifier for the participant's detail record. A participant can have multiple detail records without overlapping date ranges.

{
    "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_IsDiscriminator":"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
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : incentiveCompensationParticipants-ParticipantRoles-item-response

Type: object

Show Source

• AccessType: string
  Title: Access Type

  Read Only: true

  Maximum Length: 30

  Default Value: INDIVIDUAL

  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.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• EndDateActive: string (date)
  Title: Role End Date

  The date when the role assignment ends for that participant. The format is yyyy-mm-dd.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantId: integer (int64)
  Title: Participant Identifier

  The unique identifier of the participant record.
• ParticipantRoleId: integer (int64)
  Title: Participant Role ID

  The unique identifier for the participant role.
• PreserveRoleAssignmentFlag: boolean
  Title: Preserve Assignment

  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.
• RoleId: integer (int64)
  Title: Role ID

  The unique identifier for a role assigned to a participant record.
• RoleName: string
  Title: Role Name

  Read Only: true

  Maximum Length: 60

  The name of the role.
• StartDateActive: string (date)
  Title: Role Start Date

  The date when the role assignment starts for a participant. This is a mandatory field. The format is 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
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : incentiveCompensationParticipants-participantsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  The flex context segment code for the participant. It determines which context-sensitive segments are displayed.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  The flex context segment display name for the participant. It determines which context-sensitive segments are displayed.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantId: integer (int64)
  Title: Participant Identifier

  The unique identifier for a participant.

{
    "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_IsDiscriminator":"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
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

BusinessUnitPVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV

The list of values containing the unique identifiers of the business units.

The following properties are defined on the LOV link relation:

• Source Attribute: OrgId; Target Attribute: OrganizationId
• Display Attribute: Name

CnLookupHoldReasonVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_HOLD_REASON_CODE

The list of values indicating 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.

The following properties are defined on the LOV link relation:

• Source Attribute: HoldReason; Target Attribute: LookupCode
• Display Attribute: Meaning

CnLookupParticipantTypeVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_PARTICIPANT_TYPE

The list of values indicating 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.

The following properties are defined on the LOV link relation:

• Source Attribute: ParticipantType; Target Attribute: LookupCode
• Display Attribute: Meaning

ParticipantDetails

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantDetails

Parameters:

• incentiveCompensationParticipantsUniqID: $request.path.incentiveCompensationParticipantsUniqID

The participant details resource is used to view, create, and update the details of a participant, such as the cost center, location, etc.

ParticipantRoles

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantRoles

Parameters:

• incentiveCompensationParticipantsUniqID: $request.path.incentiveCompensationParticipantsUniqID

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.

participantsDFF

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/participantsDFF

Parameters:

• incentiveCompensationParticipantsUniqID: $request.path.incentiveCompensationParticipantsUniqID

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.

Back to Top