Module workday.common
ballerinax/workday.common Ballerina library
1.5.2
Overview
The WorkDay Common REST API v1 connector(https://community.workday.com/sites/default/files/file-hosting/restapi/index.html) OpenAPI specification.
The WorkDay common service enables applications to access REST service for common resources shared by multiple product areas.
Key Features
- Programmatic access to create and manage resources via REST API
- Secure authentication with API key or OAuth support
- Seamless integration with REST API endpoints
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.common: Client
Isolated
This is a generated connector for WorkDay Common Service REST API v1 OpenAPI specification. The WorkDay common service enables applications to access REST service for common resources shared by multiple product areas.
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
getCollectionOfWorkers
Isolated FunctionRemote Function
function getCollectionOfWorkers(int? 'limit, int? offset, string? search) returns InlineResponse200|errorRetrieves a collection of workers.
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.
- search string? (default ()) - Searches ~workers~ by name. The search is case-insensitive. You can include space-delimited search strings for an OR search.
Return Type
- InlineResponse200|error - Successful response. A successful response can return no matched data.
getWorkerReports
Isolated FunctionRemote Function
function getWorkerReports(string id, int? 'limit, int? offset) returns InlineResponse200|errorRetrieves a collection of direct reports for a specific worker.
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
- InlineResponse200|error - Successful response. A successful response can return no matched data.
getReportForWorker
Isolated FunctionRemote Function
function getReportForWorker(string id, string subresourceID) returns WorkerSummary|errorRetrieves a direct report instance for a specific worker.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
Return Type
- WorkerSummary|error - Successful response. A successful response can return no matched data.
getOrgForWorker
Isolated FunctionRemote Function
function getOrgForWorker(string id, int? 'limit, int? offset) returns InlineResponse2001|errorRetrieves a collection of organizations for a specific worker.
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
- InlineResponse2001|error - Successful response. A successful response can return no matched data.
getWorkerOrganization
Isolated FunctionRemote Function
function getWorkerOrganization(string id, string subresourceID) returns WorkerOrganizationSummary|errorRetrieves an organization instance for a specific worker.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
Return Type
- WorkerOrganizationSummary|error - Successful response. A successful response can return no matched data.
getTaskForWorker
Isolated FunctionRemote Function
function getTaskForWorker(string id, int? 'limit, int? offset) returns InlineResponse2002|errorRetrieves a collection of inbox tasks for a specific worker.
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.
getInboxTaskForWorker
Isolated FunctionRemote Function
function getInboxTaskForWorker(string id, string subresourceID) returns InboxTaskSummary|errorRetrieves an inbox task instance for a specific worker.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
Return Type
- InboxTaskSummary|error - Successful response. A successful response can return no matched data.
getTimeOffEntriesForWorker
Isolated FunctionRemote Function
function getTimeOffEntriesForWorker(string id, int? 'limit, int? offset) returns InlineResponse2003|errorRetrieves a collection of time off entries for a specific worker.
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
- InlineResponse2003|error - Successful response. A successful response can return no matched data.
getTimeOffEntryForWorker
Isolated FunctionRemote Function
function getTimeOffEntryForWorker(string id, string subresourceID) returns TimeOffEntries|errorRetrieves a time off entry for a specific worker.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
Return Type
- TimeOffEntries|error - Successful response. A successful response can return no matched data.
getTimeOffPlansForWorker
Isolated FunctionRemote Function
function getTimeOffPlansForWorker(string id, int? 'limit, int? offset) returns InlineResponse2004|errorRetrieves a collection of time off plans for a specific worker.
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.
getTimeOffPlan
Isolated FunctionRemote Function
function getTimeOffPlan(string id, string subresourceID) returns TimeOffPlans|errorRetrieves a particular time off plan for a specific worker.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
Return Type
- TimeOffPlans|error - Successful response. A successful response can return no matched data.
getHistoryItemsForWorker
Isolated FunctionRemote Function
function getHistoryItemsForWorker(string id, int? 'limit, int? offset) returns InlineResponse2005|errorRetrieves a collection of history items for a specific worker.
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.
getHistoryInstanceForWorker
Isolated FunctionRemote Function
function getHistoryInstanceForWorker(string id, string subresourceID) returns BusinessProcessSummary|errorRetrieves a history instance for a specific worker.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
Return Type
- BusinessProcessSummary|error - Successful response. A successful response can return no matched data.
getCollectionBusinessTitleChanges
Isolated FunctionRemote Function
function getCollectionBusinessTitleChanges(string id, int? 'limit, int? offset) returns InlineResponse2006|errorRetrieves a collection of business title changes for a specific worker.
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.
createBusinessTitleChange
Isolated FunctionRemote Function
function createBusinessTitleChange(string id, BusinessTitleChangeInput payload) returns BusinessTitleChangeInput|errorCreates a business title change instance with the specified data.
Return Type
- BusinessTitleChangeInput|error - Resource created.
getBusinessTitleChangeForWorker
Isolated FunctionRemote Function
function getBusinessTitleChangeForWorker(string id, string subresourceID) returns BusinessTitleChangeDetail|errorRetrieves a business title change instance for a specific worker.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
Return Type
- BusinessTitleChangeDetail|error - Successful response. A successful response can return no matched data.
getSupervisoryOrgsManagedByWorker
Isolated FunctionRemote Function
function getSupervisoryOrgsManagedByWorker(string id, int? 'limit, int? offset) returns InlineResponse2007|errorRetrieves a collection of supervisory organizations managed by a specific worker.
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.
getSupervisoryOrgManagedByWorker
Isolated FunctionRemote Function
function getSupervisoryOrgManagedByWorker(string id, string subresourceID) returns SupervisoryOrganizationSummary|errorRetrieves a supervisory organization managed by a specific worker.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
Return Type
- SupervisoryOrganizationSummary|error - Successful response. A successful response can return no matched data.
getPaySlipsForWorker
Isolated FunctionRemote Function
function getPaySlipsForWorker(string id, int? 'limit, int? offset) returns InlineResponse2008|errorRetrieves a collection of pay slips for a specific worker.
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
- InlineResponse2008|error - Successful response. A successful response can return no matched data.
getPaySlipInstancesForWorker
Isolated FunctionRemote Function
function getPaySlipInstancesForWorker(string id, string subresourceID) returns PaySlipSummary|errorRetrieves a pay slip instance for a specific worker.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
Return Type
- PaySlipSummary|error - Successful response. A successful response can return no matched data.
getWorkerInstance
Isolated FunctionRemote Function
function getWorkerInstance(string id) returns WorkerProfile|errorRetrieves a worker instance.
Parameters
- id string - The Workday ID of the resource.
Return Type
- WorkerProfile|error - Successful response. A successful response can return no matched data.
createJobChange
Isolated FunctionRemote Function
function createJobChange(string id, ChangeJobInput payload) returns ChangeJobInput|errorCreates a job change instance with the specified data.
Return Type
- ChangeJobInput|error - Resource created.
getBusinessTitle
Isolated FunctionRemote Function
function getBusinessTitle(string id) returns BusinessTitleChangeDetail|errorRetrieves a business title change instance.
Parameters
- id string - The Workday ID of the resource.
Return Type
- BusinessTitleChangeDetail|error - Successful response. A successful response can return no matched data.
getCurrencies
Isolated FunctionRemote Function
function getCurrencies(int? 'limit, int? offset) returns InlineResponse2009|errorRetrieves a collection of currencies.
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
- InlineResponse2009|error - Successful response. A successful response can return no matched data.
getCurrencyInstance
Isolated FunctionRemote Function
function getCurrencyInstance(string id) returns CurrencySummary|errorRetrieves a currency instance.
Parameters
- id string - The Workday ID of the resource.
Return Type
- CurrencySummary|error - Successful response. A successful response can return no matched data.
getAuditLogs
Isolated FunctionRemote Function
function getAuditLogs(string? 'from, int? instancesReturned, int? 'limit, int? offset, boolean? returnUserActivityEntryCount, string? systemAccount, string? taskId, string? to) returns InlineResponse20010|errorRetrieves a collection of audit logs.
Parameters
- 'from string? (default ()) - Returns value entered in "From Moment" parm
- instancesReturned int? (default ()) - Numeric
- '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.
- returnUserActivityEntryCount boolean? (default ()) - Boolean
- systemAccount string? (default ()) - The system account that initiated the request.
- taskId string? (default ()) - The Workday ID of the task executed in the transaction.
- to string? (default ()) - Returns value entered in "To Moment" parm
Return Type
- InlineResponse20010|error - Successful response. A successful response can return no matched data.
getAuditLogInstance
Isolated FunctionRemote Function
function getAuditLogInstance(string id) returns UserActivityTracking|errorRetrieves an audit log instance.
Parameters
- id string - The Workday ID of the resource.
Return Type
- UserActivityTracking|error - Successful response. A successful response can return no matched data.
getCollectionOfSupervisoryOrgs
Isolated FunctionRemote Function
function getCollectionOfSupervisoryOrgs(int? 'limit, int? offset) returns InlineResponse2007|errorRetrieves a collection of supervisory organizations.
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
- InlineResponse2007|error - Successful response. A successful response can return no matched data.
getSupervisoryOrgInstance
Isolated FunctionRemote Function
function getSupervisoryOrgInstance(string id) returns SupervisoryOrganizationSummary|errorRetrieves a supervisory organization instance.
Parameters
- id string - The Workday ID of the resource.
Return Type
- SupervisoryOrganizationSummary|error - Successful response. A successful response can return no matched data.
getWorkersOfSupervisoryOrg
Isolated FunctionRemote Function
function getWorkersOfSupervisoryOrg(string id, int? 'limit, int? offset) returns InlineResponse200|errorRetrieves a collection of workers for a specific supervisory organization.
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
- InlineResponse200|error - Successful response. A successful response can return no matched data.
getWorkerForSupervisoryOrg
Isolated FunctionRemote Function
function getWorkerForSupervisoryOrg(string id, string subresourceID) returns WorkerSummary|errorRetrieves a worker instance for a specific supervisory organization.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
Return Type
- WorkerSummary|error - Successful response. A successful response can return no matched data.
getJobChangeReason
Isolated FunctionRemote Function
function getJobChangeReason(int? 'limit, int? offset) returns InlineResponse20011|errorRetrieves a collection of job change reasons.
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
- InlineResponse20011|error - Successful response. A successful response can return no matched data.
getJobChangeInstance
Isolated FunctionRemote Function
function getJobChangeInstance(string id) returns JobChangeReasonSummary|errorRetrieves a job change reason instance.
Parameters
- id string - The Workday ID of the resource.
Return Type
- JobChangeReasonSummary|error - Successful response. A successful response can return no matched data.
validateWorkTagTypes
Isolated FunctionRemote Function
function validateWorkTagTypes(ValidateWorktagInput payload) returns ValidateWorktagInput|errorValidates the allowed and required worktag types and worktag combinations for a transaction.
Parameters
- payload ValidateWorktagInput -
Return Type
- ValidateWorktagInput|error - Resource created.
getCustomerInstance
Isolated FunctionRemote Function
Retrieves a customer instance.
Parameters
- id string - The Workday ID of the resource.
getWorkerActivities
Isolated FunctionRemote Function
function getWorkerActivities(string id, string? fromDate, int? 'limit, int? offset, string? toDate) returns InlineResponse20012|errorRetrieves a collection of activities for a specific customer.
Parameters
- id string - The Workday ID of the resource.
- fromDate string? (default ()) - The transaction date for the reporting transaction. NOTE: If used a filtering criteria for expense reports, please use Expense Report Date report field instead to improve performance.
- '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.
- toDate string? (default ()) - The transaction date for the reporting transaction. NOTE: If used a filtering criteria for expense reports, please use Expense Report Date report field instead to improve performance.
Return Type
- InlineResponse20012|error - Successful response. A successful response can return no matched data.
getActivityForCustomer
Isolated FunctionRemote Function
Retrieves an activity instance for a specific customer.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
getOrgCollection
Isolated FunctionRemote Function
function getOrgCollection(int? 'limit, int? offset) returns InlineResponse20013|errorRetrieves a collection of organizations.
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
- InlineResponse20013|error - Successful response. A successful response can return no matched data.
getOrgInstance
Isolated FunctionRemote Function
function getOrgInstance(string id) returns OrganizationSummary|errorRetrieves an organization instance.
Parameters
- id string - The Workday ID of the resource.
Return Type
- OrganizationSummary|error - Successful response. A successful response can return no matched data.
getOrganizationTypes
Isolated FunctionRemote Function
function getOrganizationTypes(int? 'limit, int? offset) returns InlineResponse20014|errorRetrieves a collection of organization 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
- InlineResponse20014|error - Successful response. A successful response can return no matched data.
getOrgTypeInstance
Isolated FunctionRemote Function
function getOrgTypeInstance(string id) returns OrganizationTypeSummary|errorRetrieves an organization type instance.
Parameters
- id string - The Workday ID of the resource.
Return Type
- OrganizationTypeSummary|error - Successful response. A successful response can return no matched data.
Records
workday.common: Activity
Fields
- invoiceOpportunity? InvoiceOpportunity -
- paymentReference? string - The check number for a customer payment. This is a reference number that's available only when processed through a settlement run and not a check number.
- transactionAmountSigned? record {} - The positive or negative sign of the transaction amount for this customer transaction. This is for internal use only on a REST API.
- transactionDate? string - The date of the customer transaction. This field is for internal use only on a REST API.
- transactionType? string - The transaction type of this customer transaction. This is for internal use only on a REST API.
- applicationStatus? string - The payment or application status of the customer invoice, customer invoice adjustment or customer invoice payment. For customer invoice payments, the application status can be Unapplied, Applied with On Account, or Fully Applied. For invoices, the payment status can be Paid, Partially Paid, or Unpaid.
- transactionStatus? string - The current status of the transaction. Applicable for all transaction types. This is for internal use only on a REST API.
- transactionNumber? string - The transaction number for the reporting transaction. This is for internal use only on a REST API.
- invoiceDueDate? string - The due date of the customer invoice or invoice adjustment as of the defined reporting date.
- id? string - Returns the Workday ID for a given object.
workday.common: BusinessObject
Fields
- Fields Included from *InstanceModelReference
workday.common: BusinessObjectFilter
Fields
- Fields Included from *InstanceModelReference
workday.common: BusinessProcessSummary
Fields
- subject? Subject -
- initiator? Initiator -
- effective? string - The date this business process takes effect.
- due? string - The date the business process needs to be completed.
- initiated? string - The date and time this business process was initiated.
- descriptor? string - A preview of the instance
- href? string - A link to the instance
- id? string - Id of the instance
workday.common: BusinessTitleChangeDetail
Fields
- currentBusinessTitle? string - The business title for the ~worker~ prior to this business process. If there is no business title override, this field defaults to the job title or job profile name.
- proposedBusinessTitle? string - The new business title for the ~worker~ as of the effective date. If there is no business title override, this field defaults to the job title or job profile name.
- effective? string - The date this business process takes effect.
- due? string - The date the business process needs to be completed.
- initiated? string - The date and time this business process was initiated.
- initiator? Initiator -
- subject? Subject -
- descriptor? string - A preview of the instance
- href? string - A link to the instance
- id? string - Id of the instance
workday.common: BusinessTitleChangeInput
Fields
- proposedBusinessTitle? string - The new business title for the ~worker~ as of the effective date. If there is no business title override, this field defaults to the job title or job profile name.
- descriptor? string - A preview of the instance
- href? string - A link to the instance
- id? string - Id of the instance
workday.common: ChangeJobInput
Fields
- supervisoryOrganization? SupervisoryOrganization -
- jobChangeReason? JobChangeReason -
- moveManagersTeam? boolean - Returns a boolean that indicates whether teams reporting to the ~Manager~ moved with them during the Change Job Event.
- effective? string - The date this business process takes effect.
- proposedOrganizations? ProposedStaffsInput[] - Contains the organizations with staffing behavior that are assigned to the position as a result of this event. All staffing behavior organization types are included (company, cost center, region, custom organizations, fund, grant, program, gift, business unit).
- descriptor? string - A preview of the instance
- href? string - A link to the instance
- id? string - Id of the instance
workday.common: 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.common: 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.common: CurrencySummary
Fields
- code? string - Currency id - 3 character currency code identified by ISO 4217
- precision? int - Decimal precision for currency amounts
- href? string - A link to the instance
- descriptor? string - A preview of the instance
- id? string - Id of the instance
workday.common: Customer
Fields
- name? string - The name of the customer.
- descriptor? string - A preview of the instance
- id? string - Id of the instance
workday.common: Employee
Fields
- Fields Included from *InstanceModelReference
workday.common: ErrorModelReference
Fields
- 'error string - A description of the error
workday.common: EventRecordAssigneeView
Fields
- assignedToWorkers? WorkerSummary[] - ~Workers~ assigned to this step.
- descriptor? string - A preview of the instance
- href? string - A link to the instance
- id? string - Id of the instance
workday.common: InboxTaskSummary
Fields
- initiator? Initiator -
- stepType? StepType -
- status? Status -
- overallProcess? OverallProcess -
- subject? Subject -
- due? string - Returns the due date for this step.
- assigned? string - Returns the date when the event record was last updated on.
- descriptor? string - A preview of the instance
- href? string - A link to the instance
- id? string - Id of the instance
workday.common: Initiator
Fields
- Fields Included from *InstanceModelReference
workday.common: InlineResponse200
collection something or other
Fields
- data? WorkerSummary[] -
- total? int -
workday.common: InlineResponse2001
collection something or other
Fields
- data? WorkerOrganizationSummary[] -
- total? int -
workday.common: InlineResponse20010
collection something or other
Fields
- data? UserActivityTracking[] -
- total? int -
workday.common: InlineResponse20011
collection something or other
Fields
- data? JobChangeReasonSummary[] -
- total? int -
workday.common: InlineResponse20012
collection something or other
Fields
- data? Activity[] -
- total? int -
workday.common: InlineResponse20013
collection something or other
Fields
- data? OrganizationSummary[] -
- total? int -
workday.common: InlineResponse20014
collection something or other
Fields
- data? OrganizationTypeSummary[] -
- total? int -
workday.common: InlineResponse2002
collection something or other
Fields
- data? InboxTaskSummary[] -
- total? int -
workday.common: InlineResponse2003
collection something or other
Fields
- data? TimeOffEntries[] -
- total? int -
workday.common: InlineResponse2004
collection something or other
Fields
- data? TimeOffPlans[] -
- total? int -
workday.common: InlineResponse2005
collection something or other
Fields
- data? BusinessProcessSummary[] -
- total? int -
workday.common: InlineResponse2006
collection something or other
Fields
- data? BusinessTitleChangeDetail[] -
- total? int -
workday.common: InlineResponse2007
collection something or other
Fields
- data? SupervisoryOrganizationSummary[] -
- total? int -
workday.common: InlineResponse2008
collection something or other
Fields
- data? PaySlipSummary[] -
- total? int -
workday.common: InlineResponse2009
collection something or other
Fields
- data? CurrencySummary[] -
- total? int -
workday.common: InstanceModelReference
Fields
- id string - wid / id / reference id
- descriptor? string - A description of the instance
- href? string - A link to the instance
workday.common: InvoiceOpportunity
Fields
- Fields Included from *OpportunityDisplay
workday.common: JobChangeReason
Fields
- Fields Included from *InstanceModelReference
workday.common: JobChangeReasonSummary
Fields
- isForContingentWorker? boolean - Identifies whether the reason is allowed to be entered for ~contingent workers~.
- isForEmployee? boolean - Identifies whether the reason is allowed to be entered for ~employees~.
- managerReason? boolean - Identifies whether the reason is allowed to be entered by ~managers~.
- descriptor? string - A preview of the instance
- href? string - A link to the instance
- id? string - Id of the instance
workday.common: Location
Fields
- Fields Included from *InstanceModelReference
workday.common: Manager
Fields
- Fields Included from *InstanceModelReference
workday.common: OpportunityDisplay
Fields
- name? string - The non-unique name of the Opportunity. This is for internal use only.
- id? string - Returns the Workday ID for a given object.
- opportunityReferenceID? string - The Reference id to use for lookups within our Workday Web Services. For ~supervisory organizations~, this is also the 'Organization id'
workday.common: OrganizationSummary
Fields
- href? string - A link to the instance
- id? string - Id of the instance
- descriptor? string - A preview of the instance
workday.common: OrganizationType
Fields
- Fields Included from *InstanceModelReference
workday.common: OrganizationTypeSummary
Fields
- descriptor? string - A preview of the instance
- href? string - A link to the instance
- id? string - Id of the instance
workday.common: OverallProcess
Fields
- Fields Included from *InstanceModelReference
workday.common: Owner
Fields
- Fields Included from *InstanceModelReference
workday.common: PaySlipSummary
Fields
- net? int - Net Pay for a Payroll Result
- gross? int - Gross Pay for a Payroll Result
- status? Status -
- date? string - Payment Date
- descriptor? string - A preview of the instance
- href? string - A link to the instance
- id? string - Id of the instance
workday.common: PhaseDetails
Fields
- name? string - The name of the ~project plan phase~.
- rowId? string - The WBS UI id of ~Project Plan Phase~.
- tasks? TaskDetails[] - The ~project tasks~ for the ~project phase~.
- href? string - A link to the instance
- id? string - Id of the instance
- descriptor? string - A preview of the instance
workday.common: Plan
Fields
- Fields Included from *InstanceModelReference
workday.common: PrimarySupervisoryOrganization
Fields
- Fields Included from *InstanceModelReference
workday.common: ProposedStaffsInput
Fields
- href? string - A link to the instance
- id? string - Id of the instance
- descriptor? string - A preview of the instance
workday.common: 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.common: RestrictionInput
Fields
- href? string - A link to the instance
- id? string - Id of the instance
- descriptor? string - A preview of the instance
workday.common: Status
Fields
- Fields Included from *InstanceModelReference
workday.common: StepType
Fields
- Fields Included from *InstanceModelReference
workday.common: Subject
Fields
- Fields Included from *InstanceModelReference
workday.common: SupervisoryOrganization
Fields
- Fields Included from *InstanceModelReference
workday.common: SupervisoryOrganizationSummary
Fields
- manager? Manager -
- workers? string - Contains the ~workers~ in the organization.
- name? string - The organization name for the organization.
- code? string - The organization id for the organization.
- href? string - A link to the instance
- id? string - Id of the instance
- descriptor? string - A preview of the instance
workday.common: TaggableConfiguration
Fields
- Fields Included from *InstanceModelReference
workday.common: Target
Fields
- Fields Included from *InstanceModelReference
workday.common: TaskDetails
Fields
- startDate? string - The start date of the ~project task~.
- percentComplete? int - The progress of the ~project task~.
- rowId? string - The WBS id of ~Project Plan Task~.
- name? string - The name of the ~project plan task~.
- endDate? string - The end date of the ~project task~.
- descriptor? string - A preview of the instance
- href? string - A link to the instance
- id? string - Id of the instance
workday.common: TimeOff
Fields
- Fields Included from *TimeOffRef
workday.common: TimeOffEntries
Fields
- units? int - The units entered for a time off request line item.
- employee? Employee -
- unitOfTime? UnitOfTime -
- timeOffRequest? TimeOffRequest -
- date? string - The date requested to be taken for a paid time off request line item.
- timeOff? TimeOff -
- href? string - A link to the instance
- descriptor? string - A preview of the instance
- id? string - Id of the instance
workday.common: TimeOffEntryStatus
Fields
- status? string - The current status of the business process. For example: Successfully Completed, Denied, Terminated.
- descriptor? string - A preview of the instance
- href? string - A link to the instance
- id? string - Id of the instance
workday.common: TimeOffPlans
Fields
- timeOffBalance? int - Returns the time off balance including pending events for the ~worker~ and time off plan. This report field should be used within Calculated Fields.
- unitOfTime? UnitOfTime -
- descriptor? string - A preview of the instance
- href? string - A link to the instance
- id? string - Id of the instance
workday.common: TimeOffRef
Fields
- plan? Plan -
- descriptor? string - A preview of the instance
- href? string - A link to the instance
- id? string - Id of the instance
workday.common: TimeOffRequest
Fields
- Fields Included from *TimeOffEntryStatus
workday.common: TransactionStatus
Fields
- Fields Included from *InstanceModelReference
workday.common: UnitOfTime
Fields
- Fields Included from *InstanceModelReference
workday.common: UserActivityTracking
Fields
- target? Target -
- ipAddress? string - The user's IP Address from the user signon used to make the request.
- userAgent? string - The client browser and operating system information from the user signon used to make this request.
- deviceType? string - The device type from the user signon used to make the request.
- taskId? string - The Workday ID of the task executed in the transaction.
- systemAccount? string - The system account that initiated the request.
- sessionId? string - The system id for tracking signons from the user signon used to make the request.
- userActivityEntryCount? int - Returns the User Activity Count for the inputted filter parameters
- requestTime? string - The request time of the action.
- taskDisplayName? string - The action executed in the transaction.
- activityAction? string - The type of action that was executed.
workday.common: ValidateWorktagInput
Fields
- validationTypes? WorkTagValidationTypeInput[] - Do Not Use. This CRF can be used only by REST APIs. Indicates a set of validation types which should be included in the REST response. If this request parm is not present or is empty, then all validation types supported by the 'validateWorktags' REST API will be included in the response.
- restrictions? RestrictionInput[] - Do Not Use. This CRF can be used only by REST APIs. Restrictions to be validated in combination with the worktags.
- onlyOneProjectOrPhaseOrTaskAllowed? string - Do Not Use. This CRF can be used only by REST APIs. Only one worktag value of type ~Project~, ~Project Phase~ or ~Project Task~ is allowed to be sent in the request. This error indicates that the set of worktags contains more than one worktag of these types.
- nonAllowedWorktagTypesForTaggableConfig? WorktagTypeInput[] - Do Not Use. This CRF can be used only by REST APIs. Set of worktag types sent in the request that are not allowed by the Taggable configuration.
- missingRequiredWorktagTypesForTaggableConfig? WorktagTypeInput[] - Do Not Use. This CRF can be used only by REST APIs. Worktag types which are configured as required for the Taggable configuration but are not sent in the request.
- nonAllowedInactiveWorktagValues? WorktagInput[] - Do Not Use. This CRF can be used only by REST APIs. Set of inactive worktags sent in the request which are disallowed by the Taggable configuration.
- status? string - Do Not Use. This CRF can be used only by REST APIs. Indicates whether the worktags sent in the request are valid or have any validation errors.
- invalidWorktagCombinations? WorkTagsComboInput[] - Do Not Use. This CRF can be used only by REST APIs. Represents the pair of related worktag and a set of worktags which are not allowed by the configuration for that related worktag.
- taggableConfiguration? TaggableConfiguration -
- missingRequiredWorktagTypesAfterDefaulting? WorktagTypeInput[] - Do Not Use. This CRF can be used only by REST APIs. Worktag types which are configured as required for the taggable configuration but are not explicitly sent in the request and are not defaulted from the related worktags.
workday.common: ValidationErrorModelReference
Fields
- Fields Included from *ErrorModelReference
- error string
- anydata...
- errors? ErrorModelReference[] - An array of validation errors
workday.common: WorkerOrganizationSummary
Fields
- organizationType? OrganizationType -
- href? string - A link to the instance
- descriptor? string - A preview of the instance
- id? string - Id of the instance
workday.common: WorkerProfile
Fields
- primaryWorkEmail? string - The primary work email address for the ~worker~.
- isManager? boolean - Identifies if the ~worker~ has a ~manager~ role.
- primaryWorkPhone? string - The primary work phone number for the ~worker~ including the area code and ~country~ code.
- location? Location -
- primarySupervisoryOrganization? PrimarySupervisoryOrganization -
- primaryWorkAddressText? string - Returns the primary work address for the ~worker~, or from their default primary work location, full format on a single line.
- yearsOfService? int - The years of service for the ~worker~.
- businessTitle? string - The business title for the ~worker's~ primary position. If no business title is defined for a position, the position title is returned back.
- dateOfBirth? string - The birth date of the ~worker~.
- supervisoryOrganizationsManaged? string - All ~supervisory organizations~, excluding inherited organizations, in which the ~worker~ has a leadership role.
- descriptor? string - A preview of the instance
- href? string - A link to the instance
- id? string - Id of the instance
workday.common: WorkersCompletedMostRecentStep
Fields
- Fields Included from *WorkerSummary
workday.common: WorkerSummary
Fields
- primaryWorkPhone? string - The primary work phone number for the ~worker~ including the area code and ~country~ code.
- isManager? boolean - Identifies if the ~worker~ has a ~manager~ role.
- primaryWorkEmail? string - The primary work email address for the ~worker~.
- businessTitle? string - The business title for the ~worker's~ primary position. If no business title is defined for a position, the position title is returned back.
- primarySupervisoryOrganization? PrimarySupervisoryOrganization -
- href? string - A link to the instance
- descriptor? string - A preview of the instance
- id? string - Id of the instance
workday.common: WorkTagAndRestrictionInput
Fields
- worktagWithRestrictedToValues? WorkTagWithRestrictedToValues -
- invalidRestrictedToValues? RestrictionInput[] - Do Not Use. This CRF can be used only by REST APIs. Indicates invalid 'Restricted To Values' for a worktag.
workday.common: WorkTagAndTypeInput
Fields
- missingWorktagTypes? WorktagTypeInput[] - Do Not Use. This CRF can be used only by REST APIs. Worktag types configured as required for a worktag with related worktags but not sent in the REST request.
workday.common: WorktagInput
Fields
- href? string - A link to the instance
- descriptor? string - A preview of the instance
- id? string - Id of the instance
workday.common: WorkTagsComboInput
Fields
- invalidWorktagValues? WorktagInput[] - Do Not Use. This CRF can be used only by REST APIs. Set of worktags from the REST request which are not valid for the anchor worktag with allowed values.
- worktagWithAllowedValues? WorktagWithAllowedValues -
workday.common: WorktagTypeInput
Fields
- descriptor? string - A preview of the instance
- href? string - A link to the instance
- id? string - Id of the instance
workday.common: WorkTagValidationTypeInput
Fields
- descriptor? string - A preview of the instance
- href? string - A link to the instance
- id? string - Id of the instance
workday.common: WorktagWithAllowedValues
Fields
- Fields Included from *InstanceModelReference
workday.common: WorkTagWithRequiredWorkTags
Fields
- Fields Included from *InstanceModelReference
workday.common: WorkTagWithRestrictedToValues
Fields
- Fields Included from *InstanceModelReference