Workday V3

Workday API Connector

This Connector allows you to interact with the Workday API. This connector is based on the Workday Rest API and uses version v3.

Prerequisites

The Workday asset requires an Host, Private Key, Client ID, and an org to interact with the API.

Capabilities

This connector provides the following capabilities:

Get Reported Hours for Worker

Notes

For more information on Workday API : Click here!

Configurations

Oauth 2.0 Client Credentials

Authenticates using oauth 2.0 client credentials

Configuration Parameters

Parameter	Description	Type	Required
url	Server Host Address	string	Required
private_key	Also created when you create a new Application in Cred Admin. You must save this key immedately upon creation of an Application. Workday does not hold this key for you.	string	Required
client_id	This is created when you create a new Application in Cred Admin	string	Required
org	This will be in your cred admin url. For example https://credentials.workday.com/gms/applications. In this case, the organization is gms.	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Get Reported Hours For Worker

Retrieves a summary of reported hours for a worker over a period.

Endpoint

URL: /api/timeTracking/v3/gms/workers/{{ID}}/timeTotals

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ID	string	Required	The Workday ID of the resource.
parameters.limit	number	Optional	The maximum number of objects in a single response. The default is 20. The maximum is 100.
parameters.offset	number	Optional	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.
parameters.periodDate	string	Optional	Contains the specified date used to match to a period containing the date. The default is today's date.

Input Example

{"parameters":{"limit":20,"offset":9,"periodDate":"date"},"path_parameters":{"ID":"16536"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
data	array	Response data
data.periodLabel	string	Response data
data.submitText	string	Response data
data.totals	array	Response data
data.totals.totalNumber	string	Response data
data.totals.quantity	string	Response data
data.totals.label	string	Response data
data.certifyText	string	Response data
total	number	Output field: total

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 30 oct 2023 20:37:23 GMT"},"reason":"OK","json_body":{"data":[{}],"total":0}}

Response Headers

Header	Description	Example
content-length	The length of the response body in bytes	140
content-type	The media type of the resource	application/json
Date	The date and time at which the message was originated	Wed, 30 oct 2023 20:37:23 GMT