Service Directory > v33.1 > Resource_Management > Get_Worktag_Split_Template_Criteria
 

Operation: Get_Worktag_Split_Template_Criteria

This service operation will get Worktag Split Template Criterias for the specified criteria. Worktag Split Template Criterias are used to filter Worktag Split Templates based on criteria selection. Worktag Split Template Criteria data includes Worktag Split Template Criteria ID, Name, Description, and the Companies and Company Hierarchies it is restricted by. The request criteria can be for a single transaction based on Reference, or all transactions can be retrieved if no criteria is specified.


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

Contains request reference, criteria, filter and response group for getting Worktag Split Template Criteria data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Worktag_Split_Template_Criteria_Request_References  [0..1]  Get Worktag Split Template Request References   
Request_Criteria [Choice]   Worktag_Split_Template_Criteria_Request_Criteria  [0..1]  Get Worktag Split Template Request Criteria 
Validation Description
You cannot submit a blank Request Criteria Element.   
 
Response_Filter  Response_Filter  [0..1]  Get Worktag Split Template Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Worktag_Split_Template_Criteria_Response_Group  [0..1]  Get Worktag Split Template Response Group   
top
 

Response Element: Get_Worktag_Split_Template_Criteria_Response

Element containing Worktag Split Template response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Worktag_Split_Template_Criteria_Request_References  [0..1]  Get Worktag Split Template Request References   
Request_Criteria  Worktag_Split_Template_Criteria_Request_Criteria  [0..1]  Get Worktag Split Template Criteria 
Validation Description
You cannot submit a blank Request Criteria Element.   
 
Response_Filter  Response_Filter  [0..1]  Get Worktag Split Template Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Worktag_Split_Template_Criteria_Response_Group  [0..1]  Get Worktag Split Template Response Group   
Response_Results  Response_Results  [0..1]  Get Worktag Split Template Response Results   
Response_Data  Worktag_Split_Template_Criteria_Response_Data  [0..1]  Get Worktag Split Template Response Data   
top
 

Worktag_Split_Template_Criteria_Request_References

part of: Get_Worktag_Split_Template_Criteria_Request, Get_Worktag_Split_Template_Criteria_Response
Element containing reference instances for a Worktag Split Template
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Split_Template_Criteria_Reference  Worktag_Split_Template_CriteriaObject  [1..*]  Reference to an existing Worktag Split Template   
top
 

Worktag_Split_Template_CriteriaObject

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

Worktag_Split_Template_CriteriaObjectID

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

Worktag_Split_Template_Criteria_Request_Criteria

part of: Get_Worktag_Split_Template_Criteria_Request, Get_Worktag_Split_Template_Criteria_Response
Element used to request certain Worktag Split Templates
 
Parameter name Type/Value Cardinality Description Validations
Template_Criteria_Name  string  [0..1]  Name for Worktag Split Template Criteria   
Restricted_By_Companies_Reference  OrganizationObject  [0..*]  Restrict by Companies and Company Hierarchies for Worktag Split Template Criteria   
Validation Description
You cannot submit a blank Request Criteria Element.   
top
 

OrganizationObject

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

OrganizationObjectID

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

Response_Filter

part of: Get_Worktag_Split_Template_Criteria_Request, Get_Worktag_Split_Template_Criteria_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, become effective (Also referred to as the Effective Moment). If you don't specify a date, this date defaults to today.{+4}   
As_Of_Entry_DateTime  dateTime  [0..1]  The date and time the data was entered into the system. (This field is also referred to as the Entry Moment). If the date isn't specified, the default date is the current date and time.   
Page  decimal (12, 0) >0   [0..1]  The numbered page of data Workday returns in the response. The default page is 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. Set a value between 1 and 999. The default value is 100.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Worktag_Split_Template_Criteria_Response_Group

part of: Get_Worktag_Split_Template_Criteria_Request, Get_Worktag_Split_Template_Criteria_Response
Element containing Worktag Split Template response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Worktag_Split_Template_Criteria_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 your request returned.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages requested. A page of data in a WWS has a 100 entry maximum.   
Page_Results  decimal (12, 0) >0   [0..1]  The number of results in the current page.   
Page  decimal (12, 0) >0   [0..1]  The page number of the data the WWS returned for your request.   
top
 

Worktag_Split_Template_Criteria_Response_Data

part of: Get_Worktag_Split_Template_Criteria_Response
Wrapper Element that includes Worktag Split Template Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Split_Template_Criteria  Worktag_Split_Template_Criteria  [0..*]  Worktag Split Template Criteria   
top
 

Worktag_Split_Template_Criteria

part of: Worktag_Split_Template_Criteria_Response_Data
Wrapper Element that includes Worktag Split Template Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Split_Template_Criteria_Reference  Worktag_Split_Template_CriteriaObject  [0..1]  Reference to an existing Worktag Split Template   
Worktag_Split_Template_Criteria_Data  Worktag_Split_Template_Criteria_Data  [0..*]  Worktag Split Template Data   
top
 

Worktag_Split_Template_Criteria_Data

part of: Worktag_Split_Template_Criteria
Data for Worktag Split Template Criteria
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Split_Template_Criteria_ID  string  [0..1]  Reference ID for Worktag Split Template Criteria Data   
Template_Criteria_Name  string  [1..1]  Name for Worktag Split Template Criteria 
Validation Description
Enter a Template Criteria Name that isn't already in use on the Worktag Split Template Criteria.   
 
Description  string  [0..1]  Description for Worktag Split Template Criteria   
Restricted_To_Companies_Reference  OrganizationObject  [1..*]  Restrict by Companies and Company Hierarchies for Worktag Split Template Criteria   
top
 

Worktag_Split_Template_CriteriaReferenceEnumeration

part of: Worktag_Split_Template_CriteriaObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top