Service Directory > v32.1 > Revenue_Management > Get_Award_Task_Statuses
 

Operation: Get_Award_Task_Statuses

Returns Award Task Statuses. The request criteria can be for a single transaction based on the Reference ID. If a Reference ID is not specified, the operation retrieves all transactions.


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

Request Element for Get Award Task Status
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Award_Task_Status_Request_References  [0..1]  Element containing Award Task Status reference for update and all Status data items.   
Request_Criteria [Choice]   Award_Task_Status_Request_Criteria  [0..1]  Request Element for Get Award Task Status   
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. 
 
top
 

Response Element: Get_Award_Task_Statuses_Response

Element containing Award task Status Response elements including received criteria, references, data based
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Award_Task_Status_Request_References  [0..1]  Element containing Award Task Status reference for update and all Status data items.   
Request_Criteria  Award_Task_Status_Request_Criteria  [0..1]  Request Element for Get Award Task Status   
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_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  Award_Task_Status_Response_Data  [0..1]  Element containing Award task Status Response elements including received criteria, references, data based   
top
 

Award_Task_Status_Request_References

part of: Get_Award_Task_Statuses_Request, Get_Award_Task_Statuses_Response
Element containing Award Task Status reference for update and all Status data items.
 
Parameter name Type/Value Cardinality Description Validations
Award_Task_Status_Reference  Award_Task_StatusObject  [1..*]  Request Reference for Award Task Status   
top
 

Award_Task_StatusObject

part of: Award_Task_Status_Request_References, Award_Task_Status
 
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
 

Award_Task_Status_Request_Criteria

part of: Get_Award_Task_Statuses_Request, Get_Award_Task_Statuses_Response
Request Element for Get Award Task Status
 
Parameter name Type/Value Cardinality Description Validations
Status_Name  string  [0..1]  Award Task Status Name   
top
 

Response_Filter

part of: Get_Award_Task_Statuses_Request, Get_Award_Task_Statuses_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
 

Response_Results

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

Award_Task_Status_Response_Data

part of: Get_Award_Task_Statuses_Response
Element containing Award task Status Response elements including received criteria, references, data based
 
Parameter name Type/Value Cardinality Description Validations
Award_Task_Status  Award_Task_Status  [0..*]  Element containing Award Task Status Data   
top
 

Award_Task_Status

part of: Award_Task_Status_Response_Data
Wrapper Element that includes Award Task Status Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Award_Task_Status_Reference  Award_Task_StatusObject  [0..1]  Wrapper Element that includes Award Task Status Instance and Data   
Award_Task_Status_Data  Award_Task_Status_Data  [0..*]  Element containing Award Task Status Data   
top
 

Award_Task_Status_Data

part of: Award_Task_Status
Element containing Award Task Status Data
 
Parameter name Type/Value Cardinality Description Validations
Order  string (6)   [0..1]  This is the Order of Award Task Status in the list.   
ID  string  [0..1]  Award Task Status ID   
Status_Name  string  [0..1]  Award Task Status Name   
Default  boolean  [0..1]  Flag Indicating if this Status is the default one.   
Indicates_Task_Is_Done  boolean  [0..1]  If this Status indicates Task is completed.   
Award_Task_Status_for_BP_Complete  boolean  [0..1]  This boolean indicates that the business process has been completed   
Inactive  boolean  [0..1]  Boolean to indicate that Award Task Status is inactive   
top
 

Award_Task_StatusReferenceEnumeration

part of: Award_Task_StatusObjectID
Base Type
string
top