Service Directory > v32.1 > Integrations > Get_Event_Documents
 

Operation: Get_Event_Documents

This operation will retrieve data related to any Documents that may be available to an Integration Event.


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

Get Event Documents Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Integration_Event_Request_References  [1..1]  Integration Event Request References   
Response_Filter  Response_Filter__No_Entry_Moment_  [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_Event_Documents_Response

Get Event Documents Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Integration_Event_Request_References  [0..1]  Integration Event Request References   
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_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  Event_Documents_Response_Data  [0..1]  Event Documents Response Data element   
top
 

Integration_Event_Request_References

part of: Get_Event_Documents_Request, Get_Event_Documents_Response
Integration Event Request References
 
Parameter name Type/Value Cardinality Description Validations
@Ignore_Invalid_References  boolean  [1..1]     
Integration_Event_Reference  Integration_ESB_Invocation__Abstract_Object  [1..*]  Integration Event Reference   
top
 

Integration_ESB_Invocation__Abstract_Object

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

Integration_ESB_Invocation__Abstract_ObjectID

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

part of: Get_Event_Documents_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_Filter

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

Response_Results

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

Event_Documents_Response_Data

part of: Get_Event_Documents_Response
Event Documents Response Data element
 
Parameter name Type/Value Cardinality Description Validations
Event_Documents  Event_Documents  [0..*]  For each Integration Event, this element contains all the available Documents   
top
 

Event_Documents

part of: Event_Documents_Response_Data
For each Integration Event, this element contains all the available Documents
 
Parameter name Type/Value Cardinality Description Validations
Integration_Event_Reference  Integration_Event__Abstract_Object  [0..1]  Integration Event Reference   
Repository_Document  Repository_Document_Summary_Data  [0..*]  Summary of Repository Document   
top
 

Integration_Event__Abstract_Object

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

Integration_Event__Abstract_ObjectID

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

Repository_Document_Summary_Data

part of: Event_Documents
Summary of Repository Document
 
Parameter name Type/Value Cardinality Description Validations
Repository_Document_Reference  Repository_DocumentObject  [0..1]  Reference to a Repository Document   
Repository_Document_Data  Integration_Repository_Document_Data  [0..*]  Document Tag reference   
top
 

Repository_DocumentObject

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

Repository_DocumentObjectID

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

Integration_Repository_Document_Data

part of: Repository_Document_Summary_Data
Encapsulating element containing all Integration Repository Document data.
 
Parameter name Type/Value Cardinality Description Validations
@Document_ID  string (513)   [1..1]  A unique ID for Repository document.   
@File_Name  string  [1..1]  Text attribute for Repository document.   
File_Size  decimal (12, 0) >0   [0..1]  Numeric attribute representing the Size (in Bytes) of the Repository document.   
Content_Type_Reference [Choice]   Mime_TypeObject  [0..1]  Reference element identifying a unique instance of Content Type of the Attachment.   
Content_Type [Choice]   string (80)   [0..1]  The Content Type of the document. Valid values defined in RFC 822, including type, subtype, and parameter.   
Document_Type_Reference  Document_TypeObject  [0..1]  Reference element identifying a unique instance of Document Type of the Repository document.   
Expiration_Timestamp  dateTime  [1..1]  DateTime attribute representing the Expiration Timestamp of the Repository document.   
Owner_Reference  System_AccountObject  [0..1]  Unique identifier for a System User reference   
Document_Tag_Reference  Document_TagObject  [0..*]  Document Tag(s) associated with Repository Document   
Custom_Document_Tag  string  [0..*]  Custom Document Tag   
Secured_Instance_Reference  InstanceObject  [0..*]  For Documents attached to an Integration Template utilizing Document Security, this Instance Reference identifies the secured instace(s) to be evaluated against the Document Security task.   
top
 

Mime_TypeObject

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

Mime_TypeObjectID

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

Document_TypeObject

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

Document_TypeObjectID

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

System_AccountObject

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

System_AccountObjectID

part of: System_AccountObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, LearningUserName, RecruitingUserName, StudentUserName, SupplierUserName, System_Account_ID, System_User_ID, System_User_OpenID, System_User_OpenID_Connect_Internal, System_User_OpenID_Internal, WorkdayUserName  [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
 

Document_TagObject

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

Document_TagObjectID

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

InstanceObject

part of: Integration_Repository_Document_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

Integration_ESB_Invocation__Abstract_ReferenceEnumeration

part of: Integration_ESB_Invocation__Abstract_ObjectID
Base Type
string
top
 

Integration_Event__Abstract_ReferenceEnumeration

part of: Integration_Event__Abstract_ObjectID
Base Type
string
top
 

Repository_DocumentReferenceEnumeration

part of: Repository_DocumentObjectID
Base Type
string
top
 

Mime_TypeReferenceEnumeration

part of: Mime_TypeObjectID
Base Type
string
top
 

Document_TypeReferenceEnumeration

part of: Document_TypeObjectID
Base Type
string
top
 

System_AccountReferenceEnumeration

part of: System_AccountObjectID
Base Type
string
top
 

Document_TagReferenceEnumeration

part of: Document_TagObjectID
Base Type
string
top