Service Directory > v31.2 > Resource_Management > Get_Project_Standard_Cost_Rate_Sheets
 

Operation: Get_Project_Standard_Cost_Rate_Sheets

The Web service operation retrieves and exports Project Standard Cost Rate Sheet and associated Project Standard Cost Rates data, i.e., project worker roles, rules and standard cost rates.


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

Root element for the Request on the Get operation. Contains references, criteria, filter and response group for specifying which instances to return in the Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Project_Standard_Cost_Rate_Sheet_Request_References  [0..1]  Element containing reference instances for a Project Role Standard Cost Rate Sheet.   
Request_Criteria  Project_Standard_Cost_Rate_Sheet_Request_Criteria  [0..1]  Element containing Project Role Standard Cost Rate 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  Project_Standard_Cost_Rate_Sheet_Response_Group  [0..1]  Element containing Project Role Standard Cost Rate response grouping options   
top
 

Response Element: Get_Project_Standard_Cost_Rate_Sheets_Response

Root element for the Response on the Get operation. Contains the instances returned by the Get operation and their accompanying data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Reference  Project_Standard_Cost_Rate_Sheet_Request_References  [0..1]  Element containing reference instances for a Project Role Standard Cost Rate Sheet.   
Request_Criteria  Project_Standard_Cost_Rate_Sheet_Request_Criteria  [0..1]  Element containing Project Role Standard Cost Rate 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  Project_Standard_Cost_Rate_Sheet_Response_Group  [0..1]  Element containing Project Role Standard Cost Rate response grouping options   
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  Project_Standard_Cost_Rate_Sheet_Response_Data  [0..1]  Wrapper Element that includes Project Role Standard Cost Rate Sheet Instance and Data   
top
 

Project_Standard_Cost_Rate_Sheet_Request_References

part of: Get_Project_Standard_Cost_Rate_Sheets_Request, Get_Project_Standard_Cost_Rate_Sheets_Response
Element containing reference instances for a Project Role Standard Cost Rate Sheet.
 
Parameter name Type/Value Cardinality Description Validations
Project_Standard_Cost_Rate_Reference  Project_Standard_Cost_Rate_SheetObject  [0..*]  Project Standard Cost Rate Sheet Request   
top
 

Project_Standard_Cost_Rate_SheetObject

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

Project_Standard_Cost_Rate_SheetObjectID

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

Project_Standard_Cost_Rate_Sheet_Request_Criteria

part of: Get_Project_Standard_Cost_Rate_Sheets_Request, Get_Project_Standard_Cost_Rate_Sheets_Response
Element containing Project Role Standard Cost Rate request criteria
 
Parameter name Type/Value Cardinality Description Validations
Project_Rate_Sheet_Currency_Reference  CurrencyObject  [0..1]  Currency   
Project_Rate_Sheet_Effective_Date  date  [0..1]  Effective Date   
top
 

CurrencyObject

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

CurrencyObjectID

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

Response_Filter

part of: Get_Project_Standard_Cost_Rate_Sheets_Request, Get_Project_Standard_Cost_Rate_Sheets_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
 

Project_Standard_Cost_Rate_Sheet_Response_Group

part of: Get_Project_Standard_Cost_Rate_Sheets_Request, Get_Project_Standard_Cost_Rate_Sheets_Response
Element containing Project Role Standard Cost Rate response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Indicates if the Reference of the Project Role Standard Cost Rate Sheet is included in the response.   
Include_Project_Role_Standard_Cost_Rate_Sheet_data  boolean  [0..1]  Indicates if the details of the Project Role Standard Cost Rate Sheet is included in the response.   
top
 

Response_Results

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

Project_Standard_Cost_Rate_Sheet_Response_Data

part of: Get_Project_Standard_Cost_Rate_Sheets_Response
Wrapper Element that includes Project Role Standard Cost Rate Sheet Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Project_Standard_Cost_Rate_Sheet  Project_Standard_Cost_Rate_Sheet  [0..*]  Project Role Standard Cost Rate Sheet   
top
 

Project_Standard_Cost_Rate_Sheet

part of: Project_Standard_Cost_Rate_Sheet_Response_Data
Wrapper Element that includes Project Role Standard Cost Rate Sheet Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Project_Standard_Cost_Rate_Sheet_Reference  Project_Standard_Cost_Rate_SheetObject  [0..1]  Project Role Standard Cost Rate Sheet Reference   
Project_Standard_Cost_Rate_Sheet_Data  Project_Standard_Cost_Rate_Sheet_Data  [0..*]  Project Standard Cost Rate Sheet Data 
Validation Description
Enter a unique currency. This currency already exists.   
You cannot change the currency of the existing rate sheet.   
 
top
 

Project_Standard_Cost_Rate_Sheet_Data

part of: Project_Standard_Cost_Rate_Sheet
Element containing all Project Standard Cost Rate Sheet data
 
Parameter name Type/Value Cardinality Description Validations
Project_Standard_Cost_Rate_Sheet_ID  string  [0..1]  Project Role Standard Cost Rate Sheet ID   
Standard_Cost_Rate_Sheet_Name  string  [1..1]  Project Rate Sheet Name   
Rate_Sheet_Currency_Reference  CurrencyObject  [1..1]  Rate Sheet Currency   
Project_Standard_Cost_Rate_Sheet_Snapshot_Data  Project_Standard_Cost_Rate_Snapshot_Details  [0..*]  Project Standard Cost Rate Sheet Snapshot Details   
Validation Description
Enter a unique currency. This currency already exists.   
You cannot change the currency of the existing rate sheet.   
top
 

Project_Standard_Cost_Rate_Snapshot_Details

part of: Project_Standard_Cost_Rate_Sheet_Data
Project Standard Cost Rate Sheet Snapshot Details
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  Effective Date   
Default_Hourly_Rate  decimal (18, 6) >0   [1..1]  Hourly rate for the project role.   
Project_Worker_Standard_Cost_Rate_Detail_Data  Project_Worker_Standard_Cost_Rate_Details  [0..*]  Project Worker Role Data 
Validation Description
The Delete option should be set to false since Project Worker Standard Cost Rate ID does not exist.   
Enter a unique project rate rule. This project rate rule already exists for the Rate Sheet: [project rate rule].   
This Project Worker Standard Cost Rate Detail ID does not belong to the rate sheet: [refid].   
Enter a unique project rate rule. This project rate rule already exists for the Rate Sheet: [project rate rule].   
 
Project_Unnamed_Resource_Standard_Cost_Rate_Detail_Data  Project_Unnamed_Resource_Standard_Cost_Rate_Details  [0..*]  Project Unnamed Resource Project Role 
Validation Description
The Delete option should be set to false since Project Unnamed Resource Standard Cost Rate Detail ID does not exist.   
This Project Unnamed Resource Standard Cost Rate Detail ID does not belong to the rate sheet: [refid].   
Enter a unique project role. This project role already exists for the Rate Sheet: [project role].   
Enter a unique project role. This project role already exists for the Rate Sheet: [project role].   
 
top
 

Project_Worker_Standard_Cost_Rate_Details

part of: Project_Standard_Cost_Rate_Snapshot_Details
Element containing Project Rate Rule Worker Data
 
Parameter name Type/Value Cardinality Description Validations
Delete  boolean  [0..1]  Delete Flag   
Project_Worker_Standard_Cost_Rate_Detail_ID  string  [0..1]  ID value required for updates.   
Order  string  [1..1]  Order   
Project_Cost_Rate_Rule_Reference  Project_Cost_Rate_RuleObject  [1..1]  Project Rate Rule   
Hourly_Rate  decimal (18, 6) >0   [1..1]  Project rate rule hourly rate   
Validation Description
The Delete option should be set to false since Project Worker Standard Cost Rate ID does not exist.   
Enter a unique project rate rule. This project rate rule already exists for the Rate Sheet: [project rate rule].   
This Project Worker Standard Cost Rate Detail ID does not belong to the rate sheet: [refid].   
Enter a unique project rate rule. This project rate rule already exists for the Rate Sheet: [project rate rule].   
top
 

Project_Cost_Rate_RuleObject

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

Project_Cost_Rate_RuleObjectID

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

Project_Unnamed_Resource_Standard_Cost_Rate_Details

part of: Project_Standard_Cost_Rate_Snapshot_Details
Element containing Project Unnamed Resource Standard Cost rate data
 
Parameter name Type/Value Cardinality Description Validations
Delete  boolean  [0..1]  Delete   
Project_Unnamed_Resource_Standard_Cost_Rate_Detail_ID  string  [0..1]  ID value required for updates.   
Unnamed_Resource_Project_Role_Reference  Project_RoleObject  [1..1]  Project Unnamed Resource Project Role   
Hourly_Rate  decimal (18, 6) >0   [1..1]  Project rate rule hourly rate   
Validation Description
The Delete option should be set to false since Project Unnamed Resource Standard Cost Rate Detail ID does not exist.   
This Project Unnamed Resource Standard Cost Rate Detail ID does not belong to the rate sheet: [refid].   
Enter a unique project role. This project role already exists for the Rate Sheet: [project role].   
Enter a unique project role. This project role already exists for the Rate Sheet: [project role].   
top
 

Project_RoleObject

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

Project_RoleObjectID

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

Project_Standard_Cost_Rate_SheetReferenceEnumeration

part of: Project_Standard_Cost_Rate_SheetObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Project_Cost_Rate_RuleReferenceEnumeration

part of: Project_Cost_Rate_RuleObjectID
Base Type
string
top
 

Project_RoleReferenceEnumeration

part of: Project_RoleObjectID
Base Type
string
top