public interface

IntegrationsPort

com.workday.integrations.IntegrationsPort
Known Indirect Subclasses

Class Overview

This Web Service contains operations related to all Integrations within the Workday system. This class was generated by Apache CXF 2.5.1 2014-02-28T19:23:33.647-03:00 Generated source version: 2.5.1

Summary

Public Methods
abstract ApproveBusinessProcessResponseType approveBusinessProcess(ApproveBusinessProcessRequestType body)
This operation approves a business process, if approvable, by the user
abstract CancelBusinessProcessResponseType cancelBusinessProcess(CancelBusinessProcessRequestType body)
This operation cancels a business process, if cancelable, by the user
abstract DenyBusinessProcessResponseType denyBusinessProcess(DenyBusinessProcessRequestType body)
This operation denies a business process, if deniable, by the user
abstract GetEIBDefinitionsResponseType getEIBDefinitions(GetEIBDefinitionsRequestType body)
This operation will retrieve data related to an EIB definition.
abstract GetEventDetailsResponseType getEventDetail(GetEventDetailsRequestType body)
This operation will retrieve data (e.g.
abstract GetEventDocumentsResponseType getEventDocuments(GetEventDocumentsRequestType body)
This operation will retrieve data related to any Documents that may be available to an Integration Event.
abstract GetIntegrationEventsResponseType getIntegrationEvents(GetIntegrationEventsRequestType body)
This operation will retrieve data related to an execution of an Integration Event.
abstract GetIntegrationSystemUsersResponseType getIntegrationSystemUsers(GetIntegrationSystemUsersRequestType body)
This operation will retrieve data related to Workday Accounts associated to an Integration System.
abstract GetIntegrationSystemsResponseType getIntegrationSystems(GetIntegrationSystemsRequestType body)
This operation will retrieve data related to an Integration System.
abstract GetReferencesResponseType getReferences(GetReferencesRequestType body)
This operation provide a list of values for a business object in Workday given its "Reference ID Type".
abstract GetSequenceGeneratorsResponseType getSequenceGenerators(GetSequenceGeneratorsRequestType body)
This operation will retrieve data related to a Sequence Generator (e.g ID Definition).
abstract GetSubscriptionsResponseType getSubscriptions(GetSubscriptionsRequestType body)
This operation will retrieve data related to Subscriptions, both for an Integration System and for Transaction Log service configuration.
abstract IncrementSequenceGeneratorResponseType incrementSequenceGenerator(IncrementSequenceGeneratorRequestType body)
This operation will increments a Sequence Generator and persists the data within Workday.
abstract LaunchEIBResponseType launchEIB(LaunchEIBRequestType body)
This operation will Launch an EIB Integration.
abstract LaunchIntegrationEventResponseType launchIntegration(LaunchIntegrationEventRequestType body)
This operation will Launch an Integration.
abstract PutIntegrationEventResponseType putIntegrationEvent(PutIntegrationEventRequestType body)
This operation will create and/or update data related to an Integration Event.
abstract PutIntegrationMessageResponseType putIntegrationMessage(PutIntegrationMessageRequestType body)
This operation adds a message to either an Integration System or Integration Event which allows for status, information and error details to be communicated back to Workday.
abstract PutIntegrationSystemResponseType putIntegrationSystem(PutIntegrationSystemRequestType body)
This operation will create and/or update data related to an Integration System.
abstract PutIntegrationSystemUserResponseType putIntegrationSystemUser(PutIntegrationSystemUserRequestType body)
This operation will create and/or update data related to Workday Accounts associated to an Integration System.
abstract PutReferenceResponseType putReference(PutReferenceRequestType body)
This operation updates the Reference IDs on a business object for a Reference ID Type.
abstract PutSequenceGeneratorResponseType putSequenceGenerator(PutSequenceGeneratorRequestType body)
This operation will create and/or update data related to a Sequence Generator (e.g ID Definition).
abstract PutSubscriptionResponseType putSubscription(PutSubscriptionRequestType body)
This operation will create and/or update data related to Subscriptions, both for an Integration System and for Transaction Log service configuration.
abstract RescindBusinessProcessResponseType rescindBusinessProcess(RescindBusinessProcessRequestType body)
This operation rescinds a business process, if rescindable by the user

Public Methods

public abstract ApproveBusinessProcessResponseType approveBusinessProcess (ApproveBusinessProcessRequestType body)

This operation approves a business process, if approvable, by the user

Parameters
body

public abstract CancelBusinessProcessResponseType cancelBusinessProcess (CancelBusinessProcessRequestType body)

This operation cancels a business process, if cancelable, by the user

Parameters
body

public abstract DenyBusinessProcessResponseType denyBusinessProcess (DenyBusinessProcessRequestType body)

This operation denies a business process, if deniable, by the user

Parameters
body

public abstract GetEIBDefinitionsResponseType getEIBDefinitions (GetEIBDefinitionsRequestType body)

This operation will retrieve data related to an EIB definition. An EIB definition will include the Integration System and a Data Source, Transformation and Transport Protocol definition.

Parameters
body

public abstract GetEventDetailsResponseType getEventDetail (GetEventDetailsRequestType body)

This operation will retrieve data (e.g. Creation Date, Event State, Event Target, etc..) related to Workday Business Process Event (e.g. Hire Employee, Enter Time Off, etc...)

Parameters
body

public abstract GetEventDocumentsResponseType getEventDocuments (GetEventDocumentsRequestType body)

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

Parameters
body

public abstract GetIntegrationEventsResponseType getIntegrationEvents (GetIntegrationEventsRequestType body)

This operation will retrieve data related to an execution of an Integration Event. Data included will be Integration System, Launch datetime, Triggering User, Status and Runtime Parameters.

Parameters
body

public abstract GetIntegrationSystemUsersResponseType getIntegrationSystemUsers (GetIntegrationSystemUsersRequestType body)

This operation will retrieve data related to Workday Accounts associated to an Integration System.

Parameters
body

public abstract GetIntegrationSystemsResponseType getIntegrationSystems (GetIntegrationSystemsRequestType body)

This operation will retrieve data related to an Integration System. Data returned within the response includes Services associated and enabled, Attribute/Map values, Service configurations and Custom Services Attributes, Maps and Launch Parameters.

Parameters
body

public abstract GetReferencesResponseType getReferences (GetReferencesRequestType body)

This operation provide a list of values for a business object in Workday given its "Reference ID Type". The "Reference ID Type" for each referenced business object can be retrieved within our API Documentation. For example, the "Reference ID Type" for a Location reference is "Location_ID". So, if we call "Get References" with "Location_ID" you will get back the list of all locations (and their Workday and Reference IDs).

Parameters
body

public abstract GetSequenceGeneratorsResponseType getSequenceGenerators (GetSequenceGeneratorsRequestType body)

This operation will retrieve data related to a Sequence Generator (e.g ID Definition). Data associated to a Sequence Generator includes the formatting, syntax, last date used, increment value, etc. Sequence Generators are typically associated with Integrations utilizing a Sequence Generator Service.

Parameters
body

public abstract GetSubscriptionsResponseType getSubscriptions (GetSubscriptionsRequestType body)

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.

Parameters
body

public abstract IncrementSequenceGeneratorResponseType incrementSequenceGenerator (IncrementSequenceGeneratorRequestType body)

This operation will increments a Sequence Generator and persists the data within Workday. The response is the fully formatted value of the Sequence Generator after the increment.

Parameters
body

public abstract LaunchEIBResponseType launchEIB (LaunchEIBRequestType body)

This operation will Launch an EIB Integration. The request has the ability to accept override Runtime Parameters that should be used within the integration processing. If no override is provided within the request, the System Default, which has been defined on the EIB Definition, will be used. The result of this operation will be the creation of an Integration Event along with the processing of the integration itself.

Parameters
body

public abstract LaunchIntegrationEventResponseType launchIntegration (LaunchIntegrationEventRequestType body)

This operation will Launch an Integration. The request has the ability to accept Runtime Parameters and the Workday Account that should be used within the integration processing. The result of this operation will be the creation of an Integration Event along with the processing of the integration itself.

Parameters
body

public abstract PutIntegrationEventResponseType putIntegrationEvent (PutIntegrationEventRequestType body)

This operation will create and/or update data related to an Integration Event. Data included will be Integration System, Launch datetime, Triggering User, Status and Runtime Parameters.

Parameters
body

public abstract PutIntegrationMessageResponseType putIntegrationMessage (PutIntegrationMessageRequestType body)

This operation adds a message to either an Integration System or Integration Event which allows for status, information and error details to be communicated back to Workday.

Parameters
body

public abstract PutIntegrationSystemResponseType putIntegrationSystem (PutIntegrationSystemRequestType body)

This operation will create and/or update data related to an Integration System. Data returned within the response includes Services associated and enabled, Attribute/Map values, Service configurations and Custom Services Attributes, Maps and Launch Parameters.

Parameters
body

public abstract PutIntegrationSystemUserResponseType putIntegrationSystemUser (PutIntegrationSystemUserRequestType body)

This operation will create and/or update data related to Workday Accounts associated to an Integration System.

Parameters
body

public abstract PutReferenceResponseType putReference (PutReferenceRequestType body)

This operation updates the Reference IDs on a business object for a Reference ID Type. Currently, updating Reference IDs for most, but not all Reference ID Types is supported.

Parameters
body

public abstract PutSequenceGeneratorResponseType putSequenceGenerator (PutSequenceGeneratorRequestType body)

This operation will create and/or update data related to a Sequence Generator (e.g ID Definition). Data associated to a Sequence Generator includes the formatting, syntax, last date used, increment value, etc. Sequence Generators are typically associated with Integrations utilizing a Sequence Generator Service.

Parameters
body

public abstract PutSubscriptionResponseType putSubscription (PutSubscriptionRequestType body)

This operation will create and/or update 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.

Parameters
body

public abstract RescindBusinessProcessResponseType rescindBusinessProcess (RescindBusinessProcessRequestType body)

This operation rescinds a business process, if rescindable by the user

Parameters
body