Service Directory > v23.0 > Campus_Engagement > Get_Engagement_External_Items
 

Operation: Get_Engagement_External_Items

Retrieves Engagement External Items, such as Engagement Emails, by reference.


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

Top-level input element used for getting Engagement External Items
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Engagement_External_Item_Request_References  [0..1]  Parameters that let you choose which data to edit based on WID or ID.   
Request_Criteria [Choice]   Engagement_External_Item_Request_Criteria  [0..1]  Parameters that let you choose which data to edit based on non-ID attributes.   
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  Engagement_External_Item_Response_Group  [0..1]  Parameters that allow you to configure the data set returned.   
top
 

Response Element: Get_Engagement_External_Items_Response

Get Engagement External Items Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Engagement_External_Item_Request_References  [0..1]  External Item instances to process.   
Request_Criteria  Engagement_External_Item_Request_Criteria  [0..1]  Non-ID parameters that allow you to choose what instance data to edit.   
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  Engagement_External_Item_Response_Group  [0..1]  Engagement External Response Group element   
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  Engagement_External_Item_Response_Data  [0..1]  Engagement External Item Response Data element   
top
 

Engagement_External_Item_Request_References

part of: Get_Engagement_External_Items_Request, Get_Engagement_External_Items_Response
External Item instances to process.
 
Parameter name Type/Value Cardinality Description Validations
Engagement_External_Item_Reference  Engagement_External_ItemObject  [1..*]  Instance of External Item to process.   
top
 

Engagement_External_ItemObject

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

Engagement_External_ItemObjectID

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

Engagement_External_Item_Request_Criteria

part of: Get_Engagement_External_Items_Request, Get_Engagement_External_Items_Response
Non-ID parameters that allow you to choose what instance data to edit.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Engagement_External_Items_Request, Get_Engagement_External_Items_Response
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
 

Engagement_External_Item_Response_Group

part of: Get_Engagement_External_Items_Request, Get_Engagement_External_Items_Response
Engagement External Response Group element
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean to indicate whether or not to include the instance reference in the response   
top
 

Response_Results

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

Engagement_External_Item_Response_Data

part of: Get_Engagement_External_Items_Response
Engagement External Item Response Data element
 
Parameter name Type/Value Cardinality Description Validations
Engagement_External_Item  Engagement_External_Item  [0..*]  Engagement External Item element   
top
 

Engagement_External_Item

part of: Engagement_External_Item_Response_Data
Engagement External Item Response Data element
 
Parameter name Type/Value Cardinality Description Validations
Engagement_External_Item_Reference  Engagement_External_ItemObject  [0..1]  Engagement External Item reference   
Engagement_External_Item_Data  Engagement_External_Item_Data  [0..*]  Engagement External Item Data element   
top
 

Engagement_External_Item_Data

part of: Engagement_External_Item
Engagement External Item Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Parameter to set ID for Engagement External Item   
Name  string  [0..1]  Parameter to set Name for Engagement External Item   
Description  string  [0..1]  Parameter to set Description for Engagement External Item   
External_URL_Data  External_URL  [0..*]  Parameter to set URL(s) for Engagement External Item   
Recipients_Reference  Academic_PersonObject  [0..*]  Parameter to set Academic Persons who have recieved this Engagement External Item   
top
 

External_URL

part of: Engagement_External_Item_Data
This element represents an external URL
 
Parameter name Type/Value Cardinality Description Validations
External_URL_Reference  External_URLObject  [0..1]  Reference to an existing external URL   
External_URL_Data  External_URL_Data  [0..1]  Detail data for an external URL   
top
 

External_URLObject

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

External_URLObjectID

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

External_URL_Data

part of: External_URL
This element contains the details of an external URL.
 
Parameter name Type/Value Cardinality Description Validations
URL_Name  string  [0..1]  Name of external URL   
URL  string  [0..1]  Value of external URL (hyperlink)   
top
 

Academic_PersonObject

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

Academic_PersonObjectID

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

Engagement_External_ItemReferenceEnumeration

part of: Engagement_External_ItemObjectID
Base Type
string
top
 

External_URLReferenceEnumeration

part of: External_URLObjectID
Base Type
string
top
 

Academic_PersonReferenceEnumeration

part of: Academic_PersonObjectID
Base Type
string
top