Service Directory > v32.1 > Recruiting > Get_Maintain_Candidate_List_Assignment
 

Operation: Get_Maintain_Candidate_List_Assignment

Retrieves the Job Requisition Rules with Candidate List Grid Configurations


@ - 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_Maintain_Candidate_List_Assignment_Request

Get Maintain Candidate List Assignment Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Reference  Candidate_List_Assignment_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Candidate List Assignment and its associated data.   
Request_Criteria  Maintain_Candidate_List_Assignment_Request_Criteria  [0..1]  Maintain Candidate List Assignment Request Criteria   
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  Maintain_Candidate_List_Assignment_Response_Group  [0..1]  Maintain Candidate List Assignment Response Group   
top
 

Response Element: Get_Maintain_Candidate_List_Assignment_Response

Get Maintain Candidate List Assignment Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Response_Reference  Candidate_List_Assignment_Request_References  [0..1]  Reference to existing Candidate List Assignment   
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  Maintain_Candidate_List_Assignment_Response_Group  [0..1]  Maintain candidate List Assignment Reference Group   
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  Maintain_Candidate_List_Assignment_Response_Data  [0..1]  Candidate List Assignment Response Data   
top
 

Candidate_List_Assignment_Request_References

part of: Get_Maintain_Candidate_List_Assignment_Request, Get_Maintain_Candidate_List_Assignment_Response
Documentation Utilize the Request References element to retrieve a specific instance(s) of Candidate List Assignment and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Candidate_List_Assignment_Reference  Candidate_List_Rule_Configuration_SingletonObject  [0..1]  A unique identifier for the candidate list assignment.   
top
 

Candidate_List_Rule_Configuration_SingletonObject

part of: Candidate_List_Assignment_Request_References, Maintain_Candidate_List_Assignment_Get_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_List_Rule_Configuration_SingletonObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Candidate_List_Rule_Configuration_SingletonObjectID

part of: Candidate_List_Rule_Configuration_SingletonObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Candidate_List_Rule_Configuration_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
 

Maintain_Candidate_List_Assignment_Request_Criteria

part of: Get_Maintain_Candidate_List_Assignment_Request
Request Criteria for Maintain Candidate List Assignment
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Maintain_Candidate_List_Assignment_Request, Get_Maintain_Candidate_List_Assignment_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
 

Maintain_Candidate_List_Assignment_Response_Group

part of: Get_Maintain_Candidate_List_Assignment_Request, Get_Maintain_Candidate_List_Assignment_Response
Maintain candidate List Assignment Reference Group
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Results

part of: Get_Maintain_Candidate_List_Assignment_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
 

Maintain_Candidate_List_Assignment_Response_Data

part of: Get_Maintain_Candidate_List_Assignment_Response
This contains the Candidate List Assignment Data Content
 
Parameter name Type/Value Cardinality Description Validations
Maintain_Candidate_List_Assignment  Maintain_Candidate_List_Assignment_Get_Data  [0..*]  Contains the default grid and Rules   
top
 

Maintain_Candidate_List_Assignment_Get_Data

part of: Maintain_Candidate_List_Assignment_Response_Data
Contains Canidate List Assignment Get Data
 
Parameter name Type/Value Cardinality Description Validations
Candidate_List_Assignment_Reference  Candidate_List_Rule_Configuration_SingletonObject  [0..1]  Reference to the Candidate List Assignment   
Maintain_Candidate_List_Assignment_Data  Maintain_Candidate_List_Assignment_Data  [0..1]  Maintain Candidate List Assignment Data   
top
 

Maintain_Candidate_List_Assignment_Data

part of: Maintain_Candidate_List_Assignment_Get_Data
Maintain Candidate List Assignment Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID   
Candidate_List_Default_Grid_Reference  Grid_ConfigurationObject  [1..1]  Contains the Default Configuration Grid   
Candidate_Grid_Configuration_Data  Maintain_Candidate_List_Assignment_Subedit_Data  [0..*]  Contains the Condition Rules for Maintain Candidate List Assignment 
Validation Description
Select another condition rule because this one is already in use.   
 
top
 

Grid_ConfigurationObject

part of: Maintain_Candidate_List_Assignment_Subedit_Data, Maintain_Candidate_List_Assignment_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  Grid_ConfigurationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Grid_ConfigurationObjectID

part of: Grid_ConfigurationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Grid_Configuration_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
 

Maintain_Candidate_List_Assignment_Subedit_Data

part of: Maintain_Candidate_List_Assignment_Data
Contains the data for the Configuration Rule Rows
 
Parameter name Type/Value Cardinality Description Validations
Order  string (6)   [1..1]  The Row Order   
Condition_Rule_Reference  Condition_RuleObject  [1..1]  The Job Requisition Condition Rule   
Candidate_Grid_Configuration_Reference  Grid_ConfigurationObject  [1..1]  The Candidate List Configuration Grid   
Comment  string  [0..1]  The Rule Comment   
Validation Description
Select another condition rule because this one is already in use.   
top
 

Condition_RuleObject

part of: Maintain_Candidate_List_Assignment_Subedit_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  Condition_RuleObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Condition_RuleObjectID

part of: Condition_RuleObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Condition_Rule_ID, WCP_Component_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_List_Rule_Configuration_SingletonReferenceEnumeration

part of: Candidate_List_Rule_Configuration_SingletonObjectID
Base Type
string
top
 

Grid_ConfigurationReferenceEnumeration

part of: Grid_ConfigurationObjectID
Base Type
string
top
 

Condition_RuleReferenceEnumeration

part of: Condition_RuleObjectID
Base Type
string
top