Service Directory > v31.2 > Workday_Extensibility > Put_Custom_List
 

Operation: Put_Custom_List

This service operation allows you to add and update a custom list.


@ - 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: Put_Custom_List_Request

Request Element . A custom list can be edited by specifying a reference or a webservice alias
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Indicates whether the request is Add Only   
Custom_List_Reference  Custom_ListObject  [0..1]  A Custom List Reference. Can be accessed via WID, or Custom_List_ID   
Custom_List_Data  Custom_List_Data  [0..1]  Custom List Request Criteria. Includes Custom List Value 
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.   
 
Validation Description
Add Only cannot be applied to an Existing Custom List.   
top
 

Response Element: Put_Custom_List_Response

Response Element for Custom List
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Custom_List_Reference  Custom_ListObject  [0..1]  Custom List Reference Updated   
top
 

Custom_ListObject

part of: Put_Custom_List_Request, Put_Custom_List_Response
 
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_Data

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