Service Directory > v32.1 > Compensation > Get_Period_Activity_Tasks
 

Operation: Get_Period_Activity_Tasks

This operation allows the retrieval of period activity tasks. You must have access to the "Set Up: Work Activity for Pay" domain to access this operation.


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

Request element to get period activity task information. If no criteria are specified in either the period activity task request references or period activity task request criteria elements, all active instances will be returned.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Period_Activity_Task_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Period_Activity_Task_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Period_Activity_Task_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Period_Activity_Tasks_Response

Response element containing instances of period activity tasks and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Period_Activity_Task_Request_References  [0..1]  Utilize the period activity task to retrieve specific instance(s) of period activity task and its associated data.   
Request_Criteria  Period_Activity_Task_Request_Criteria  [0..1]  Utilize the period activity task to retrieve specific instance(s) of period activity task and its associated data.   
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  Period_Activity_Task_Response_Group  [0..1]  Provides the filters for the web service operation.   
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  Period_Activity_Task_Response_Data  [0..1]  Contains period activity task information based on Request References or Request Criteria.   
top
 

Period_Activity_Task_Request_References

part of: Get_Period_Activity_Tasks_Request, Get_Period_Activity_Tasks_Response
Utilize the period activity task to retrieve specific instance(s) of period activity task and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Period_Activity_Task_Reference  Period_Activity_TaskObject  [1..*]  Period Work Task Reference   
top
 

Period_Activity_TaskObject

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

Period_Activity_TaskObjectID

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

Period_Activity_Task_Request_Criteria

part of: Get_Period_Activity_Tasks_Request, Get_Period_Activity_Tasks_Response
Utilize the period activity task to retrieve specific instance(s) of period activity task and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Include_Inactive  boolean  [0..1]  Include Inactive indicates the response will also include inactive period work tasks.   
top
 

Response_Filter

part of: Get_Period_Activity_Tasks_Request, Get_Period_Activity_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
 

Period_Activity_Task_Response_Group

part of: Get_Period_Activity_Tasks_Request, Get_Period_Activity_Tasks_Response
Provides the filters for the web service operation.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Period_Activity_Task_Response_Data

part of: Get_Period_Activity_Tasks_Response
Contains period activity task information based on Request References or Request Criteria.
 
Parameter name Type/Value Cardinality Description Validations
Period_Activity_Task  Period_Activity_Task  [0..*]  Period Activity Task   
top
 

Period_Activity_Task

part of: Period_Activity_Task_Response_Data
Contains a period activity task and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Period_Activity_Task_Reference  Period_Activity_TaskObject  [0..1]  Period Activity Task Reference   
Period_Activity_Task_Data  Period_Activity_Task_Data  [0..*]  Period Activity Task Data   
top
 

Period_Activity_Task_Data

part of: Period_Activity_Task
Contains Period Activity Task data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID for the period activity task. This is the index for the period activity task and will be autopopulated if left blank.   
Period_Activity_Task_Code  string  [1..1]  The Period Activity Task Code. 
Validation Description
The Period Activity Task Code is currently in use by another Period Activity Task.   
 
Period_Activity_Task_Name  string  [1..1]  The Period Activity Task Name.   
Period_Activity_Task_Description  string  [0..1]  The description of a Period Activity Task   
Period_Activity_Unit_Reference  Period_Activity_UnitObject  [0..1]  The Period Activity Unit associated with this Period Activity Task.   
Academic_Period_Reference  Academic_PeriodObject  [0..1]  The Academic Period associated with this Period Activity Task.   
Default_Unit_Quantity  decimal (16, 6) >0   [0..1]  The Default Unit Quantity used when assigning tasks. 
Validation Description
The Default Unit Quantity cannot be 0 when Allow Unit Quantity Override is false.   
 
Allow_Unit_Quantity_Override  boolean  [0..1]  A boolean value that indicates whether the Default Unit Quantity can be overridden or not on assignment.   
Inactive  boolean  [0..1]  Inactive status indicator for this Period Activity Task.   
top
 

Period_Activity_UnitObject

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

Period_Activity_UnitObjectID

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

Academic_PeriodObject

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

Academic_PeriodObjectID

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

Period_Activity_TaskReferenceEnumeration

part of: Period_Activity_TaskObjectID
Base Type
string
top
 

Period_Activity_UnitReferenceEnumeration

part of: Period_Activity_UnitObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top