Service Directory > v31.2 > Financial_Management > Get_Search_Settings
 

Operation: Get_Search_Settings

This operation will get information for search settings.


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

Get search settings
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
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. 
 
top
 

Response Element: Get_Search_Settings_Response

Response element search setup data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
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_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  Search_Settings_Response_Data  [0..1]  Wrapper element that includes Search Settings data   
top
 

Response_Filter

part of: Get_Search_Settings_Request, Get_Search_Settings_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
 

Response_Results

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

Search_Settings_Response_Data

part of: Get_Search_Settings_Response
Wrapper element that includes Search Settings data
 
Parameter name Type/Value Cardinality Description Validations
Search_Settings  Search_Settings  [0..1]  Wrapper Element that includes Search Settings Data   
top
 

Search_Settings

part of: Search_Settings_Response_Data
Wrapper Element that includes Search Settings Data
 
Parameter name Type/Value Cardinality Description Validations
Search_Settings_Data  Search_Settings_Data  [0..1]  Search Settings Data   
top
 

Search_Settings_Data

part of: Search_Settings
Search Settings Data
 
Parameter name Type/Value Cardinality Description Validations
Object_Type_to_Suppress_from_Search_Reference  Unique_IdentifierObject  [0..*]  Specify the object types that are suppressed by default in search results. Suppressions are not applied to domain searches and can be turned off by using the "all:" domain.   
Synonyms  Synonym_Webservice_Data  [0..*]  Create synonyms for Workday Terms to help make tasks and standard reports more easily discovered using worker's terminology. Enter the Workday Term using the tenant base language, then define synonyms separated by comma (i.e. "PTO, vacation, holiday"). Synonyms in different languages can be listed together. However, if many synonyms will be defined across several languages, it is recommended to define synonyms below in the tenant base language and then use the Business Object Translation task to create translations in other languages. 
Validation Description
The same workday term cannot be used for more than one synonym.   
 
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Synonym_Webservice_Data

part of: Search_Settings_Data
A synonym which maps a single workday term to one or more custom terms
 
Parameter name Type/Value Cardinality Description Validations
Workday_Term  string  [1..1]  The workday term, i.e. "time off" 
Validation Description
The workday term you entered does not match any tasks or standard reports.   
The same workday term cannot be used for more than one synonym.   
 
Custom_Terms  string  [1..1]  The customer terms, i.e. "PTO, vacation"   
Validation Description
The same workday term cannot be used for more than one synonym.   
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top