Jump to

• Request
• Response

Submit all details of candidate site TCP preferences

post

/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences

Request

Path Parameters

• CandidateNumber(required): string
  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=

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• FlowVersionId: integer
  Flow version ID in candidate site TCP preferences.
• LegalDescriptionVersionId: integer
  Legal description Version Id in candidate site TCP preferences.
• OptInJobAlertFlag: boolean
  Opt in job alert indicator in candidate site TC preferences.
• preferredJobFamilies: array Preferred Job Families
  Title: Preferred Job Families

  The preferredJobFamilies resource is a child of siteTCPreferences. It includes the details of preferred job families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
• preferredJobFunctions: array Preferred Job Functions
  Title: Preferred Job Functions

  The preferredJobFunctions resource is the child of the siteTCPreferences resource. It provides the details of preferred job functions of a candidate from the Talent Community Pool preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
• preferredLocations: array Preferred Locations
  Title: Preferred Locations

  The preferredLocations resource is a child of preferredjobFamilies. It includes the details of preferred locations families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
• SiteNumber: string
  Maximum Length: 255

  Site number in candidate site TCP preferences.

{
    "type":"object",
    "properties":{
        "FlowVersionId":{
            "type":"integer",
            "description":"Flow version ID in candidate site TCP preferences.",
            "nullable":true
        },
        "OptInJobAlertFlag":{
            "type":"boolean",
            "description":"Opt in job alert indicator in candidate site TC preferences.",
            "nullable":true
        },
        "preferredJobFunctions":{
            "title":"Preferred Job Functions",
            "type":"array",
            "description":"The preferredJobFunctions resource is the child of the siteTCPreferences resource. It provides the details of preferred job functions of a candidate from the Talent Community Pool preferences. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidateSitePreferences-siteTCPreferences-preferredJobFunctions-item-post-request"
            }
        },
        "preferredJobFamilies":{
            "title":"Preferred Job Families",
            "type":"array",
            "description":"The preferredJobFamilies resource is a child of siteTCPreferences. It includes the details of preferred job families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidateSitePreferences-siteTCPreferences-preferredJobFamilies-item-post-request"
            }
        },
        "preferredLocations":{
            "title":"Preferred Locations",
            "type":"array",
            "description":"The preferredLocations resource is a child of preferredjobFamilies. It includes the details of preferred locations families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidateSitePreferences-siteTCPreferences-preferredLocations-item-post-request"
            }
        },
        "SiteNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Site number in candidate site TCP preferences.",
            "nullable":true
        },
        "LegalDescriptionVersionId":{
            "type":"integer",
            "description":"Legal description Version Id in candidate site TCP preferences.",
            "nullable":true
        }
    }
}

Nested Schema : Preferred Job Families

Type: array

Title: Preferred Job Families

The preferredJobFamilies resource is a child of siteTCPreferences. It includes the details of preferred job families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object schema

{
    "title":"Preferred Job Families",
    "type":"array",
    "description":"The preferredJobFamilies resource is a child of siteTCPreferences. It includes the details of preferred job families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidateSitePreferences-siteTCPreferences-preferredJobFamilies-item-post-request"
    }
}

Nested Schema : Preferred Job Functions

Type: array

Title: Preferred Job Functions

The preferredJobFunctions resource is the child of the siteTCPreferences resource. It provides the details of preferred job functions of a candidate from the Talent Community Pool preferences. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCECandidateSitePreferences-siteTCPreferences-preferredJobFunctions-item-post-request

{
    "title":"Preferred Job Functions",
    "type":"array",
    "description":"The preferredJobFunctions resource is the child of the siteTCPreferences resource. It provides the details of preferred job functions of a candidate from the Talent Community Pool preferences. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidateSitePreferences-siteTCPreferences-preferredJobFunctions-item-post-request"
    }
}

Nested Schema : Preferred Locations

Type: array

Title: Preferred Locations

The preferredLocations resource is a child of preferredjobFamilies. It includes the details of preferred locations families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCECandidateSitePreferences-siteTCPreferences-preferredLocations-item-post-request

{
    "title":"Preferred Locations",
    "type":"array",
    "description":"The preferredLocations resource is a child of preferredjobFamilies. It includes the details of preferred locations families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidateSitePreferences-siteTCPreferences-preferredLocations-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• JobFamilyId: integer
  Job family ID in preferred job families in candidate site TCP preferences.

{
    "type":"object",
    "properties":{
        "JobFamilyId":{
            "type":"integer",
            "description":"Job family ID in preferred job families in candidate site TCP preferences.",
            "nullable":true
        }
    }
}

Nested Schema : recruitingCECandidateSitePreferences-siteTCPreferences-preferredJobFunctions-item-post-request

Type: object

Show Source

• JobFunctionCode: string
  Job function ID of a preferred job function of a candidate from the Talent Community Pool preferences.

{
    "type":"object",
    "properties":{
        "JobFunctionCode":{
            "type":"string",
            "description":"Job function ID of a preferred job function of a candidate from the Talent Community Pool preferences.",
            "nullable":true
        }
    }
}

Nested Schema : recruitingCECandidateSitePreferences-siteTCPreferences-preferredLocations-item-post-request

Type: object

Show Source

• GeographyId: integer
  Geography ID in preferred locations in candidate site TCP preferences.

{
    "type":"object",
    "properties":{
        "GeographyId":{
            "type":"integer",
            "description":"Geography ID in preferred locations in candidate site TCP preferences.",
            "nullable":true
        }
    }
}

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 : recruitingCECandidateSitePreferences-siteTCPreferences-item-response

Type: object

Show Source

• FlowVersionId: integer
  Flow version ID in candidate site TCP preferences.
• LegalDescriptionVersionId: integer
  Legal description Version Id in candidate site TCP preferences.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OptInJobAlertFlag: boolean
  Opt in job alert indicator in candidate site TC preferences.
• preferredJobFamilies: array Preferred Job Families
  Title: Preferred Job Families

  The preferredJobFamilies resource is a child of siteTCPreferences. It includes the details of preferred job families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
• preferredJobFunctions: array Preferred Job Functions
  Title: Preferred Job Functions

  The preferredJobFunctions resource is the child of the siteTCPreferences resource. It provides the details of preferred job functions of a candidate from the Talent Community Pool preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
• preferredLocations: array Preferred Locations
  Title: Preferred Locations

  The preferredLocations resource is a child of preferredjobFamilies. It includes the details of preferred locations families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
• SiteNumber: string
  Maximum Length: 255

  Site number in candidate site TCP preferences.

{
    "type":"object",
    "properties":{
        "FlowVersionId":{
            "type":"integer",
            "description":"Flow version ID in candidate site TCP preferences.",
            "nullable":true,
            "x-queryable":true
        },
        "OptInJobAlertFlag":{
            "type":"boolean",
            "description":"Opt in job alert indicator in candidate site TC preferences.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "preferredJobFunctions":{
            "title":"Preferred Job Functions",
            "type":"array",
            "description":"The preferredJobFunctions resource is the child of the siteTCPreferences resource. It provides the details of preferred job functions of a candidate from the Talent Community Pool preferences. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidateSitePreferences-siteTCPreferences-preferredJobFunctions-item-response"
            }
        },
        "preferredJobFamilies":{
            "title":"Preferred Job Families",
            "type":"array",
            "description":"The preferredJobFamilies resource is a child of siteTCPreferences. It includes the details of preferred job families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidateSitePreferences-siteTCPreferences-preferredJobFamilies-item-response"
            }
        },
        "preferredLocations":{
            "title":"Preferred Locations",
            "type":"array",
            "description":"The preferredLocations resource is a child of preferredjobFamilies. It includes the details of preferred locations families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidateSitePreferences-siteTCPreferences-preferredLocations-item-response"
            }
        },
        "SiteNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Site number in candidate site TCP preferences.",
            "nullable":true,
            "x-queryable":true
        },
        "LegalDescriptionVersionId":{
            "type":"integer",
            "description":"Legal description Version Id in candidate site TCP preferences.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Preferred Job Families

Type: array

Title: Preferred Job Families

The preferredJobFamilies resource is a child of siteTCPreferences. It includes the details of preferred job families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCECandidateSitePreferences-siteTCPreferences-preferredJobFamilies-item-response

{
    "title":"Preferred Job Families",
    "type":"array",
    "description":"The preferredJobFamilies resource is a child of siteTCPreferences. It includes the details of preferred job families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidateSitePreferences-siteTCPreferences-preferredJobFamilies-item-response"
    }
}

Nested Schema : Preferred Job Functions

Type: array

Title: Preferred Job Functions

The preferredJobFunctions resource is the child of the siteTCPreferences resource. It provides the details of preferred job functions of a candidate from the Talent Community Pool preferences. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCECandidateSitePreferences-siteTCPreferences-preferredJobFunctions-item-response

{
    "title":"Preferred Job Functions",
    "type":"array",
    "description":"The preferredJobFunctions resource is the child of the siteTCPreferences resource. It provides the details of preferred job functions of a candidate from the Talent Community Pool preferences. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidateSitePreferences-siteTCPreferences-preferredJobFunctions-item-response"
    }
}

Nested Schema : Preferred Locations

Type: array

Title: Preferred Locations

The preferredLocations resource is a child of preferredjobFamilies. It includes the details of preferred locations families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCECandidateSitePreferences-siteTCPreferences-preferredLocations-item-response

{
    "title":"Preferred Locations",
    "type":"array",
    "description":"The preferredLocations resource is a child of preferredjobFamilies. It includes the details of preferred locations families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidateSitePreferences-siteTCPreferences-preferredLocations-item-response"
    }
}

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 : recruitingCECandidateSitePreferences-siteTCPreferences-preferredJobFamilies-item-response

Type: object

Show Source

• JobFamilyId: integer
  Job family ID in preferred job families in candidate site TCP preferences.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "JobFamilyId":{
            "type":"integer",
            "description":"Job family ID in preferred job families in candidate site TCP preferences.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : recruitingCECandidateSitePreferences-siteTCPreferences-preferredJobFunctions-item-response

Type: object

Show Source

• JobFunctionCode: string
  Job function ID of a preferred job function of a candidate from the Talent Community Pool preferences.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "JobFunctionCode":{
            "type":"string",
            "description":"Job function ID of a preferred job function of a candidate from the Talent Community Pool preferences.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : recruitingCECandidateSitePreferences-siteTCPreferences-preferredLocations-item-response

Type: object

Show Source

• GeographyId: integer
  Geography ID in preferred locations in candidate site TCP preferences.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GeographyId":{
            "type":"integer",
            "description":"Geography ID in preferred locations in candidate site TCP preferences.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

preferredJobFamilies

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredJobFamilies

Parameters:

• CandidateNumber: $request.path.CandidateNumber
• SiteNumber: $request.path.SiteNumber

The preferredJobFamilies resource is a child of siteTCPreferences. It includes the details of preferred job families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.

preferredJobFunctions

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredJobFunctions

Parameters:

• CandidateNumber: $request.path.CandidateNumber
• SiteNumber: $request.path.SiteNumber

The preferredJobFunctions resource is the child of the siteTCPreferences resource. It provides the details of preferred job functions of a candidate from the Talent Community Pool preferences. Note that the service endpoints in this resource category are only for Oracle internal use.

preferredLocations

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredLocations

Parameters:

• CandidateNumber: $request.path.CandidateNumber
• SiteNumber: $request.path.SiteNumber

The preferredLocations resource is a child of preferredjobFamilies. It includes the details of preferred locations families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.

Back to Top