Jump to

• Request
• Response

Get the details of a candidate

get

/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}

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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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

Type: object

Show Source

• Action: string
  Maximum Length: 255

  Action in recruitingCECandidates.
• AddlAddressAttribute1: string
  Maximum Length: 255

  Additional address attribute 1 in recruitingCECandidates.
• AddlAddressAttribute2: string
  Maximum Length: 255

  Additional address attribute 2 in recruitingCECandidates.
• AddlAddressAttribute3: string
  Maximum Length: 255

  Additional address attribute 3 in recruitingCECandidates.
• AddlAddressAttribute4: string
  Maximum Length: 255

  Additional address attribute 4 in recruitingCECandidates.
• AddlAddressAttribute5: string
  Maximum Length: 255

  Additional address attribute 5 in recruitingCECandidates.
• AddressLine1: string
  Maximum Length: 240

  Address Line 1 in recruitingCECandidates.
• AddressLine2: string
  Maximum Length: 240

  Address Line 2 in recruitingCECandidates.
• AddressLine3: string
  Maximum Length: 255

  Address Line 3 in recruitingCECandidates.
• AddressLine4: string
  Maximum Length: 255

  Value of line 4 of the candidate's address.
• attachments: array Candidate Details with Attachments
  Title: Candidate Details with Attachments

  The attachments resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with attachments. Note that the service endpoints in this resource category are only for Oracle internal use.
• Building: string
  Maximum Length: 255

  Building in recruitingCECandidates.
• candidateExtraInformation: array Candidate Details with Extra Information Data
  Title: Candidate Details with Extra Information Data

  The CandidateExtraInformation resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information. Note that the service endpoints in this resource category are only for Oracle internal use.
• CandidateLastModifiedDate: string (date-time)
  Read Only: true

  Candidate last modified date.
• CandidateNumber: string
  Maximum Length: 240

  Candidate Number in recruitingCECandidates.
• CandidatePIIData: array Candidate Details with PII Data
  Title: Candidate Details with PII Data

  The CandidatePIIData resource is a child of the recruitingCECandidates resource. It includes the details of the candidate national identifiers and date of birth. Note that the service endpoints in this resource category are only for Oracle internal use.
• City: string
  Maximum Length: 60

  City in recruitingCECandidates.
• Country: string
  Maximum Length: 60

  Country in recruitingCECandidates.
• CwkCandidateFlag: boolean
  Read Only: true

  Indicates if it's a contingent worker candidate in recruitingCECandidates
• DateOfBirth: string (date)
  Date of birth in recruitingCECandidates
• DisplayName: string
  Maximum Length: 240

  Display Name in recruitingCECandidates.
• Email: string
  Maximum Length: 240

  Email in recruitingCECandidates.
• EmailChangeConfirmed: string
  Maximum Length: 255

  Email Change Confirmed in recruitingCECandidates.
• EmailChangeRequested: string
  Maximum Length: 255

  Email Change Requested in recruitingCECandidates.
• EmailPreferredFlag: boolean
  Maximum Length: 255

  Indicates that the candidate has selected email as the preferred communication channel.
• EmailVerificationRequested: string
  Maximum Length: 255

  Indicates that the candidate has requested for an email verification.
• EmailVerifiedFlag: boolean
  Maximum Length: 255

  Indicates that the email ID is verified.
• ExWorkerFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates if the candidate is an ex worker in recruitingCECandidates.
• FirstName: string
  Maximum Length: 150

  First Name in recruitingCECandidates.
• FloorNumber: string
  Maximum Length: 255

  Floor Number in recruitingCECandidates.
• Honors: string
  Maximum Length: 255

  Honors in recruitingCECandidates.
• KnownAs: string
  Maximum Length: 255

  Attribute to represent a candidate's name also KnownAs.
• LastName: string
  Maximum Length: 150

  Last Name in recruitingCECandidates.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListName: string
  Maximum Length: 240

  List Name in recruitingCECandidates.
• LongPostalCode: string
  Maximum Length: 255

  Long Postal Code in recruitingCECandidates.
• MiddleNames: string
  Maximum Length: 80

  Middle Names in recruitingCECandidates.
• MilitaryRank: string
  Maximum Length: 255

  Military Rank in recruitingCECandidates.
• MobilePhoneAreaCode: string
  Maximum Length: 30

  Mobile Phone Area Code in recruitingCECandidates.
• MobilePhoneCountryCode: string
  Maximum Length: 30

  Mobile Phone Country Code in recruitingCECandidates.
• MobilePhoneLegislationCode: string
  Maximum Length: 30

  Mobile phone legislation code in recruitingCECandidates.
• MobilePhoneNumber: string
  Maximum Length: 60

  Mobile Phone Number in recruitingCECandidates.
• NamInformation1: string
  NamInformation 1 is a configurable attribute in recruitingCECandidates.
• NamInformation10: string
  NamInformation 10 is a configurable attribute in recruitingCECandidates.
• NamInformation11: string
  NamInformation 11 is a configurable attribute in recruitingCECandidates.
• NamInformation12: string
  NamInformation 12 is a configurable attribute in recruitingCECandidates.
• NamInformation13: string
  NamInformation 13 is a configurable attribute in recruitingCECandidates.
• NamInformation14: string
  NamInformation 14 is a configurable attribute in recruitingCECandidates.
• NamInformation15: string
  NamInformation 15 is a configurable attribute in recruitingCECandidates.
• NamInformation16: string
  NamInformation 16 is a configurable attribute in recruitingCECandidates.
• NamInformation17: string
  NamInformation 17 is a configurable attribute in recruitingCECandidates.
• NamInformation18: string
  NamInformation 18 is a configurable attribute in recruitingCECandidates.
• NamInformation19: string
  NamInformation 19 is a configurable attribute in recruitingCECandidates.
• NamInformation2: string
  NamInformation 2 is a configurable attribute in recruitingCECandidates.
• NamInformation20: string
  NamInformation 20 is a configurable attribute in recruitingCECandidates.
• NamInformation21: string
  NamInformation 21 is a configurable attribute in recruitingCECandidates.
• NamInformation22: string
  NamInformation 22 is a configurable attribute in recruitingCECandidates.
• NamInformation23: string
  NamInformation 23 is a configurable attribute in recruitingCECandidates.
• NamInformation24: string
  NamInformation 24 is a configurable attribute in recruitingCECandidates.
• NamInformation25: string
  NamInformation 25 is a configurable attribute in recruitingCECandidates.
• NamInformation26: string
  NamInformation 26 is a configurable attribute in recruitingCECandidates.
• NamInformation27: string
  NamInformation 27 is a configurable attribute in recruitingCECandidates.
• NamInformation28: string
  NamInformation 28 is a configurable attribute in recruitingCECandidates.
• NamInformation29: string
  NamInformation 29 is a configurable attribute in recruitingCECandidates.
• NamInformation3: string
  NamInformation 3 is a configurable attribute in recruitingCECandidates.
• NamInformation30: string
  NamInformation 30 is a configurable attribute in recruitingCECandidates.
• NamInformation4: string
  NamInformation 4 is a configurable attribute in recruitingCECandidates.
• NamInformation5: string
  NamInformation 5 is a configurable attribute in recruitingCECandidates.
• NamInformation6: string
  NamInformation 6 is a configurable attribute in recruitingCECandidates.
• NamInformation7: string
  NamInformation 7 is a configurable attribute in recruitingCECandidates.
• NamInformation8: string
  NamInformation 8 is a configurable attribute in recruitingCECandidates.
• NamInformation9: string
  NamInformation 9 is a configurable attribute in recruitingCECandidates.
• NewEmail: string
  Maximum Length: 255

  New email ID in recruitingCECandidates.
• NewPhone: string
  Maximum Length: 255

  Phone number specified by the candidate in the event of a change in the existing phone number.
• PhonePreferredFlag: boolean
  Maximum Length: 255

  Indicates that the candidate has selected phone as the preferred communication channel.
• PhoneVerificationRequested: string
  Maximum Length: 255

  Indicates that the candidate has requested for a phone verification.
• PhoneVerifiedFlag: boolean
  Maximum Length: 255

  Indicates that the phone number is verified.
• PostalCode: string
  Maximum Length: 30

  Postal code in recruitingCECandidates.
• PreferredLanguage: string
  Preferred language in recruitingCECandidates.
• PreferredTimezone: string
  Preferred time zone of the external candidate.
• PreNameAdjunct: string
  Maximum Length: 255

  Previous name adjunct as entered by the candidate.
• PreviousEmail: string
  Maximum Length: 255

  Previous email ID in recruitingCECandidates.
• PreviousLastName: string
  Maximum Length: 255

  Previous last name in recruitingCECandidates.
• PreviousPhone: string
  Maximum Length: 255

  Previous phone number specified by the candidate before the change in the number.
• Region1: string
  Maximum Length: 120

  Region 1 in recruitingCECandidates.
• Region2: string
  Maximum Length: 120

  Region 2 in recruitingCECandidates.
• Region3: string
  Maximum Length: 120

  Region 3 in recruitingCECandidates.
• SiteNumber: string
  Maximum Length: 255

  Site Number in recruitingCECandidates.
• Suffix: string
  Maximum Length: 80

  Suffix in recruitingCECandidates.
• Title: string
  Maximum Length: 30

  Title in recruitingCECandidates.

{
    "type":"object",
    "properties":{
        "PreNameAdjunct":{
            "maxLength":"255",
            "type":"string",
            "description":"Previous name adjunct as entered by the candidate.",
            "nullable":true,
            "x-queryable":false
        },
        "Email":{
            "maxLength":"240",
            "type":"string",
            "description":"Email in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "CandidateLastModifiedDate":{
            "type":"string",
            "description":"Candidate last modified date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PhoneVerificationRequested":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates that the candidate has requested for a phone verification.",
            "nullable":true,
            "x-queryable":true
        },
        "PreviousEmail":{
            "maxLength":"255",
            "type":"string",
            "description":"Previous email ID in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneVerifiedFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates that the phone number is verified.",
            "nullable":true,
            "x-queryable":true
        },
        "AddlAddressAttribute5":{
            "maxLength":"255",
            "type":"string",
            "description":"Additional address attribute 5 in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "AddlAddressAttribute4":{
            "maxLength":"255",
            "type":"string",
            "description":"Additional address attribute 4 in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredTimezone":{
            "type":"string",
            "description":"Preferred time zone of the external candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "AddlAddressAttribute3":{
            "maxLength":"255",
            "type":"string",
            "description":"Additional address attribute 3 in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "candidateExtraInformation":{
            "title":"Candidate Details with Extra Information Data",
            "type":"array",
            "description":"The CandidateExtraInformation resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidates-candidateExtraInformation-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MiddleNames":{
            "maxLength":"80",
            "type":"string",
            "description":"Middle Names in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "MilitaryRank":{
            "maxLength":"255",
            "type":"string",
            "description":"Military Rank in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation30":{
            "type":"string",
            "description":"NamInformation 30 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation20":{
            "type":"string",
            "description":"NamInformation 20 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "MobilePhoneCountryCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Mobile Phone Country Code in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "DateOfBirth":{
            "type":"string",
            "description":"Date of birth in recruitingCECandidates",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "NamInformation21":{
            "type":"string",
            "description":"NamInformation 21 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "CandidateNumber":{
            "maxLength":"240",
            "type":"string",
            "description":"Candidate Number in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation22":{
            "type":"string",
            "description":"NamInformation 22 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation23":{
            "type":"string",
            "description":"NamInformation 23 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "CandidatePIIData":{
            "title":"Candidate Details with PII Data",
            "type":"array",
            "description":"The CandidatePIIData resource is a child of the recruitingCECandidates resource. It includes the details of the candidate national identifiers and date of birth. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidates-CandidatePIIData-item-response"
            }
        },
        "NamInformation24":{
            "type":"string",
            "description":"NamInformation 24 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation25":{
            "type":"string",
            "description":"NamInformation 25 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation26":{
            "type":"string",
            "description":"NamInformation 26 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "LongPostalCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Long Postal Code in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "PreviousLastName":{
            "maxLength":"255",
            "type":"string",
            "description":"Previous last name in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation27":{
            "type":"string",
            "description":"NamInformation 27 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation28":{
            "type":"string",
            "description":"NamInformation 28 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "AddlAddressAttribute2":{
            "maxLength":"255",
            "type":"string",
            "description":"Additional address attribute 2 in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation29":{
            "type":"string",
            "description":"NamInformation 29 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "AddlAddressAttribute1":{
            "maxLength":"255",
            "type":"string",
            "description":"Additional address attribute 1 in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "maxLength":"60",
            "type":"string",
            "description":"City in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "CwkCandidateFlag":{
            "type":"boolean",
            "description":"Indicates if it's a contingent worker candidate in recruitingCECandidates",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhonePreferredFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates that the candidate has selected phone as the preferred communication channel.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine3":{
            "maxLength":"255",
            "type":"string",
            "description":"Address Line 3 in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressLine2":{
            "maxLength":"240",
            "type":"string",
            "description":"Address Line 2 in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressLine1":{
            "maxLength":"240",
            "type":"string",
            "description":"Address Line 1 in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "Suffix":{
            "maxLength":"80",
            "type":"string",
            "description":"Suffix in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressLine4":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of line 4 of the candidate's address.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":"60",
            "type":"string",
            "description":"Country in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "maxLength":"150",
            "type":"string",
            "description":"Last Name in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailPreferredFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates that the candidate has selected email as the preferred communication channel.",
            "nullable":true,
            "x-queryable":true
        },
        "Building":{
            "maxLength":"255",
            "type":"string",
            "description":"Building in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation10":{
            "type":"string",
            "description":"NamInformation 10 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation11":{
            "type":"string",
            "description":"NamInformation 11 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "FloorNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Floor Number in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "Action":{
            "maxLength":"255",
            "type":"string",
            "description":"Action in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation12":{
            "type":"string",
            "description":"NamInformation 12 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "MobilePhoneAreaCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Mobile Phone Area Code in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "attachments":{
            "title":"Candidate Details with Attachments",
            "type":"array",
            "description":"The attachments resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with attachments. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidates-attachments-item-response"
            }
        },
        "ExWorkerFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates if the candidate is an ex worker in recruitingCECandidates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NamInformation13":{
            "type":"string",
            "description":"NamInformation 13 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "Honors":{
            "maxLength":"255",
            "type":"string",
            "description":"Honors in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation14":{
            "type":"string",
            "description":"NamInformation 14 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation15":{
            "type":"string",
            "description":"NamInformation 15 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation16":{
            "type":"string",
            "description":"NamInformation 16 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation17":{
            "type":"string",
            "description":"NamInformation 17 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "KnownAs":{
            "maxLength":"255",
            "type":"string",
            "description":"Attribute to represent a candidate's name also KnownAs.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation18":{
            "type":"string",
            "description":"NamInformation 18 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Postal code in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation19":{
            "type":"string",
            "description":"NamInformation 19 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "MobilePhoneNumber":{
            "maxLength":"60",
            "type":"string",
            "description":"Mobile Phone Number in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation3":{
            "type":"string",
            "description":"NamInformation 3 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation2":{
            "type":"string",
            "description":"NamInformation 2 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation5":{
            "type":"string",
            "description":"NamInformation 5 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation4":{
            "type":"string",
            "description":"NamInformation 4 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation7":{
            "type":"string",
            "description":"NamInformation 7 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NewPhone":{
            "maxLength":"255",
            "type":"string",
            "description":"Phone number specified by the candidate in the event of a change in the existing phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "NamInformation6":{
            "type":"string",
            "description":"NamInformation 6 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation9":{
            "type":"string",
            "description":"NamInformation 9 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "NamInformation8":{
            "type":"string",
            "description":"NamInformation 8 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplayName":{
            "maxLength":"240",
            "type":"string",
            "description":"Display Name in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredLanguage":{
            "type":"string",
            "description":"Preferred language in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailChangeConfirmed":{
            "maxLength":"255",
            "type":"string",
            "description":"Email Change Confirmed in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailVerificationRequested":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates that the candidate has requested for an email verification.",
            "nullable":true,
            "x-queryable":true
        },
        "MobilePhoneLegislationCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Mobile phone legislation code in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "ListName":{
            "maxLength":"240",
            "type":"string",
            "description":"List Name in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "FirstName":{
            "maxLength":"150",
            "type":"string",
            "description":"First Name in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailVerifiedFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates that the email ID is verified.",
            "nullable":true,
            "x-queryable":true
        },
        "Region1":{
            "maxLength":"120",
            "type":"string",
            "description":"Region 1 in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "Title":{
            "maxLength":"30",
            "type":"string",
            "description":"Title in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "Region3":{
            "maxLength":"120",
            "type":"string",
            "description":"Region 3 in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "Region2":{
            "maxLength":"120",
            "type":"string",
            "description":"Region 2 in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "SiteNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Site Number in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":true
        },
        "NamInformation1":{
            "type":"string",
            "description":"NamInformation 1 is a configurable attribute in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        },
        "PreviousPhone":{
            "maxLength":"255",
            "type":"string",
            "description":"Previous phone number specified by the candidate before the change in the number.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailChangeRequested":{
            "maxLength":"255",
            "type":"string",
            "description":"Email Change Requested in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":true
        },
        "NewEmail":{
            "maxLength":"255",
            "type":"string",
            "description":"New email ID in recruitingCECandidates.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Candidate Details with Attachments

Type: array

Title: Candidate Details with Attachments

The attachments resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with attachments. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCECandidates-attachments-item-response

{
    "title":"Candidate Details with Attachments",
    "type":"array",
    "description":"The attachments resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with attachments. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidates-attachments-item-response"
    }
}

Nested Schema : Candidate Details with Extra Information Data

Type: array

Title: Candidate Details with Extra Information Data

The CandidateExtraInformation resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCECandidates-candidateExtraInformation-item-response

{
    "title":"Candidate Details with Extra Information Data",
    "type":"array",
    "description":"The CandidateExtraInformation resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidates-candidateExtraInformation-item-response"
    }
}

Nested Schema : Candidate Details with PII Data

Type: array

Title: Candidate Details with PII Data

The CandidatePIIData resource is a child of the recruitingCECandidates resource. It includes the details of the candidate national identifiers and date of birth. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCECandidates-CandidatePIIData-item-response

{
    "title":"Candidate Details with PII Data",
    "type":"array",
    "description":"The CandidatePIIData resource is a child of the recruitingCECandidates resource. It includes the details of the candidate national identifiers and date of birth. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidates-CandidatePIIData-item-response"
    }
}

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 : recruitingCECandidates-attachments-item-response

Type: object

Show Source

• Attachment: string
  Attachment in the recruitingCECandidates attachments.
• Category: string
  Maximum Length: 30

  Category in recruitingCECandidates attachments.
• Description: string
  Maximum Length: 255

  Description in recruitingCECandidates attachments.
• FileContents: string
  File Contents in recruitingCECandidates attachments.
• Id: string
  Maximum Length: 255

  ID assigned to the recruitingCECandidates attachments.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MimeType: string
  Mime type in the recruitingCECandidates attachments.
• SourceAttachmentId: integer
  ID assigned to the source attachment in the recruitingCECandidates attachments.
• Title: string
  Maximum Length: 80

  Title of the attachment.
• Type: string
  Type of recruitingCECandidates attachments.

{
    "type":"object",
    "properties":{
        "Type":{
            "type":"string",
            "description":"Type of recruitingCECandidates attachments.",
            "nullable":true,
            "x-queryable":true
        },
        "Category":{
            "maxLength":"30",
            "type":"string",
            "description":"Category in recruitingCECandidates attachments.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"255",
            "type":"string",
            "description":"Description in recruitingCECandidates attachments.",
            "nullable":true,
            "x-queryable":true
        },
        "FileContents":{
            "type":"string",
            "description":"File Contents in recruitingCECandidates attachments.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceAttachmentId":{
            "type":"integer",
            "description":"ID assigned to the source attachment in the recruitingCECandidates attachments.",
            "nullable":true,
            "x-queryable":true
        },
        "Title":{
            "maxLength":"80",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Attachment":{
            "type":"string",
            "description":"Attachment in the recruitingCECandidates attachments.",
            "nullable":true,
            "x-queryable":true
        },
        "Id":{
            "maxLength":"255",
            "type":"string",
            "description":"ID assigned to the recruitingCECandidates attachments.",
            "nullable":true,
            "x-queryable":true
        },
        "MimeType":{
            "type":"string",
            "description":"Mime type in the recruitingCECandidates attachments.",
            "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 : 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 : recruitingCECandidates-candidateExtraInformation-item-response

Type: object

Show Source

• CandidateNumber: string
  Maximum Length: 255

  Unique identifier for the candidate.
• ContextLink: string
  Maximum Length: 2000

  Name of the extra information context.
• ContextName: string
  Maximum Length: 255

  Unique identifier for the extra information data of the candidate.
• DataId: integer
  Unique identifier for the person.
• dataRows: array Candidate Details with Extra Information Rows
  Title: Candidate Details with Extra Information Rows

  The Rows resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information rows. Note that the service endpoints in this resource category are only for Oracle internal use.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "dataRows":{
            "title":"Candidate Details with Extra Information Rows",
            "type":"array",
            "description":"The Rows resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information rows. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidates-candidateExtraInformation-dataRows-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CandidateNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier for the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "DataId":{
            "type":"integer",
            "description":"Unique identifier for the person.",
            "nullable":true,
            "x-queryable":true
        },
        "ContextLink":{
            "maxLength":"2000",
            "type":"string",
            "description":"Name of the extra information context.",
            "nullable":true,
            "x-queryable":true
        },
        "ContextName":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier for the extra information data of the candidate.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Candidate Details with Extra Information Rows

Type: array

Title: Candidate Details with Extra Information Rows

The Rows resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information rows. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCECandidates-candidateExtraInformation-dataRows-item-response

{
    "title":"Candidate Details with Extra Information Rows",
    "type":"array",
    "description":"The Rows resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information rows. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidates-candidateExtraInformation-dataRows-item-response"
    }
}

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 : recruitingCECandidates-candidateExtraInformation-dataRows-item-response

Type: object

Show Source

• attributes: array Candidate Details with Extra Information Attributes
  Title: Candidate Details with Extra Information Attributes

  The attributes resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information row attributes. Note that the service endpoints in this resource category are only for Oracle internal use.
• ContextRowId: string
  Maximum Length: 255

  Name of the context corresponding to the extra information rows.
• ContextRowLink: string
  Maximum Length: 3000

  Unique identifier for the extra information context row.
• DataId: integer
  Unique link corresponding to the extra information context row.
• DataRowId: integer
  Unique identifier for the extra information data row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RowAction: string
  Maximum Length: 255

  Unique identifier for extra information row attribute.

{
    "type":"object",
    "properties":{
        "DataId":{
            "type":"integer",
            "description":"Unique link corresponding to the extra information context row.",
            "nullable":true,
            "x-queryable":true
        },
        "ContextRowId":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the context corresponding to the extra information rows.",
            "nullable":true,
            "x-queryable":true
        },
        "ContextRowLink":{
            "maxLength":"3000",
            "type":"string",
            "description":"Unique identifier for the extra information context row.",
            "nullable":true,
            "x-queryable":true
        },
        "RowAction":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier for extra information row attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "attributes":{
            "title":"Candidate Details with Extra Information Attributes",
            "type":"array",
            "description":"The attributes resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information row attributes. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidates-candidateExtraInformation-dataRows-attributes-item-response"
            }
        },
        "DataRowId":{
            "type":"integer",
            "description":"Unique identifier for the extra information data row.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Candidate Details with Extra Information Attributes

Type: array

Title: Candidate Details with Extra Information Attributes

The attributes resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information row attributes. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCECandidates-candidateExtraInformation-dataRows-attributes-item-response

{
    "title":"Candidate Details with Extra Information Attributes",
    "type":"array",
    "description":"The attributes resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information row attributes. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidates-candidateExtraInformation-dataRows-attributes-item-response"
    }
}

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 : recruitingCECandidates-candidateExtraInformation-dataRows-attributes-item-response

Type: object

Show Source

• AttributeId: integer
  Unique identifier for extra information row context corresponding to the attributes.
• DataRowId: integer
  Unique identifier for extra information row data corresponding to the attributes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 255

  Name of the candidate extra information row attribute.
• Value: string
  Maximum Length: 255

  Value of the candidate extra information row attribute.

{
    "type":"object",
    "properties":{
        "Value":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the candidate extra information row attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DataRowId":{
            "type":"integer",
            "description":"Unique identifier for extra information row data corresponding to the attributes.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeId":{
            "type":"integer",
            "description":"Unique identifier for extra information row context corresponding to the attributes.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the candidate extra information row attribute.",
            "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 : recruitingCECandidates-CandidatePIIData-item-response

Type: object

Show Source

• ExpirationDate: string (date)
  Expiration date in the recruiting candidate PII data.
• Id: string
  ID for Candidate PII data
• IssueDate: string (date)
  Date of issue in the recruiting candidate PII data.
• LegislationCode: string
  Legislation code in the recruiting candidate PII data.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NationalIdentifierNumber: string
  National identifier number in the recruiting candidate PII data.
• NationalIdentifierType: string
  National identifier type in the recruiting candidate PII data.
• PlaceOfIssue: string
  Place of issue in the recruiting candidate PII data.

{
    "type":"object",
    "properties":{
        "LegislationCode":{
            "type":"string",
            "description":"Legislation code in the recruiting candidate PII data.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Expiration date in the recruiting candidate PII data.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "NationalIdentifierNumber":{
            "type":"string",
            "description":"National identifier number in the recruiting candidate PII data.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueDate":{
            "type":"string",
            "description":"Date of issue in the recruiting candidate PII data.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"string",
            "description":"ID for Candidate PII data",
            "nullable":true,
            "x-queryable":true
        },
        "NationalIdentifierType":{
            "type":"string",
            "description":"National identifier type in the recruiting candidate PII data.",
            "nullable":true,
            "x-queryable":true
        },
        "PlaceOfIssue":{
            "type":"string",
            "description":"Place of issue in the recruiting candidate PII data.",
            "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

CandidatePIIData

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/CandidatePIIData

Parameters:

• CandidateNumber: $request.path.CandidateNumber

The CandidatePIIData resource is a child of the recruitingCECandidates resource. It includes the details of the candidate national identifiers and date of birth. Note that the service endpoints in this resource category are only for Oracle internal use.

attachments

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/attachments

Parameters:

• CandidateNumber: $request.path.CandidateNumber

The attachments resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with attachments. Note that the service endpoints in this resource category are only for Oracle internal use.

candidateExtraInformation

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation

Parameters:

• CandidateNumber: $request.path.CandidateNumber

The CandidateExtraInformation resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information. Note that the service endpoints in this resource category are only for Oracle internal use.

Back to Top