Service Directory > v32.1 > Human_Resources > Get_Work_Status_Rule_Sets
 

Operation: Get_Work_Status_Rule_Sets

Retrieves existing Work Status Rule Sets via Web Service


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

Request Element for Get Work Status Rule Sets
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Work_Status_Rule_Set_Request_References  [0..1]  References Provided to be returned by Get Work Status Rule Set   
Request_Criteria [Choice]   Work_Status_Rule_Set_Request_Criteria  [0..1]  Criteria for filtering which Work Status Rule Sets are returned   
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_Group  Work_Status_Rule_Set_Response_Group  [0..1]  Response Group for Work Status Rule Set   
top
 

Response Element: Get_Work_Status_Rule_Sets_Response

Response Element from Work Status Rule Set
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Work_Status_Rule_Set_Request_References  [0..1]  References Provided to be returned by Get Work Status Rule Set   
Request_Criteria  Work_Status_Rule_Set_Request_Criteria  [0..1]  Criteria for filtering which Work Status Rule Sets are returned   
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_Group  Work_Status_Rule_Set_Response_Group  [0..1]  Response Group for Work Status Rule Set   
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  Work_Status_Rule_Set_Response_Data  [0..1]  Contains the Response of the Web Service Get Request   
top
 

Work_Status_Rule_Set_Request_References

part of: Get_Work_Status_Rule_Sets_Request, Get_Work_Status_Rule_Sets_Response
References Provided to be returned by Get Work Status Rule Set
 
Parameter name Type/Value Cardinality Description Validations
Work_Status_Rule_Set_Reference  Work_Status_Rule_SetObject  [1..*]  References provided to obtain attributes and relationship information   
top
 

Work_Status_Rule_SetObject

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

Work_Status_Rule_SetObjectID

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

Work_Status_Rule_Set_Request_Criteria

part of: Get_Work_Status_Rule_Sets_Request, Get_Work_Status_Rule_Sets_Response
Criteria for filtering which Work Status Rule Sets are returned
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Work_Status_Rule_Sets_Request, Get_Work_Status_Rule_Sets_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
 

Work_Status_Rule_Set_Response_Group

part of: Get_Work_Status_Rule_Sets_Request, Get_Work_Status_Rule_Sets_Response
Response Group for Work Status Rule Set
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean that checks on whether or not to include the reference ID   
top
 

Response_Results

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

Work_Status_Rule_Set_Response_Data

part of: Get_Work_Status_Rule_Sets_Response
Contains the Response of the Web Service Get Request
 
Parameter name Type/Value Cardinality Description Validations
Work_Status_Rule_Set  Work_Status_Rule_Set  [0..*]  Contains the Data and Reference to the Work Status Rule Sets   
top
 

Work_Status_Rule_Set

part of: Work_Status_Rule_Set_Response_Data
Contains the Data and Reference to the Work Status Rule Sets
 
Parameter name Type/Value Cardinality Description Validations
Work_Status_Rule_Set_Reference  Work_Status_Rule_SetObject  [0..1]  Reference to Work Status Rule Set where data is retrieved from   
Work_Status_Rule_Set_Data  Work_Status_Rule_Set_Data  [0..*]  Container Element containing all Attributes and Relationship for a Work Status Rule Set   
top
 

Work_Status_Rule_Set_Data

part of: Work_Status_Rule_Set
Container Element containing all Attributes and Relationship for a Work Status Rule Set
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Work Status Rule Set 
Validation Description
Enter a Work Status Rule Set Reference ID that isn't already in use.   
 
Work_Status_Rule_Set_Name  string  [1..1]  Name of Work Status Rule Set 
Validation Description
Work Status Rule Set Name must be unique.   
 
Work_Status_Rule_Set_Description  RichText  [0..1]  Description of Work Status Rule Set   
Restricted_to_Academic_Unit_Reference  Academic_UnitObject  [0..*]  The Academic Unit that the Work Status Rule Set is restricted to   
Default_Work_Status_Rule_Set  boolean  [0..1]  Determines whether the Work Status Rule Set is defaulted to be used in other reports 
Validation Description
You can't select the Default Rule Set check box because the [rule set name] rule set is already defined as the default. To make this rule set the default, clear the check box on the other one.   
You can't select the Default Rule Set check box because the [rule set name] rule set is already defined as the default. To make this rule set the default, clear the check box on the other one.   
An Inactive Work Status Rule Set can not be a Default rule set.   
 
Inactive  boolean  [0..1]  This flag will inactivate the Work Status Rule Set.   
Applies_to_Leave_Types_Reference  Leave_of_Absence_TypeObject  [0..*]  Leave Types that are used in the Evaluation of certain Work Status Rules   
Active_Periods_Required_for_Eligibility  decimal (10, 0) >0   [0..1]  Number of Active Periods Required for Eligibility of Leave 
Validation Description
Number of Active Periods must be 0 if not provided a Leave Type.   
 
Minimum_Years_Since_Last_Applicable_Leave  decimal (4, 0) >0   [0..1]  Minimum Years Since Last Applicable Leave 
Validation Description
You did not enter a Leave Type so Minimum Years Since Last Applicable Leave must be blank.   
 
Work_Status_Rule_Row_Subdata  Work_Status_Rule_Row_Subdata  [0..*]  Element Container for all the Attributes and Relationships for each Work Status Rule Row 
Validation Description
Enter the Work Status Rule Row Reference for the work status rule row you want to delete.   
Add Only is set to true. You can not submit a reference to update. Please remove the Add Only flag for updating.   
 
top
 

Academic_UnitObject

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

Academic_UnitObjectID

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

Leave_of_Absence_TypeObject

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

Leave_of_Absence_TypeObjectID

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

Work_Status_Rule_Row_Subdata

part of: Work_Status_Rule_Set_Data
Container Element for all Attributes and Relationships associated to the Work Status Rule Row
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Flag indicating that the referenced data should be deleted.   
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update. If an existing instance is found and this flag is set there will be an error.   
Work_Status_Rule_Row_ID  string  [0..1]  Reference ID for Work Status Rule Row.   
Order  string (6)   [1..1]  Specifies the order of evaluation of the Work Status Rules   
Work_Status_Rule_Name  string  [1..1]  Name of the Work Status Rule Row   
Work_Status_Reference  Work_StatusObject  [1..1]  Specific Work Status associated to the row 
Validation Description
Enter a valid Work Status ID for this tenant.   
 
Work_Status_Rule_Reference  Work_Status_RuleObject  [1..1]  Evaluation designated for the row 
Validation Description
Enter a valid Work Status Rule ID for this tenant.   
 
Validation Description
Enter the Work Status Rule Row Reference for the work status rule row you want to delete.   
Add Only is set to true. You can not submit a reference to update. Please remove the Add Only flag for updating.   
top
 

Work_StatusObject

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

Work_StatusObjectID

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

Work_Status_RuleObject

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

Work_Status_RuleObjectID

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

Work_Status_Rule_SetReferenceEnumeration

part of: Work_Status_Rule_SetObjectID
Base Type
string
top
 

RichText

part of: Work_Status_Rule_Set_Data
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Leave_of_Absence_TypeReferenceEnumeration

part of: Leave_of_Absence_TypeObjectID
Base Type
string
top
 

Work_StatusReferenceEnumeration

part of: Work_StatusObjectID
Base Type
string
top
 

Work_Status_RuleReferenceEnumeration

part of: Work_Status_RuleObjectID
Base Type
string
top