Service Directory > v25.1 > Integrations > Get_Subscriptions
 

Operation: Get_Subscriptions

This operation will retrieve data related to Subscriptions, both for an Integration System and for Transaction Log service configuration. A Subscription includes an association with 1 or more Transaction/Business Process Types.


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

Get Subscriptions Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Subscription_Request_References  [0..1]  Subscription Request References element   
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_Subscriptions_Response

Get Subscriptions Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Subscription_Request_References  [0..1]  Subscription Request References element   
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  Subscription_Response_Data  [0..1]  Subscription Response Data element   
top
 

Subscription_Request_References

part of: Get_Subscriptions_Request, Get_Subscriptions_Response
Subscription Request References element
 
Parameter name Type/Value Cardinality Description Validations
Subscription_Reference  Unique_IdentifierObject  [1..*]  Subscription Reference   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Subscription_Response_Data

part of: Get_Subscriptions_Response
Subscription Response Data element
 
Parameter name Type/Value Cardinality Description Validations
Subscription  Subscription  [0..*]  Subscription element   
top
 

Subscription

part of: Subscription_Response_Data
Subscription element
 
Parameter name Type/Value Cardinality Description Validations
Subscription_Reference  Unique_IdentifierObject  [0..1]  Subscription Reference   
Subscription_Data  Subscription_Data  [0..1]  Subscription Data element 
Validation Description
Endpoints cannot be defined for this Subscriber. Endpoints can only be defined for Subscribers of type Integration System, because Push Subscription is only supported for Integration System.   
A Subscription can not have multiple Endpoints that use the same OMS Environment   
A Subscription can not have multiple Endpoints that use the same OMS Environment   
A Subscription cannot use 'Subscribe to all Transaction Types' and define Endpoints for Push Subscriptions at the same time. Push Subscriptions are only allowed for Transaction Types that are Business Processes or Event Lites, but not Reorganization Activities.   
A Subscription cannot subscribe to Reorganization Activities and define Endpoints for Push Subscriptions at the same time. Push Subscriptions are only allowed for Transaction Types that are Business Processes or Event Lites.   
A Subscription cannot use 'Subscribe to all Transaction Types except' a list of Transaction Types and define Endpoints for Push Subscriptions at the same time. Push Subscriptions are only allowed for Transaction Types that are Business Processes or Event Lites, but not Reorganization Activities.   
 
top
 

Subscription_Data

part of: Subscription
Subscription Data element
 
Parameter name Type/Value Cardinality Description Validations
Subscriber_Reference  SubscriberObject  [1..1]  Subscriber Reference   
Endpoint_Info_Data  External_Endpoint_Data  [0..*]  Endpoint Info Data element   
Run_As_User_Reference  System_UserObject  [0..1]  System User to use to fire the Integration Background Future Process   
Integration_Background_Future_Process_Data  Integration_Background_Process_Definition_Data  [0..1]  Integration Background Process Definition Data element   
Subscribe_to_all_Transaction_Types [Choice]   boolean  [0..1]  Subscribe to all Transaction Types (e.g. both Business Processes and Event Lites)   
Excluded_Transaction_Log_Type_Reference [Choice]   Transaction_Log_TypeObject  [0..*]  Subscribe to all Transaction Types except for the specified Transaction Types   
Subscribe_to_all_Business_Processes [Choice]   boolean  [0..1]  Subscribe to all Business Processes   
Excluded_Business_Process_Type_Reference [Choice]   Business_Process_TypeObject  [0..*]  Subscribe to all Business Processes except for the specified Business Processes   
Included_Transaction_Log_Type_Reference [Choice]   Transaction_Log_TypeObject  [0..*]  Subscribe to specific Transaction Log Type   
Validation Description
Endpoints cannot be defined for this Subscriber. Endpoints can only be defined for Subscribers of type Integration System, because Push Subscription is only supported for Integration System.   
A Subscription can not have multiple Endpoints that use the same OMS Environment   
A Subscription can not have multiple Endpoints that use the same OMS Environment   
A Subscription cannot use 'Subscribe to all Transaction Types' and define Endpoints for Push Subscriptions at the same time. Push Subscriptions are only allowed for Transaction Types that are Business Processes or Event Lites, but not Reorganization Activities.   
A Subscription cannot subscribe to Reorganization Activities and define Endpoints for Push Subscriptions at the same time. Push Subscriptions are only allowed for Transaction Types that are Business Processes or Event Lites.   
A Subscription cannot use 'Subscribe to all Transaction Types except' a list of Transaction Types and define Endpoints for Push Subscriptions at the same time. Push Subscriptions are only allowed for Transaction Types that are Business Processes or Event Lites, but not Reorganization Activities.   
top
 

SubscriberObject

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

SubscriberObjectID

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

External_Endpoint_Data

part of: Subscription_Data
Endpoint Info Data element
 
Parameter name Type/Value Cardinality Description Validations
Web_Service_API_Version_Reference  Web_Service_API_VersionObject  [1..1]  Version Reference   
Use_Deployed_Service_Endpoint [Choice]   boolean  [0..1]  Use the endpoint defined by the Integration   
Subscriber_URL [Choice]   string  [0..1]  Use this specific endpoint   
Subscription_User_Name  string  [0..1]  Text attribute identifying User Name.   
Subscription_Password  string  [0..1]  Text attribute identifying Password.   
Disable_Endpoint  boolean  [0..1]  Use to disable sending notifications to the external system.   
OMS_Environment_Reference  OMS_EnvironmentObject  [0..*]  Unique identifier for an OMS Environment reference   
top
 

Web_Service_API_VersionObject

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

Web_Service_API_VersionObjectID

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

OMS_EnvironmentObject

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

OMS_EnvironmentObjectID

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

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

System_UserObjectID

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

part of: Subscription_Data
Integration Background Process Definition Data element
 
Parameter name Type/Value Cardinality Description Validations
Process_Description [Choice]   string  [1..1]  When Integration Event is created for this Background Future Process, this text will be used for its Process Description   
Dynamic_Description_External_Field_Reference [Choice]   External_FieldObject  [1..1]  When Integration Event is created for this Background Future Process, the result of this External Field will be used for its Process Description   
Integration_Background_Process_Data  Integration_Scheduled_Future_Process_Data  [1..1]  Integration Scheduled Future Process Data element   
top
 

External_FieldObject

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

External_FieldObjectID

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

part of: Integration_Background_Process_Definition_Data
Integration Scheduled Future Process Data element
 
Parameter name Type/Value Cardinality Description Validations
Integration_System_Reference  Integration_System_IdentifierObject  [1..1]  Unique identifier for an Integration System reference   
Integration_Parameter_Initialization_Data [Choice]   Integration_Parameter_Initialization_Data  [0..*]  Integration Parameter Initialization Data element   
EIB_Parameter_Initialization_Data [Choice]   EIB_Parameter_Initialization_Data  [0..*]  EIB Parameter Initialization Data element   
top
 

Integration_System_IdentifierObject

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

Integration_System_IdentifierObjectID

part of: Integration_System_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Dynamic_Integration_Step_Name, Integration_System_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Business_Process_Type  [1..1]  The unique identifier type of a parent object   
top
 

Integration_Parameter_Initialization_Data

part of: Integration_Scheduled_Future_Process_Data
Integration Parameter Initialization Data element
 
Parameter name Type/Value Cardinality Description Validations
Launch_Parameter_Reference  Launch_ParameterObject  [1..1]  Launch Parameter Reference   
Parameter_Initialization_Data  Parameter_Initialization_WWS_Data  [1..1]  Defines the value to be used for parameter assignment.   
top
 

Launch_ParameterObject

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

Launch_ParameterObjectID

part of: Launch_ParameterObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Filter_Parameter_Name, Launch_Parameter_Name, Web_Service_Data_Source_Launch_Parameter_Name, Workday_Launch_Parameter_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Document_ID, File_ID, Integration_Service_Component_ID, Integration_Service_Name, Integration_System_ID, Integration_Template_Name, Parameter_Based_Filter_Name, Workday_Integration_Service_Name  [1..1]  The unique identifier type of a parent object   
top
 

Parameter_Initialization_WWS_Data

part of: Integration_Parameter_Initialization_Data, EIB_Parameter_Initialization_Data
Defines the value to be used for parameter assignment.
 
Parameter name Type/Value Cardinality Description Validations
Boolean [Choice]   boolean  [0..1]  Boolean   
Currency [Choice]   decimal (26, 6)   [0..1]  Currency   
Date [Choice]   date  [0..1]  Date   
DateTime [Choice]   dateTime  [0..1]  DateTime   
Numeric [Choice]   decimal (26, 6)   [0..1]  Numeric   
Text [Choice]   string  [0..1]  Text   
Business_Object_Instance_Reference [Choice]   InstanceObject  [0..*]  Business Object Instance Reference   
External_Field_Reference [Choice]   External_FieldObject  [0..1]  If Parameter Initialization Operator is "Determine Value at Runtime", then specify an External Field to be resolved at runtime.   
Parameter_Initialization_Operator_Reference  Parameter_Initialization_OperatorObject  [1..1]  Parameter Initialization Operator Reference   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference   
top
 

InstanceObject

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

Parameter_Initialization_OperatorObject

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

Parameter_Initialization_OperatorObjectID

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

CurrencyObject

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

CurrencyObjectID

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

EIB_Parameter_Initialization_Data

part of: Integration_Scheduled_Future_Process_Data
EIB Parameter Initialization Data element
 
Parameter name Type/Value Cardinality Description Validations
Data_Source [Choice]   boolean  [1..1]  TRUE if this Parameter Initialization is for a Service Component that is part of the EIB Data Source.   
Transformation [Choice]   boolean  [1..1]  TRUE if this Parameter Initialization is for a Service Component that is part of the EIB Transformation.   
File_Utility [Choice]   boolean  [1..1]  TRUE if this Parameter Initialization is for a Service Component that is part of the EIB File Utility.   
Transport_Protocol [Choice]   boolean  [1..1]  TRUE if this Parameter Initialization is for a Service Component that is part of the EIB Transport Protocol.   
Field_Name  string  [1..1]  Name of the Integration Service Component Field   
Parameter_Initialization_Data  Parameter_Initialization_WWS_Data  [1..1]  Defines the value to be used for parameter assignment.   
top
 

Transaction_Log_TypeObject

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

Transaction_Log_TypeObjectID

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

Business_Process_TypeObject

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

Business_Process_TypeObjectID

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

SubscriberReferenceEnumeration

part of: SubscriberObjectID
Base Type
string
top
 

Web_Service_API_VersionReferenceEnumeration

part of: Web_Service_API_VersionObjectID
Base Type
string
top
 

OMS_EnvironmentReferenceEnumeration

part of: OMS_EnvironmentObjectID
Base Type
string
top
 

System_UserReferenceEnumeration

part of: System_UserObjectID
Base Type
string
top
 

External_FieldReferenceEnumeration

part of: External_FieldObjectID
Base Type
string
top
 

Integration_System_IdentifierReferenceEnumeration

part of: Integration_System_IdentifierObjectID
Base Type
string
top
 

Base Type
string

top
 

Launch_ParameterReferenceEnumeration

part of: Launch_ParameterObjectID
Base Type
string
top
 

Base Type
string

top
 

Parameter_Initialization_OperatorReferenceEnumeration

part of: Parameter_Initialization_OperatorObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Transaction_Log_TypeReferenceEnumeration

part of: Transaction_Log_TypeObjectID
Base Type
string
top
 

Business_Process_TypeReferenceEnumeration

part of: Business_Process_TypeObjectID
Base Type
string
top