Service Directory > v31.2 > Staffing > Assign_Roles
 

Operation: Assign_Roles

Assigns roles to assignees and uses the Assign Roles business process. You may specify a worker or position. If you specify a worker as the event target or an assignee to add and the worker has multiple positions as of the role assignment effective date, the international assignment (IA) position will take precedence over the worker's primary position. Specifying a worker with multiple positions as an assignee to remove will remove all the positions for that worker for that role assignment.


@ - 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: Assign_Roles_Request

This operation will assign organization roles to one ore more workers or positions.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Assign_Roles_Event_Data  Assign_Roles_Event_Data  [1..1]  Wrapper Element for the Assign Roles web service   
top
 

Response Element: Assign_Roles_Response

Responds with the Event ID for the Assign Organization Roles business process event.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Assign_Roles_Event_Reference  Unique_IdentifierObject  [0..1]  Responds with the Event ID for the Assign Organization Roles business process event.   
top
 

Business_Process_Parameters

part of: Assign_Roles_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

Assign_Roles_Event_Data

part of: Assign_Roles_Request
Wrapper Element for the Assign Roles web service
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  Date the Role Assignments should take effect. Defaults to the current date if not provided.   
Effective_Timezone_Reference  Time_ZoneObject  [0..1]  Only users secured to Manage: Role Assignment Time Zone security domain can override the default time zone in Assign Role Web Services. If left blank and role assignment tenant setup option = 'Assignee Location', then time zone of Event Target Assignee's location will be used for all role assignments including assignees to add/remove that are in different time zones. If tenant setup option = 'Tenant Default', then tenant default time zone will be used. Leave this field blank if no role assignment time zone option has been selected in tenant setup. 
Validation Description
Time zone must be left blank because no time zone option has been selected in tenant setup.   
Time zone must be left blank because you do not have security access to override the default time zone.   
 
Event_Target_Assignee_Reference  Rolee_SelectorObject  [1..1]  The Position/Worker that is the subject of this event, used for business process definition selection and routing. If a worker is specified and they have multiple jobs as of specified effective date, business process definition selection and routing will be based on the international assignment (IA) position with earliest start date, otherwise it will be based on worker's primary position. Specify a position if this behavior for worker is not desired.   
Remove_All_Role_Assignments_for_Event_Target_Assignee  boolean  [0..1]  When TRUE, ALL role assignments for assignee as of the specified effective date onward will be removed including role assignments with a later-dated effective date. 
Validation Description
If "Remove All Role Assignments for Event Target Assignee" is true, all data fields except "Effective Date" and "Event Target Assignee" must be empty.   
 
Assign_Roles_Role_Assignment_Data  Assign_Roles_Role_Assignment_Data  [0..*]  Encapsulating Element for all Organization Role Assignment data. 
Validation Description
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
 

Time_ZoneObject

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

Rolee_SelectorObject

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

Rolee_SelectorObjectID

part of: Rolee_SelectorObject
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, Contingent_Worker_ID, Employee_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, Tenant_Security_Group_ID, 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
 

Assign_Roles_Role_Assignment_Data

part of: Assign_Roles_Event_Data
Encapsulating Element for all Organization Role Assignment data.
 
Parameter name Type/Value Cardinality Description Validations
Role_Assigner_Reference  Role_AssignerObject  [1..1]  The Role Assigner (e.g., Organization or Project) this role assignment is for.   
Assignable_Role_Reference  Assignable_RoleObject  [1..1]  The Organization Role being assigned. 
Validation Description
Assignable Role is not valid.   
Assignable Role is not valid.   
Assignable Role is not valid.   
 
Remove_Existing_Assignees_for_Assignable_Role_on_Role_Assigner  boolean  [0..1]  When TRUE, all existing assignees as of specified effective date and onward for the specified assignable role and role assigner are removed. 
Validation Description
When 'Remove All Existing Assignees' is true, 'Update Later Dated Assignments' must be true as well.   
When 'Remove All Existing Assignees' is true, 'Assignees to Remove' must be empty.   
 
Update_Later_Dated_Assignments  boolean  [0..1]  When true, updates later dated assignments.   
Assignees_to_Add_Reference  Rolee_SelectorObject  [0..*]  If a worker is specified, position to which role is to be assigned as of specified effective date is determined when event is submitted, not when it is completed. If worker has multiple jobs as of specified effective date, role will be assigned to international assignment (IA) position with earliest start date, otherwise to worker's primary position. Specify a position if this behavior for worker is not desired. 
Validation Description
"Role Assignees to Add" cannot contain existing assignee as of effective date specified.   
Role is restricted to single assignment, therefore only one assignee can be specified.   
 
Assignees_to_Remove_Reference  Rolee_SelectorObject  [0..*]  If a worker is specified and they have multiple jobs as of specified effective date, role is removed from all the worker's positions. 
Validation Description
"Role Assignees to Remove" must be an existing assignee as of effective date specified.   
"Update Later-dated Assignments" must be set true when assignees are removed.   
'Role Assignees to Remove' and 'Role Assignees to Add' cannot have same assignees.   
 
Supervisory_Organization_Single_Assignment_Manager_Reference  Rolee_SelectorObject  [0..1]  Position explicitly assigned as 'Single Assignment Manager' for a Supervisory org. 
Validation Description
'Single Assignment Manager' can only have a value for the assignable role linked to 'Manager', the 'Restricted to Single Assignment' option must be turned off for this role, and the organization type must be supervisory.   
'Single Assignment Manager' can only have a value for the assignable role linked to 'Manager', the 'Restricted to Single Assignment' option must be turned off for this role, and the organization type must be supervisory.   
'Single Assignment Manager' can only have a value for the assignable role linked to 'Manager', the 'Restricted to Single Assignment' option must be turned off for this role, and the organization type must be supervisory.   
'Single Assignment Manager' cannot be among 'Role Assignees to Remove'.   
Single Assignment Manager Assignee must be an existing assignee when it is not among 'Assignees to Add' or when 'Assignees to Add' is empty.   
 
Remove_Supervisory_Organization_Single_Assignment_Manager  boolean  [0..1]  Removes existing Single Assignment Manager for a Supervisory org. 
Validation Description
When 'Remove Existing Single Assignment Manager' is true, 'Single Assignment Manager' must be empty and 'Update Later Dated Assignments' must be true..   
When 'Remove Existing Single Assignment Manager' is true, 'Single Assignment Manager' must be empty and 'Update Later Dated Assignments' must be true..   
'Remove Supervisory Organization Single Assignment Manager' can only have a value when the assignable role is linked to a 'Manager', 'Restricted to Single Assignment' option is turned off for this role, and the organization type is supervisory.   
'Remove Supervisory Organization Single Assignment Manager' can only have a value when the assignable role is linked to a 'Manager', 'Restricted to Single Assignment' option is turned off for this role, and the organization type is supervisory.   
'Remove Supervisory Organization Single Assignment Manager' can only have a value when the assignable role is linked to a 'Manager', 'Restricted to Single Assignment' option is turned off for this role, and the organization type is supervisory.   
 
Validation Description
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_AssignerObject

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

Assignable_RoleObject

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

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

Time_ZoneReferenceEnumeration

part of: Time_ZoneObjectID
Base Type
string
top
 

Rolee_SelectorReferenceEnumeration

part of: Rolee_SelectorObjectID
Base Type
string
top
 

Role_AssignerReferenceEnumeration

part of: Role_AssignerObjectID
Base Type
string
top
 

Assignable_RoleReferenceEnumeration

part of: Assignable_RoleObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top