Service Directory > v32.1 > Performance_Management > Get_Check-In_Topics
 

Operation: Get_Check-In_Topics

This operation allows the getting of ~Check-In~ ~Topics~


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

The request that gets Check-In Topics
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Check-In_Topic_Request_References  [0..1]  Element for Check-In Topic Request Reference   
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. 
 
top
 

Response Element: Get_Check-In_Topics_Response

Get the Check-In Topics
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Check-In_Topic_Request_References  [0..1]  Element container for Check-In Topic Request References   
Response_Filter  Response_Filter  [0..1]  Element container for Response Filter. Parameters that let you filter the data returned in the resp 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Element container for Response Results. This contains summary information about the data that has been returned from your request.   
Response_Data  Check-in_Topic_Response_Data  [0..1]  Element container for the response element of the Check-In Topic   
top
 

Check-In_Topic_Request_References

part of: Get_Check-In_Topics_Response, Get_Check-In_Topics_Request
Element for Check-In Topic Request Reference
 
Parameter name Type/Value Cardinality Description Validations
Check-In_Topic_Reference  Check-In_TopicObject  [1..*]  The Check-In Topic Reference   
top
 

Check-In_TopicObject

part of: Check-In_Topic, Check-In_Topic_Request_References
 
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
 

Response_Filter

part of: Get_Check-In_Topics_Response, Get_Check-In_Topics_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
 

Response_Results

part of: Get_Check-In_Topics_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
 

Check-in_Topic_Response_Data

part of: Get_Check-In_Topics_Response
The response element for the Get Check-In Topic Web Service
 
Parameter name Type/Value Cardinality Description Validations
Check-In_Topic  Check-In_Topic  [0..*]  The Check-In Topic that contains the Check-In Topic reference and Check-In Topic Data ob   
top
 

Check-In_Topic

part of: Check-in_Topic_Response_Data
Element containing the response for the Check-In Topic instance that was created or edited
 
Parameter name Type/Value Cardinality Description Validations
Check-In_Topic_Reference  Check-In_TopicObject  [0..1]  The workset containing the Check-In Topic that was created or edited   
Check-In_Topic_Data  Check-In_Topic_Data  [0..*]  Element which contains all the components of a Check-In Topic 
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_Topic_Data

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