Jump to

• Request
• Response

Create details of a job requisition in a recruiting agency

post

/hcmRestApi/resources/11.13.18.05/recruitingUIAgencyRequisitionDetails

Request

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ReferralsDFF: array ReferralsDFF

{
    "type":"object",
    "properties":{
        "ReferralsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/recruitingUIAgencyRequisitionDetails-ReferralsDFF-item-post-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : ReferralsDFF

Type: array

Show Source

• Array of: object Discriminator: __FLEX_Context
  Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AGENCY_REFERRAL":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffAGENCY__5FREFERRALVO-item-post-request", "EMPLOYEE_REFERRAL":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffEMPLOYEE__5FREFERRALVO-item-post-request" } }

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/recruitingUIAgencyRequisitionDetails-ReferralsDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested 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-post-request",
            "EMPLOYEE_REFERRAL":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffEMPLOYEE__5FREFERRALVO-item-post-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffAGENCY__5FREFERRALVO-item-post-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffEMPLOYEE__5FREFERRALVO-item-post-request"
        }
    ],
    "x-base-schema":"#/components/schemas/oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffVO-post-item"
}

Match One Schema

Show Source

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

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

Nested Schema : oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffAGENCY__5FREFERRALVO-item-post-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
• 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"
                }
            }
        }
    }
}

Nested Schema : oracle_apps_flex_hcm_recruiting_sourcing_referrals_referralFlex_view_ReferralDffEMPLOYEE__5FREFERRALVO-item-post-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
• 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"
                }
            }
        }
    }
}

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 : recruitingUIAgencyRequisitionDetails-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReferralId: integer
  Read Only: true

  Unique identifier of the referral associated with job requisition in a recruiting agency.
• ReferralsDFF: array ReferralsDFF
• RequisitionId: integer
  Read Only: true

  Unique identifier of the job requisition in a recruiting agency.

{
    "type":"object",
    "properties":{
        "ReferralId":{
            "type":"integer",
            "description":"Unique identifier of the referral associated with job requisition in a recruiting agency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferralsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/recruitingUIAgencyRequisitionDetails-ReferralsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Unique identifier of the job requisition in a recruiting agency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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 : ReferralsDFF

Type: array

Show Source

• Array of: object Discriminator: __FLEX_Context
  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" } }

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/recruitingUIAgencyRequisitionDetails-ReferralsDFF-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 : 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 : 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

ReferralsDFF

Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIAgencyRequisitionDetails/{ReferralId}/child/ReferralsDFF

Parameters:

• ReferralId: $request.path.ReferralId

Back to Top