Service Directory > v31.2 > Financial_Management > Put_Program_Hierarchy
 

Operation: Put_Program_Hierarchy

This service operation will add or update Program Hierarchies. This operation will allow the addition of an existing Program Hierarchy as the superior and the addition of existing Programs as subordinates.


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

Element containing Program Hierarchy reference for update and all Program Hierarchy data items
 
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.   
Program_Hierarchy_Reference  Program_HierarchyObject  [0..1]  Reference to an existing Program Hierarchy   
Program_Hierarchy_Data  Program_Hierarchy_Data  [0..*]  Program Hierarchy Data 
Validation Description
Programs cannot be used more than once in a single hierarchy. Please change the Parent or modify the Programs to Include. (Programs: [program])   
Parent Program Hierarchy is not valid because it is a descendent in the existing hierarchy. Please remove the parent hierarchy or select a new one.   
This Program Hierarchy cannot be inactivated because it has active subordinates.   
An inactive Program Hierarchy cannot be assigned as the superior of a Program Hierarchy.   
A hierarchy structure is defined on this organization. Please delete the hierarchy structure before assigning any superior organization.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the Organization Subtype for this hierarchy.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the parent hierarchy.   
A top-level hierarchy structure exists and is enforced for this parent hierarchy. Please unenforce the top-level hierarchy structure first before selecting this as a parent hierarchy.   
 
Validation Description
Program Hierarchy exists where Web Service is set to Add Only.   
Program Hierarchy Name matches a Program Hierarchy Name in an existing Program Hierarchy. Change Program Hierarchy name.   
top
 

Response Element: Put_Program_Hierarchy_Response

Element containing Put Program Hierarchy Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Program_Hierarchy_Reference  Program_HierarchyObject  [0..1]  Reference to an existing Program Hierarchy   
top
 

Program_HierarchyObject

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

Program_HierarchyObjectID

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

Program_Hierarchy_Data

part of: Put_Program_Hierarchy_Request
Element containing all Program Hierarchy data
 
Parameter name Type/Value Cardinality Description Validations
Program_Hierarchy_ID  string  [0..1]  Program Hierarchy Reference ID. This is the Program Hierarchy unique identifier.   
Program_Hierarchy_Name  string  [1..1]  Program Hierarchy Name.   
Include_Program_Hierarchy_ID_In_Name  boolean  [0..1]  Boolean flag which when set to true will include the Program Hierarchy ID in the Program Hierarchy Name.   
Program_Hierarchy_is_Inactive  boolean  [0..1]  Boolean Flag which when set to true Inactivates the Program Hierarchy.   
Organization_Subtype_Reference  Organization_SubtypeObject  [0..1]  Reference to an existing Organization Subtype valid for Program Hierarchies. 
Validation Description
Organization Subtype is not valid for Organization Type  Organization Subtype needs to be valid for Organization Type. 
 
Parent_Program_Hierarchy_Reference  Program_HierarchyObject  [0..1]  Reference to an existing Program Hierarchy to add as the superior.   
Contains_Program_Reference  ProgramObject  [0..*]  Reference to existing Programs to add as the subordinates.   
Validation Description
Programs cannot be used more than once in a single hierarchy. Please change the Parent or modify the Programs to Include. (Programs: [program])   
Parent Program Hierarchy is not valid because it is a descendent in the existing hierarchy. Please remove the parent hierarchy or select a new one.   
This Program Hierarchy cannot be inactivated because it has active subordinates.   
An inactive Program Hierarchy cannot be assigned as the superior of a Program Hierarchy.   
A hierarchy structure is defined on this organization. Please delete the hierarchy structure before assigning any superior organization.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the Organization Subtype for this hierarchy.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the parent hierarchy.   
A top-level hierarchy structure exists and is enforced for this parent hierarchy. Please unenforce the top-level hierarchy structure first before selecting this as a parent hierarchy.   
top
 

Organization_SubtypeObject

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

Organization_SubtypeObjectID

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

ProgramObject

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

ProgramObjectID

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

Program_HierarchyReferenceEnumeration

part of: Program_HierarchyObjectID
Base Type
string
top
 

Organization_SubtypeReferenceEnumeration

part of: Organization_SubtypeObjectID
Base Type
string
top
 

ProgramReferenceEnumeration

part of: ProgramObjectID
Base Type
string
top