Service Directory > v31.2 > Resource_Management > Put_Resource_Pool_Hierarchy
 

Operation: Put_Resource_Pool_Hierarchy

Put Resource Pool Hierarchy.


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

Put Resource Pool Hierarchy Top Level Request Element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update. If an existing instance is found and this flag is set there will be an error.   
Resource_Pool_Hierarchy_Reference  Resource_Pool_HierarchyObject  [0..1]  Resource Pool Hierarchy Instance.   
Resource_Pool_Hierarchy_Data  Resource_Pool_Hierarchy_Data  [0..1]  Resource Pool Hierarchy Data Element used in Resource Pool Hierarchy Web Service Task. 
Validation Description
These resource pools aren’t valid for this hierarchy: [resourcepools]. They are already part of this parent hierarchy: [parentrespoolhier].   
These resource pools are already in the hierarchy : [resourcepools]. They are part of this parent hierarchy: [parentrespoolhier]   
 
Validation Description
Resource Pool Hierarchy Name already exists. Specify a unique Resource Pool Hierarchy Name.   
Resource Pool Hierarchy ID already exists. Provide a unique Resource Pool Hierarchy ID.   
Resource Pool Hierarchy Name is required. Please enter an unique name.   
This resource pool hierarchy is already a parent of the new superior resource pool hierarchy selected. Such circular hierarchical relationships are not permitted.   
Cannot edit a resource pool hierarchy that is inactivated by other hierarchies.   
Cannot set an inactive resource pool hierarchy as the parent hierarchy.   
Cannot create an inactive resource pool hierarchy.   
top
 

Response Element: Put_Resource_Pool_Hierarchy_Response

Put Resource Pool Hierarchy Response Element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Resource_Pool_Hierarchy_Reference  Resource_Pool_HierarchyObject  [0..1]  Resource Pool Hierarchy Instance in Response.   
top
 

Resource_Pool_HierarchyObject

part of: Put_Resource_Pool_Hierarchy_Request, Put_Resource_Pool_Hierarchy_Response, Resource_Pool_Hierarchy_Data, Resource_Pool_Hierarchy_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  Resource_Pool_HierarchyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Resource_Pool_HierarchyObjectID

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

Resource_Pool_Hierarchy_Data

part of: Put_Resource_Pool_Hierarchy_Request
Resource Pool Hierarchy Data Element used in Resource Pool Hierarchy Web Service Task.
 
Parameter name Type/Value Cardinality Description Validations
Resource_Pool_Hierarchy_ID  string  [0..1]  Resource Pool Hierarchy ID.   
Resource_Pool_Hierarchy_Name  string  [1..1]  Resource Pool Hierarchy Name is Required.   
Include_Resource_Pool_Hierarchy_ID_in_Name  boolean  [0..1]  Boolean value indicating if the Resource Pool Hierarchy ID will be included in the display of Resource Pool Hierarchy Name.   
Inactive  boolean  [0..1]  Indicates the resource pool hierarchy is inactive. A resource pool hierarchy may also be inactivated by a parent resource pool hierarchy as indicated by the 'Inactivated By Hierarchy Reference'. In which case, the current resource pool hierarchy is considered Inactive even though this Boolean returns False. Changes to an inactive hierarchy are ignored. Reactivating a resource pool hierarchy can only be done on the hierarchy if it was explicitly marked 'Inactive' or by reactivating the hierarchy that made the current hierarchy inactive.   
Description  string  [0..1]  Resource Pool Hierarchy Description.   
Inactivated_By_Reference  Resource_Pool_HierarchyObject  [0..*]  Resource Pool Hierarchies that this current Resource Pool Hierarchy is inactivated by.   
Parent_Reference  Resource_Pool_HierarchyObject  [0..1]  Parent Resource Pool Hierarchy for the Resource Pool Hierarchy created from Put Resource Pool Hierarchy Web Service Task.   
Included_Resource_Pools_Reference  Resource_PoolObject  [0..*]  Resource Pools rolled up under Resource Pool Hierarchy.   
Validation Description
These resource pools aren’t valid for this hierarchy: [resourcepools]. They are already part of this parent hierarchy: [parentrespoolhier].   
These resource pools are already in the hierarchy : [resourcepools]. They are part of this parent hierarchy: [parentrespoolhier]   
top
 

Resource_PoolObject

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

Resource_PoolObjectID

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

Resource_Pool_HierarchyReferenceEnumeration

part of: Resource_Pool_HierarchyObjectID
Base Type
string
top
 

Resource_PoolReferenceEnumeration

part of: Resource_PoolObjectID
Base Type
string
top