Service Directory > v31.2 > Staffing > Assign_Organization_Roles
 

Operation: Assign_Organization_Roles DEPRECATED

DEPRECATED: This web service operation is deprecated. Please use the Assign_Roles web service operation instead. If you do use this web service operation, note that all new and existing assignees must be specified as role assignees. Any existing role assignees that are not included in the set of role assignees will be removed. Later-dated role assignments will not be updated with new or removed 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: Assign_Organization_Roles_Request

This operation will assign organization roles to one ore more workers using the Assign Organization Roles business process event.
 
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_Organization_Roles_Data  Assign_Organization_Roles_Event_Data  [1..1]  Wrapper Element for the Assign Organization Roles web service. 
Validation Description
Role Assignee is required.   
 
top
 

Response Element: Assign_Organization_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]  The Event ID for the Assign Organization Roles business process event.   
top
 

Business_Process_Parameters

part of: Assign_Organization_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_Organization_Roles_Event_Data

part of: Assign_Organization_Roles_Request
Wrapper for Organization Role Assignment Data. Includes Role Assignments.
 
Parameter name Type/Value Cardinality Description Validations
Role_Assignee_Reference  RoleeObject  [0..1]  The Position that is the subject of this event, used for business process definition selection and routing. Regardless of value specified, role assignee will be the Position_Reference specified in 'Change_Job_Data' subelement   
Effective_Date  date  [0..1]  Date the Role Assignments should take effect. Defaults to the current date if not provided.   
Role_Assignment  Role_Assignment  [0..*]  Encapsulating Element for all Organization Role Assignment data. 
Validation Description
Combination of Assignable Role/Role Assigner cannot be included more than once.   
 
Validation Description
Role Assignee is required.   
top
 

RoleeObject

part of: Assign_Organization_Roles_Event_Data, Organization_Role_Assignment_Data, Organization_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_Assignment

part of: Assign_Organization_Roles_Event_Data
Encapsulating Element for all Organization Role Assignment data.
 
Parameter name Type/Value Cardinality Description Validations
Role_Assignment_Reference  Unique_IdentifierObject  [0..1]  Workday ID for Role Assignment. 
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.   
 
Role_Assignment_Data  Organization_Role_Assignment_Data  [1..1]  Wrapper element for a Organization Role Assignment 
Validation Description
Role Assigner is required.   
Organization Role not valid for this Role Assigner.   
Role Assigner should not be specified for Create Job Requisition.   
Role Assigner must be the Job Requisition for Edit Job Requisition.   
Organization Role not valid for this Role Assigner.   
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.   
 
Validation Description
Combination of Assignable Role/Role Assigner cannot be included more than once.   
top
 

Unique_IdentifierObject

part of: Role_Assignment, Assign_Organization_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
 

Organization_Role_Assignment_Data

part of: Role_Assignment
Wrapper element for a Organization Role Assignment
 
Parameter name Type/Value Cardinality Description Validations
Role_Assigner_Reference  Role_AssignerObject  [0..1]  The Role Assigner (e.g., Organization or Project) this role assignment is for.   
Organization_Role_Reference  Assignable_RoleObject  [1..1]  The Organization Role being assigned.   
Role_Assignee_Reference  RoleeObject  [0..*]  The positions to assign to this role assignment.   
Single_Assignment_Manager_Reference  RoleeObject  [0..1]  Position explicitly assigned as 'Single Assignment Manager' for a Supervisory org. Must be a position assigned to the Manager role and in 'Maintain Assignable Roles' for the Manager role, the 'Restricted to Single Assignment' option must be turned off. If this field is left blank, the position specified for 'Single Assignment Manager' will be removed. 
Validation Description
Position selected for 'Single Assignment Manager' is not allowed as they are not assigned to the 'Manager' role   
'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.   
 
Validation Description
Role Assigner is required.   
Organization Role not valid for this Role Assigner.   
Role Assigner should not be specified for Create Job Requisition.   
Role Assigner must be the Job Requisition for Edit Job Requisition.   
Organization Role not valid for this Role Assigner.   
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: Organization_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: Organization_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
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

RoleeReferenceEnumeration

part of: RoleeObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Role_AssignerReferenceEnumeration

part of: Role_AssignerObjectID
Base Type
string
top
 

Assignable_RoleReferenceEnumeration

part of: Assignable_RoleObjectID
Base Type
string
top