Service Directory > v31.2 > Recruiting > Get_Candidate_Attachments
 

Operation: Get_Candidate_Attachments

This operation returns attachments for a Candidate and/or a Candidate's Job Application.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Candidate_Attachments_Request

Contains request reference, criteria, filter and response group for getting Candidate attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Candidate_Attachment_Request_References  [0..1]  Contains reference to a candidate attachment.   
Request_Criteria  Candidate_Attachment_Request_Criteria  [0..1]  Utilize the following criteria options to search for Candidate attachments within the Workday system.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Candidate_Attachment_Response_Group  [0..1]  Element containing Candidate attachment response grouping options   
top
 

Response Element: Get_Candidate_Attachments_Response

Wrapper element containing Candidate Attachment Response Data for requested references or criteria and for requested response group.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Candidate_Attachment_Request_References  [0..1]  Contains reference to a candidate attachment.   
Request_Criteria  Candidate_Attachment_Request_Criteria  [0..1]  Utilize the following criteria options to search for Candidate attachments within the Workday system.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Candidate_Attachment_Response_Group  [0..1]  Element containing Candidate attachment response grouping options   
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Candidate_Attachment_Response_Data  [0..1]  Contains Candidate attachment data.   
top
 

Candidate_Attachment_Request_References

part of: Get_Candidate_Attachments_Request, Get_Candidate_Attachments_Response
Contains reference to a candidate attachment.
 
Parameter name Type/Value Cardinality Description Validations
@Skip_Non_Existing_Instances  boolean  [1..1]     
Candidate_Attachment_Reference  Candidate_AttachmentObject  [0..*]  Reference to a candidate attachment.   
top
 

Candidate_AttachmentObject

part of: Candidate_Attachment_Request_References, Candidate_Attachment_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Candidate_AttachmentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Candidate_AttachmentObjectID

part of: Candidate_AttachmentObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, File_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Candidate_Attachment_Request_Criteria

part of: Get_Candidate_Attachments_Request, Get_Candidate_Attachments_Response
Utilize the following criteria options to search for Candidate attachments within the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
Candidate_Reference  CandidateObject  [0..*]  Reference to a Candidate.   
top
 

CandidateObject

part of: Candidate_Attachment_Request_Criteria, Candidate_Attachment_WWS
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  CandidateObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CandidateObjectID

part of: CandidateObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Candidate_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Response_Filter

part of: Get_Candidate_Attachments_Request, Get_Candidate_Attachments_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Candidate_Attachment_Response_Group

part of: Get_Candidate_Attachments_Request, Get_Candidate_Attachments_Response
Element containing Candidate attachment response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Candidate_Attachments_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Candidate_Attachment_Response_Data

part of: Get_Candidate_Attachments_Response
Contains Candidate attachment data.
 
Parameter name Type/Value Cardinality Description Validations
Candidate_Attachment  Candidate_Attachment_WWS  [0..*]  Contains Candidate attachment data.   
top
 

Candidate_Attachment_WWS

part of: Candidate_Attachment_Response_Data
Contains Candidate attachment data.
 
Parameter name Type/Value Cardinality Description Validations
Candidate_Reference  CandidateObject  [0..1]  Reference to a Candidate.   
Candidate_Attachment_Data  Candidate_Attachment_Data  [0..1]  Contains information about a Attachment to add to a Candidate. 
Validation Description
File ID for the attachment already in use.   
 
top
 

Candidate_Attachment_Data

part of: Candidate_Attachment_WWS
Contains information about a Attachment to add to a Candidate.
 
Parameter name Type/Value Cardinality Description Validations
Candidate_Attachment_Reference  Candidate_AttachmentObject  [0..1]  Reference for a Candidate Attachment.   
Attachment_Data  Attachment_WWS_Data  [0..1]  Attachment WWS Data element   
Document_Category_Reference  Document_Category__All_Object  [1..1]  Identifies the category for the document.   
Validation Description
File ID for the attachment already in use.   
top
 

Attachment_WWS_Data

part of: Candidate_Attachment_Data
Attachment WWS Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Text attribute identifying a unique ID for Attachment.   
Filename  string (255)   [1..1]  Filename for the attachment.   
File_Content  base64Binary  [1..1]  File content in binary format.   
Mime_Type_Reference  Mime_TypeObject  [0..1]  Mime Type Reference   
Comment  string  [0..1]  Comment   
top
 

Mime_TypeObject

part of: Attachment_WWS_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Mime_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Mime_TypeObjectID

part of: Mime_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Content_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Document_Category__All_Object

part of: Candidate_Attachment_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Document_Category__All_ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Document_Category__All_ObjectID

part of: Document_Category__All_Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Document_Category__Workday_Owned__ID, Document_Category_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Candidate_AttachmentReferenceEnumeration

part of: Candidate_AttachmentObjectID
Base Type
string
top
 

CandidateReferenceEnumeration

part of: CandidateObjectID
Base Type
string
top
 

Mime_TypeReferenceEnumeration

part of: Mime_TypeObjectID
Base Type
string
top
 

Document_Category__All_ReferenceEnumeration

part of: Document_Category__All_ObjectID
Base Type
string
top