Service Directory > v32.1 > Human_Resources > Get_Sort_Order_Enableds
 

Operation: Get_Sort_Order_Enableds

Web Service to get the order of orderable instances.


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

Get Sort Order Enableds request element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Sort_Order_Enabled_Request_References  [0..1]  Sort Order Enabled instance references.   
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. 
 
top
 

Response Element: Get_Sort_Order_Enableds_Response

Get Sort Order Enableds Web Service response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Sort_Order_Enabled_Request_References  [0..1]  Sort Order Enabled request references.   
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  Sort_Order_Enabled_Response_Data  [0..1]  Get Sort Order Enableds response element.   
top
 

Sort_Order_Enabled_Request_References

part of: Get_Sort_Order_Enableds_Request, Get_Sort_Order_Enableds_Response
Sort Order Enabled request references.
 
Parameter name Type/Value Cardinality Description Validations
Sort_Order_Enabled_Reference  Sort_Order_EnabledObject  [0..*]  Sort Order Enabled instance references.   
top
 

Sort_Order_EnabledObject

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

Sort_Order_EnabledObjectID

part of: Sort_Order_EnabledObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Business_Unit_Hierarchy_ID, Custom_Organization_Reference_ID, Fund_Hierarchy_ID, Gift_Hierarchy_ID, Grant_Hierarchy_ID, Ledger_Account_Summary_ID, Location_ID, Organization_Reference_ID, Program_Hierarchy_ID, Project_Hierarchy_ID, Resource_Category_Hierarchy_ID, Resource_Pool_Hierarchy_ID, Revenue_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Account_Set_ID  [1..1]  The unique identifier type of a parent object   
top
 

Response_Filter

part of: Get_Sort_Order_Enableds_Request, Get_Sort_Order_Enableds_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_Sort_Order_Enableds_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
 

Sort_Order_Enabled_Response_Data

part of: Get_Sort_Order_Enableds_Response
Get Sort Order Enableds response element.
 
Parameter name Type/Value Cardinality Description Validations
Sort_Order_Enabled  Sort_Order_Enabled  [0..*]  Sort Order Enabled data.   
top
 

Sort_Order_Enabled

part of: Sort_Order_Enabled_Response_Data
Sort Order Enabled data.
 
Parameter name Type/Value Cardinality Description Validations
Sort_Order_Enabled_Data  Sort_Order_Enabled_Order_Data_Container  [0..*]  Element containing information about the Orderable Items and their order.   
top
 

Sort_Order_Enabled_Order_Data_Container

part of: Sort_Order_Enabled
Element containing information about the Orderable Items and their order.
 
Parameter name Type/Value Cardinality Description Validations
Sort_Order_Enabled_Reference  Sort_Order_EnabledObject  [1..1]  Sort Order Enabled instance reference.   
Order_Data  Sort_Order_Enabled_Order_Data  [0..*]  Element containing information about the Orderable Item and its order. 
Validation Description
Order can not be duplicated.   
Orderable Item can not be duplicated.   
 
top
 

Sort_Order_Enabled_Order_Data

part of: Sort_Order_Enabled_Order_Data_Container
Element containing information about the Orderable Item and its order.
 
Parameter name Type/Value Cardinality Description Validations
Order  string (6)   [1..1]  Order for the Orderable Item.   
Orderable_Item_Reference  Orderable_ItemObject  [1..1]  Orderable Item instance reference. 
Validation Description
[oi] is not allowed to be ordered under [soe].   
 
Validation Description
Order can not be duplicated.   
Orderable Item can not be duplicated.   
top
 

Orderable_ItemObject

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

Orderable_ItemObjectID

part of: Orderable_ItemObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Accounting_Journal_ID, Business_Unit_Hierarchy_ID, Business_Unit_ID, Candidate_ID, Company_Reference_ID, Contingent_Worker_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Employee_ID, Fund_Hierarchy_ID, Fund_ID, Gift_Hierarchy_ID, Gift_Reference_ID, Grant_Hierarchy_ID, Grant_ID, Ledger_Account_Summary_ID, Location_ID, Organization_Reference_ID, Program_Hierarchy_ID, Program_ID, Project_Hierarchy_ID, Project_ID, Region_Reference_ID, Resource_Category_Hierarchy_ID, Resource_Pool_Hierarchy_ID, Revenue_Category_Hierarchy_ID, Revenue_Category_ID, 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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Account_Set_ID  [1..1]  The unique identifier type of a parent object   
top
 

Sort_Order_EnabledReferenceEnumeration

part of: Sort_Order_EnabledObjectID
Base Type
string
top
 

Base Type
string

top
 

Orderable_ItemReferenceEnumeration

part of: Orderable_ItemObjectID
Base Type
string
top
 

Base Type
string

top