Service Directory > v31.2 > Workday_Extensibility > Get_Custom_Lists
 

Operation: Get_Custom_Lists

This service operation allows you to get all custom lists or custom lists for the specified criteria.


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

Request for a Specific Custom List or All Custom Lists
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Custom_List_Request_References  [0..1]  Custom List Request Reference   
Request_Criteria [Choice]   Custom_List_Request_Criteria  [0..1]  Request Criteria for Custom List. Includes Custom List name and Custom List Value Name   
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  Custom_List_Response_Group  [0..1]  Custom List Response Group   
top
 

Response Element: Get_Custom_Lists_Response

Get Custom List Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Custom_List_Request_References  [0..1]  Custom List Reference   
Request_Criteria  Custom_List_Request_Criteria  [0..1]  Request Criteria for Bringing back Custom List   
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  Custom_List_Response_Group  [0..1]  Custom List Response 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  Custom_List_Response_Data  [0..1]  Data for all Custom Lists Returned. Includes Data about the Custom List Values as well   
top
 

Custom_List_Request_References

part of: Get_Custom_Lists_Request, Get_Custom_Lists_Response
Custom List Reference
 
Parameter name Type/Value Cardinality Description Validations
Custom_List_Reference  Custom_ListObject  [1..*]  Custom List Reference   
top
 

Custom_ListObject

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

Custom_ListObjectID

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

Custom_List_Request_Criteria

part of: Get_Custom_Lists_Request, Get_Custom_Lists_Response
Request Criteria for Bringing back Custom List
 
Parameter name Type/Value Cardinality Description Validations
Custom_List_Alias  string  [0..1]  The Custom List Name   
Custom_List_Value_Alias  string  [0..1]  The name of the Custom List Value   
top
 

Response_Filter

part of: Get_Custom_Lists_Request, Get_Custom_Lists_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
 

Custom_List_Response_Group

part of: Get_Custom_Lists_Request, Get_Custom_Lists_Response
Custom List Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Includes Reference   
top
 

Response_Results

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

Custom_List_Response_Data

part of: Get_Custom_Lists_Response
Custom List and Data
 
Parameter name Type/Value Cardinality Description Validations
Custom_List  Custom_List  [0..*]  Custom List Reference and Data   
top
 

Custom_List

part of: Custom_List_Response_Data
Custom List Reference and Data
 
Parameter name Type/Value Cardinality Description Validations
Custom_List_Reference  Custom_ListObject  [0..1]  The Custom List Reference   
Custom_List_Data  Custom_List_Data  [0..*]  the Custom List Data 
Validation Description
You have exceeded the maximum number of allowed Custom List Values of [max].   
Enter a custom list value name that isn't already in use for this list   
Enter a Web Service Alias that isn't already in use for a value in this custom list.   
Custom List cannot be deprecated if it is in use.   
 
top
 

Custom_List_Data

part of: Custom_List
Custom List Data
 
Parameter name Type/Value Cardinality Description Validations
Web_Service_Alias  string  [0..1]  Custom List Web Service Alias. This is used to access an instance of a Custom List, or create a new Custom list. it must be present if the custom list reference is not present 
Validation Description
A webservice alias is required for a new Custom List   
Enter a web service alias that isn't already in use for this custom field type.   
Enter a Web Service Alias that doesn't begin with a number.   
Enter a web service alias that contains only lowercase letters and numbers without spaces.   
The web service alias of the custom field type must be different from all related custom object web service aliases.   
 
Custom_Field_Type_Name  string  [0..1]  Custom List Name Unique to all Custom Lists 
Validation Description
Name is required for a new custom List   
Enter a custom field type name that isn't already in use   
 
Do_Not_Use  boolean  [0..1]  Custom List is Do Not Use   
Custom_List_Value_Data  Custom_List_Value  [0..*]  Custom List Value Data   
Validation Description
You have exceeded the maximum number of allowed Custom List Values of [max].   
Enter a custom list value name that isn't already in use for this list   
Enter a Web Service Alias that isn't already in use for a value in this custom list.   
Custom List cannot be deprecated if it is in use.   
top
 

Custom_List_Value

part of: Custom_List_Data
Custom List Value Data
 
Parameter name Type/Value Cardinality Description Validations
Order  string (6)   [0..1]  Custom List Value Data   
List_Value_Name  string  [0..1]  Value Name 
Validation Description
A name is required for a new custom list value   
Enter a custom list value name that isn't already in use for this list   
 
Web_Service_Alias  string  [1..1]  Alias 
Validation Description
Enter a web service alias that contains only lowercase letters and numbers without spaces.   
Enter a Web Service Alias that doesn't begin with a number.   
 
Deprecated  boolean  [0..1]  Deprecated   
top
 

Custom_ListReferenceEnumeration

part of: Custom_ListObjectID
Base Type
string
top