workday.connect
Module workday.connect
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_workday.connect_1.4.0.png)
ballerinax/workday.connect Ballerina library
Overview
This is a generated connector for WorkDay Connect REST API v2 OpenAPI specification.
The WorkDay connect service enables applications to access REST service for for Multichannel Collaboration (MCC) services.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a workday application in the Credential Administrator console
- Obtain tokens by following this guide
Clients![](/images/permalink.svg)
workday.connect: Client![](/images/permalink.svg)
This is a generated connector for WorkDay Connect Service REST API v1 OpenAPI specification. The WorkDay connect service enables applications to access REST service for Multichannel Collaboration (MCC) services.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Follow [this guide] https://credentials.workday.com/docs/authentication/ and obtain tokens.
init (ConnectionConfig config, string serviceUrl)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
getMessageTemplateByID![](/images/permalink.svg)
function getMessageTemplateByID(string id) returns MessageTemplateDetailRef|error
Secured by: Set Up: Message Templates
Scope: Learning Coredescription
Parameters
- id string - The Workday ID of the resource.
Return Type
- MessageTemplateDetailRef|error - Successful response. A successful response can return no matched data.
createMessageTemplateByID![](/images/permalink.svg)
function createMessageTemplateByID(string id, MessageTemplateDetailRef payload) returns MessageTemplateDetailRef|error
Secured by: Set Up: Message Templates
Scope: Learning Core
Return Type
- MessageTemplateDetailRef|error - Successful response. A successful response can return no matched data. Updating resource.
updateMessageTemplateByID![](/images/permalink.svg)
function updateMessageTemplateByID(string id, MessageTemplateDetailRef payload) returns MessageTemplateDetailRef|error
Secured by: Set Up: Message Templates
Scope: Learning Core
Return Type
- MessageTemplateDetailRef|error - Successful response. A successful response can return no matched data. Updating resource.
getNotificationTypes![](/images/permalink.svg)
function getNotificationTypes(int? 'limit, int? offset) returns InlineResponse200|error
Secured by: Administer Communications, Set Up: Message Templates
Scope: Learning Core
Parameters
- 'limit int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- offset int? (default ()) - The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Return Type
- InlineResponse200|error - Successful response. A successful response can return no matched data.
sendMessage![](/images/permalink.svg)
function sendMessage(MessageDetail payload) returns MessageDetail|error
Secured by: Administer Communications
Parameters
- payload MessageDetail -
Return Type
- MessageDetail|error - Resource created.
getNotificationTypeByID![](/images/permalink.svg)
function getNotificationTypeByID(string id) returns NotificationCategoryDetail|error
Secured by: Administer Communications, Set Up: Message Templates
Scope: Learning Core
Parameters
- id string - The Workday ID of the resource.
Return Type
- NotificationCategoryDetail|error - Successful response. A successful response can return no matched data.
getMessageTemplate![](/images/permalink.svg)
function getMessageTemplate(boolean? inactive, int? 'limit, string? name, string? notificationType, int? offset) returns InlineResponse2001|error
Secured by: Set Up: Message Templates
Scope: Learning Core
Parameters
- inactive boolean? (default ()) - Indicates template is active or has been disabled.
- 'limit int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- name string? (default ()) - Message Template Name
- notificationType string? (default ()) - Notification Type indicates where the template can be used.
- offset int? (default ()) - The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Return Type
- InlineResponse2001|error - Successful response. A successful response can return no matched data.
createMessageTemplate![](/images/permalink.svg)
function createMessageTemplate(MessageTemplateDetailRef payload, boolean? inactive, string? name, string? notificationType) returns MessageTemplateDetailRef|error
Secured by: Set Up: Message Templates
Scope: Learning Core
Parameters
- payload MessageTemplateDetailRef -
- inactive boolean? (default ()) - Indicates template is active or has been disabled.
- name string? (default ()) - Message Template Name
- notificationType string? (default ()) - Notification Type indicates where the template can be used.
Return Type
- MessageTemplateDetailRef|error - Resource created.
Records![](/images/permalink.svg)
workday.connect: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
workday.connect: CommID![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.connect: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
workday.connect: ConnectSubscriberRepresentation![](/images/permalink.svg)
Fields
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.connect: CreatedBy![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.connect: EmailDetail![](/images/permalink.svg)
Fields
- Fields Included from *EmailDetailRef
workday.connect: EmailDetailRef![](/images/permalink.svg)
Fields
- name string? - Email Configuration Data container for REST API.
- body string - Message content of the email.
- subject string - Email subject line.
- replyTo string? - Reply To
workday.connect: ErrorModelReference![](/images/permalink.svg)
Fields
- 'error string - A description of the error
workday.connect: InlineResponse200![](/images/permalink.svg)
collection something or other
Fields
- data NotificationCategoryDetail[]? -
- total int? -
workday.connect: InlineResponse2001![](/images/permalink.svg)
collection something or other
Fields
- data MessageTemplateDetailRef[]? -
- total int? -
workday.connect: InstanceModelReference![](/images/permalink.svg)
Fields
- id string - wid / id / reference id
- descriptor string? - A description of the instance
- href string? - A link to the instance
workday.connect: LastUpdatedBy![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.connect: MessageDetail![](/images/permalink.svg)
Fields
- senderOverride SenderOverride? -
- commID CommID? -
- emailDetail EmailDetail? -
- recipients Recipients? -
- messageTemplate MessageTemplate? -
- notificationType NotificationType? -
- pushDetail PushDetail? -
workday.connect: MessageTemplate![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.connect: MessageTemplateDetailRef![](/images/permalink.svg)
Fields
- createdBy CreatedBy? -
- emailDetail EmailDetail? -
- lastUpdated string? -
- pushDetail PushDetail? -
- usageCount int? - Count of instances using this Message Template
- createdOn string? - Gives the date that the instance was originally created.
- notificationType NotificationType -
- name string - Message Template Name
- lastUpdatedBy LastUpdatedBy? -
- referenceID string? - The Reference ID to use for lookups within our Workday Web Services. For ~supervisory organizations~, this is also the 'Organization ID'
- inactive boolean? - Indicates template is active or has been disabled.
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.connect: MultipleInstanceModelReference![](/images/permalink.svg)
Fields
- total int? -
- data InstanceModelReference[]? -
workday.connect: NotificationCategoryDetail![](/images/permalink.svg)
Fields
- parentCategory ParentCategory? -
- name string? -
- referenceID string? - The Reference ID to use for lookups within our Workday Web Services. For ~supervisory organizations~, this is also the 'Organization ID'
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.connect: NotificationType![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.connect: ParentCategory![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.connect: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
workday.connect: PushDetail![](/images/permalink.svg)
Fields
- Fields Included from *PushDetailRef
workday.connect: PushDetailRef![](/images/permalink.svg)
Fields
- redirectURL string? - The URL to launch the appropriate mobile app upon acknowledgement.
- message string - Message content of a push notification.
- id string? - Id of the instance
workday.connect: Recipients![](/images/permalink.svg)
Fields
- Fields Included from *RecipientsDetail
- contacts ConnectSubscriberRepresentation[]
- anydata...
workday.connect: RecipientsDetail![](/images/permalink.svg)
Fields
- contacts ConnectSubscriberRepresentation[]? - Recipients for the Send Message. This CRF supports any instance of type superclass Workday Connect Subscriber, 1$17306.
workday.connect: SenderOverride![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.connect: ValidationErrorModelReference![](/images/permalink.svg)
Fields
- Fields Included from *ErrorModelReference
- error string
- anydata...
- errors ErrorModelReference[]? - An array of validation errors
Import
import ballerinax/workday.connect;
Metadata
Released date: almost 2 years ago
Version: 1.4.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.2.1
GraalVM compatible: Yes
Pull count
Total: 3
Current verison: 3
Weekly downloads
Keywords
Human Resources/HRMS
Cost/Paid
Contributors
Dependencies