Service Directory > v33.1 > Resource_Management > Get_Worker_Utilization_Target_Sheets
 

Operation: Get_Worker_Utilization_Target_Sheets

The Web service operation retrieves and exports Worker Utilization Target Sheet and associated Utilization Target data, i.e., Utilization Target % defined for Utilization Target Rules or Workers.


@ - 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_Worker_Utilization_Target_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  Worker_Utilization_Target_Sheets_Request_References  [0..1]  Element containing references to Worker Utilization Target Sheets   
Request_Criteria  Worker_Utilization_Target_Sheets_Request_Criteria  [0..1]  Element Container for Worker Utilization Target Sheets 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  Worker_Utilization_Target_Sheets_Response_Group  [0..1]  Element Container for Worker Utilization Target Sheets Response Group   
top
 

Response Element: Get_Worker_Utilization_Target_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  Worker_Utilization_Target_Sheets_Request_References  [0..*]  Element containing references to Worker Utilization Target Sheets   
Request_Criteria  Worker_Utilization_Target_Sheets_Request_Criteria  [0..*]  Element Container for Worker Utilization Target Sheets Request Criteria   
Response_Filter  Response_Filter  [0..*]  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  Worker_Utilization_Target_Sheets_Response_Group  [0..*]  Element Container for Worker Utilization Target Sheets Response Group   
Response_Results  Response_Results  [0..*]  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  Worker_Utilization_Target_Sheets_Response_Data  [0..*]  Element Container for Worker Utilization Target Sheets Response Data   
top
 

Worker_Utilization_Target_Sheets_Request_References

part of: Get_Worker_Utilization_Target_Sheets_Response, Get_Worker_Utilization_Target_Sheets_Request
Element containing references to Worker Utilization Target Sheets
 
Parameter name Type/Value Cardinality Description Validations
Worker_Utilization_Target_Sheet_Request_Reference  Utilization_Target_SheetObject  [0..*]  Worker Utilization Target Sheet Request Reference   
top
 

Utilization_Target_SheetObject

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

Utilization_Target_SheetObjectID

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

Worker_Utilization_Target_Sheets_Request_Criteria

part of: Get_Worker_Utilization_Target_Sheets_Response, Get_Worker_Utilization_Target_Sheets_Request
Element Container for Worker Utilization Target Sheets Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Worker_Utilization_Target_Sheet_Company_Reference  CompanyObject  [0..*]  Company   
Worker_Utilization_Target_Sheet_Effective_Date  date  [0..1]  Effective Date   
top
 

CompanyObject

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

CompanyObjectID

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

Response_Filter

part of: Get_Worker_Utilization_Target_Sheets_Response, Get_Worker_Utilization_Target_Sheets_Request
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, become effective (Also referred to as the Effective Moment). If you don't specify a date, this date defaults to today.{+4}   
As_Of_Entry_DateTime  dateTime  [0..1]  The date and time the data was entered into the system. (This field is also referred to as the Entry Moment). If the date isn't specified, the default date is the current date and time.   
Page  decimal (12, 0) >0   [0..1]  The numbered page of data Workday returns in the response. The default page is 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. Set a value between 1 and 999. The default value is 100.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Worker_Utilization_Target_Sheets_Response_Group

part of: Get_Worker_Utilization_Target_Sheets_Response, Get_Worker_Utilization_Target_Sheets_Request
Element Container for Worker Utilization Target Sheets Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Indicates if the Reference of the Worker Utilization Target Sheet is included in the response.   
Include_Worker_Utilization_Target_Sheet_Data  boolean  [0..1]  Indicates if the details of the Worker Utilization Target Sheet is included in the response.   
top
 

Response_Results

part of: Get_Worker_Utilization_Target_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 your request returned.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages requested. A page of data in a WWS has a 100 entry maximum.   
Page_Results  decimal (12, 0) >0   [0..1]  The number of results in the current page.   
Page  decimal (12, 0) >0   [0..1]  The page number of the data the WWS returned for your request.   
top
 

Worker_Utilization_Target_Sheets_Response_Data

part of: Get_Worker_Utilization_Target_Sheets_Response
Element Container for Worker Utilization Target Sheets Response Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Utilization_Target_Sheet  Worker_Utilization_Target_Sheet  [0..*]  Element Container for Worker Utilization Target Sheet   
top
 

Worker_Utilization_Target_Sheet

part of: Worker_Utilization_Target_Sheets_Response_Data
Element Container for Worker Utilization Target Sheet
 
Parameter name Type/Value Cardinality Description Validations
Worker_Utilization_Target_Sheet_Request_Reference  Utilization_Target_SheetObject  [0..1]  Utilization Target Sheet Reference   
Worker_Utilization_Target_Sheet_Data  Worker_Utilization_Target_Sheet_Data  [0..*]  Element Container for Worker Utilization Target Sheet Data 
Validation Description
You can't edit an inactive Worker Utilization Target Sheet.   
 
top
 

Worker_Utilization_Target_Sheet_Data

part of: Worker_Utilization_Target_Sheet
Element Container for Worker Utilization Target Sheet Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Utilization_Target_Sheet_Reference_ID  string  [0..1]  Utilization Target Sheet ID   
Worker_Utilization_Target_Sheet_Name  string  [0..1]  Utilization Target Sheet Name   
Inactive  boolean  [0..1]  Utilization Target Sheet Inactive   
Worker_Utilization_Target_Snapshot_Data  Worker_Utilization_Target_Snapshot_Data  [0..*]  Element Container for Worker Utilization Target Snapshot Data 
Validation Description
You can only use 1 Worker Utilization Target Sheet at a time for a company. A sheet for this company already exists.   
Enter a different priority. You can't use the same priority more than once.   
 
Validation Description
You can't edit an inactive Worker Utilization Target Sheet.   
top
 

Worker_Utilization_Target_Snapshot_Data

part of: Worker_Utilization_Target_Sheet_Data
Element Container for Worker Utilization Target Snapshot Data
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..*]  Company   
Effective_Date  date  [1..1]  Effective Date   
Utilization_Target_1st_Priority_Reference  Utilization_Target_PriorityObject  [1..1]  Utilization Target Sheet 1st Priority   
Utilization_Target_2nd_Priority_Reference  Utilization_Target_PriorityObject  [0..1]  Utilization Target Sheet 2nd Priority   
Worker_Utilization_Target_Data  Worker_Utilization_Target_Details_Data  [0..*]  Element Container for Worker Utilization Target Data 
Validation Description
Enter a unique worker. This worker already exists for the Worker Utilization Target Sheet: [worker].   
Enter a value between 0 and 9.99.   
Enter a unique worker. This worker already exists for the Worker Utilization Target Sheet: [worker].   
You can't update the worker detail for this Worker Utilization Sheet. The Worker Utilization Target Reference ID doesn't belong to the Worker Utilization Target Sheet: [refid].   
This worker doesn't have a primary position in any of the listed companies: [worker].   
Clear the Delete option. The Worker Utilization Target Reference ID doesn't exist.   
 
Worker_Utilization_Target_Rule_Data  Worker_Utilization_Target_Rule_Details_Data  [0..*]  Element Container for Worker Utilization Target Rule Data 
Validation Description
Clear the Delete option. The Worker Utilization Target Rule Reference ID doesn't exist.   
Enter a value between 0 and 9.99.   
Enter a unique project rate rule. This project rate rule already exists for the Worker Utilization Target Sheet: [project rate rule].   
Enter a unique project rate rule. This project rate rule already exists for the Worker Utilization Target Sheet: [project rate rule].   
You can't update the rule for this Worker Utilization Sheet. This Worker Utilization Target Rule Reference ID doesn't belong to the Worker Utilization Target Sheet: [refid].   
Enter a unique evaluation order. This value already exists: [evaluation order].   
 
Validation Description
You can only use 1 Worker Utilization Target Sheet at a time for a company. A sheet for this company already exists.   
Enter a different priority. You can't use the same priority more than once.   
top
 

Utilization_Target_PriorityObject

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

Utilization_Target_PriorityObjectID

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

Worker_Utilization_Target_Details_Data

part of: Worker_Utilization_Target_Snapshot_Data
Element Container for Worker Utilization Target Data
 
Parameter name Type/Value Cardinality Description Validations
Delete  boolean  [0..1]  Delete   
Worker_Utilization_Target_Reference_ID  string  [0..1]  Worker Utilization Target Details Reference ID   
Worker_Reference  WorkerObject  [1..1]  Worker Reference   
Utilization_Target_Percent  decimal (5, 2) >0   [1..1]  Utilization Target Percent   
Validation Description
Enter a unique worker. This worker already exists for the Worker Utilization Target Sheet: [worker].   
Enter a value between 0 and 9.99.   
Enter a unique worker. This worker already exists for the Worker Utilization Target Sheet: [worker].   
You can't update the worker detail for this Worker Utilization Sheet. The Worker Utilization Target Reference ID doesn't belong to the Worker Utilization Target Sheet: [refid].   
This worker doesn't have a primary position in any of the listed companies: [worker].   
Clear the Delete option. The Worker Utilization Target Reference ID doesn't exist.   
top
 

WorkerObject

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

WorkerObjectID

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

Worker_Utilization_Target_Rule_Details_Data

part of: Worker_Utilization_Target_Snapshot_Data
Element Container for Worker Utilization Target Rule Data
 
Parameter name Type/Value Cardinality Description Validations
Delete  boolean  [0..1]  Delete   
Worker_Utilization_Target_Rule_Reference_ID  string  [0..1]  Utilization Target Rule Reference ID   
Order  string  [1..1]  Order   
Project_Rate_Rule_Reference  Project_Cost_Rate_RuleObject  [1..1]  Project Rate Rule   
Utilization_Target_Percent  decimal (5, 2) >0   [1..1]  Utilization Target Percent   
Validation Description
Clear the Delete option. The Worker Utilization Target Rule Reference ID doesn't exist.   
Enter a value between 0 and 9.99.   
Enter a unique project rate rule. This project rate rule already exists for the Worker Utilization Target Sheet: [project rate rule].   
Enter a unique project rate rule. This project rate rule already exists for the Worker Utilization Target Sheet: [project rate rule].   
You can't update the rule for this Worker Utilization Sheet. This Worker Utilization Target Rule Reference ID doesn't belong to the Worker Utilization Target Sheet: [refid].   
Enter a unique evaluation order. This value already exists: [evaluation order].   
top
 

Project_Cost_Rate_RuleObject

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

Utilization_Target_SheetReferenceEnumeration

part of: Utilization_Target_SheetObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Utilization_Target_PriorityReferenceEnumeration

part of: Utilization_Target_PriorityObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Project_Cost_Rate_RuleReferenceEnumeration

part of: Project_Cost_Rate_RuleObjectID
Base Type
string
top