Jump to

• Request
• Response

Update a participant detail

patch

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

Request

Path Parameters

• ParticipantDetailId(required): integer(int64)
  The unique identifier for the participant's detail record. A participant can have multiple details records without overlapping date ranges.
• incentiveCompensationParticipantsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Participants resource and used to uniquely identify an instance of Participants. The client should not generate the hash key value. Instead, the client should query on the Participants collection resource in order to navigate to a specific instance of Participants to get the hash key.

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

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

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

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

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

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

Links

CountryCodeVO

Operation: /fscmRestApi/resources/11.13.18.05/territoriesLOV

The list of values containing the codes indicating the country where the participant works, as of the effective date range of the detail record.

The following properties are defined on the LOV link relation:

• Source Attribute: CountryCode; Target Attribute: TerritoryCode
• Display Attribute: TerritoryShortName

CurrencyCodeVO

Operation: /fscmRestApi/resources/11.13.18.05/currenciesLOV

The list of values containing the codes indicating the participant home currency, as of the effective date range of the detail record.

The following properties are defined on the LOV link relation:

• Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
• Display Attribute: CurrencyCode, Name

participantDetailsDFF

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

Parameters:

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

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.

Back to Top