Service Directory > v31.2 > Staffing > Get_Role_Assignments_For_Role_Assigners
 

Operation: Get_Role_Assignments_For_Role_Assigners

This web service returns role assignments (the combination of assignable role and role assignees) for the role assigner(s) specified in the request. You must specify at least 1 role assigner. Only explicitly assigned role assignees are returned. Default and inherited role assignees are not returned. Optional request parameters include Assignable Roles, Effective Date and Time Zone. When no value is specified for 'Assignable Roles', role assignments for all roles are returned. When at least one value is specified for 'Assignable Roles', role assignments for only the specified roles are returned. When no effective date is specified, role assignments as of the current date are returned. When an effective date is specified, role assignments in effect as of the specified effective date are returned. You cannot specify a time zone in the request unless the 'Role Assignment Time Zone Option' field in Tenant Setup - System has a value. When no time zone is specified, role assignments as of the effective date and Pacific Standard time (PST) are returned. When a time zone is specified, role assignments as of the effective date and the specified time zone are returned. The count in the response filter applies to the number of role assigners returned. For the supervisory organization assignable role linked to the Workday Role of 'Manager', only the single assignment manager role assignee is returned when this role has multiple role assignees.


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

Gets Role Assignments for Role Assigners Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Role_Assigner_Request_References  [1..1]  Role Assigner References for Get Role Assignments Request.   
Request_Criteria  Role_Assignments_Request_Criteria  [0..1]  Request Criteria for Role Assignments of Role Assigner References.   
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  Role_Assigner_Response_Group  [0..1]  Parameters for Response Group for Role Assigner References.   
top
 

Response Element: Get_Role_Assignments_For_Role_Assigners_Response

Get Role Assignments Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Role_Assigner_Request_References  [0..1]  Role Assigner References for Get Role Assignments Request.   
Request_Criteria  Role_Assignments_Request_Criteria  [0..1]  Request Criteria for Role Assignments of Role Assigner References.   
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  Role_Assigner_Response_Group  [0..1]  Parameters for Response Group for Role Assigner References.   
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  Role_Assigner_Response_Data  [0..1]  Role Assignments for Role Assigner References.   
top
 

Role_Assigner_Request_References

part of: Get_Role_Assignments_For_Role_Assigners_Response, Get_Role_Assignments_For_Role_Assigners_Request
Role Assigner References.
 
Parameter name Type/Value Cardinality Description Validations
Role_Assigner_Reference  Role_AssignerObject  [1..*]  Role Assigner References.   
top
 

Role_AssignerObject

part of: Role_Assigner_Request_References, Role_Assigner, Role_Assigner_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_AssignerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Role_AssignerObjectID

part of: Role_AssignerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Division_Configuration_ID, Academic_Unit_Hierarchy_ID, Academic_Unit_ID, Account_Certification_Definition_ID, AgencyID, Award_Reference_ID, Business_Unit_Hierarchy_ID, Business_Unit_ID, Candidate_Pool_ID, Committee_ID, Company_Reference_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Customer_ID, Customer_Reference_ID, Customer_Tenant_ID, Data_Set_ID, Document_Number, Dynamic_Talent_Pool_ID, Extended_Enterprise_Affiliation_ID, Federal_School_Code_Rule_Set_ID, Fund_Hierarchy_ID, Fund_ID, Gift_Hierarchy_ID, Gift_Reference_ID, Grant_Hierarchy_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Job_Posting_Site_ID, Job_Requisition_ID, Opportunity_ID, Organization_Reference_ID, Program_Hierarchy_ID, Program_ID, Project_Hierarchy_ID, Project_ID, Purchase_Order_Reference_ID, Recruiting_Agency_ID, Recruiting_Self_Service_Schedule_ID, Region_Reference_ID, Requisition_Number, Resource_Category_Hierarchy_ID, Resource_Pool_Hierarchy_ID, Resource_Pool_ID, Service_Center_ID, Spend_Category_ID, Student_Application_Pool_ID, Student_Cohort_ID, Student_Course_Section_ID, Succession_Pool_ID, Supplier_Contract_ID, Supplier_ID, Supplier_Reference_ID, Talent_Pool_ID, Team_ID, Union_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_Assignments_Request_Criteria

part of: Get_Role_Assignments_For_Role_Assigners_Response, Get_Role_Assignments_For_Role_Assigners_Request
Request Criteria for Role Assignments of Role Assigner References.
 
Parameter name Type/Value Cardinality Description Validations
Assignable_Role_Reference  Assignable_RoleObject  [0..*]  Designate Assignable Role References to filter the set of returned Role Assignments.   
top
 

Assignable_RoleObject

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

Assignable_RoleObjectID

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

Role_Assigner_Response_Group

part of: Get_Role_Assignments_For_Role_Assigners_Response, Get_Role_Assignments_For_Role_Assigners_Request
Parameters for Response Group for Role Assigner References.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Allows you specify whether references should be included in the response.   
Effective_Timezone_Reference  Time_ZoneObject  [0..1]  Allows you to override the effective timezone used when application data is deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to the current timezone 
Validation Description
Time zone must be left blank because you do not have security access to override the default time zone.  Time zone must be left blank if the Processing/Delegating System Account is not part of domain: Manage: Role Assignment Time Zone, 2229$2994. 
Time zone must be left blank because no time zone option has been selected in tenant setup.  Time zone must be left blank if the time zone option has not been selected in tenant setup. 
 
top
 

Time_ZoneObject

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

Time_ZoneObjectID

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

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

Role_Assigner_Response_Data

part of: Get_Role_Assignments_For_Role_Assigners_Response
Role Assignments for Role Assigner References.
 
Parameter name Type/Value Cardinality Description Validations
Role_Assigner  Role_Assigner  [0..*]  Role Assignments for Role Assigner Reference.   
top
 

Role_Assigner

part of: Role_Assigner_Response_Data
Role Assigner Reference and Data.
 
Parameter name Type/Value Cardinality Description Validations
Role_Assigner_Reference  Role_AssignerObject  [0..1]  Role Assigner Reference.   
Role_Assigner_Data  Role_Assigner_Data  [0..1]  Role Assigner Reference and Data.   
top
 

Role_Assigner_Data

part of: Role_Assigner
Role Assigner Reference and Data.
 
Parameter name Type/Value Cardinality Description Validations
@Effective_Date  date  [1..1]  Effective Moment with Pacific Timezone.   
Effective_Timezone_Reference  Time_ZoneObject  [0..1]  Overridden Effective Timezone. 
Validation Description
Time zone must be left blank because you do not have security access to override the default time zone.  Time zone must be left blank if Processing/Delegating System User is not part of Manage: Role Assignment Time Zone+TG, 2229$2994. 
Time zone must be left blank because no time zone option has been selected in tenant setup.  Time zone must be left blank if no time zone option has been selected in tenant setup 
 
Role_Assigner_Reference  Role_AssignerObject  [1..1]  Role Assigner Reference.   
Role_Assignment_Data  Role_Assignment_Data  [0..*]  Role Assignment Data 
Validation Description
The same role cannot be specified in more than one role assignment.  The same role cannot be specified in more than one role assignment. 
At least one role is restricted to singular assignment, but has more than one member assigned.  At least one role is restricted to singular assignment, but has more than one member assigned. 
Role '[role]' is restricted to single assignment, and so may not be updated with an additional assignment.  Validation will throw if a role selected is restricted to single assignment, and so may not be updated with an additional assignment. 
Role assignees must be current members of the security groups specified for the role in the Role Assignees Restricted to column in Maintain Assignable Roles.  Role assignees must be current members of the security groups specified for the role in the Role Assignees Restricted to column in Maintain Assignable Roles. 
 
top
 

Role_Assignment_Data

part of: Role_Assigner_Data
Role Assignment Data
 
Parameter name Type/Value Cardinality Description Validations
Delete [Choice]   boolean  [0..1]  Flag indicating that the role assignment should be deleted.   
Update [Choice]   boolean  [0..1]  Flag indicating that the role assignment should be updated.   
Organization_Role_Reference  Assignable_RoleObject  [1..1]  Reference to the Assignable Role 
Validation Description
Role is not supported for this type of organization.  Role is not supported for this type of organization. 
 
Role_Assignee_Reference  RoleeObject  [0..*]  Reference to the Role Assignee. 
Validation Description
The Role Assignee Reference is ignored if Delete is true.  The Role Assignee Reference is ignored if Delete is true. 
The Role Assignee Reference is required unless Delete is true.  The Role Assignee Reference is required unless Delete is true. 
This role can only be filled by a single role assignee.  This role can only be filled by a single role assignee. 
 
Validation Description
The same role cannot be specified in more than one role assignment.  The same role cannot be specified in more than one role assignment. 
At least one role is restricted to singular assignment, but has more than one member assigned.  At least one role is restricted to singular assignment, but has more than one member assigned. 
Role '[role]' is restricted to single assignment, and so may not be updated with an additional assignment.  Validation will throw if a role selected is restricted to single assignment, and so may not be updated with an additional assignment. 
Role assignees must be current members of the security groups specified for the role in the Role Assignees Restricted to column in Maintain Assignable Roles.  Role assignees must be current members of the security groups specified for the role in the Role Assignees Restricted to column in Maintain Assignable Roles. 
top
 

RoleeObject

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

RoleeObjectID

part of: RoleeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Affiliate_ID, Academic_Person_ID, Business_Entity_Contact_ID, Extended_Enterprise_Learner_ID, External_Committee_Member_ID, Position_ID, Recruiting_Agency_User_ID, Service_Center_Representative_ID, Student_ID, Student_Recruiter_ID, 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
 

Role_AssignerReferenceEnumeration

part of: Role_AssignerObjectID
Base Type
string
top
 

Assignable_RoleReferenceEnumeration

part of: Assignable_RoleObjectID
Base Type
string
top
 

Time_ZoneReferenceEnumeration

part of: Time_ZoneObjectID
Base Type
string
top
 

RoleeReferenceEnumeration

part of: RoleeObjectID
Base Type
string
top