Service Directory > v32.1 > Human_Resources > Inactivate_Organization
 

Operation: Inactivate_Organization

This operation will inactivate an Organization. If you do not choose to 'Keep in Hierarchy' then the organization being inactivated will be moved out of the hierarchy. Default behavior for inactive subordinates / included organizations is that they remain as is. Default behavior for active subordinates is that they are moved to the superior unless you specify another organization to move them to. If the organization has subordinates or included content that you do not want to move to its superior or another organization, you can use the DISSOLVE_ORGANIZATION_STRUCTURE web service to disconnect it from the hierarchy and remove its subordinates and included organizations. In this web service, the Integration_ID_Reference must be the external system id.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Element(s)

 

Request Element: Organization_Inactivate

Utilize the following elements to Inactivate an existing Organization within the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Validate_Only  boolean  [0..1]  Use this boolean to validate the request without processing it.   
Organization_Reference_Data  Organization_Reference  [1..1]  Reference element representing a unique instance of Organization. 
Validation Description
Organization Reference Integration ID does not exist!  A valid instance of Organization must exist for the given Integration ID Reference. 
Organization Reference references an Inactive Organization.  A valid instance of Organization also infers that the Organization is in an Active status. 
 
Organization_Inactivate_Data  Organization_Inactivate_Data  [1..1]  This element contains the effective date that the organization is inactivated.   
Keep_in_Hierarchy  boolean  [0..1]  Use this boolean to keep the organization in hierarchy.   
Organization_for_Subordinates_Reference  OrganizationObject  [0..1]  Use this element to specify the new superior organization for current subordinates. When blank, default behavior is that active organizations are moved to superior.   
Organization_for_Included_Organizations_Reference  OrganizationObject  [0..1]  Use this element to specify the new superior organization for current included organizations. When blank, default behavior is that active organizations are moved to superior.   
Remove_All_Role_Assignments  boolean  [0..1]  Use this boolean to remove all direct role assignments as of the inactivation effective date and later. If empty or FALSE, direct role assignments will remain as is. Inherited role assignments will remain as is if you choose to keep the organization in the hierarchy.   
Validation Description
Organization has events in progress, so it cannot be inactivated.  An organization cannot be inactivated while it still has events in progress. 
Organization has conflicting events (in progress or future events) so it cannot be inactivated.  An organization cannot be inactivated while it has conflicting events. Those events can be events in progress or future events. 
Organization is inactive as of entered effective date so it cannot be inactivated.  An organization must be active in order to be inactivated. 
Organization still has retiree members or positions or restrictions, so it cannot be inactivated.  An organization cannot be inactivated if it has retiree members or positions or restrictions. 
Value for 'Organization for Subordinates Reference' and 'Organization for Included Organizations Reference' must be the reference id of an active organization that does not have a future inactivation and is for same organization type.  Value for 'Organization for Subordinates Reference' and 'Organization for Included Organizations Reference' must be the reference id of an active organization that does not have a future inactivation and is for same organization type. 
When 'Keep in Hierarchy' is false and there are active included organizations, you must specify a value for 'Organization for Included Organizations Reference'.  When 'Keep in Hierarchy' is false and there are active included organizations, you must specify a value for 'Organization for Included Organizations Reference'. 
When 'Keep in Hierarchy' is false and there are active subordinates you must specify a value for 'Organization for Subordinates Reference'.  When 'Keep in Hierarchy' is false and there are active subordinates you must specify a value for 'Organization for Subordinates Reference'. 
Organization being inactivated has no superior to move active included organizations to so you must specify a value for 'Organization for Included Organizations Reference'.  Organization being inactivated has no superior to move active included organizations to so you must specify a value for 'Organization for Included Organizations Reference'. 
Organization being inactivated has no superior to move active organizations to so you must specify a value for 'Organization for Subordinates Reference'.  Organization being inactivated has no superior to move active organizations to so you must specify a value for 'Organization for Subordinates Reference'. 
The superior that active subordinates are to move to cannot be inactive or have a future inactivation.  The superior that active subordinates are to move to cannot be inactive or have a future inactivation. 
The superior that active included organizations are to move to cannot be inactive or have a future inactivation.  The superior that active included organizations are to move to cannot be inactive or have a future inactivation. 
'Organization for Subordinates Reference' cannot be one of the active subordinates.  'Organization for Subordinates Reference' cannot be one of the active subordinates. 
top
 

Organization_Reference

part of: Organization_Inactivate
Reference element representing a unique instance of Organization.
 
Parameter name Type/Value Cardinality Description Validations
Integration_ID_Reference  External_Integration_ID_Reference_Data  [1..1]  Integration ID reference is used as a unique identifier for integratable objects in the Workday system.   
Validation Description
Organization Reference Integration ID does not exist!  A valid instance of Organization must exist for the given Integration ID Reference. 
Organization Reference references an Inactive Organization.  A valid instance of Organization also infers that the Organization is in an Active status. 
top
 

External_Integration_ID_Reference_Data

part of: Organization_Reference
Integration ID reference is used as a unique identifier for integratable objects in the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display name inside the Workday system.   
ID  ID  [1..1]  External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.   
top
 

ID

part of: External_Integration_ID_Reference_Data
External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@System_ID  string  [1..1]  Integration system identifier, part of a two part key (including the text value of the ID element) that uniquely identify integratable object. 
Validation Description
Integration System ID does not exist.  A valid instance of Integration ID must exist for the given System ID. 
 
top
 

Organization_Inactivate_Data

part of: Organization_Inactivate
This element contains the effective date that the organization is inactivated.
 
Parameter name Type/Value Cardinality Description Validations
@Effective_Date  date  [1..1]  The effective date of the organization inactivation.   
top
 

OrganizationObject

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

OrganizationObjectID

part of: OrganizationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Organization_Reference_ID, Region_Reference_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
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top