ADO.NET Provider for Workday

Build 25.0.9434

Prospects

Manages and stores information about prospective candidates for recruitment, allowing for the creation and tracking of potential hires within the system.

Table Specific Information

Select

The Workday provider requires filtering on Id in order to perform the query.

For example:

SELECT * FROM Prospects WHERE Id = 'c1d030d96f4c900144b4d0bd8d470000';

Workday Resource Information

Creates a single prospect instance with the specified data. In the request body, specify at least the required field: candidate.name.country.id. The Recruiting Name Components configuration might require additional fields for candidate.name. To determine additional required fields, see the Recruiting Name Components tab on the Maintain Name Components by Country task.

Secured by: Create External Prospects, Set Up: External Career Site Access

Scope: Recruiting

Aggregate Fields

The provider represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.

This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.

CandidatePools_Aggregate


[{
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
}]

CandidateTags_Aggregate


[{
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
}]

Columns

Name Type ReadOnly Description
Id [KEY] String False

A system-generated unique identifier assigned to each candidate record, used to track the candidate throughout the recruitment and hiring process.

CandidatePools_Aggregate String False

A list of candidate pools that the candidate is actively part of. These pools help categorize candidates based on hiring needs.

CandidateTags_Aggregate String False

A collection of tags assigned to the candidate, often used to facilitate searching and filtering based on skills, experience, or other attributes.

Candidate_Descriptor String False

A brief, human-readable representation of the candidate's record, typically used for display purposes in user interfaces or reports.

Candidate_Email String False

The email address associated with the candidate, used for communication and identification in the recruitment process.

Candidate_Id String False

A unique identifier assigned to the candidate within the system, used to track their application and recruitment progress.

Candidate_Name_Country_Descriptor String False

A descriptive label providing a human-readable format of the country associated with the candidate's name, typically used for reporting and selection interfaces.

Candidate_Name_Country_Id String False

A unique identifier representing the country associated with the candidate's name, used for reference and categorization.

Candidate_Name_Descriptor String False

A human-readable display of the candidate’s full name, formatted for ease of identification in reports and application tracking.

Candidate_Name_FirstName String False

The given name of the candidate, used in formal records and communications throughout the hiring process.

Candidate_Name_FirstNameLocal String False

The candidate's first name displayed in the local script, applicable in regions where non-Latin scripts are used.

Candidate_Name_FirstNameLocal2 String False

An additional local script version of the candidate's first name, relevant for countries with multiple non-Latin scripts.

Candidate_Name_FullName String False

The complete name of the candidate as officially recorded. This is used primarily in regions where a full name is a recognized component.

Candidate_Name_Hereditary_Descriptor String False

A descriptive label for the hereditary name component, if applicable.

Candidate_Name_Hereditary_Id String False

A unique identifier assigned to the candidate's name instance within the Workday system. This hereditary ID ensures consistency across different processes.

Candidate_Name_Id String False

A system-generated unique identifier assigned to each candidate's name record. This ID ensures that every candidate's name entry is distinct and can be referenced across the system.

Candidate_Name_LastName String False

The last name or surname of the candidate, used for identification and record-keeping. This value is typically derived from the candidate's submitted personal information.

Candidate_Name_LastNameLocal String False

The candidate's last name in local script, applicable in regions where non-Latin scripts are used.

Candidate_Name_LastNameLocal2 String False

A secondary local script version of the candidate's last name, relevant for countries with multiple non-Latin scripts.

Candidate_Name_MiddleName String False

The middle name of the candidate, which is useful for distinguishing individuals with common first and last names.

Candidate_Name_MiddleNameLocal String False

The candidate's middle name in local script, applicable in regions where non-Latin scripts are used.

Candidate_Name_Salutation_Descriptor String False

A readable label for the salutation associated with the candidate’s name (for example, Mr., Ms., Dr.).

Candidate_Name_Salutation_Id String False

The unique identifier for the salutation or title (for example, Mr., Ms., Dr.) associated with the candidate's name and ensures proper addressing.

Candidate_Name_SecondaryLastName String False

The secondary family name of the candidate, typically used in cultures where multiple last names are common. This can represent a maternal surname in some naming conventions.

Candidate_Name_SecondaryLocal String False

The secondary family name of the candidate written in the local script, ensuring accurate representation of names in native languages.

Candidate_Name_Social_Descriptor String False

A text preview or summary of the candidate's name as it appears in social or public settings, often used for display purposes in reports and dashboards.

Candidate_Name_Social_Id String False

A system-generated unique identifier for tracking the candidate's social name entry in Workday. This ID links the candidate's name to relevant records.

Candidate_Name_TertiaryLastName String False

The tertiary family name of the candidate, used in cultures where three-part surnames are common. This ensures accurate representation of the candidate's full legal name.

Candidate_Name_Title_Descriptor String False

A text preview of the candidate's professional or academic title, such as 'Dr.', 'Prof.', or 'Sir', used in communications and official documentation.

Candidate_Name_Title_Id String False

A unique system-generated identifier for the candidate's title, ensuring proper classification and retrieval of title-related information.

Candidate_Phone_CountryPhoneCode_Descriptor String False

A textual description of the country phone code associated with the candidate's phone number, such as 'United States (+1)' or 'United Kingdom (+44)'.

Candidate_Phone_CountryPhoneCode_Href String False

A hyperlink reference to additional details about the country phone code, potentially linking to country-specific communication guidelines.

Candidate_Phone_CountryPhoneCode_Id String False

A system-generated identifier representing the country phone code, such as 'US-1' or 'IN-91', ensuring standardized international dialing information.

Candidate_Phone_Descriptor String False

A text summary of the candidate's primary phone number, often used for quick reference in reports or user interfaces.

Candidate_Phone_DeviceType_Descriptor String False

A description of the type of phone device the candidate is using, such as 'Mobile', 'Home', 'Work', or 'Fax', which helps categorize communication preferences.

Candidate_Phone_DeviceType_Href String False

A hyperlink reference providing more information about the device type, potentially linking to system configurations or usage policies.

Candidate_Phone_DeviceType_Id String False

A system-generated identifier for the phone device type, ensuring proper classification of the candidate's contact details.

Candidate_Phone_Extension String False

The extension number associated with the candidate's phone line, typically used in office phone systems to route calls efficiently.

Candidate_Phone_Id String False

A unique identifier for the candidate's phone record, linking it to other contact information in the system.

Candidate_Phone_PhoneNumber String False

The candidate's full primary phone number, including country and area codes where applicable. Used for direct communication with the candidate.

ContactConsent Bool False

Indicates whether the candidate has given explicit consent to be contacted by recruiters or hiring teams. A value of 'true' means the candidate has opted in for communications.

Descriptor String False

A textual summary or preview of the record, typically used for quick reference in user interfaces and reports.

Href String False

A hyperlink reference to additional details about the current record, allowing users to navigate to related information.

Level_Descriptor String False

A descriptive label indicating the hierarchical level of the candidate, such as 'Entry Level', 'Mid-Level', or 'Senior', categorizing the candidate's experience.

Level_Href String False

A hyperlink reference providing additional details about the candidate's level, potentially linking to job level guidelines.

Level_Id String False

A unique identifier for the candidate's level, ensuring accurate classification and retrieval of experience-related information.

ReferredBy_Descriptor String False

A textual description of the individual or organization that referred the candidate, such as 'Employee Referral' or 'External Agency'.

ReferredBy_Href String False

A hyperlink reference to details about the referrer, linking to additional information about referral programs.

ReferredBy_Id String False

A unique identifier for the referring individual or organization, ensuring accurate tracking of referrals.

Source_Descriptor String False

A description of the source from which the candidate application originated, such as 'Job Board', 'Recruiter', or 'Direct Application'.

Source_Href String False

A hyperlink reference providing more details about the candidate's source, allowing users to analyze recruiting effectiveness.

Source_Id String False

A unique identifier for the source, ensuring proper categorization and reporting of recruitment channels.

Status_Descriptor String False

A descriptive label indicating the candidate's current application status, such as 'Applied', 'Interviewing', or 'Hired'.

Status_Href String False

A hyperlink reference to details about the candidate's status, allowing users to track progress in the hiring process.

Status_Id String False

A unique identifier for the candidate's status, ensuring accurate reporting and workflow processing.

Type_Descriptor String False

A description of the candidate's classification within the system, such as 'Internal Applicant', 'External Applicant', or 'Employee Transfer'.

Type_Href String False

A hyperlink reference providing more details about the candidate type, linking to relevant hiring policies or classifications.

Type_Id String False

A unique identifier for the candidate type, ensuring proper categorization and processing in recruitment workflows.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434