Module workday.businessprocess
ballerinax/workday.businessprocess Ballerina library
1.5.1
Overview
This is a generated connector for WorkDay Business Process REST API v1 OpenAPI specification.
The WorkDay business process service enables applications to access information on event actions and details
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
workday.businessprocess: Client
Isolated
This is a generated connector for WorkDay Business Process REST API v1 OpenAPI specification. The WorkDay business process service enables applications to access information on event actions and details
Constructor
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
getBusinessProcessEventSteps
Isolated FunctionRemote Function
function getBusinessProcessEventSteps(string[]? businessProcess, string? createdOnOrAfter, string? createdOnOrBefore, string? dueDateOnOrAfter, string? dueDateOnOrBefore, int? 'limit, int? offset, string[]? stepType) returns InlineResponse200|errorRetrieves business process event steps.
Parameters
- businessProcess string[]? (default ()) - The business process type of the event that the step is associated with.
- createdOnOrAfter string? (default ()) - The last moment the step was updated.
- createdOnOrBefore string? (default ()) - The last moment the step was updated.
- dueDateOnOrAfter string? (default ()) - Returns the due date for this step.
- dueDateOnOrBefore string? (default ()) - Returns the due date for this step.
- '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.
- stepType string[]? (default ()) - Retired. We retire this report field because when there are multiple steps on the business process definition that are associated with this event step, this report field doesn't return the step type for each associated step. We recommend that you use the Step Type report field instead.
Return Type
- InlineResponse200|error - Successful response. A successful response can return no matched data.
getBusinessProcessEvents
Isolated FunctionRemote Function
function getBusinessProcessEvents(string[]? businessProcess, string? completedOnOrAfter, string? completedOnOrBefore, string? initiatedOnOrAfter, string? initiatedOnOrBefore, string[]? initiator, int? 'limit, int? offset, string[]? status, string? 'worker) returns InlineResponse2001|errorRetrieves business process events.
Parameters
- businessProcess string[]? (default ()) - The business process type associated with the business process. Returns filterable search results. Use with the Business Process Type data source.
- completedOnOrAfter string? (default ()) - The date and time the business process was completed.
- completedOnOrBefore string? (default ()) - The date and time the business process was completed.
- initiatedOnOrAfter string? (default ()) - The date and time this business process was initiated.
- initiatedOnOrBefore string? (default ()) - The date and time this business process was initiated.
- initiator string[]? (default ()) - The ~worker~ that initiated the business process. Please do not use this field in a condition rule for the initiation step of a process, as it will not return results. This is because there is no initiating ~worker~ designated until the process has started. The Initiating ~Worker~ field only gets a value after the event is initiated (after the process is submitted).
- '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.
- status string[]? (default ()) - Transaction Status for Facet Search
- 'worker string? (default ()) - Event about ~Worker~ for Facet Search
Return Type
- InlineResponse2001|error - Successful response. A successful response can return no matched data.
getCompletedStepsBusinessProcess
Isolated FunctionRemote Function
function getCompletedStepsBusinessProcess(string id, int? 'limit, int? offset) returns InlineResponse2002|errorRetrieves completed steps for a business process event.
Parameters
- id string - The Workday ID of the resource.
- '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
- InlineResponse2002|error - Successful response. A successful response can return no matched data.
getAllBusinessProcessTypes
Isolated FunctionRemote Function
function getAllBusinessProcessTypes(int? 'limit, int? offset) returns InlineResponse2003|errorRetrieves all business process types.
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
- InlineResponse2003|error - Successful response. A successful response can return no matched data.
getAttachmentBusinessProcessEvent
Isolated FunctionRemote Function
function getAttachmentBusinessProcessEvent(string id, int? 'limit, int? offset) returns InlineResponse2004|errorRetrieves attachments for a business process event.
Parameters
- id string - The Workday ID of the resource.
- '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
- InlineResponse2004|error - Successful response. A successful response can return no matched data.
getBusinessProcessTypeByID
Isolated FunctionRemote Function
function getBusinessProcessTypeByID(string id) returns BusinessProcessTypeDetails|errorRetrieves a business process type.
Parameters
- id string - The Workday ID of the resource.
Return Type
- BusinessProcessTypeDetails|error - Successful response. A successful response can return no matched data.
getBusinessProcessEventStepByID
Isolated FunctionRemote Function
function getBusinessProcessEventStepByID(string id) returns EventStepsView|errorRetrieves a business process event step.
Parameters
- id string - The Workday ID of the resource.
Return Type
- EventStepsView|error - Successful response. A successful response can return no matched data.
getCommentsBusinessProcessEvent
Isolated FunctionRemote Function
function getCommentsBusinessProcessEvent(string id, int? 'limit, int? offset) returns InlineResponse2005|errorRetrieves comments for a business process event.
Parameters
- id string - The Workday ID of the resource.
- '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
- InlineResponse2005|error - Successful response. A successful response can return no matched data.
getInProcessStepsBusinessProcessEvent
Isolated FunctionRemote Function
function getInProcessStepsBusinessProcessEvent(string id, int? 'limit, int? offset) returns InlineResponse2006|errorRetrieves in progress steps for a business process event.
Parameters
- id string - The Workday ID of the resource.
- '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
- InlineResponse2006|error - Successful response. A successful response can return no matched data.
deniesBusinessProcess
Isolated FunctionRemote Function
function deniesBusinessProcess(string id, BusinessProcessStepsDeny payload) returns BusinessProcessStepsDeny|errorDenies a business process event step.
Return Type
- BusinessProcessStepsDeny|error - Resource created.
getRetrievesInstances
Isolated FunctionRemote Function
function getRetrievesInstances(string? eventStep) returns MultipleInstanceModelReference|errorRetrieves instances that can be used as values for other endpoint parameters in this service.
Parameters
- eventStep string? (default ()) - Please do not add superclasses to, or relationships on this class without first discussing with the BPF team.
Return Type
- MultipleInstanceModelReference|error - Successful response. A successful response can return no matched data.
getRemainingStepsBusinessProcessEvent
Isolated FunctionRemote Function
function getRemainingStepsBusinessProcessEvent(string id, int? 'limit, int? offset) returns InlineResponse2007|errorRetrieves remaining steps for a business process event.
Parameters
- id string - The Workday ID of the resource.
- '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
- InlineResponse2007|error - Successful response. A successful response can return no matched data.
getAttachmentCategories
Isolated FunctionRemote Function
function getAttachmentCategories(string id, string? eventTarget, int? 'limit, int? offset) returns InlineResponse2008|errorRetrieves attachment categories for a business process type.
Parameters
- id string - The Workday ID of the resource.
- eventTarget string? (default ()) - The Workday ID of the event target that this business process is about. You can use a returned id from an API that returns instances of the event target type. For example, if your event target is a worker, use GET /workers in the Staffing service.
- '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
- InlineResponse2008|error - Successful response. A successful response can return no matched data.
getBusinessProcessEvent
Isolated FunctionRemote Function
function getBusinessProcessEvent(string id) returns EventDetails|errorRetrieves a business process event.
Parameters
- id string - The Workday ID of the resource.
Return Type
- EventDetails|error - Successful response. A successful response can return no matched data.
approveBusinessProcess
Isolated FunctionRemote Function
function approveBusinessProcess(string id, BusinessProcessStepsApprove payload) returns BusinessProcessStepsApprove|errorApproves a business process event step.
Return Type
- BusinessProcessStepsApprove|error - Resource created.
sendBackBusinessProcessEvent
Isolated FunctionRemote Function
function sendBackBusinessProcessEvent(string id, BusinessProcessStepSendBack payload) returns BusinessProcessStepSendBack|errorSends back a business process event step.
Return Type
- BusinessProcessStepSendBack|error - Resource created.
Records
workday.businessprocess: AttachmentCategoryView
Fields
- 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.businessprocess: AwaitingPerson
Fields
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.businessprocess: BusinessProcess
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: BusinessProcessStep
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: BusinessProcessStep2
Fields
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.businessprocess: BusinessProcessStepRef
Fields
- Fields Included from *BusinessProcessStep2
workday.businessprocess: BusinessProcessStepsApprove
Fields
- eventStatus EventStatus? -
- comment string? - Returns user's comment for Event Record.
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.businessprocess: BusinessProcessStepsDeny
Fields
- comment string? - Returns user's comment for Event Record.
- stepAction StepAction? -
- eventStatus EventStatus? -
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.businessprocess: BusinessProcessStepSendBack
Fields
- reason string - Returns user's comment for Event Record.
- to To -
- status StatusReadOnly? -
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.businessprocess: BusinessProcessTypeDetails
Fields
- helpText string? - The help text for the initiation step of a business process.
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.businessprocess: BusinessProcessTypeView
Fields
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.businessprocess: Category
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: ClientHttp1Settings
Closed record
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.businessprocess: Comments
Fields
- person Person? -
- comment string? - Comment
- commentDate string? - Gives the moment at which the instance was originally created.
workday.businessprocess: CompletedByPerson
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: CompletedStepsView
Fields
- awaitingPersons AwaitingPerson[]? - The people this event is currently awaiting for action.
- event Event? -
- completedDate string? - The date when this step was completed
- creationDate string? - The date when the event record was created.
- status Status? -
- completedByPerson CompletedByPerson? -
- 'order string? - Retired. We retire this report field because when there are multiple steps on the business process definition that are associated with this event step, this report field doesn't return the order for each associated step. We recommend that you use the Order report field instead.
- parallelStepInboxOrder string? - The order that parallel steps display in the Inbox. This will be populated only if this Business Process Type allows configuration of Parallel Step Inbox Order. If there are multiple steps from the business process definition that are associated to this event step, this field returns no value.
- comments Comments[]? - Returns the comments for the business process event step
- dueDate string? - Returns the due date for this step.
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.businessprocess: ConnectionConfig
Closed record
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-forwardedheader
- 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.businessprocess: ContentType
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: DueDate
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: ErrorModelReference
Fields
- 'error string - A description of the error
workday.businessprocess: Event
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: EventAttachmentsView
Fields
- uploadedBy UploadedBy? -
- description string? - Event attachment description
- category Category? -
- contentType ContentType? -
- fileLength int? - File length of the attachment
- fileName string? - File name of the attachment
- uploadDate string? - Returns Date the Business Process Attachment was updated.
- id string? - Id of the instance
workday.businessprocess: EventDetails
Fields
- subBusinessProcesses SubBusinessProcess[]? - Returns other Business Processes (sub-processes) part of this process, including processes multiple levels down.
- dueDate string? - The date the business process needs to be completed.
- for For? -
- overallBusinessProcess OverallBusinessProcess? -
- completedDate string? - The date and time the business process was completed.
- creationDate string? - Date the business process was initiated.
- status Status? -
- initiator Initiator? -
- effectiveDate string? - The date this business process takes effect.
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.businessprocess: EventStatus
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: EventStepsSummary
Fields
- stepEvent StepEvent? -
- creationDate string? - The date when the event record was created.
- stepHelpText string? - This CRF returns the step help text that is configured for the Workflow Step of the Event Record.
- overallProcess OverallProcess? -
- delayedDate string? - The date the delayed step will trigger.
- completedDate string? - The date when this step was completed
- task Task? -
- awaitingPersons AwaitingPerson[]? - The people this event is currently awaiting for action.
- businessProcessStep BusinessProcessStep? -
- stepType StepType? -
- businessProcess BusinessProcess? -
- parallelStepInboxOrder string? - The order that parallel steps display in the Inbox. This will be populated only if this Business Process Type allows configuration of Parallel Step Inbox Order. If there are multiple steps from the business process definition that are associated to this event step, this field returns no value.
- completedByPerson CompletedByPerson? -
- comments Comments[]? - Returns the comments for the business process event step
- status Status? -
- 'order string? - Retired. We retire this report field because when there are multiple steps on the business process definition that are associated with this event step, this report field doesn't return the order for each associated step. We recommend that you use the Order report field instead.
- dueDate string? - Returns the due date for this step.
- event Event? -
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.businessprocess: EventStepsView
Fields
- delayedDate string? - The date the delayed step will trigger.
- stepEvent StepEvent? -
- businessProcessStep BusinessProcessStep? -
- parallelStepInboxOrder string? - The order that parallel steps display in the Inbox. This will be populated only if this Business Process Type allows configuration of Parallel Step Inbox Order. If there are multiple steps from the business process definition that are associated to this event step, this field returns no value.
- status Status? -
- dueDate string? - Returns the due date for this step.
- stepType StepType? -
- 'order string? - Retired. We retire this report field because when there are multiple steps on the business process definition that are associated with this event step, this report field doesn't return the order for each associated step. We recommend that you use the Order report field instead.
- stepHelpText string? - This CRF returns the step help text that is configured for the Workflow Step of the Event Record.
- businessProcess BusinessProcess? -
- completedDate string? - The date when this step was completed
- task Task? -
- awaitingPersons AwaitingPerson[]? - The people this event is currently awaiting for action.
- overallProcess OverallProcess? -
- comments Comments[]? - Returns the comments for the business process event step
- event Event? -
- completedByPerson CompletedByPerson? -
- questionnaire Questionnaire? -
- creationDate string? - The date when the event record was created.
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.businessprocess: FacetsModelReferenceInner
This object represents the possible facets for this resource
Fields
- descriptor string? - A description of the facet
- facetParameter string? - The alias used to select the facet
workday.businessprocess: For
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: Initiator
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: InlineResponse200
collection something or other
Fields
- data EventStepsSummary[]? -
- total int? -
workday.businessprocess: InlineResponse2001
collection something or other
Fields
- data EventDetails[]? -
- total int? -
workday.businessprocess: InlineResponse2002
collection something or other
Fields
- data CompletedStepsView[]? -
- total int? -
workday.businessprocess: InlineResponse2003
collection something or other
Fields
- data BusinessProcessTypeView[]? -
- total int? -
workday.businessprocess: InlineResponse2004
collection something or other
Fields
- data EventAttachmentsView[]? -
- total int? -
workday.businessprocess: InlineResponse2005
collection something or other
Fields
- data Comments[]? -
- total int? -
workday.businessprocess: InlineResponse2006
collection something or other
Fields
- data StepsInProgressView[]? -
- total int? -
workday.businessprocess: InlineResponse2007
collection something or other
Fields
- data RemainingStepView[]? -
- total int? -
workday.businessprocess: InlineResponse2008
collection something or other
Fields
- data AttachmentCategoryView[]? -
- total int? -
workday.businessprocess: InstanceModelReference
Fields
- id string - wid / id / reference id
- descriptor string? - A description of the instance
- href string? - A link to the instance
workday.businessprocess: MultipleInstanceModelReference
Fields
- total int? -
- data InstanceModelReference[]? -
workday.businessprocess: OverallBusinessProcess
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: OverallProcess
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: Person
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: ProxyConfig
Closed record
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.businessprocess: Questionnaire
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: RemainingStepView
Fields
- completionStep boolean? - Returns true if this step completes the business process.
- stepType StepType? -
- groups SecurityGroupView[]? - Returns the security groups that can perform the workflow step.
- step string? - Returns the alternate name of the workflow step for the business process definition.
- dueDate DueDate? -
- parallelStepInboxOrder string? - This report field controls ordering of parallel steps in Inbox. It will be populated only if this Business Process Type allows configuration of Parallel Step Inbox Order.
- 'order string? - Returns the order of this step within the business process definition it is part of.
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.businessprocess: SecurityGroupView
Fields
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.businessprocess: Status
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: StatusReadOnly
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: StepAction
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: StepEvent
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: StepsInProgressView
Fields
- delayedDate string? - The date the delayed step will trigger.
- dueDate string? - Returns the due date for this step.
- anonymous boolean? - Returns if the event step has been anonymously assigned.
- businessProcessStep BusinessProcessStepRef? -
- 'order string? - Retired. We retire this report field because when there are multiple steps on the business process definition that are associated with this event step, this report field doesn't return the order for each associated step. We recommend that you use the Order report field instead.
- parallelStepInboxOrder string? - The order that parallel steps display in the Inbox. This will be populated only if this Business Process Type allows configuration of Parallel Step Inbox Order. If there are multiple steps from the business process definition that are associated to this event step, this field returns no value.
- awaitingPersons AwaitingPerson[]? - The people this event is currently awaiting for action.
- creationDate string? - The date when the event record was created.
- status Status? -
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.businessprocess: StepType
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: SubBusinessProcess
Fields
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.businessprocess: Task
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: To
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: UploadedBy
Fields
- Fields Included from *InstanceModelReference
workday.businessprocess: ValidationErrorModelReference
Fields
- Fields Included from *ErrorModelReference
- error string
- anydata...
- errors ErrorModelReference[]? - An array of validation errors