Service Directory > v31.2 > Resource_Management > Get_Resource_Pools
 

Operation: Get_Resource_Pools

This web service task retrieves Resource Pools.


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

Root element for the request to get Resource Pools.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Resource_Pool_Request_References  [0..1]  Element containing request references for a Resource Pool.   
Request_Criteria [Choice]   Resource_Pool_Request_Criteria  [0..1]  Resource Pool Request Criteria element.   
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  Resource_Pool_Response_Group  [0..1]  Resource Pool Response Group Element.   
top
 

Response Element: Get_Resource_Pools_Response

Root element for the Response on the Get Resource Pools operation. Contains the instances.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Resource_Pool_Request_References  [0..1]  Element containing request references for a Resource Pool.   
Request_Criteria  Resource_Pool_Request_Criteria  [0..1]  Resource Pool Request Criteria element.   
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  Resource_Pool_Response_Group  [0..1]  Resource Pool Response Group Element.   
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  Resource_Pool_Response_Data  [0..1]  Resource Pool Data from Web Service.   
top
 

Resource_Pool_Request_References

part of: Get_Resource_Pools_Request, Get_Resource_Pools_Response
Element containing request references for a Resource Pool.
 
Parameter name Type/Value Cardinality Description Validations
Resource_Pool_Reference  Resource_PoolObject  [1..*]  References for the Resource Pools.   
top
 

Resource_PoolObject

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

Resource_PoolObjectID

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

Resource_Pool_Request_Criteria

part of: Get_Resource_Pools_Request, Get_Resource_Pools_Response
Resource Pool Request Criteria element.
 
Parameter name Type/Value Cardinality Description Validations
Resource_Pool_Name  string  [0..1]  Resource Pool Name as Request Criteria for Get Resource Pool web service task.   
top
 

Response_Filter

part of: Get_Resource_Pools_Request, Get_Resource_Pools_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
 

Resource_Pool_Response_Group

part of: Get_Resource_Pools_Request, Get_Resource_Pools_Response
Resource Pool Response Group Element.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean flag to include Reference in response.   
top
 

Response_Results

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

Resource_Pool_Response_Data

part of: Get_Resource_Pools_Response
Resource Pool Data from Web Service.
 
Parameter name Type/Value Cardinality Description Validations
Resource_Pool  Resource_Pool  [0..*]  Resource Pool Element.   
top
 

Resource_Pool

part of: Resource_Pool_Response_Data
Resource Pool Element.
 
Parameter name Type/Value Cardinality Description Validations
Resource_Pool_Reference  Resource_PoolObject  [0..1]  Resource Pool Reference.   
Resource_Pool_Data  Resource_Pool_Data  [0..*]  Resource Pool Data Element used in Resource Pool Web Service Task.   
top
 

Resource_Pool_Data

part of: Resource_Pool
Resource Pool Data Element used in Resource Pool Web Service Task.
 
Parameter name Type/Value Cardinality Description Validations
Resource_Pool_ID  string  [0..1]  Resource Pool ID.   
Resource_Pool_Name  string  [1..1]  Resource Pool Name is Required.   
Include_Resource_Pool_ID_in_Name  boolean  [0..1]  Boolean value indicating if the Resource Pool ID will be included in the display of Resource Pool Name.   
Inactive  boolean  [0..1]  Indicates the resource pool is inactive. A resource pool may also be inactivated.   
Description  string  [0..1]  Resource Pool Description.   
Inactivated_By_Reference  Resource_Pool_HierarchyObject  [0..*]  Resource Pool Hierarchies that this current Resource Pool is inactivated by.   
Resource_Pool_Hierarchy_Reference  Resource_Pool_HierarchyObject  [0..*]  Resource Pool Hierarchy that this Resource Pool belongs to.   
Workers_Reference  WorkerObject  [0..*]  Workers included in this Resource Pool.   
top
 

Resource_Pool_HierarchyObject

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

Resource_Pool_HierarchyObjectID

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

WorkerObject

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

WorkerObjectID

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

Resource_PoolReferenceEnumeration

part of: Resource_PoolObjectID
Base Type
string
top
 

Resource_Pool_HierarchyReferenceEnumeration

part of: Resource_Pool_HierarchyObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top