Service Directory > v32.1 > Resource_Management > Get_Asset_Shares
 

Operation: Get_Asset_Shares

This service allows you to get asset shares for a business asset.


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

Request element for the asset shares operation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Asset_Shares_Request_Reference  [0..1]  Element containing request references for the asset shares operation   
Request_Criteria [Choice]   Asset_Shares_Request_Criteria  [0..1]  Element containing request criteria for the asset shares operation   
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  Asset_Shares_Response_Group  [0..1]  Element containing response group for the asset share operation   
top
 

Response Element: Get_Asset_Shares_Response

Element containing request and response elements for the asset shares operation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Asset_Shares_Request_Reference  [0..1]  Element containing request references for the asset shares operation   
Request_Criteria  Asset_Shares_Request_Criteria  [0..1]  Element containing request criteria for the asset shares operation   
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  Asset_Shares_Response_Group  [0..1]  Element containing response group for the asset share operation   
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  Asset_Shares_Response_Data  [0..1]  Response element for the Asset Shares operation   
top
 

Asset_Shares_Request_Reference

part of: Get_Asset_Shares_Request, Get_Asset_Shares_Response
Element containing request references for the asset shares operation
 
Parameter name Type/Value Cardinality Description Validations
Business_Asset_Reference  Business_AssetObject  [1..*]  Reference to an existing shared business asset to which the asset shares data applies   
top
 

Business_AssetObject

part of: Asset_Shares_Request_Criteria, Asset_Shares_Request_Reference, Asset_Shares
 
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  Business_AssetObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Business_AssetObjectID

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

Asset_Shares_Request_Criteria

part of: Get_Asset_Shares_Request, Get_Asset_Shares_Response
Element containing request criteria for the asset shares operation
 
Parameter name Type/Value Cardinality Description Validations
Business_Assets_Reference  Business_AssetObject  [0..*]  Reference to an existing shared business asset to which the asset shares data applies   
top
 

Response_Filter

part of: Get_Asset_Shares_Request, Get_Asset_Shares_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
 

Asset_Shares_Response_Group

part of: Get_Asset_Shares_Request, Get_Asset_Shares_Response
Element containing response group for the asset share operation
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Included Reference boolean element   
top
 

Response_Results

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

Asset_Shares_Response_Data

part of: Get_Asset_Shares_Response
Element containing asset shares response data
 
Parameter name Type/Value Cardinality Description Validations
Asset_Shares  Asset_Shares  [0..*]  Element containing a reference to an existing business asset and all its asset share data   
top
 

Asset_Shares

part of: Asset_Shares_Response_Data
Element containing a reference to an existing business asset and all its asset share data
 
Parameter name Type/Value Cardinality Description Validations
Business_Asset_Reference  Business_AssetObject  [0..1]  Reference to an existing business asset for which the asset share data applies   
Asset_Share_Response_Data  Asset_Share_Response_Data  [0..*]  Element containing the asset share response data   
top
 

Asset_Share_Response_Data

part of: Asset_Shares
Element containing the asset share response data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  This is a unique reference identifier to the asset share.   
Share_Percent  decimal (18, 15) >0   [0..1]  The percent of the asset share.   
Asset_Share_Amount  decimal (18, 3)   [0..1]  The amount of the asset share.   
Asset_Class_Reference  Asset_ClassObject  [0..1]  Reference to the asset class that the asset is shared by.   
Asset_Type_Reference  Asset_TypeObject  [0..1]  Reference to the asset type that the asset is shared by   
Asset_Worktags_Reference  Accounting_WorktagObject  [0..*]  Reference to the worktags that the asset is shared by   
top
 

Asset_ClassObject

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

Asset_ClassObjectID

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

Asset_TypeObject

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

Asset_TypeObjectID

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

Accounting_WorktagObject

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

Accounting_WorktagObjectID

part of: Accounting_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Alternate_Supplier_Contract_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_ID, Calculation_Compensation_Basis_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Basis_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Reference_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Is_Manager_ID, Is_People_Manager, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, Job_Category_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Lease_Expense_Recognition_ID, Loan_ID, Location_ID, Management_Level_ID, NI_Category_Letter, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Payroll_Federal_Authority_Tax_Code, Payroll_Income_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_ID, Program_of_Study_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Application_Residency_Status_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Point_Date_Type_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_ID, Workday_Deduction_Code, Workday_Earning_Code, Worker_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
 

Business_AssetReferenceEnumeration

part of: Business_AssetObjectID
Base Type
string
top
 

Asset_ClassReferenceEnumeration

part of: Asset_ClassObjectID
Base Type
string
top
 

Asset_TypeReferenceEnumeration

part of: Asset_TypeObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top