Service Directory > v31.2 > Human_Resources > Get_Provisioning_Groups
 

Operation: Get_Provisioning_Groups

This web service operation will get provisioning groups. It will return the provisioning groups and their associated information excluding any provisioning group assignments. The request can be for a single transaction based on reference, or all transactions can be retrieved if no reference is specified.


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

Request element to retrieve provisioning group setup data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Provisioning_Group_Request_References  [0..*]  Utilize the Request References element to retrieve a specific instance(s) of provisioning groups.   
Response_Filter  Response_Filter  [0..*]  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  Provisioning_Group_Response_Group  [0..*]  The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request all sub-elements will be returned.   
top
 

Response Element: Provisioning_Groups_Response

Response element containing the requested instances of provisioning groups and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Provisioning_Group_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of provisioning groups.   
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  Provisioning_Group_Response_Group  [0..1]  The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request all sub-elements will be returned.   
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  Provisioning_Group_Response_Data  [0..1]  Contains each provisioning group based on the Request References or Request Criteria.   
top
 

Provisioning_Group_Request_References

part of: Get_Provisioning_Groups_Request, Provisioning_Groups_Response
Utilize the Request References element to retrieve a specific instance(s) of provisioning groups.
 
Parameter name Type/Value Cardinality Description Validations
Provisioning_Group_Request_Reference  Provisioning_GroupObject  [0..*]  A unique identifier to reference a provisioning group.   
top
 

Provisioning_GroupObject

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

Provisioning_GroupObjectID

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

Provisioning_Group_Response_Group

part of: Get_Provisioning_Groups_Request, Provisioning_Groups_Response
The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request all sub-elements will be returned.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Indicates if the Reference element for the provisioning group is included in the response.   
Include_Provisioning_Group_Data  boolean  [0..1]  Indicates if the Provisioning Group Data element is included in the response.   
top
 

Response_Results

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

Provisioning_Group_Response_Data

part of: Provisioning_Groups_Response
Contains each provisioning group based on the Request References or Request Criteria.
 
Parameter name Type/Value Cardinality Description Validations
Provisioning_Group  Provisioning_Group  [0..*]  Encapsulating element containing all provisioning group data.   
top
 

Provisioning_Group

part of: Provisioning_Group_Response_Data
Encapsulating element containing all provisioning group data.
 
Parameter name Type/Value Cardinality Description Validations
Provisioning_Group_Reference  Provisioning_GroupObject  [0..1]  A unique identifier used to reference a provisioning group.   
Provisioning_Group_Data  Provisioning_Group_Data  [0..1]  This element contains all setup data for a provisioning group.   
top
 

Provisioning_Group_Data

part of: Provisioning_Group
This element contains all setup data for a provisioning group.
 
Parameter name Type/Value Cardinality Description Validations
Name  string  [1..1]  Name of the provisioning group   
Description  string  [0..1]  Description of the provisioning group   
top
 

Provisioning_GroupReferenceEnumeration

part of: Provisioning_GroupObjectID
Base Type
string
top