Service Directory > v31.2 > Resource_Management > Get_Project_Role_Categories
 

Operation: Get_Project_Role_Categories

Returns Project Role Categories by Reference ID, or returns all Project Role Categories if no Reference ID is provided.


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

Get Project Role Categories Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Project_Role_Category_Request_References  [0..1]  Request References for Project Role Category   
Request_Criteria [Choice]   Project_Role_Category_Request_Criteria  [0..1]  Request Criteria for Project Role Categories   
Response_Filter  Response_Filter  [0..1]  Response Filter for Project Role Categories 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Project_Role_Category_Response_Group  [0..1]  Response Group for Project Role Categories   
top
 

Response Element: Get_Project_Role_Categories_Response

Element Containing Project Role Categories Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Project_Role_Category_Request_References  [0..1]  Request References for Project Role Category   
Request_Criteria  Project_Role_Category_Request_Criteria  [0..1]  Request Criteria for Project Role Categories   
Response_Filter  Response_Filter  [0..1]  Response Filter for Project Role Categories 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Project_Role_Category_Response_Group  [0..1]  Response Group for Project Role Categories   
Response_Results  Response_Results  [0..1]  Response Results for Project Role Categories   
Response_Data  Project_Role_Category_Response_Data  [0..1]  Response Data for Project Role Category   
top
 

Project_Role_Category_Request_References

part of: Get_Project_Role_Categories_Request, Get_Project_Role_Categories_Response
The Request References element contains the specific instance set that should be returned in the Get operation. Either a Reference ID or the Workday ID (GUID) should be specified for each instance to be returned.
 
Parameter name Type/Value Cardinality Description Validations
Project_Role_Category_Reference  Project_Role_CategoryObject  [1..*]  Request References for Project Role Category   
top
 

Project_Role_CategoryObject

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

Project_Role_CategoryObjectID

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

Project_Role_Category_Request_Criteria

part of: Get_Project_Role_Categories_Request, Get_Project_Role_Categories_Response
Project Role Category Request Criteria Element
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Project_Role_Categories_Request, Get_Project_Role_Categories_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_Role_Category_Response_Group

part of: Get_Project_Role_Categories_Request, Get_Project_Role_Categories_Response
Get Project Role Categories Response Group Element
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Documentation Root element for the Response on the Get operation. Contains the instances returned by the Get operation and their accompanying data.   
top
 

Response_Results

part of: Get_Project_Role_Categories_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_Role_Category_Response_Data

part of: Get_Project_Role_Categories_Response
Response Data for Project Role Category
 
Parameter name Type/Value Cardinality Description Validations
Project_Role_Category  Project_Role_Category  [0..*]  Project Role Category   
top
 

Project_Role_Category

part of: Project_Role_Category_Response_Data
Element for Project Role Category
 
Parameter name Type/Value Cardinality Description Validations
Project_Role_Category_Reference  Project_Role_CategoryObject  [0..1]  Reference for Project Role Category   
Project_Role_Category_Data  Project_Role_Category_Data  [0..1]  Data for Project Role Category   
top
 

Project_Role_Category_Data

part of: Project_Role_Category
Data Element for Project Role Category
 
Parameter name Type/Value Cardinality Description Validations
Project_Role_Category_ID  string  [0..1]  Unique ID for Project Role Category   
Project_Role_Category_Name  string  [1..1]  Unique Name for Project Role Category 
Validation Description
Enter a unique project role category name.   
 
Project_Role_Category_Description  string  [0..1]  Description for Project Role Category   
Inactive_Project_Role_Category  boolean  [0..1]  Boolean flag to set the Project Role Categories to Inactive.   
top
 

Project_Role_CategoryReferenceEnumeration

part of: Project_Role_CategoryObjectID
Base Type
string
top