Service Directory > v32.1 > Resource_Management > Get_Project_Worker_Roles
 

Operation: Get_Project_Worker_Roles

This service operation will get Project Worker Roles for the specified criteria. Project Worker Role data includes Project Worker Role ID, Project Worker Role Name, Project Worker Role Description, Default Hourly Billable Rate, Default Hourly Internal Rate, and Currency. The request criteria can be for a single Project Worker Role based on Reference, or all transactions can be retrieved if no criteria 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_Project_Worker_Roles_Request

Contains request reference, criteria, filter and response group for getting Project Worker Role data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Project_Worker_Role_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Project_Worker_Role_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Project_Worker_Role_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Project_Worker_Roles_Response

Element containing Project Worker Role response elements including received criteria, references, data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Project_Worker_Role_Request_References  [0..1]  Request References   
Request_Criteria  Project_Worker_Role_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Project_Worker_Role_Response_Group  [0..1]  Response Group   
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Project_Worker_Role_Response_Data  [0..1]  Response Data   
top
 

Project_Worker_Role_Request_References

part of: Get_Project_Worker_Roles_Request, Get_Project_Worker_Roles_Response
Element containing reference instances for a Project Worker Role
 
Parameter name Type/Value Cardinality Description Validations
Project_Worker_Role_Reference  Project_RoleObject  [1..*]  Project Worker Role Reference   
top
 

Project_RoleObject

part of: Project_Worker_Role_Request_References, Project_Worker_Role
 
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_Worker_Role_Request_Criteria

part of: Get_Project_Worker_Roles_Request, Get_Project_Worker_Roles_Response
Element containing Project Worker Role request criteria
 
Parameter name Type/Value Cardinality Description Validations
Inactive  boolean  [0..1]  Project Worker Role Request Criteria   
top
 

Response_Filter

part of: Get_Project_Worker_Roles_Request, Get_Project_Worker_Roles_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_Worker_Role_Response_Group

part of: Get_Project_Worker_Roles_Request, Get_Project_Worker_Roles_Response
Element containing Project Worker Role response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Indicates if the Reference of the Project Worker Role is included in the response.   
Include_Project_Worker_Role_Data  boolean  [0..1]  Indicates if the details of the Project Worker Role is included in the response.   
top
 

Response_Results

part of: Get_Project_Worker_Roles_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_Worker_Role_Response_Data

part of: Get_Project_Worker_Roles_Response
Wrapper Element that includes Project Worker Role Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Project_Worker_Role  Project_Worker_Role  [0..*]  Project Worker Role   
top
 

Project_Worker_Role

part of: Project_Worker_Role_Response_Data
Wrapper Element that includes Project Worker Role Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Project_Worker_Role_Reference  Project_RoleObject  [0..1]  Project Worker Role Reference   
Project_Worker_Role_Data  Project_Worker_Role_Data  [0..1]  Project Worker Role Data   
top
 

Project_Worker_Role_Data

part of: Project_Worker_Role
Element containing all Project Worker Role data
 
Parameter name Type/Value Cardinality Description Validations
Project_Worker_Role_ID  string  [0..1]  Project Worker Role ID   
Name  string  [1..1]  Name 
Validation Description
Enter a unique Project Worker Role Name. [name] is already in use.   
 
Description  string  [0..1]  Description   
Inactive  boolean  [0..1]  Inactive Project Role   
Project_Resource_Requirement_Parameter_Data  Project_Resource_Requirement_Parameter_Data  [0..*]  Project Resource Requirement Parameter Data 
Validation Description
You can’t have duplicate entries on a Category.   
You can’t have duplicate entries on a Category.   
Project Role Requirement Reference ID already exists for another Project Role.   
The Delete option should be set to false since Project Resource Requirement Parameter ID does not exist.   
Requirement value has to be of the same type of the Requirement Category.   
 
top
 

Project_Resource_Requirement_Parameter_Data

part of: Project_Worker_Role_Data
Project Resource Requirement Parameter Data
 
Parameter name Type/Value Cardinality Description Validations
Delete  boolean  [0..1]  Delete   
Project_Resource_Requirement_Parameter_ID  string  [0..1]  Project Role Resource Plan Requirement Parameter ID   
Requirement_Field_Reference  External_FieldObject  [0..1]  Requirement category 
Validation Description
Requirement Category or Requirement Value cannot be empty.   
Location category can only have one Requirement value.   
Job Profile category can only have one Requirement value.   
 
Requirement_Value_Reference  InstanceObject  [0..*]  Requirement value 
Validation Description
Invalid Requirement for Category.   
 
Validation Description
You can’t have duplicate entries on a Category.   
You can’t have duplicate entries on a Category.   
Project Role Requirement Reference ID already exists for another Project Role.   
The Delete option should be set to false since Project Resource Requirement Parameter ID does not exist.   
Requirement value has to be of the same type of the Requirement Category.   
top
 

External_FieldObject

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

External_FieldObjectID

part of: External_FieldObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Calculated_Field_ID, Computed_Data_Source_Field_ID, Custom_Field_Data_Set_ID, Extension_Computed_Data_Field_Reference_ID, External_Analytics_Data_Source_Field_ID, WCP_Component_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
 

InstanceObject

part of: Project_Resource_Requirement_Parameter_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

Project_RoleReferenceEnumeration

part of: Project_RoleObjectID
Base Type
string
top
 

External_FieldReferenceEnumeration

part of: External_FieldObjectID
Base Type
string
top