Service Directory > v31.2 > Financial_Management > Put_Grant_Hierarchy
 

Operation: Put_Grant_Hierarchy

Adds or updates Grant Hierarchies. In addition, this operation allows adding an existing Grant Hierarchy as the superior and adding existing Grants 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_Grant_Hierarchy_Request

Element containing Grant Hierarchy reference for update and all Grant 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.   
Grant_Hierarchy_Reference  Grant_HierarchyObject  [0..1]  Reference to an existing Grant Hierarchy   
Grant_Hierarchy_Data  Grant_Hierarchy_Data  [0..1]  Grant Hierarchy Data 
Validation Description
An inactive Grant Hierarchy cannot be assigned as the superior of a Grant Hierarchy.   
Superior Grant Hierarchy is not valid because it is a descendent in the existing hierarchy. Please remove the superior hierarchy or select a new one.   
This Grant Hierarchy cannot be inactivated because it has active subordinates.   
A hierarchy structure is defined on this organization. Please delete the hierarchy structure before assigning any superior organization.   
Organization Subtype does not match the Hierarchy Structure defined on top level organization.  Organization Subtype needs to be valid for the Hierarchy Structure on top level organization. 
Organization Subtype is required for the Hierarchy Structure on top level organization.   
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
Grant Hierarchy Name matches a Grant Hierarchy Name in an existing Grant Hierarchy. Change Grant Hierarchy Name.   
The Web Service is set to Add Only but a Grant Hierarchy exists for the id provided.   
top
 

Response Element: Put_Grant_Hierarchy_Response

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

Grant_HierarchyObject

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

Grant_HierarchyObjectID

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

Grant_Hierarchy_Data

part of: Put_Grant_Hierarchy_Request
Element containing all Grant Hierarchy data. Allows for grant hierarchy name and relevant information to be added
 
Parameter name Type/Value Cardinality Description Validations
Grant_Hierarchy_ID  string  [0..1]  Grant Hierarchy Reference ID. This is the Grant Hierarchy unique identifier.   
Grant_Hierarchy_Name  string  [1..1]  Grant Hierarchy Name   
Include_Grant_Hierarchy_ID_in_Name  boolean  [0..1]  Boolean flag which when set to true will include the Grant Hierarchy ID in the Grant Hierarchy Name.   
Grant_Hierarchy_is_Inactive  boolean  [0..1]  Boolean Flag which when set to true inactivates the Grant Hierarchy   
Organization_Subtype_Reference  Organization_SubtypeObject  [0..1]  Reference to an existing Organization Subtype valid for Grant Hierarchies. 
Validation Description
Organization Subtype is not valid for Organization Type  Organization Subtype needs to be valid for Organization Type. 
 
Superior_Grant_Hierarchy_Reference  Grant_HierarchyObject  [0..1]  Reference to an existing Grant Hierarchy to add as the superior.   
Included_Grant_Reference  GrantObject  [0..*]  Reference to existing Grants to add as the subordinates.   
Validation Description
An inactive Grant Hierarchy cannot be assigned as the superior of a Grant Hierarchy.   
Superior Grant Hierarchy is not valid because it is a descendent in the existing hierarchy. Please remove the superior hierarchy or select a new one.   
This Grant Hierarchy cannot be inactivated because it has active subordinates.   
A hierarchy structure is defined on this organization. Please delete the hierarchy structure before assigning any superior organization.   
Organization Subtype does not match the Hierarchy Structure defined on top level organization.  Organization Subtype needs to be valid for the Hierarchy Structure on top level organization. 
Organization Subtype is required for the Hierarchy Structure on top level organization.   
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: Grant_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
 

GrantObject

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

GrantObjectID

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

Grant_HierarchyReferenceEnumeration

part of: Grant_HierarchyObjectID
Base Type
string
top
 

Organization_SubtypeReferenceEnumeration

part of: Organization_SubtypeObjectID
Base Type
string
top
 

GrantReferenceEnumeration

part of: GrantObjectID
Base Type
string
top