Service Directory > v31.2 > Financial_Management > Get_Object_Class_Sets
 

Operation: Get_Object_Class_Sets

This service operation will get Object Class Sets for the specified criteria. This service will return the Object Class Set and the Object Classes included in the Object Class Set. The request criteria can be for a single transaction based on Reference, or all transactions 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_Object_Class_Sets_Request

Contains request reference, criteria, filter and response group for getting Object Class Set data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Object_Class_Set_Request_References  [0..*]  Get Object Class Sets Request References   
Request_Criteria [Choice]   Object_Class_Set_Request_Criteria  [0..*]  Get Object Class Sets Request Criteria   
Response_Filter  Response_Filter  [0..*]  Get Object Class Sets Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Object_Class_Sets_Response

Element containing Object Class Set response elements including received criteria, references, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Object_Class_Set_Request_References  [0..1]  Element containing reference instances for a Object Class Set   
Request_Criteria  Object_Class_Set_Request_Criteria  [0..1]  Element containing Object Class Set 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_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  Object_Class_Set_Response_Data  [0..1]  Get Object Class Sets Response Data   
top
 

Object_Class_Set_Request_References

part of: Get_Object_Class_Sets_Request, Get_Object_Class_Sets_Response
Element containing reference instances for a Object Class Set
 
Parameter name Type/Value Cardinality Description Validations
Object_Class_Set_Reference  Object_Class_SetObject  [1..*]  Reference to an existing Object Class Set   
top
 

Object_Class_SetObject

part of: Object_Class_Set_Request_References, Object_Class_Set
 
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
 

Object_Class_Set_Request_Criteria

part of: Get_Object_Class_Sets_Request, Get_Object_Class_Sets_Response
Element containing Object Class Set request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Object_Class_Sets_Request, Get_Object_Class_Sets_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
 

Response_Results

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

Object_Class_Set_Response_Data

part of: Get_Object_Class_Sets_Response
Wrapper Element that includes Object Class Set Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Object_Class_Set  Object_Class_Set  [0..*]  Object Class Set Data   
top
 

Object_Class_Set

part of: Object_Class_Set_Response_Data
Wrapper Element that includes Object Class Set Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Object_Class_Set_Reference  Object_Class_SetObject  [0..1]  Reference to an existing Object Class Set   
Object_Class_Set_Data  Object_Class_Set_Data  [0..*]  Object Class Set Data   
top
 

Object_Class_Set_Data

part of: Object_Class_Set
Element containing all Object Class Set Data
 
Parameter name Type/Value Cardinality Description Validations
Object_Class_Set_ID  string  [0..1]  Object Class Set Reference ID. This is the Object Class Set unique identifier   
Object_Class_Set_Name  string  [1..1]  Object Class Set Name   
Object_Class_Data  Object_Class_Data  [0..*]  Object Class Data. An Object Class Set can contain multiple Object Classes. 
Validation Description
This object class code exists as part of a different object class set and therefore cannot be updated.   
 
top
 

Object_Class_Data

part of: Object_Class_Set_Data
Element containing all Object Class Data
 
Parameter name Type/Value Cardinality Description Validations
Object_Class_Code  string  [1..1]  Object Class Code. This is the Object Class Set unique identifier   
Object_Class_Description  string  [0..1]  Object Class Name   
Validation Description
This object class code exists as part of a different object class set and therefore cannot be updated.   
top
 

Object_Class_SetReferenceEnumeration

part of: Object_Class_SetObjectID
Base Type
string
top