Jump to

• Request
• Response

Update a payroll relationship flexfields

patch

/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/PayRelationshipsDDF/{PayRelationshipsDDFUniqID}

Request

Path Parameters

• PayRelationshipsDDFUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PayrollRelationshipId, EffectiveStartDate and EffectiveEndDate ---for the Payroll Relationship Developer Descriptive Flexfields resource and used to uniquely identify an instance of Payroll Relationship Developer Descriptive Flexfields. The client should not generate the hash key value. Instead, the client should query on the Payroll Relationship Developer Descriptive Flexfields collection resource with a filter on the primary key values in order to navigate to a specific instance of Payroll Relationship Developer Descriptive Flexfields.
  
  For example: PayRelationshipsDDF?q=PayrollRelationshipId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3>
• payrollRelationshipsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Payroll Relationships resource and used to uniquely identify an instance of Payroll Relationships. The client should not generate the hash key value. Instead, the client should query on the Payroll Relationships collection resource in order to navigate to a specific instance of Payroll Relationships to get the hash key.

Header Parameters

• Metadata-Context: string
  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: string
  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 : Discriminator: __FLEX_Context

Type: object

Discriminator: __FLEX_Context

Discriminator Values

• AE
• SA
• US

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "AE":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-patch-request",
            "SA":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-patch-request",
            "US":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-patch-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-patch-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-patch-request"
        }
    ]
}

Match One Schema

Show Source

• AE - object oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-patch-request
• SA - object oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-patch-request
• US - object oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-patch-request

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "AE":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-patch-request",
            "SA":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-patch-request",
            "US":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-patch-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-patch-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-patch-request"
        }
    ]
}

Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Default Value: AE

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• _ACCOMMODATION_PROVIDED: string
  Title: Accommodation Provided

  Maximum Length: 150

  Accommodation Provided
• _ACCOMMODATION_PROVIDED_Display: string
  Title: Accommodation Provided

  Accommodation Provided
• _ORA_HRX_AE_MOL_EMPLOYEE_ID: string
  Title: MOHRE Employee ID

  Maximum Length: 150

  MOHRE Employee ID
• _ORA_HRX_AE_WPS_ACCOUNT_NUMBER: string
  Title: WPS Account Number

  Maximum Length: 150

  WPS Account Number
• _TRANSPORTATION_PROVIDED: string
  Title: Transportation Provided

  Maximum Length: 150

  Transportation Provided
• _TRANSPORTATION_PROVIDED_Display: string
  Title: Transportation Provided

  Transportation Provided
• EffectiveEndDate: string (date)
  Title: Effective End Date
• EffectiveStartDate: string (date)
  Title: Effective Start Date
• wpsAgentEmployeeId: string
  Title: WPS Agent Employee ID

  Maximum Length: 150

  WPS Agent Employee ID

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "_ACCOMMODATION_PROVIDED":{
            "title":"Accommodation Provided",
            "maxLength":150,
            "type":"string",
            "description":"Accommodation Provided",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_ACCOMMODATION_PROVIDED_Display",
                "help":{
                    "instruction":"Accommodation Provided"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"HRC_YES_NO#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ColumnName":"REL_INFORMATION1",
                "FND_ACFF_SegmentName":"ACCOMMODATION_PROVIDED",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_ACCOMMODATION_PROVIDED_Display":{
            "title":"Accommodation Provided",
            "type":"string",
            "description":"Accommodation Provided",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_ACCOMMODATION_PROVIDED",
                "help":{
                    "instruction":"Accommodation Provided"
                },
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_ORA_HRX_AE_MOL_EMPLOYEE_ID":{
            "title":"MOHRE Employee ID",
            "maxLength":150,
            "type":"string",
            "description":"MOHRE Employee ID",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"MOHRE Employee ID"
                },
                "FND_ACFF_ValueSetInfo":"ORA_HRX_AE_NUM_14#FORMAT_ONLY",
                "FND_ACFF_IsNumericOnly":"true",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"14",
                "FND_ACFF_ColumnName":"REL_INFORMATION3",
                "FND_ACFF_SegmentName":"ORA_HRX_AE_MOL_EMPLOYEE_ID",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_ORA_HRX_AE_WPS_ACCOUNT_NUMBER":{
            "title":"WPS Account Number",
            "maxLength":150,
            "type":"string",
            "description":"WPS Account Number",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"WPS Account Number"
                },
                "FND_ACFF_ValueSetInfo":"ORA_HRX_AE_NUM_16#FORMAT_ONLY",
                "FND_ACFF_IsNumericOnly":"true",
                "includeInCompactView":true,
                "FND_ACFF_MinimumValue":"1000000000000000",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"16",
                "FND_ACFF_ColumnName":"REL_INFORMATION4",
                "FND_ACFF_MaximumValue":"9999999999999999",
                "FND_ACFF_SegmentName":"ORA_HRX_AE_WPS_ACCOUNT_NUMBER",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_TRANSPORTATION_PROVIDED":{
            "title":"Transportation Provided",
            "maxLength":150,
            "type":"string",
            "description":"Transportation Provided",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_TRANSPORTATION_PROVIDED_Display",
                "help":{
                    "instruction":"Transportation Provided"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"HRC_YES_NO#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ColumnName":"REL_INFORMATION2",
                "FND_ACFF_SegmentName":"TRANSPORTATION_PROVIDED",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_TRANSPORTATION_PROVIDED_Display":{
            "title":"Transportation Provided",
            "type":"string",
            "description":"Transportation Provided",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_TRANSPORTATION_PROVIDED",
                "help":{
                    "instruction":"Transportation Provided"
                },
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "default":"AE",
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"PER_TERRITORY_CODE#TABLE",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "wpsAgentEmployeeId":{
            "title":"WPS Agent Employee ID",
            "maxLength":150,
            "type":"string",
            "description":"WPS Agent Employee ID",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"WPS Agent Employee ID"
                },
                "FND_ACFF_ValueSetInfo":"ORA_HRX_AE_NUM_9#FORMAT_ONLY",
                "FND_ACFF_IsNumericOnly":"true",
                "includeInCompactView":true,
                "FND_ACFF_MinimumValue":"100000000",
                "FND_ACFF_OpenIdentifier":"wpsAgentEmployeeId",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"9",
                "FND_ACFF_ColumnName":"REL_INFORMATION5",
                "FND_ACFF_MaximumValue":"999999999",
                "FND_ACFF_SegmentName":"ORA_HRX_AE_WPS_Agent_Empl_ID",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Default Value: SA

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• _ACCOMMODATION_PROVIDED: string
  Title: Accommodation Provided

  Maximum Length: 150

  Accommodation Provided
• _ACCOMMODATION_PROVIDED_Display: string
  Title: Accommodation Provided

  Accommodation Provided
• _TRANSPORTATION_PROVIDED: string
  Title: Transportation Provided

  Maximum Length: 150

  Transportation Provided
• _TRANSPORTATION_PROVIDED_Display: string
  Title: Transportation Provided

  Transportation Provided
• EffectiveEndDate: string (date)
  Title: Effective End Date
• EffectiveStartDate: string (date)
  Title: Effective Start Date

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "_ACCOMMODATION_PROVIDED":{
            "title":"Accommodation Provided",
            "maxLength":150,
            "type":"string",
            "description":"Accommodation Provided",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_ACCOMMODATION_PROVIDED_Display",
                "help":{
                    "instruction":"Accommodation Provided"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"HRC_YES_NO#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ColumnName":"REL_INFORMATION1",
                "FND_ACFF_SegmentName":"ACCOMMODATION_PROVIDED",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_ACCOMMODATION_PROVIDED_Display":{
            "title":"Accommodation Provided",
            "type":"string",
            "description":"Accommodation Provided",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_ACCOMMODATION_PROVIDED",
                "help":{
                    "instruction":"Accommodation Provided"
                },
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_TRANSPORTATION_PROVIDED":{
            "title":"Transportation Provided",
            "maxLength":150,
            "type":"string",
            "description":"Transportation Provided",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_TRANSPORTATION_PROVIDED_Display",
                "help":{
                    "instruction":"Transportation Provided"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"HRC_YES_NO#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ColumnName":"REL_INFORMATION2",
                "FND_ACFF_SegmentName":"TRANSPORTATION_PROVIDED",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_TRANSPORTATION_PROVIDED_Display":{
            "title":"Transportation Provided",
            "type":"string",
            "description":"Transportation Provided",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_TRANSPORTATION_PROVIDED",
                "help":{
                    "instruction":"Transportation Provided"
                },
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "default":"SA",
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"PER_TERRITORY_CODE#TABLE",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Default Value: US

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• EffectiveEndDate: string (date)
  Title: Effective End Date
• EffectiveStartDate: string (date)
  Title: Effective Start Date
• overtimeStatus: string
  Title: Overtime Status

  Maximum Length: 150

  Overtime Status
• overtimeStatus_Display: string
  Title: Overtime Status

  Overtime Status

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "default":"US",
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"PER_TERRITORY_CODE#TABLE",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "overtimeStatus":{
            "title":"Overtime Status",
            "maxLength":150,
            "type":"string",
            "description":"Overtime Status",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"overtimeStatus_Display",
                "help":{
                    "instruction":"Overtime Status"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"HRX_US_FLSA_CATEGORY#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_OpenIdentifier":"overtimeStatus",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ColumnName":"REL_INFORMATION1",
                "FND_ACFF_SegmentName":"FLSA_STATUS",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "overtimeStatus_Display":{
            "title":"Overtime Status",
            "type":"string",
            "description":"Overtime Status",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"overtimeStatus",
                "help":{
                    "instruction":"Overtime Status"
                },
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "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 : Discriminator: __FLEX_Context

Type: object

Discriminator: __FLEX_Context

Discriminator Values

• AE
• SA
• US

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "AE":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-response",
            "SA":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-response",
            "US":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-response"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-response"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-response"
        }
    ]
}

Match One Schema

Show Source

• AE - object oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-response
• SA - object oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-response
• US - object oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-response

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "AE":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-response",
            "SA":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-response",
            "US":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-response"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-response"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-response"
        }
    ]
}

Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Default Value: AE

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• _ACCOMMODATION_PROVIDED: string
  Title: Accommodation Provided

  Maximum Length: 150

  Accommodation Provided
• _ACCOMMODATION_PROVIDED_Display: string
  Title: Accommodation Provided

  Accommodation Provided
• _ORA_HRX_AE_MOL_EMPLOYEE_ID: string
  Title: MOHRE Employee ID

  Maximum Length: 150

  MOHRE Employee ID
• _ORA_HRX_AE_WPS_ACCOUNT_NUMBER: string
  Title: WPS Account Number

  Maximum Length: 150

  WPS Account Number
• _TRANSPORTATION_PROVIDED: string
  Title: Transportation Provided

  Maximum Length: 150

  Transportation Provided
• _TRANSPORTATION_PROVIDED_Display: string
  Title: Transportation Provided

  Transportation Provided
• EffectiveEndDate: string (date)
  Title: Effective End Date
• EffectiveStartDate: string (date)
  Title: Effective Start Date
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayrollRelationshipId: integer (int64)
• wpsAgentEmployeeId: string
  Title: WPS Agent Employee ID

  Maximum Length: 150

  WPS Agent Employee ID

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "PayrollRelationshipId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "_ACCOMMODATION_PROVIDED":{
            "title":"Accommodation Provided",
            "maxLength":150,
            "type":"string",
            "description":"Accommodation Provided",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_ACCOMMODATION_PROVIDED_Display",
                "help":{
                    "instruction":"Accommodation Provided"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"HRC_YES_NO#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ColumnName":"REL_INFORMATION1",
                "FND_ACFF_SegmentName":"ACCOMMODATION_PROVIDED",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_ACCOMMODATION_PROVIDED_Display":{
            "title":"Accommodation Provided",
            "type":"string",
            "description":"Accommodation Provided",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_ACCOMMODATION_PROVIDED",
                "help":{
                    "instruction":"Accommodation Provided"
                },
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_ORA_HRX_AE_MOL_EMPLOYEE_ID":{
            "title":"MOHRE Employee ID",
            "maxLength":150,
            "type":"string",
            "description":"MOHRE Employee ID",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"MOHRE Employee ID"
                },
                "FND_ACFF_ValueSetInfo":"ORA_HRX_AE_NUM_14#FORMAT_ONLY",
                "FND_ACFF_IsNumericOnly":"true",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"14",
                "FND_ACFF_ColumnName":"REL_INFORMATION3",
                "FND_ACFF_SegmentName":"ORA_HRX_AE_MOL_EMPLOYEE_ID",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_ORA_HRX_AE_WPS_ACCOUNT_NUMBER":{
            "title":"WPS Account Number",
            "maxLength":150,
            "type":"string",
            "description":"WPS Account Number",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"WPS Account Number"
                },
                "FND_ACFF_ValueSetInfo":"ORA_HRX_AE_NUM_16#FORMAT_ONLY",
                "FND_ACFF_IsNumericOnly":"true",
                "includeInCompactView":true,
                "FND_ACFF_MinimumValue":"1000000000000000",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"16",
                "FND_ACFF_ColumnName":"REL_INFORMATION4",
                "FND_ACFF_MaximumValue":"9999999999999999",
                "FND_ACFF_SegmentName":"ORA_HRX_AE_WPS_ACCOUNT_NUMBER",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_TRANSPORTATION_PROVIDED":{
            "title":"Transportation Provided",
            "maxLength":150,
            "type":"string",
            "description":"Transportation Provided",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_TRANSPORTATION_PROVIDED_Display",
                "help":{
                    "instruction":"Transportation Provided"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"HRC_YES_NO#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ColumnName":"REL_INFORMATION2",
                "FND_ACFF_SegmentName":"TRANSPORTATION_PROVIDED",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_TRANSPORTATION_PROVIDED_Display":{
            "title":"Transportation Provided",
            "type":"string",
            "description":"Transportation Provided",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_TRANSPORTATION_PROVIDED",
                "help":{
                    "instruction":"Transportation Provided"
                },
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "default":"AE",
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"PER_TERRITORY_CODE#TABLE",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "wpsAgentEmployeeId":{
            "title":"WPS Agent Employee ID",
            "maxLength":150,
            "type":"string",
            "description":"WPS Agent Employee ID",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"WPS Agent Employee ID"
                },
                "FND_ACFF_ValueSetInfo":"ORA_HRX_AE_NUM_9#FORMAT_ONLY",
                "FND_ACFF_IsNumericOnly":"true",
                "includeInCompactView":true,
                "FND_ACFF_MinimumValue":"100000000",
                "FND_ACFF_OpenIdentifier":"wpsAgentEmployeeId",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"9",
                "FND_ACFF_ColumnName":"REL_INFORMATION5",
                "FND_ACFF_MaximumValue":"999999999",
                "FND_ACFF_SegmentName":"ORA_HRX_AE_WPS_Agent_Empl_ID",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Default Value: SA

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• _ACCOMMODATION_PROVIDED: string
  Title: Accommodation Provided

  Maximum Length: 150

  Accommodation Provided
• _ACCOMMODATION_PROVIDED_Display: string
  Title: Accommodation Provided

  Accommodation Provided
• _TRANSPORTATION_PROVIDED: string
  Title: Transportation Provided

  Maximum Length: 150

  Transportation Provided
• _TRANSPORTATION_PROVIDED_Display: string
  Title: Transportation Provided

  Transportation Provided
• EffectiveEndDate: string (date)
  Title: Effective End Date
• EffectiveStartDate: string (date)
  Title: Effective Start Date
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayrollRelationshipId: integer (int64)

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "PayrollRelationshipId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "_ACCOMMODATION_PROVIDED":{
            "title":"Accommodation Provided",
            "maxLength":150,
            "type":"string",
            "description":"Accommodation Provided",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_ACCOMMODATION_PROVIDED_Display",
                "help":{
                    "instruction":"Accommodation Provided"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"HRC_YES_NO#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ColumnName":"REL_INFORMATION1",
                "FND_ACFF_SegmentName":"ACCOMMODATION_PROVIDED",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_ACCOMMODATION_PROVIDED_Display":{
            "title":"Accommodation Provided",
            "type":"string",
            "description":"Accommodation Provided",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_ACCOMMODATION_PROVIDED",
                "help":{
                    "instruction":"Accommodation Provided"
                },
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_TRANSPORTATION_PROVIDED":{
            "title":"Transportation Provided",
            "maxLength":150,
            "type":"string",
            "description":"Transportation Provided",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_TRANSPORTATION_PROVIDED_Display",
                "help":{
                    "instruction":"Transportation Provided"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"HRC_YES_NO#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ColumnName":"REL_INFORMATION2",
                "FND_ACFF_SegmentName":"TRANSPORTATION_PROVIDED",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_TRANSPORTATION_PROVIDED_Display":{
            "title":"Transportation Provided",
            "type":"string",
            "description":"Transportation Provided",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_TRANSPORTATION_PROVIDED",
                "help":{
                    "instruction":"Transportation Provided"
                },
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "default":"SA",
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"PER_TERRITORY_CODE#TABLE",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Default Value: US

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• EffectiveEndDate: string (date)
  Title: Effective End Date
• EffectiveStartDate: string (date)
  Title: Effective Start Date
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• overtimeStatus: string
  Title: Overtime Status

  Maximum Length: 150

  Overtime Status
• overtimeStatus_Display: string
  Title: Overtime Status

  Overtime Status
• PayrollRelationshipId: integer (int64)

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "PayrollRelationshipId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "default":"US",
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"PER_TERRITORY_CODE#TABLE",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "overtimeStatus":{
            "title":"Overtime Status",
            "maxLength":150,
            "type":"string",
            "description":"Overtime Status",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"overtimeStatus_Display",
                "help":{
                    "instruction":"Overtime Status"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"HRX_US_FLSA_CATEGORY#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_OpenIdentifier":"overtimeStatus",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ColumnName":"REL_INFORMATION1",
                "FND_ACFF_SegmentName":"FLSA_STATUS",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "overtimeStatus_Display":{
            "title":"Overtime Status",
            "type":"string",
            "description":"Overtime Status",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"overtimeStatus",
                "help":{
                    "instruction":"Overtime Status"
                },
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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

LVVO_V___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndPvsCharacterIdCharacterValues

Parameters:

• finder: ValidValuesFinder%3BBind_DataSource%3Doracle.apps.hcm.payrolls.registrations.flex.payrollRelationshipInformation.view.PayRelationshipsDDFPER_5FTERRITORY_5FCODEVSO

The following properties are defined on the LOV link relation:

• Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Value
• Display Attribute: Value, Description

LVVO___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndPvsCharacterIdCharacterValues

Parameters:

• finder: ValidValuesFinder%3BBind_DataSource%3Doracle.apps.hcm.payrolls.registrations.flex.payrollRelationshipInformation.view.PayRelationshipsDDFPER_5FTERRITORY_5FCODEVSO

The following properties are defined on the LOV link relation:

• Source Attribute: __FLEX_Context; Target Attribute: Id
• Display Attribute: Value

Back to Top