Jump to

• Request
• Response

Update a referral descriptive flexfield for a job requisition in a recruiting agency

patch

/hcmRestApi/resources/11.13.18.05/recruitingUIAgencyRequisitionDetails/{ReferralId}/child/ReferralsDFF/{ReferralsDFFUniqID}

Request

Path Parameters

• ReferralId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• ReferralsDFFUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Job Referral Descriptive Flexfields in Opportunity Marketplace resource and used to uniquely identify an instance of Job Referral Descriptive Flexfields in Opportunity Marketplace. The client should not generate the hash key value. Instead, the client should query on the Job Referral Descriptive Flexfields in Opportunity Marketplace collection resource in order to navigate to a specific instance of Job Referral Descriptive Flexfields in Opportunity Marketplace 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

• AGENCY_REFERRAL
• EMPLOYEE_REFERRAL

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "AGENCY_REFERRAL":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffAGENCY__5FREFERRALVO-item-patch-request",
            "EMPLOYEE_REFERRAL":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffEMPLOYEE__5FREFERRALVO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffAGENCY__5FREFERRALVO-item-patch-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffEMPLOYEE__5FREFERRALVO-item-patch-request"
        }
    ],
    "x-base-schema":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffVO-patch-item"
}

Match One Schema

Show Source

• AGENCY_REFERRAL - object oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffAGENCY__5FREFERRALVO-item-patch-request
• EMPLOYEE_REFERRAL - object oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffEMPLOYEE__5FREFERRALVO-item-patch-request

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "AGENCY_REFERRAL":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffAGENCY__5FREFERRALVO-item-patch-request",
            "EMPLOYEE_REFERRAL":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffEMPLOYEE__5FREFERRALVO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffAGENCY__5FREFERRALVO-item-patch-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffEMPLOYEE__5FREFERRALVO-item-patch-request"
        }
    ],
    "x-base-schema":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffVO-patch-item"
}

Nested Schema : oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffAGENCY__5FREFERRALVO-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Default Value: AGENCY_REFERRAL

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment

{
    "type":"object",
    "properties":{
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "default":"AGENCY_REFERRAL",
            "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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"
                }
            }
        }
    }
}

Nested Schema : oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffEMPLOYEE__5FREFERRALVO-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Default Value: EMPLOYEE_REFERRAL

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment

{
    "type":"object",
    "properties":{
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "default":"EMPLOYEE_REFERRAL",
            "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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"
                }
            }
        }
    }
}

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

• AGENCY_REFERRAL
• EMPLOYEE_REFERRAL

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "AGENCY_REFERRAL":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffAGENCY__5FREFERRALVO-item-response",
            "EMPLOYEE_REFERRAL":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffEMPLOYEE__5FREFERRALVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffAGENCY__5FREFERRALVO-item-response"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffEMPLOYEE__5FREFERRALVO-item-response"
        }
    ],
    "x-base-schema":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffVO-item"
}

Match One Schema

Show Source

• AGENCY_REFERRAL - object oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffAGENCY__5FREFERRALVO-item-response
• EMPLOYEE_REFERRAL - object oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffEMPLOYEE__5FREFERRALVO-item-response

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "AGENCY_REFERRAL":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffAGENCY__5FREFERRALVO-item-response",
            "EMPLOYEE_REFERRAL":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffEMPLOYEE__5FREFERRALVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffAGENCY__5FREFERRALVO-item-response"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffEMPLOYEE__5FREFERRALVO-item-response"
        }
    ],
    "x-base-schema":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffVO-item"
}

Nested Schema : oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffAGENCY__5FREFERRALVO-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Default Value: AGENCY_REFERRAL

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

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

{
    "type":"object",
    "properties":{
        "ReferralId":{
            "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":"AGENCY_REFERRAL",
            "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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"
                }
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffEMPLOYEE__5FREFERRALVO-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Default Value: EMPLOYEE_REFERRAL

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

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

{
    "type":"object",
    "properties":{
        "ReferralId":{
            "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":"EMPLOYEE_REFERRAL",
            "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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"
                }
            }
        },
        "links":{
            "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"
    }
}

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

Links

LVVO_V___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

• finder: ValidValuesFinder%3BBind_ApplicationId%3D821%2CBind_DescriptiveFlexfieldCode%3DIRC_RF_REFERRALS_DFF

The following properties are defined on the LOV link relation:

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

LVVO___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

• finder: ValidValuesFinder%3BBind_ApplicationId%3D821%2CBind_DescriptiveFlexfieldCode%3DIRC_RF_REFERRALS_DFF

The following properties are defined on the LOV link relation:

• Source Attribute: __FLEX_Context; Target Attribute: ContextCode
• Display Attribute: Name

Back to Top