Service Directory > v32.1 > Revenue_Management > Get_Award_Tasks
 

Operation: Get_Award_Tasks

Retrieves Award Tasks for the specified request criteria or references. An empty request returns all Award Tasks.


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

Element containing request references, criteria, filter and response group for getting Award Task data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Award_Task_Request_References  [0..1]  Element containing references to Award Tasks.   
Request_Criteria [Choice]   Award_Task_Request_Criteria  [0..1]  Element containing request criteria for finding Award Tasks.   
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  Award_Task_Response_Group  [0..1]  Element containing Award Task response grouping options.   
top
 

Response Element: Get_Award_Tasks_Response

Element containing Award Tasks response elements.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Award_Task_Request_References  [0..1]  Element containing references to Award Tasks.   
Request_Criteria  Award_Task_Request_Criteria  [0..1]  Element containing request criteria for finding Award Tasks.   
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  Award_Task_Response_Group  [0..1]  Element containing Award Task response grouping options.   
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_Response_Data  [0..1]  Element containing Award Task instances and data.   
top
 

Award_Task_Request_References

part of: Get_Award_Tasks_Request, Get_Award_Tasks_Response
Element containing references to Award Tasks.
 
Parameter name Type/Value Cardinality Description Validations
Award_Task_Reference  Award_TaskObject  [1..*]  References to Award Tasks.   
top
 

Award_TaskObject

part of: Award_Task_Request_References, Award_Task, Award_Task_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_TaskObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Award_TaskObjectID

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

part of: Get_Award_Tasks_Request, Get_Award_Tasks_Response
Element containing request criteria for finding Award Tasks.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  OrganizationObject  [0..*]  Companies on the header of the Award for the Award Task, or Company Hierarchies containing the header Company.   
Award_Reference  Award_ContractObject  [0..*]  Awards for the Award Tasks.   
Task_Type_Reference  Award_Task_TypeObject  [0..*]  Task Types for the Award Tasks.   
Task_Type_Group_Reference  Award_Task_Type_GroupObject  [0..*]  Task Type Groups containing the Task Type for Award Tasks.   
Role_Reference  Security_GroupObject  [0..*]  Roles assigned to the Award Tasks.   
Status_Reference  Award_Task_StatusObject  [0..*]  Statuses assigned to the Award Tasks.   
Due_Date_On_or_After  date  [0..1]  Lower bound for the due date on the Award Tasks (inclusive).   
Due_Date_On_or_Before  date  [0..1]  Upper bound for the due date on the Award Tasks (inclusive).   
top
 

OrganizationObject

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

Award_ContractObject

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

Award_ContractObjectID

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

part of: Award_Task_Request_Criteria, Award_Task_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_Type_GroupObject

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

Award_Task_Type_GroupObjectID

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

Security_GroupObject

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

Security_GroupObjectID

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

Response_Filter

part of: Get_Award_Tasks_Request, Get_Award_Tasks_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
 

Award_Task_Response_Group

part of: Get_Award_Tasks_Request, Get_Award_Tasks_Response
Element containing Award Task response grouping options.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include a reference to the Award Task.   
top
 

Response_Results

part of: Get_Award_Tasks_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_Response_Data

part of: Get_Award_Tasks_Response
Element containing Award Task instances and data.
 
Parameter name Type/Value Cardinality Description Validations
Award_Task  Award_Task  [0..*]  Element containing all data for one Award Task.   
top
 

Award_Task

part of: Award_Task_Response_Data
Element containing all data for one Award Task.
 
Parameter name Type/Value Cardinality Description Validations
Award_Task_Reference  Award_TaskObject  [0..1]  Reference to the Award Task.   
Award_Task_Data  Award_Task_Data  [0..1]  Element containing enterable data for one Award Task.   
top
 

Award_Task_Data

part of: Award_Task
Element containing enterable data for one Award Task.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Flag indicating that the referenced Award Task should be deleted from the Award.   
Award_Task_Reference  Award_TaskObject  [0..1]  Reference to the Award Task. Required when Delete is set.   
ID  string  [0..1]  The Award Task ID for referencing Award Tasks.   
Award_Task_Type_Reference  Award_Task_TypeObject  [0..1]  Reference to the Award Task Type, which defines the type of work to be completed. 
Validation Description
Reference to an Award Task Type is required.  Reference to an Award Task Type is required. 
 
Award_Line_Reference  Award_Contract_LineObject  [0..1]  Reference to an Award Line on the Award Contract for the Award Task. Defaults to the primary Award Line. 
Validation Description
The referenced Award Contract Line must be a line on the referenced Award Contract, or blank to use the primary line.  The referenced Award Contract Line must be a line on the referenced Award Contract, or blank to use the primary line. 
Award Line Reference is required.  Award Line Reference is required. 
The referenced Award Line must be on an Award.  The referenced Award Line must be on an Award. 
 
Start_Date  date  [0..1]  The start date of the date range for which the Award Task applies.   
End_Date  date  [0..1]  The end date for the date range for which the Award Task applies.   
Due_Date  date  [0..1]  The date on which the Award Task is due.   
Completed_Date  date  [0..1]  The date on which the Award Task was completed.   
Status_Reference  Award_Task_StatusObject  [0..1]  Reference to the current status of the Award Task. Defaults to the Award Task Status marked as default.   
Comments  RichText  [0..1]  Comments on the Award Task.   
Attachment_Data  Financials_Attachment_Data  [0..*]  Encapsulating element containing all Business Document Attachment data. 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
Role_Assignment_Data  Award_Task_Role_Assignment_Data  [0..*]  Contains the Role Assignment information for an Award Task. 
Validation Description
Role usage should be specified for Award Line and Award Header Organizations.   
The referenced Role must be assignable on Company, Grant, a worktag on the referenced Award Contract Line, or any hierarchies that roll up these organizations.  The referenced Role must be assignable on Company, Grant, a worktag on the referenced Award Contract Line, or any hierarchies that roll up these organizations. 
 
top
 

Award_Contract_LineObject

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

Award_Contract_LineObjectID

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

Financials_Attachment_Data

part of: Award_Task_Data
Encapsulating element containing all Business Document Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
top
 

Award_Task_Role_Assignment_Data

part of: Award_Task_Data
Contains the Role Assignment information for an Award Task.
 
Parameter name Type/Value Cardinality Description Validations
Award_Task_Role_Assignment_Reference  Award_Task_Role_AssignmentObject  [0..1]  Roles assigned to the Award Tasks.   
Awad_Task_Role_Assignment_ID  string  [0..1]  The Award Task Role Assignment ID. This is the Award Task Role Assignment unique identifier.   
Role_Group_Reference  Award_Task_Role_GroupObject  [0..1]  Reference to the Role Group responsible for completing the Award Task. This can be either Grant, Award, Award Line Organization or Award Header Organization.   
Role_Usage_Reference  Role_UsageObject  [0..1]  Reference to Organization responsible for completing the Award Task. This must be specified if Award Line Organization or Award Header Organization is selected as Role Group Reference.   
Role_Reference  Security_GroupObject  [1..1]  Reference to the Role responsible for completing the Award Task. Must be a Role that is assignable on Company, Grant, a worktag on the referenced Award Line, or any hierarchies that roll up these organizations.   
Validation Description
Role usage should be specified for Award Line and Award Header Organizations.   
The referenced Role must be assignable on Company, Grant, a worktag on the referenced Award Contract Line, or any hierarchies that roll up these organizations.  The referenced Role must be assignable on Company, Grant, a worktag on the referenced Award Contract Line, or any hierarchies that roll up these organizations. 
top
 

Award_Task_Role_AssignmentObject

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

Award_Task_Role_AssignmentObjectID

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

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

Award_Task_Role_GroupObjectID

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

Role_UsageObject

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

Role_UsageObjectID

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

part of: Award_TaskObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Award_ContractReferenceEnumeration

part of: Award_ContractObjectID
Base Type
string
top
 

Award_Task_TypeReferenceEnumeration

part of: Award_Task_TypeObjectID
Base Type
string
top
 

Award_Task_Type_GroupReferenceEnumeration

part of: Award_Task_Type_GroupObjectID
Base Type
string
top
 

Security_GroupReferenceEnumeration

part of: Security_GroupObjectID
Base Type
string
top
 

Award_Task_StatusReferenceEnumeration

part of: Award_Task_StatusObjectID
Base Type
string
top
 

Award_Contract_LineReferenceEnumeration

part of: Award_Contract_LineObjectID
Base Type
string
top
 

RichText

part of: Award_Task_Data
Base Type
string
top
 

Award_Task_Role_AssignmentReferenceEnumeration

part of: Award_Task_Role_AssignmentObjectID
Base Type
string
top
 

Award_Task_Role_GroupReferenceEnumeration

part of: Award_Task_Role_GroupObjectID
Base Type
string
top
 

Role_UsageReferenceEnumeration

part of: Role_UsageObjectID
Base Type
string
top