Service Directory > v31.2 > Financial_Management > Get_Spend_Category_Hierarchies
 

Operation: Get_Spend_Category_Hierarchies

This service operation will get Spend Category Hierarchies for the specified criteria. The request criteria can be for a single Spend Category Hierarchy based on Reference, Spend Category Hierarchy Name, or all Hierarchies can be retrieved if no Reference is specified.


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

Contains request reference, criteria, filter and response group for getting Spend Category Hierarchy data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Spend_Category_Hierarchy_Request_References  [0..1]  Get Spend Category Hierarchies Request References   
Request_Criteria [Choice]   Spend_Category_Hierarchy_Request_Criteria  [0..1]  Get Spend Category Hierarchies Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Spend Category Hierarchies Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Spend_Category_Hierarchy_Response_Group  [0..1]  Get Spend Category Hierarchies Response Group   
top
 

Response Element: Get_Spend_Category_Hierarchies_Response

Element containing Spend Category Hierarchy response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Spend_Category_Hierarchy_Request_References  [0..1]  Get Spend Category Hierarchies Request References   
Request_Criteria  Spend_Category_Hierarchy_Request_Criteria  [0..1]  Get Spend Category Hierarchies Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Spend Category Hierarchies Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Spend_Category_Hierarchy_Response_Group  [0..1]  Get Spend Category Hierarchies Response Group   
Response_Results  Response_Results  [0..1]  Get Spend Category Hierarchies Response Results   
Response_Data  Spend_Category_Hierarchy_Response_Data  [0..1]  Get Spend Category Hierarchies Response Data   
top
 

Spend_Category_Hierarchy_Request_References

part of: Get_Spend_Category_Hierarchies_Request, Get_Spend_Category_Hierarchies_Response
Element containing reference instances for a Spend Category Hierarchy
 
Parameter name Type/Value Cardinality Description Validations
Spend_Category_Hierarchy_Reference  Spend_Category_HierarchyObject  [1..*]  Reference to an existing Spend Category Hierarchy.   
top
 

Spend_Category_HierarchyObject

part of: Spend_Category_Hierarchy_Data, Spend_Category_Hierarchy_Request_References, Spend_Category_Hierarchy
 
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_Request_Criteria

part of: Get_Spend_Category_Hierarchies_Request, Get_Spend_Category_Hierarchies_Response
Element containing Spend Category Hierarchy request criteria
 
Parameter name Type/Value Cardinality Description Validations
Spend_Category_Hierarchy_Name  string  [0..1]  Spend Category Hierarchy Name   
Exclude_Hierarchy_Dependencies  boolean  [0..1]  Exclude Hierarchy Dependencies   
top
 

Response_Filter

part of: Get_Spend_Category_Hierarchies_Request, Get_Spend_Category_Hierarchies_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Spend_Category_Hierarchy_Response_Group

part of: Get_Spend_Category_Hierarchies_Request, Get_Spend_Category_Hierarchies_Response
Element containing Spend Category Hierarchies response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Spend_Category_Hierarchies_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Spend_Category_Hierarchy_Response_Data

part of: Get_Spend_Category_Hierarchies_Response
Wrapper Element that includes Spend Category Hierarchy Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Spend_Category_Hierarchy  Spend_Category_Hierarchy  [0..*]  Spend Category Hierarchy   
top
 

Spend_Category_Hierarchy

part of: Spend_Category_Hierarchy_Response_Data
Wrapper Element that includes Spend Category Hierarchy Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
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.   
 
top
 

Spend_Category_Hierarchy_Data

part of: Spend_Category_Hierarchy
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