Service Directory > v32.1 > Human_Resources > Put_Workteam
 

Operation: Put_Workteam

This operation adds or deletes workteam members, or updates workteam members' membership status. Each membership status change is effective dated in order to capture membership status history. Each effective-dated membership status change is referred to as a snapshot. 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. When a worker does not exist as a workteam member as of the specified effective date, they are added as a member with the specified effective date and membership status. When a worker does exist as a workteam member as of the specified effective date, the operation updates their membership status. You can correct a membership status by using the same effective date as an existing membership status snapshot or correct the membership status to an earlier effective date by specifying the desired effective date and the same membership status as the next effective-dated snapshot. Example: Membership status is Passive with effective date December 1, 2018. If you specify November 15, 2018 as the effective date and membership status as Passive, the system will change the effective date on the December 1, 2018 snapshot to November 15, 2018. If a workteam member is added too early, you can either delete the member entirely and add them again, or correct the membership status of the first snapshot to be Inactive and then add a new snapshot with the correct effective date and a membership status of Active or Passive.


@ - 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: Put_Workteam_Request

Element containing Workteam reference for update and all Workteam data items.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Add_Only  boolean  [0..1]  Add Only   
Workteam_Reference  WorkteamObject  [0..1]  Unique Instance ID or Reference ID.   
Workteam_Data  Workteam_Data  [1..1]  Workteam Data 
Validation Description
Organization Subtype "[subtype]" is not allowed for Team   
 
Validation Description
Workteam already exists.   
Cannot delete a member while creating a workteam.   
Enter a unique name. This Workteam Name is already in use.   
top
 

Response Element: Put_Workteam_Response

Element containing Put Workteam Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Workteam_Reference  WorkteamObject  [0..1]  Workteam Class   
top
 

WorkteamObject

part of: Put_Workteam_Response, Put_Workteam_Request
 
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_Data

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