Service Directory > v31.2 > Recruiting > Get_Recruiting_Assessment_Category_Security_Segments
 

Operation: Get_Recruiting_Assessment_Category_Security_Segments

Web service operation to retrieve Recruiting Assessment Category Security Segments.


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

Element containing the request to retrieve Recruiting Assessment Category Security Segment(s).
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Recruiting_Assessment_Category_Security_Segment_Request_References  [0..1]  Element containing references to Recruiting Assessment Category Security Segments to retrieve.   
Request_Criteria [Choice]   Recruiting_Assessment_Category_Security_Segment_Request_Criteria  [0..1]  Element containing filtering logic for the Recruiting Assessment Category Security Segments.   
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  Recruiting_Assessment_Category_Security_Segment_Response_Group  [0..1]  Element containing Recruiting Assessment Category Security Segment response grouping options.   
top
 

Response Element: Get_Recruiting_Assessment_Category_Security_Segments_Response

Element containing the Recruiting Assessment Category Security Segment(s) retrieved by the web service.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Recruiting_Assessment_Category_Security_Segment_Request_References  [0..1]  Element containing references to Recruiting Assessment Category Security Segments to retrieve.   
Request_Criteria  Recruiting_Assessment_Category_Security_Segment_Request_Criteria  [0..1]  Element containing filtering logic for the Recruiting Assessment Category Security Segments.   
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  Recruiting_Assessment_Category_Security_Segment_Response_Group  [0..1]  Element containing Recruiting Assessment Category Security Segment 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  Recruiting_Assessment_Category_Security_Segment_Response_Data  [0..1]  Element containing data for the Recruiting Assessment Category Security Segment.   
top
 

Recruiting_Assessment_Category_Security_Segment_Request_References

part of: Get_Recruiting_Assessment_Category_Security_Segments_Response, Get_Recruiting_Assessment_Category_Security_Segments_Request
Element containing references to Recruiting Assessment Category Security Segments to retrieve.
 
Parameter name Type/Value Cardinality Description Validations
Recruiting_Assessment_Category_Security_Segment_Reference  Recruiting_Assessment_Category_Security_SegmentObject  [1..*]  References to Recruiting Assessment Category Security Segments to retrieve.   
top
 

Recruiting_Assessment_Category_Security_SegmentObject

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

Recruiting_Assessment_Category_Security_SegmentObjectID

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

Recruiting_Assessment_Category_Security_Segment_Request_Criteria

part of: Get_Recruiting_Assessment_Category_Security_Segments_Response, Get_Recruiting_Assessment_Category_Security_Segments_Request
Element containing filtering logic for the Recruiting Assessment Category Security Segments.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Recruiting_Assessment_Category_Security_Segments_Response, Get_Recruiting_Assessment_Category_Security_Segments_Request
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
 

Recruiting_Assessment_Category_Security_Segment_Response_Group

part of: Get_Recruiting_Assessment_Category_Security_Segments_Response, Get_Recruiting_Assessment_Category_Security_Segments_Request
Element containing Recruiting Assessment Category Security Segment response grouping options.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean flag to include Reference in response.   
top
 

Response_Results

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

Recruiting_Assessment_Category_Security_Segment_Response_Data

part of: Get_Recruiting_Assessment_Category_Security_Segments_Response
Element containing data for the Recruiting Assessment Category Security Segment.
 
Parameter name Type/Value Cardinality Description Validations
Recruiting_Assessment_Category_Security_Segment  Recruiting_Assessment_Category_Security_Segment  [0..*]  Element containing data for the Recruiting Assessment Category Security Segment.   
top
 

Recruiting_Assessment_Category_Security_Segment

part of: Recruiting_Assessment_Category_Security_Segment_Response_Data
Element containing data for the Recruiting Assessment Category Security Segment.
 
Parameter name Type/Value Cardinality Description Validations
Recruiting_Assessment_Category_Security_Segment_Reference  Recruiting_Assessment_Category_Security_SegmentObject  [0..1]  A unique identifier used to reference a Recruiting Assessment Category Security Segment.   
Recruiting_Assessment_Category_Security_Segment_Data  Recruiting_Assessment_Category_Security_Segment_Data  [0..1]  Element containing data for the Recruiting Assessment Category Security Segment.   
top
 

Recruiting_Assessment_Category_Security_Segment_Data

part of: Recruiting_Assessment_Category_Security_Segment
Element containing data for the Recruiting Assessment Category Security Segment.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  A unique identifier used to reference a Recruiting Assessment Category Security Segment. 
Validation Description
A Recruiting Assessment Category Security Segment with the specified ID already exists.   
 
Recruiting_Assessment_Category_Security_Segment_Name  string  [1..1]  The name for the Recruiting Assessment Category Security Segment.   
Recruiting_Assessment_Category_Reference  Recruiting_Assessment_CategoryObject  [1..*]  The Recruiting Assessment Category secured by the security segment.   
top
 

Recruiting_Assessment_CategoryObject

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

Recruiting_Assessment_CategoryObjectID

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

Recruiting_Assessment_Category_Security_SegmentReferenceEnumeration

part of: Recruiting_Assessment_Category_Security_SegmentObjectID
Base Type
string
top
 

Recruiting_Assessment_CategoryReferenceEnumeration

part of: Recruiting_Assessment_CategoryObjectID
Base Type
string
top