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

Operation: Put_Check-In_Topic

Creates a new ~Check-In~ ~Topic~ or updates an existing ~Check-In~ ~Topic~ 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_Topic_Request

Web Service element for Put Check-InTopic 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 Topic will be added.   
Check-In_Topic_Reference  Check-In_TopicObject  [0..1]  Check-In Topic reference to be added or updated.   
Check-In_Topic_Data  Check-In_Topic_Data  [1..1]  Element container for Check-In Topic data 
Validation Description
The participants of the topic and associated check-ins must be the same   
Topic creator cannot also be the topic participant.   
 
Validation Description
The web service is set to add only, but the Check-In Topic already exists.   
top
 

Response Element: Put_Check-In_Topic_Response

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

Check-In_TopicObject

part of: Put_Check-In_Topic_Response, Put_Check-In_Topic_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-In_TopicObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Check-In_TopicObjectID

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

part of: Put_Check-In_Topic_Request
Element which contains all the components of a Check-In Topic
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID of a Check-In Topic   
Check-In_Topic_Name  string  [1..1]  The Name for a Check-In Topic   
Topic_Archived  boolean  [0..1]  The boolean that allows the user to determine whether or not the Check-In Topic is archived.   
Shared_Note  RichText  [0..1]  The note shared between the creator and participant of a Check-In Topic   
Private_Note_for_Check-In_Topic_Participant  RichText  [0..1]  The note created by the Check-In Topic participant that is not shared with the creator.   
Private_Note_for_Check-In_Topic_Creator  RichText  [0..1]  The note created by the Check-In Topic creator that is not shared with the participant.   
Check-In_Topic_Creator_Reference  Check-In_RoleObject  [1..1]  The creator of the Check-In Topic 
Validation Description
You cannot change the participant or creator of an existing Check-In Topic.   
 
Check-In_Topic_Participant_Reference  Check-In_RoleObject  [1..1]  The participant of the Check-In Topic 
Validation Description
You cannot change the participant or creator of an existing Check-In Topic.   
 
Associated_Check-In_Reference  Check-InObject  [0..*]  The Check-In(s) that the Check-In Topic is associated with.   
Validation Description
The participants of the topic and associated check-ins must be the same   
Topic creator cannot also be the topic participant.   
top
 

Check-In_RoleObject

part of: Check-In_Topic_Data, Check-In_Topic_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-InObject

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

part of: Check-In_TopicObjectID
Base Type
string
top
 

RichText

part of: Check-In_Topic_Data, Check-In_Topic_Data, Check-In_Topic_Data
Base Type
string
top
 

Check-In_RoleReferenceEnumeration

part of: Check-In_RoleObjectID
Base Type
string
top
 

Check-InReferenceEnumeration

part of: Check-InObjectID
Base Type
string
top