Operation: Get_Custom_Worktags

This service operation will get all the Custom Worktags and the Custom Worktag Configuration. Custom Worktags are user-defined values that can be used to tag transaction with data that is not represented by the Workday delivered transaction Worktags. Custom Worktags must be enabled and mapped to a Custom Worktag Configuration. Custom Worktag data includes the Configuration Reference, the Worktags Reference ID and Value for that Configuration.

@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.

Response_Filter

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.

Response_Results

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.

For web service version v26.0 and later, when the configuration in 'Maintain Related Worktag Usage' for this Taggable Type has any worktag types configured with 'Default Required', the 'Related Worktags Data' subelement must be included.

Validation

Description

The number of worktags for this Custom Worktag Type cannot be larger than the governor limit.

For web service version v26.0 and later, when the configuration in 'Maintain Related Worktag Usage' for this Taggable Type has any worktag types configured with 'Default Required', the 'Related Worktags Data' subelement must be included.

Related_Worktag_Widget_Data

All existing related worktags (both allowed and default) are replaced with the ones specified in the request. It will supersede any "remove all" or delete option set to True by worktag type. When True, a default value must be provided for all worktag types that are configured with 'Default Required' in the 'Maintain Related Worktag Usage'.

For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote] you cannot specify allowed values as they are not enabled in ‘Maintain Related Worktag Usage’.

For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Default Worktag field is "Required".

Worktag Type: [AWT] is not allowed for Taggable Type: [TT]

For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Allowed Value cannot be 'Y' when all allowed values are being replaced.

For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value and allowed values are being replaced, allowed values in file must be empty or include default value specified in file.

For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when allowed values are being replaced but existing default value is not being replaced or deleted, allowed values in file must be empty or include existing default value.

For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], you cannot have a 'Default Value' on more than one row.

For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value is being replaced, persisted allowed values must be empty or include default value specified in file.

Boolean to indicate if the Worktag Type will be required on a transaction when a value for the worktag type that has related values is entered.

Required_On_Transaction_For_Validation

boolean

[0..1]

Boolean to indicate if 'Required on Transaction' is enabled in either 'Maintain Related Worktag Usage' or on the Worktag instance. When you generate an EIB template with data, 'y' is returned when either boolean is true. This boolean is informational only in the 'Put' operation.

For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when existing default value is being replaced, default value in file must match an allowed value in file or an existing allowed value

'[worktag value]' is not permitted as an allowed value for worktag type: [worktag type] because it is inactive.

[concatenated validation message for constraint provider]

Validation

Description

For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote] you cannot specify allowed values as they are not enabled in ‘Maintain Related Worktag Usage’.

For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Default Worktag field is "Required".

Worktag Type: [AWT] is not allowed for Taggable Type: [TT]

For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Allowed Value cannot be 'Y' when all allowed values are being replaced.

For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value and allowed values are being replaced, allowed values in file must be empty or include default value specified in file.

For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when allowed values are being replaced but existing default value is not being replaced or deleted, allowed values in file must be empty or include existing default value.

For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], you cannot have a 'Default Value' on more than one row.

For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value is being replaced, persisted allowed values must be empty or include default value specified in file.

IMPORTANT: You must check 'Separate Type Column' for this field in your EIB template to see values when you generate a template with data or to configure related worktags for multiple worktag types. The list of valid ID types for this column exceeds the size limit of an Excel validation list so ID types must be entered as text. Valid ID types for this column may include: Business_Unit_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_1-5_ID, Custom_Worktag_06-15_ID, Fund_ID, Gift_Reference_ID, Grant_ID, Investor_ID, Location_ID, Opportunity_Reference_ID, Organization_Reference_ID, Program_ID, Project_ID, Project_Phase_Name_ID, Project_Task_Name_ID, Region_Reference_ID, Sales_Item_Group_ID, Sales_Item_ID.

Validation

Description

Worktag Type of Default Worktag "[AW]" does not match the Worktag Type: "[WT]".

Worktag Aggregation Dimension: '[wt]' is not allowed in the default worktag field.

For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Default Value cannot be 'Y' when a default is required or the default value is not the existing value or if its blank.

Boolean to indicate that specified allowed values are to be deleted. At least 1 existing allowed value must be specified When set to true (or 'y' in EIB). Cannot be set to true if 'Replace All Allowed Values' is set to true.