Service Directory > v31.2 > Human_Resources > Get_Assign_User-Based_Security_Group
 

Operation: Get_Assign_User-Based_Security_Group

Retrieves User-Based Security Group and Workday Accounts assigned to the security group.


@ - 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_Assign_User-Based_Security_Group_Request

Get Request wrapper for retrieving User-Based Security Groups and Workday Accounts that are members of the group
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   User-Based_Security_Group_Request_References  [0..*]  Request References element for retrieving specific User-Based Security Groups and their member Workday Accounts   
Request_Criteria [Choice]   User-Based_Security_Group_Request_Criteria  [0..*]  User-Based Security Group Request by Name   
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  User-Based_Security_Group_Reference_Only_Response_Group  [0..*]  Include User-Based Security Group Reference in the Response   
top
 

Response Element: Get_Assign_User-Based_Security_Group_Response

Response Element for the User-Based Security Group and its member Workday Accounts
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  User-Based_Security_Group_Request_References  [0..1]  Request References element for retrieving specific User-Based Security Groups and their member Workday Accounts   
Request_Criteria  User-Based_Security_Group_Request_Criteria  [0..1]  User-Based Security Group Request by Name   
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  User-Based_Security_Group_Reference_Only_Response_Group  [0..1]  Include User-Based Security Group Reference in the Response   
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  Assign_User-Based_Security_Group_Response_Data  [0..1]  Element to return User-Based Security Group and its member Workday Accounts   
top
 

User-Based_Security_Group_Request_References

part of: Get_Assign_User-Based_Security_Group_Request, Get_Assign_User-Based_Security_Group_Response
Request References element for retrieving specific User-Based Security Groups and their member Workday Accounts
 
Parameter name Type/Value Cardinality Description Validations
User-Based_Security_Group_Reference  User-Based_Security_GroupObject  [0..*]  Requested User-Based Security Group References   
top
 

User-Based_Security_GroupObject

part of: User-Based_Security_Group_Request_References, Assign_User-Based_Security_Group_Data, Assign_User-Based_Security_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  User-Based_Security_GroupObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

User-Based_Security_GroupObjectID

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

User-Based_Security_Group_Request_Criteria

part of: Get_Assign_User-Based_Security_Group_Request, Get_Assign_User-Based_Security_Group_Response
User-Based Security Group Request by Name
 
Parameter name Type/Value Cardinality Description Validations
Name  string  [0..1]  Name of User-Based Security Group   
top
 

Response_Filter

part of: Get_Assign_User-Based_Security_Group_Request, Get_Assign_User-Based_Security_Group_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
 

User-Based_Security_Group_Reference_Only_Response_Group

part of: Get_Assign_User-Based_Security_Group_Request, Get_Assign_User-Based_Security_Group_Response
Include User-Based Security Group Reference in the Response
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Indicator to Include User-Based Security Group Reference   
top
 

Response_Results

part of: Get_Assign_User-Based_Security_Group_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
 

Assign_User-Based_Security_Group_Response_Data

part of: Get_Assign_User-Based_Security_Group_Response
Element to return User-Based Security Group and its member Workday Accounts
 
Parameter name Type/Value Cardinality Description Validations
Assign_User-Based_Security_Group  Assign_User-Based_Security_Group  [0..*]  Element to include Optional User-Based Security Group Reference and the Element with User-Based Security Group and its member Workday Accounts   
top
 

Assign_User-Based_Security_Group

part of: Assign_User-Based_Security_Group_Response_Data
Element to include Optional User-Based Security Group Reference and the Element with User-Based Security Group and its member Workday Accounts
 
Parameter name Type/Value Cardinality Description Validations
User-Based_Security_Group_Reference  User-Based_Security_GroupObject  [0..1]  User-Based Security Group Reference Id and Workday ID   
Assign_User-Based_Security_Group_Data  Assign_User-Based_Security_Group_Data  [0..1]  Data element containing User-Based Security Group and Workday Accounts   
top
 

Assign_User-Based_Security_Group_Data

part of: Assign_User-Based_Security_Group
Data element containing User-Based Security Group and Workday Accounts
 
Parameter name Type/Value Cardinality Description Validations
User-Based_Security_Group_Reference  User-Based_Security_GroupObject  [1..1]  User-Based Security Group Reference Id and Workday ID   
Workday_Account_Reference  System_UserObject  [0..*]  Workday Accounts that are members of the User-Based Security Group   
top
 

System_UserObject

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

System_UserObjectID

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

User-Based_Security_GroupReferenceEnumeration

part of: User-Based_Security_GroupObjectID
Base Type
string
top
 

System_UserReferenceEnumeration

part of: System_UserObjectID
Base Type
string
top