Service Directory > v31.2 > Revenue_Management > Get_Award_Lifecycle_Status_Update_Rules
 

Operation: Get_Award_Lifecycle_Status_Update_Rules

Gets Award Lifecycle Status Update Rules specified by Award Lifecycle Status Update Rule Reference IDs, or if no request ID is provided, all Award Lifecycle Status Update Rules. Lifecycle Status Update Rule Data includes Award Lifecycle Status Update Rule, Evaluation Order, Applies To Header Status, Applies To Line Status, Change To New Status Reference, Unless Current Status Reference, Based On Dates, Based On Award Tasks, Number of Months, Number of Days, On or Before Date, On or After Date, Award Schedule Life, Award Contract Period, Award Line Life, and Lifecycle Status Update Rule Award Task Criteria Data.


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

This element is the top-level request element for all Lifecycle Status Update Rule "Get" operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Lifecycle_Status_Update_Rule_Request_References  [0..1]  This element contains the specific instance set containing the requested LIfecycle Status Update Rules. The ID is the value and the Type attribute is either the Lookup ID type or the Workday ID (GUID) for the instance of Lifecycle Status Update Rule   
Request_Criteria [Choice]   Lifecycle_Status_Update_Rule_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the Lifecycle Status Update Rule specific criteria needed to search for instances.   
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  Lifecycle_Status_Update_Rule_Response_Group  [0..1]  Documentation Wrapper element around a list of elements representing the amount of data that should be included in the Lifecycle Status Update Rules response. If this element is not included then ALL of the Response Groups are included in the response.   
top
 

Response Element: Get_Award_Lifecycle_Status_Update_Rules_Response

Element containing Lifecycle Status Update Rule response elements including echoed request data and request result data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Lifecycle_Status_Update_Rule_Request_References  [0..1]  This element contains the specific instance set containing the requested Lifecycle Status Update Rule.   
Request_Criteria  Lifecycle_Status_Update_Rule_Request_Criteria  [0..1]  This element is the top-level request element for all Lifecycle Status Update Rule "Get" operations.   
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  Lifecycle_Status_Update_Rule_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Lifecycle Status Update Rule response. If this element is not included then ALL of the Response Groups are included in the response.   
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  Lifecycle_Status_Update_Rule_Response_Data  [0..1]  Wrapper element containing Lifecycle Status Update Rule Response Data for requested references or criteris and for requested response group   
top
 

Lifecycle_Status_Update_Rule_Request_References

part of: Get_Award_Lifecycle_Status_Update_Rules_Request, Get_Award_Lifecycle_Status_Update_Rules_Response
This element contains the specific instance set containing the requested Lifecycle Status Update Rule.
 
Parameter name Type/Value Cardinality Description Validations
Lifecycle_Status_Update_Rule_Reference  Lifecycle_Status_Update_RuleObject  [1..*]  This element contains the specific instance set containing the requested Lifecycle Status Update Rule.   
top
 

Lifecycle_Status_Update_RuleObject

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

Lifecycle_Status_Update_RuleObjectID

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

Lifecycle_Status_Update_Rule_Request_Criteria

part of: Get_Award_Lifecycle_Status_Update_Rules_Request, Get_Award_Lifecycle_Status_Update_Rules_Response
This element is the top-level request element for all Lifecycle Status Update Rule "Get" operations.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Award_Lifecycle_Status_Update_Rules_Request, Get_Award_Lifecycle_Status_Update_Rules_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
 

Lifecycle_Status_Update_Rule_Response_Group

part of: Get_Award_Lifecycle_Status_Update_Rules_Request, Get_Award_Lifecycle_Status_Update_Rules_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Lifecycle Status Update Rule response. If this element is not included then ALL of the Response Groups are included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Lifecycle Status Update Rule Reference is to be included in the response   
top
 

Response_Results

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

Lifecycle_Status_Update_Rule_Response_Data

part of: Get_Award_Lifecycle_Status_Update_Rules_Response
Wrapper element containing Lifecycle Status Update Rule Response Data for requested references or criteris and for requested response group
 
Parameter name Type/Value Cardinality Description Validations
Lifecycle_Status_Update_Rule  Lifecycle_Status_Update_Rule  [0..*]  Lifecycle Status Update Rule element   
top
 

Lifecycle_Status_Update_Rule

part of: Lifecycle_Status_Update_Rule_Response_Data
Wrapper Element that includes all data for a single Lifecycle Status Update Rule
 
Parameter name Type/Value Cardinality Description Validations
Lifecycle_Status_Update_Rule_Reference  Lifecycle_Status_Update_RuleObject  [0..1]  Reference to a single Lifecycle Status Update Rule for which data is being returned.   
Lifecycle_Status_Update_Rule_Data  Lifecycle_Status_Update_Rule_Data  [0..*]  Lifecycle Status Update Rule Data contains all of the data to describe an Lifecycle Status Update Rule. 
Validation Description
Choose one option for Start or End Date in Lifecycle Status Update Rule Data: Start_Date or End_Date  Choose one option for Start or End Date in Lifecycle Status Update Rule Data: Start_Date or End_Date 
Choose one option for Before or After in Lifecycle Status Update Rule Data: On_or_Before_Date or On_or_After_Date  Choose one option for Before or After in Lifecycle Status Update Rule Data: On_or_Before_Date or On_or_After_Date 
Choose one option for Relative To: Relative_To_Award_Schedule_Life, Relative_To_Award_Contract_Period, and Relative_To_Award_Line_Life  Choose one option for Relative To: Relative_To_Award_Schedule_Life, Relative_To_Award_Contract_Period, and Relative_To_Award_Line_Life 
The New Status is invalid. Choose an active Lifecycle Status.  The New Status is invalid. Choose an active Lifecycle Status. 
The New Status is invalid for the award header. Choose a valid New Status.  The New Status is invalid for the award header. Choose a valid New Status. 
The New Status is invalid for the award line. Choose a valid New Status.  The New Status is invalid for the award line. Choose a valid New Status. 
Choose one option in Lifecycle Status Update Rule Data: Based_On_Dates or Based_On_Award_Tasks  Choose one option in Lifecycle Status Update Rule Data: Based_On_Dates or Based_On_Award_Tasks 
Choose one option in Lifecycle Status Update Rule Data: Applies_To_Header_Status or Applies_To_Line_Status  Choose one option in Lifecycle Status Update Rule Data: Applies_To_Header_Status or Applies_To_Line_Status 
Enter the required information for Change_To_New_Status_Reference  Enter the required information for Change_To_New_Status_Reference 
Based On Award Tasks is active. Lifecycle Status Update Rule Award Task Criteria Data is invalid.  Based On Award Tasks is active. Lifecycle Status Update Rule Award Task Criteria Data is invalid. 
Enter the required information for Evaluation Order.  Enter the required information for Evaluation Order. 
Based On Dates is active. Award task data is invalid.  Based On Dates is active. Award task data is invalid. 
Applies To Header Status is active, Relative To Award Line Life is invalid.  Applies To Header Status is active, Relative To Award Line Life is invalid. 
 
top
 

Lifecycle_Status_Update_Rule_Data

part of: Lifecycle_Status_Update_Rule
Lifecycle Status Update Rule Data of a single Lifecycle Status Update Rule instance
 
Parameter name Type/Value Cardinality Description Validations
Award_Lifecycle_Status_Update_Rule_ID  string  [0..1]  Reference to an existing Lifecycle Status Update Rule for update only purposes.   
Evaluation_Order  string  [1..1]  The order the rule should be evaluated. 
Validation Description
Enter a unique name for Evaluation Order.   
 
Applies_To_Header_Status  boolean  [0..1]  A boolean flag indicating if the lifecycle status rule should apply to award header status or not.   
Applies_To_Line_Status  boolean  [0..1]  A boolean flag indicating if the lifecycle status rule should apply to award line status or not.   
Change_To_New_Status_Reference  Award_Lifecycle_StatusObject  [1..1]  The new status that the award header status or award line status will change to.   
Unless_Current_Status_Reference  Award_Lifecycle_StatusObject  [0..*]  Award header status or award line status will change to a new status specified in Change To New Status unless the current status equals to the one specified in this field.   
Based_On_Dates  boolean  [0..1]  A boolean flag indicating whether the update is based on dates or not.   
Based_On_Award_Tasks  boolean  [0..1]  A boolean flag indicating whether the update is based on Award Tasks or not.   
Number_of_Months  decimal (2, 0) >0   [0..1]  Number of Months   
Number_of_Days  decimal (12, 0) >0   [0..1]  Number of Days   
On_or_Before_Date  boolean  [0..1]  Occurs Before Anchor Date   
On_or_After_Date  boolean  [0..1]  Occurs After Anchor Date   
End_Date  boolean  [0..1]  End Date   
Start_Date  boolean  [0..1]  Start Date   
Relative_To_Award_Schedule_Life  boolean  [0..1]  Relative to Award Life   
Relative_To_Award_Contract_Period  boolean  [0..1]  Relative to Award Contract Period   
Relative_To_Award_Line_Life  boolean  [0..1]  Relative to Award Line Life   
Lifecycle_Status_Update_Rule_Award_Task_Criteria_Data  Lifecycle_Status_Update_Rule_Award_Task_Criteria_Data  [0..*]  Award Task Criteria Data for a single Lifecycle Status Update Rule Award Task Criteria   
Validation Description
Choose one option for Start or End Date in Lifecycle Status Update Rule Data: Start_Date or End_Date  Choose one option for Start or End Date in Lifecycle Status Update Rule Data: Start_Date or End_Date 
Choose one option for Before or After in Lifecycle Status Update Rule Data: On_or_Before_Date or On_or_After_Date  Choose one option for Before or After in Lifecycle Status Update Rule Data: On_or_Before_Date or On_or_After_Date 
Choose one option for Relative To: Relative_To_Award_Schedule_Life, Relative_To_Award_Contract_Period, and Relative_To_Award_Line_Life  Choose one option for Relative To: Relative_To_Award_Schedule_Life, Relative_To_Award_Contract_Period, and Relative_To_Award_Line_Life 
The New Status is invalid. Choose an active Lifecycle Status.  The New Status is invalid. Choose an active Lifecycle Status. 
The New Status is invalid for the award header. Choose a valid New Status.  The New Status is invalid for the award header. Choose a valid New Status. 
The New Status is invalid for the award line. Choose a valid New Status.  The New Status is invalid for the award line. Choose a valid New Status. 
Choose one option in Lifecycle Status Update Rule Data: Based_On_Dates or Based_On_Award_Tasks  Choose one option in Lifecycle Status Update Rule Data: Based_On_Dates or Based_On_Award_Tasks 
Choose one option in Lifecycle Status Update Rule Data: Applies_To_Header_Status or Applies_To_Line_Status  Choose one option in Lifecycle Status Update Rule Data: Applies_To_Header_Status or Applies_To_Line_Status 
Enter the required information for Change_To_New_Status_Reference  Enter the required information for Change_To_New_Status_Reference 
Based On Award Tasks is active. Lifecycle Status Update Rule Award Task Criteria Data is invalid.  Based On Award Tasks is active. Lifecycle Status Update Rule Award Task Criteria Data is invalid. 
Enter the required information for Evaluation Order.  Enter the required information for Evaluation Order. 
Based On Dates is active. Award task data is invalid.  Based On Dates is active. Award task data is invalid. 
Applies To Header Status is active, Relative To Award Line Life is invalid.  Applies To Header Status is active, Relative To Award Line Life is invalid. 
top
 

Award_Lifecycle_StatusObject

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

Award_Lifecycle_StatusObjectID

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

Lifecycle_Status_Update_Rule_Award_Task_Criteria_Data

part of: Lifecycle_Status_Update_Rule_Data
Award Task Criteria Data for a single Lifecycle Status Update Rule Award Task Criteria
 
Parameter name Type/Value Cardinality Description Validations
Update_Rule_Award_Task_Criteria_Reference  Lifecycle_Status_Update_Rule_Award_Task_CriteriaObject  [0..1]  The Award Lifecycle Status Update Rule for which data is returned.   
Update_Rule_Award_Task_Criteria_ID  string  [0..1]  Award Lifecycle Status Update Rule ID. This is the Award Lifecycle Status Update Rule Unique Identifier.   
Award_Task_Type_Reference  Award_Task_TypeObject  [1..1]  Award Task Type   
Award_Task_Status_Reference  Award_Task_StatusObject  [1..*]  Award Task Statuses   
top
 

Lifecycle_Status_Update_Rule_Award_Task_CriteriaObject

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

Lifecycle_Status_Update_Rule_Award_Task_CriteriaObjectID

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

Award_Task_TypeObject

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

Award_Task_TypeObjectID

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

Award_Task_StatusObject

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

Award_Task_StatusObjectID

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

Lifecycle_Status_Update_RuleReferenceEnumeration

part of: Lifecycle_Status_Update_RuleObjectID
Base Type
string
top
 

Award_Lifecycle_StatusReferenceEnumeration

part of: Award_Lifecycle_StatusObjectID
Base Type
string
top
 

Lifecycle_Status_Update_Rule_Award_Task_CriteriaReferenceEnumeration

part of: Lifecycle_Status_Update_Rule_Award_Task_CriteriaObjectID
Base Type
string
top
 

Award_Task_TypeReferenceEnumeration

part of: Award_Task_TypeObjectID
Base Type
string
top
 

Award_Task_StatusReferenceEnumeration

part of: Award_Task_StatusObjectID
Base Type
string
top