Service Directory > v31.2 > Human_Resources > Put_Search_Settings
 

Operation: Put_Search_Settings

This operation will put search configurations into workday.


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

Put search settings request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Search_Settings_Data  Search_Settings_Data  [1..1]  Search Settings Data   
top
 

Response Element: Put_Search_Settings_Response

Response element containing tenant setup search data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Search_Settings_Data  Search_Settings_Data  [0..*]  Search Settings Data   
top
 

Search_Settings_Data

part of: Put_Search_Settings_Request, Put_Search_Settings_Response
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