Service Directory > v32.1 > Financial_Management > Get_Spend_Restrictions
 

Operation: Get_Spend_Restrictions

This web service operation returns the specified Spend Restriction and its associated data.


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

Request element for Spend Restriction get request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Spend_Restriction_Request_References  [0..1]  Element containing Spend Restriction Request References.   
Request_Criteria [Choice]   Spend_Restriction_Request_Criteria  [0..1]  Spend Restriction Request Criteria.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Spend_Restriction_Response_Group  [0..1]  Spend Restriction Response Group.   
top
 

Response Element: Get_Spend_Restrictions_Response

Response element for Spend Restriction get request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Spend_Restriction_Request_References  [0..1]  Spend Restriction Request References.   
Request_Criteria  Spend_Restriction_Request_Criteria  [0..1]  Spend Restriction Request Criteria.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Spend_Restriction_Response_Group  [0..1]  Spend Restriction Response Group.   
Response_Results  Response_Results  [0..1]  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.   
Response_Data  Spend_Restriction_Response_Data  [0..1]  Element containing Spend Restriction response data for get request.   
top
 

Spend_Restriction_Request_References

part of: Get_Spend_Restrictions_Request, Get_Spend_Restrictions_Response
Element containing Spend Restriction Request References.
 
Parameter name Type/Value Cardinality Description Validations
Spend_Restriction_Reference  Spend_RestrictionObject  [1..*]  Spend Restriction Request References.   
top
 

Spend_RestrictionObject

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

Spend_RestrictionObjectID

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

part of: Get_Spend_Restrictions_Request, Get_Spend_Restrictions_Response
Spend Restriction Request Criteria.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Spend_Restrictions_Request, Get_Spend_Restrictions_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_Restriction_Response_Group

part of: Get_Spend_Restrictions_Request, Get_Spend_Restrictions_Response
Spend Restriction Response Group.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean flag to include Reference in response.   
top
 

Response_Results

part of: Get_Spend_Restrictions_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_Restriction_Response_Data

part of: Get_Spend_Restrictions_Response
Element containing Spend Restriction response data for get request.
 
Parameter name Type/Value Cardinality Description Validations
Spend_Restriction  Spend_Restriction  [0..*]  Element containing a Spend Restriction and its data.   
top
 

Spend_Restriction

part of: Spend_Restriction_Response_Data
Element containing a Spend Restriction and its data.
 
Parameter name Type/Value Cardinality Description Validations
Spend_Restriction_Reference  Spend_RestrictionObject  [0..1]  Spend Restriction reference.   
Spend_Restriction_Data  Spend_Restriction_Data  [0..1]  Element containing Spend Restriction data. 
Validation Description
You must enter an object class set when the restriction type is Object Class.   
Object class set can only be entered if the restriction type is Object Class.   
You must select 1 or more restrictions.   
Object class can only be entered if the restriction type is Object Class.   
Spend category hierarchy, spend category, and pay component group can only be entered if the restriction type is Spend Category and Pay Component Group.   
 
top
 

Spend_Restriction_Data

part of: Spend_Restriction
Element containing Spend Restriction data.
 
Parameter name Type/Value Cardinality Description Validations
Spend_Restriction_Name  string  [1..1]  Spend Restriction name.   
Spend_Restriction_Reference_ID  string  [0..1]  Reference to an existing Spend Restriction for update only purposes.   
Inactive  boolean  [0..1]  Boolean flag to indicate Spend Restriction is inactive.   
Allowable_Costs [Choice]   boolean  [1..1]  Boolean flag to indicate Spend Restriction contains allowable costs.   
Unallowable_Costs [Choice]   boolean  [1..1]  Boolean flag to indicate Spend Restriction contains unallowable costs.   
Spend_Restriction_Type_Reference  Spend_Restriction_TypeObject  [1..1]  Spend Restriction Type reference.   
Object_Class_Set_Reference  Object_Class_SetObject  [0..1]  Object Class Set reference.   
Spend_Category_Hierarchies_Reference  Spend_Category_HierarchyObject  [0..*]  Spend Category Hierarchies reference.   
Spend_Categories_Reference  Spend_CategoryObject  [0..*]  Spend Categories reference.   
Pay_Component_Groups_Reference  Pay_Component_Group__All_Object  [0..*]  Earning Codes reference.   
Object_Classes_Reference  Object_ClassObject  [0..*]  Object Classes reference.   
Validation Description
You must enter an object class set when the restriction type is Object Class.   
Object class set can only be entered if the restriction type is Object Class.   
You must select 1 or more restrictions.   
Object class can only be entered if the restriction type is Object Class.   
Spend category hierarchy, spend category, and pay component group can only be entered if the restriction type is Spend Category and Pay Component Group.   
top
 

Spend_Restriction_TypeObject

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

Spend_Restriction_TypeObjectID

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

Object_Class_SetObject

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

Object_Class_SetObjectID

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

part of: Spend_Restriction_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_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_CategoryObject

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

Pay_Component_Group__All_Object

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

Pay_Component_Group__All_ObjectID

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

Object_ClassObject

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

Object_ClassObjectID

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

part of: Spend_RestrictionObjectID
Base Type
string
top
 

Spend_Restriction_TypeReferenceEnumeration

part of: Spend_Restriction_TypeObjectID
Base Type
string
top
 

Object_Class_SetReferenceEnumeration

part of: Object_Class_SetObjectID
Base Type
string
top
 

Spend_Category_HierarchyReferenceEnumeration

part of: Spend_Category_HierarchyObjectID
Base Type
string
top
 

Spend_CategoryReferenceEnumeration

part of: Spend_CategoryObjectID
Base Type
string
top
 

Pay_Component_Group__All_ReferenceEnumeration

part of: Pay_Component_Group__All_ObjectID
Base Type
string
top
 

Object_ClassReferenceEnumeration

part of: Object_ClassObjectID
Base Type
string
top