Service Directory > v31.2 > Resource_Management > Put_Spend_Category_Hierarchy
 

Operation: Put_Spend_Category_Hierarchy

This service operation will add or update Spend Category Hierarchies. This operation will allow for the addition of an existing Spend Category Hierarchies as the superiors/subordinates and addition of existing Spend Categories 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_Spend_Category_Hierarchy_Request

Element containing Spend Category Hierarchy reference for update and all Spend Category 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.   
Spend_Category_Hierarchy_Reference  Spend_Category_HierarchyObject  [0..1]  Reference to an existing Spend Category Hierarchy.   
Spend_Category_Hierarchy_Data  Spend_Category_Hierarchy_Data  [0..1]  Spend Category Hierarchy Data 
Validation Description
A hierarchy structure is defined for this spend category hierarchy. Please delete the hierarchy structure before assigning a parent.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the Hierarchy Level 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.   
You can't select a parent spend category as itself, or any of its children. Select a different spend category hierarchy.   
The Spend Category included in this request already exists in the Current Spend Category Hierarchical tree.   
 
Validation Description
This spend category hierarchy is already a parent of the new superior spend category hierarchy selected. Such circular hierachical relationships are not permitted.   
Spend Category Hierarchy Name already exists. Specify a unique Spend Category Hierarchy Name.   
Spend Category Hierarchy ID already exists. Provide a unique Spend Category Hierarchy ID.   
top
 

Response Element: Put_Spend_Category_Hierarchy_Response

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

Spend_Category_HierarchyObject

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

Spend_Category_HierarchyObjectID

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

Spend_Category_Hierarchy_Data

part of: Put_Spend_Category_Hierarchy_Request
Element containing all Spend Category Hierarchy data
 
Parameter name Type/Value Cardinality Description Validations
Spend_Category_Hierarchy_ID  string  [0..1]  Spend Category Reference Hierarchy ID. This is the Spend Category Hierarchy unique identifier   
Spend_Category_Hierarchy_Names  string  [1..1]  Free form text field for a meaningful Spend Category Hierarchy Name   
Hierarchy_Level_Reference  Hierarchy_LevelObject  [0..1]  Reference to an existing Hierarchy Level valid for Spend Category Hierarchies. 
Validation Description
Hierarchy Level is not valid for Spend Category Hierarchy.  Hierarchy Level needs to be valid for Spend Category Hierarchy. 
 
Parent_Reference  Spend_Category_HierarchyObject  [0..1]  Reference to the parent Spend Category Hierarchy.   
Enable_for_External_Website  boolean  [0..1]  If true, the spend categories included in this spend category hierarchy will be exposed on the supplier registration external website. If false, they will not be exposed. 
Validation Description
As long as the parent hierarchy is enabled for this external website, this hierarchy must also be enabled.  As long as the parent hierarchy is enabled for this external website, this hierarchy must also be enabled. 
 
Included_Spend_Categories_Reference  Spend_CategoryObject  [0..*]  Reference to the Spend Categories that are included in this Spend Category Hierarchy.   
Commodity_Code  string  [0..1]  A code or ID used for classifications like NIGP or UNSPSC.   
Description  RichText  [0..1]  A description that is used in conjunction with the Commodity Code field.   
Inactive  boolean  [0..1]  True if the Spend Category Hierarchy is Inactive. False otherwise. 
Validation Description
Unable to inactivate this hierarchy because there are active child spend category hierarchies. Please move or inactivate them first.  Unable to inactivate this hierarchy because there are active child spend category hierarchies. Please move or inactivate them first. 
Unable to inactivate this hierarchy because there are active included spend categories. Please move or inactivate them first.  Unable to inactivate this hierarchy because there are active included spend categories. Please move or inactivate them first. 
 
Spend_Category_Hierarchy_Display_Option_Reference  Spend_Category_or_Hierarchy_Display_OptionObject  [0..1]  Determines how the Spend Category Hierarchy label is displayed.   
Validation Description
A hierarchy structure is defined for this spend category hierarchy. Please delete the hierarchy structure before assigning a parent.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the Hierarchy Level 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.   
You can't select a parent spend category as itself, or any of its children. Select a different spend category hierarchy.   
The Spend Category included in this request already exists in the Current Spend Category Hierarchical tree.   
top
 

Hierarchy_LevelObject

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

Hierarchy_LevelObjectID

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

Spend_CategoryObject

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

Spend_CategoryObjectID

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

Spend_Category_or_Hierarchy_Display_OptionObject

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

Spend_Category_or_Hierarchy_Display_OptionObjectID

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

Spend_Category_HierarchyReferenceEnumeration

part of: Spend_Category_HierarchyObjectID
Base Type
string
top
 

Hierarchy_LevelReferenceEnumeration

part of: Hierarchy_LevelObjectID
Base Type
string
top
 

Spend_CategoryReferenceEnumeration

part of: Spend_CategoryObjectID
Base Type
string
top
 

RichText

part of: Spend_Category_Hierarchy_Data
Base Type
string
top
 

Spend_Category_or_Hierarchy_Display_OptionReferenceEnumeration

part of: Spend_Category_or_Hierarchy_Display_OptionObjectID
Base Type
string
top