Service Directory > v31.2 > Human_Resources > Get_Workteams
 

Operation: Get_Workteams

Returns Workteam information. If the request does not specify a Workteam, the operation returns information for all Workteam.


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

Contains request reference, criteria, filter for getting Workteam data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Workteam_Request_References  [0..1]  Workteam Request References   
Request_Criteria [Choice]   Workteam_Request_Criteria  [0..1]  Workteam Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Workteam_Response_Group  [0..1]  Workteam Response Group   
top
 

Response Element: Get_Workteams_Response

Response element generated by Get Workteam task.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Workteam_Request_References  [0..1]  Get Workteam references.   
Request_Criteria  Workteam_Request_Criteria  [0..1]  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  Workteam_Response_Group  [0..1]  Workteam Response Group   
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  Workteam_Response_Data  [0..1]  Get Workteam Response Data.   
top
 

Workteam_Request_References

part of: Get_Workteams_Response, Get_Workteams_Request
Get Workteam references.
 
Parameter name Type/Value Cardinality Description Validations
Workteam_Reference  WorkteamObject  [1..*]  Workteam Request References   
top
 

WorkteamObject

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

WorkteamObjectID

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

Workteam_Request_Criteria

part of: Get_Workteams_Response, Get_Workteams_Request
Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Workteams_Response, Get_Workteams_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, 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
 

Workteam_Response_Group

part of: Get_Workteams_Response, Get_Workteams_Request
Workteam Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Workteam_Response_Data

part of: Get_Workteams_Response
Get Workteam Response Data.
 
Parameter name Type/Value Cardinality Description Validations
Workteam  Workteam  [0..*]  Get Workteam Response Data.   
top
 

Workteam

part of: Workteam_Response_Data
Get Workteam Response Data.
 
Parameter name Type/Value Cardinality Description Validations
Workteam_Reference  WorkteamObject  [0..1]  Workteam   
Workteam_Data  Workteam_Data  [0..*]  Workteam Data 
Validation Description
Organization Subtype "[subtype]" is not allowed for Team   
 
top
 

Workteam_Data

part of: Workteam
Element containing all Team data.
 
Parameter name Type/Value Cardinality Description Validations
Name  string  [1..1]  Name   
Description  RichText  [0..1]  HTML-Encoded Workteam Description   
ID  string  [0..1]  ID   
Workteam_System_Source_Reference  External_Source_SystemObject  [0..1]  The source system in which the Workteam is/was created from   
Organization_Subtype_Reference  Organization_SubtypeObject  [1..1]  The Organization Subtype/s assigned to the Workteam   
Workteam_Membership_Data  Workteam_Membership_Data  [0..*]  Holds data for each individual member of the Workteam 
Validation Description
Membership status cannot be empty for action.   
If the delete flag is true, the effective date must be empty.   
 
Validation Description
Organization Subtype "[subtype]" is not allowed for Team   
top
 

External_Source_SystemObject

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

External_Source_SystemObjectID

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

Organization_SubtypeObject

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

Organization_SubtypeObjectID

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

Workteam_Membership_Data

part of: Workteam_Data
Information required for the workteam membership.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  When true, membership status and effective date must be empty. The specified worker must be a workteam member now or in the future. When a workteam member is deleted, it is as if they were never a member and their entire membership status history is also deleted. If you want to retain membership status history after a member departs, Workday recommends that you change the member's status to Inactive instead.   
Effective_Date  date  [0..1]  When the worker is not a member as of this effective date, they are added as a member with the specified effective date and membership status. When the worker is a member as of the specified effective date, only their membership status is updated. Use the same effective date as an existing membership status snapshot to correct the membership status. To correct the effective date of a membership status to an earlier date, specify the desired effective date and the same membership status as the next effective-dated snapshot. When the effective date is empty, the current date is used.   
Worker_Reference  WorkerObject  [1..1]  Worker ID. Can specify either the ID or WID.   
Workteam_Membership_Status_Reference  Workteam_Membership_StatusObject  [0..1]  Required unless Delete is true. Valid values are Active, Passive, or Inactive.   
Validation Description
Membership status cannot be empty for action.   
If the delete flag is true, the effective date must be empty.   
top
 

WorkerObject

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

Workteam_Membership_StatusObject

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

Workteam_Membership_StatusObjectID

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

WorkteamReferenceEnumeration

part of: WorkteamObjectID
Base Type
string
top
 

RichText

part of: Workteam_Data
Base Type
string
top
 

External_Source_SystemReferenceEnumeration

part of: External_Source_SystemObjectID
Base Type
string
top
 

Organization_SubtypeReferenceEnumeration

part of: Organization_SubtypeObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Workteam_Membership_StatusReferenceEnumeration

part of: Workteam_Membership_StatusObjectID
Base Type
string
top