Service Directory > v32.1 > Performance_Management > Put_Check-In
 

Operation: Put_Check-In

Creates a new ~Check-In~ or updates an existing ~Check-In~ with the information supplied in the the request.


@ - 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_Check-In_Request

Web Service element for Put Check-In request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only boolean that signifies that the Check-In will be added.   
Check-In_Reference  Check-InObject  [0..1]  The workset containing the Check-In that was created or edited   
Check-In_Data  Check-In_Data  [0..1]  Element which contains all the components of a Check-In 
Validation Description
The Check-In participant and creator must be different.   
 
Validation Description
The web service is set to add only, but the Check-In already exists.   
top
 

Response Element: Put_Check-In_Response

Web service element that returns the Check-In Reference after a put request is sent.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Check-In_Reference  Check-InObject  [0..1]  Reference to the Check-In that was added or updated.   
top
 

Check-InObject

part of: Put_Check-In_Response, Put_Check-In_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  Check-InObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Check-InObjectID

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

Check-In_Data

part of: Put_Check-In_Request
Element which contains all the components of a Check-In.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID of a Check-In   
Check-In_Date  date  [1..1]  The date of a Check-In 
Validation Description
You cannot have more than one check-in on the same date with the same participant.   
 
Check_In_Archived  boolean  [0..1]  The boolean that allows the user to determine whether or not the Check-In is archived.   
Check-In_Description  RichText  [0..1]  The description for a Check-In   
Check-In_Creator_Reference  Check-In_RoleObject  [1..1]  The creator of the Check-In 
Validation Description
You cannot change the participant or creator of an existing Check-In.   
 
Check-In_Participant_Reference  Check-In_RoleObject  [1..1]  The participant of the Check-In 
Validation Description
You cannot change the participant or creator of an existing Check-In.   
 
Check-In_Topics_Within_Check-In_Reference  Check-In_Topic_within_a_Check-In_Data  [0..*]  The Check-In Topic within the Check-In 
Validation Description
You cannot change the participant or creator of an existing Check-In Topic.   
Topic creator cannot also be the topic participant.   
 
Validation Description
The Check-In participant and creator must be different.   
top
 

Check-In_RoleObject

part of: Check-In_Data, Check-In_Data, Check-In_Topic_within_a_Check-In_Data, Check-In_Topic_within_a_Check-In_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  Check-In_RoleObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Check-In_RoleObjectID

part of: Check-In_RoleObject
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
 

Check-In_Topic_within_a_Check-In_Data

part of: Check-In_Data
Element which contains all the components of a Check-In Topic within a Check-In.
 
Parameter name Type/Value Cardinality Description Validations
Topic_ID  string  [0..1]  The ID of a Check-In Topic within a Check-In.   
Topic_Within_Check_In_Name  string  [1..1]  The Name for a Check-In Topic within a Check-In   
Topic_Within_Check_In_Archived  boolean  [0..1]  The boolean that allows the user to determine whether or not the Check-In Topic within a Check-In is archived.   
Topic_Within_Check_In_Shared_Note  RichText  [0..1]  The note shared between the creator and participant of the Check-In Topic within a Check-In   
Topic_Within_Check_In_Private_Note_for_Participant  RichText  [0..1]  The note created by the participant of the Check-In Topic within a Check-In that is not shared with the creator.   
Topic_Within_Check_In_Private_Note_for_Creator  RichText  [0..1]  The note created by the creator of the Check-In Topic within a Check-In that is not shared   
Check-In_Topic_Creator_Reference  Check-In_RoleObject  [1..1]  The creator of the Check-In Topic 
Validation Description
The creator of the Check-In Topic must be either the creator of the Check-In or the participant of the Check-In.   
 
Check-In_Topic_Participant_Reference  Check-In_RoleObject  [1..1]  The participant of the Check-In Topic 
Validation Description
The participant of the Check-In Topic must be either the creator of the Check-In or the participant of the Check-In.   
 
Validation Description
You cannot change the participant or creator of an existing Check-In Topic.   
Topic creator cannot also be the topic participant.   
top
 

Check-InReferenceEnumeration

part of: Check-InObjectID
Base Type
string
top
 

RichText

part of: Check-In_Data, Check-In_Topic_within_a_Check-In_Data, Check-In_Topic_within_a_Check-In_Data, Check-In_Topic_within_a_Check-In_Data
Base Type
string
top
 

Check-In_RoleReferenceEnumeration

part of: Check-In_RoleObjectID
Base Type
string
top