Workday V2

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 v2.

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 Job by ID

Get Jobs

Get People by Universal ID

Get People by ID

Get Request by ID

Get Requests

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
host	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 job by ID

Retrieves a job with the specified job ID.

Endpoint

URL: /api/payroll/v2/gms/jobs/{{ID}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ID	string	Required	The Workday ID of the resource.

Input Example

{"path_parameters":{"ID":"16536"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
location	object	Output field: location
location.country	object	Output field: location.country
location.country.descriptor	string	Output field: location.country.descriptor
location.id	string	Unique identifier
location.descriptor	string	Output field: location.descriptor
businessTitle	string	Output field: businessTitle
worker	object	Output field: worker
worker.id	string	Unique identifier
worker.descriptor	string	Output field: worker.descriptor
supervisoryOrganization	object	Output field: supervisoryOrganization
supervisoryOrganization.id	string	Unique identifier
supervisoryOrganization.descriptor	string	Output field: supervisoryOrganization.descriptor
nextPayPeriodStartDate	string	Date value
jobType	object	Type of the resource
jobType.descriptor	string	Type of the resource
jobProfile	object	Output field: jobProfile
jobProfile.id	string	Unique identifier
jobProfile.descriptor	string	Output field: jobProfile.descriptor
id	string	Unique identifier
descriptor	string	Output field: descriptor

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":{"location":{"country":{},"id":"string","descriptor":"Lorem ipsum dolor sit ame"},"businessTitle":"Sample Business Title","worker":{"id":"string","descriptor":"Lorem ipsum dolor sit ame"},"supervisoryOrganization":{"id":"string","descriptor":"Lorem ipsum dolor sit ame"},"nextPayPeriodStartDate":"2020-01-27T16:00:00.000Z","jobType":{"des...

Get Jobs

Retrieves a collection of jobs.

Endpoint

URL: /api/payroll/v2/gms/jobs

Method: GET

Input

Argument Name	Type	Required	Description
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.

Input Example

{"parameters":{"limit":20,"offset":9}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
data	array	Response data
data.location	object	Response data
data.location.country	object	Response data
data.location.country.descriptor	string	Response data
data.location.id	string	Response data
data.location.descriptor	string	Response data
data.businessTitle	string	Response data
data.worker	object	Response data
data.worker.id	string	Response data
data.worker.descriptor	string	Response data
data.supervisoryOrganization	object	Response data
data.supervisoryOrganization.id	string	Response data
data.supervisoryOrganization.descriptor	string	Response data
data.nextPayPeriodStartDate	string	Response data
data.jobType	object	Response data
data.jobType.descriptor	string	Response data
data.jobProfile	object	Response data
data.jobProfile.id	string	Response data
data.jobProfile.descriptor	string	Response data
data.id	string	Response data
data.descriptor	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}}

Get People by ID

Retrieves a person with the specified ID.

Endpoint

URL: /api/person/v2/gms/people/{{ID}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ID	string	Required	The Workday ID of the resource.

Input Example

{"path_parameters":{"ID":"16536"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
photos	string	Output field: photos
homeEmails	string	Output field: homeEmails
personalInformation	string	Output field: personalInformation
homeWebAddresses	string	Output field: homeWebAddresses
universal_ID	object	Unique identifier
universal_ID.id	string	Unique identifier
workInstantMessengers	string	Output field: workInstantMessengers
homePhones	string	Output field: homePhones
preferredName	string	Name of the resource
workEmails	string	Output field: workEmails
workAddresses	string	Output field: workAddresses
workWebAddresses	string	Output field: workWebAddresses
homeAddresses	string	Output field: homeAddresses
legalName	string	Name of the resource
socialNetworks	string	Output field: socialNetworks
workPhones	string	Output field: workPhones
additionalNames	string	Name of the resource
homeInstantMessengers	string	Output field: homeInstantMessengers
id	string	Unique identifier
href	string	Output field: href

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":{"photos":"http://example.com","homeEmails":"http://example.com","personalInformation":"http://example.com","homeWebAddresses":"http://example.com","universal_ID":{"id":"string"},"workInstantMessengers":"http://example.com","homePhones":"http://example.com","preferredName":"http://example.com","workEmails":"http://example.com","workAddr...

Get People By Universal ID

Retrieves a person of the specified ID. When the person has any person information, for example:home addresses, a hyperlink to the resource of the information will be included in the response.

Endpoint

URL: /api/person/v2/gms/people

Method: GET

Input

Argument Name	Type	Required	Description
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.universal_ID	string	Optional	The Universal ID of the person you want to retrieve.

Input Example

{"parameters":{"limit":20,"offset":9,"universal_ID":"Universal ID"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
data	array	Response data
data.photos	string	Response data
data.homeEmails	string	Response data
data.personalInformation	string	Response data
data.homeWebAddresses	string	Response data
data.universal_ID	object	Response data
data.universal_ID.id	string	Response data
data.workInstantMessengers	string	Response data
data.homePhones	string	Response data
data.preferredName	string	Response data
data.workEmails	string	Response data
data.workAddresses	string	Response data
data.workWebAddresses	string	Response data
data.homeAddresses	string	Response data
data.legalName	string	Response data
data.socialNetworks	string	Response data
data.workPhones	string	Response data
data.additionalNames	string	Response data
data.homeInstantMessengers	string	Response data
data.id	string	Response data
data.href	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}}

Get Request by ID

Retrieves the request with the specified ID.

Endpoint

URL: /api/request/v2/gms/requests/{{ID}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ID	string	Required	The Workday ID of the resource.

Input Example

{"path_parameters":{"ID":"16536"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
workdayObjectValue	object	Value for the parameter
workdayObjectValue.id	string	Unique identifier
workdayObjectValue.descriptor	string	Value for the parameter
workdayObjectValue.href	string	Value for the parameter
requestDate	string	Date value
resolution	object	Output field: resolution
resolution.id	string	Unique identifier
resolution.descriptor	string	Output field: resolution.descriptor
resolution.href	string	Output field: resolution.href
description	string	Output field: description
questionnaireResponses	object	Output field: questionnaireResponses
questionnaireResponses.totalScore	string	Score value
questionnaireResponses.creationDate	string	Date value
questionnaireResponses.questionnaireTarget	object	Output field: questionnaireResponses.questionnaireTarget
questionnaireResponses.questionnaireTarget.id	string	Unique identifier
questionnaireResponses.questionnaireTarget.descriptor	string	Output field: questionnaireResponses.questionnaireTarget.descriptor
questionnaireResponses.questionnaireTarget.href	string	Output field: questionnaireResponses.questionnaireTarget.href
questionnaireResponses.surveyTarget	array	Output field: questionnaireResponses.surveyTarget
questionnaireResponses.surveyTarget.id	string	Unique identifier
questionnaireResponses.surveyTarget.descriptor	string	Output field: questionnaireResponses.surveyTarget.descriptor
questionnaireResponses.businessProcessType	object	Type of the resource
questionnaireResponses.businessProcessType.id	string	Unique identifier
questionnaireResponses.businessProcessType.descriptor	string	Type of the resource

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":{"workdayObjectValue":{"id":"^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$","descriptor":"string","href":"string"},"requestDate":"2023-10-28T07:00:00.000Z","resolution":{"id":"^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$","descriptor":"string","href":"string"},"description":"Lorem ipsum dolor sit amet, cum choro singu...

Get Requests

Retrieves a collection of in progress requests based on the specified meters.

Endpoint

URL: /api/request/v2/gms/requests

Method: GET

Input

Argument Name	Type	Required	Description
parameters.completedOnOrAfter	string	Optional	Parameters for the Get Requests action
parameters.completedOnOrBefore	string	Optional	Parameters for the Get Requests action
parameters.initiatedOnOrAfter	string	Optional	Parameters for the Get Requests action
parameters.initiatedOnOrBefore	string	Optional	Parameters for the Get Requests action
parameters.initiator	array	Optional	The WID for the person who initiated the request.
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.onBehalfOf	string	Optional	The Workday ID of the person this request is being initiated on behalf of.
parameters.requestId	string	Optional	The ID of the request based on the ID generator format.
parameters.requestSubtype	array	Optional	The Workday ID of the request subtype. You can specify more than 1 requestType query parameter.
parameters.requestType	array	Optional	The Workday ID of the request type. You can specify more than 1 requestType query parameter.
parameters.resolution	array	Optional	The Workday ID of the resolution of the request.
parameters.resolutionDetails	array	Optional	The Workday ID of the resolution details.
parameters.workdayObjectValue	array	Optional	The Workday ID of the business object associated with the request.

Input Example

{"parameters":{"completedOnOrAfter":"2023-10-28T07:00:00.000Z","completedOnOrBefore":"2023-11-28T07:00:00.000Z","initiatedOnOrAfter":"2023-12-28T07:00:00.000Z","initiatedOnOrBefore":"2023-01-28T07:00:00.000Z","initiator":["a","b","c"],"limit":20,"offset":9,"onBehalfOf":"Behalf of","requestId":"Request ID","requestSubtype":["a","b","c"],"requestType":["a","b","c"],"resolution":["done","Duplicate","Denied","Canceled"],"resolutionDetails":["a","b","c"],"workdayObjectValue":["a","b","c"]}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
data	array	Response data
data.requestEvent	object	Response data
data.requestEvent.id	string	Response data
data.requestEvent.descriptor	string	Response data
data.requestEvent.href	string	Response data
data.completionDate	string	Response data
data.onBehalfOf	object	Response data
data.onBehalfOf.id	string	Response data
data.onBehalfOf.descriptor	string	Response data
data.onBehalfOf.href	string	Response data
data.requestId	string	Response data
data.initiator	object	Response data
data.initiator.id	string	Response data
data.initiator.descriptor	string	Response data
data.initiator.href	string	Response data
data.resolution	object	Response data
data.resolution.id	string	Response data
data.resolution.descriptor	string	Response data
data.resolution.href	string	Response data
data.subtype	object	Response data
data.subtype.id	string	Response data
data.subtype.descriptor	string	Response data
data.subtype.href	string	Response data

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