Workday

this connector allows you to interact with the workday api this connector is based on the workday rest api and uses version v1 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 activities for a specific customer get activity for customer get customer get direct reports for worker get history items for worker get leave status get organization by id get organizations get organizations for worker get pay slips for worker get time off entires for worker get values time off status get worker by id get workers get workers eligible absence types and so on notes for more information on workday api https //community workday com/sites/default/files/file hosting/restapi/index html 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 activities for a specific customer get activities for a specific customer endpoint url /api/common/v1/gms/customers/{{id}}/activities method get input argument name type required description path parameters id string required the workday id of the resource parameters fromdate string optional parameters for the get activities for a specific customer action 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 todate string optional parameters for the get activities for a specific customer action input example {"parameters" {"fromdate" "2023 10 28t07 00 00 000z","limit" 20,"offset" 9,"todate" "2023 11 28t07 00 00 000z"},"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 invoiceopportunity object response data data invoiceopportunity name string response data data invoiceopportunity id string response data data invoiceopportunity opportunityreferenceid string response data data paymentreference string response data data transactionamountsigned string response data data transactiondate string response data data applicationstatus string response data data transactiontype string response data data transactionstatus string response data data transactionnumber string response data data invoiceduedate string response data data id 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 activity for customer retrieves an activity instance for a specific customer endpoint url /api/common/v1/gms/customers/{{id}}/activities/{{subresourceid}} method get input argument name type required description path parameters id string required the workday id of the resource path parameters subresourceid string optional the workday id of the subresource input example {"path parameters" {"id" "16536","subresourceid" "16536"}} output parameter type description status code number http status code of the response reason string response reason phrase invoiceopportunity object output field invoiceopportunity invoiceopportunity name string name of the resource invoiceopportunity id string unique identifier invoiceopportunity opportunityreferenceid string unique identifier paymentreference string output field paymentreference transactionamountsigned string output field transactionamountsigned transactiondate string date value applicationstatus string status value transactiontype string type of the resource transactionstatus string status value transactionnumber string output field transactionnumber invoiceduedate string date value id string unique identifier 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" {"invoiceopportunity" {"name" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ","id" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ","opportunityreferenceid" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co "},"paymentreference" get customer retrieves a customer instance endpoint url api/common/v1/gms/customers/{{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 name string name of the resource 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" {"name" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ","id" "string","descriptor" "lorem ipsum dolor sit ame"}} get direct reports for worker retrieves a collection of workers and current staffing information endpoint url /api/common/v1/gms/workers/{{id}}/directreports method get input argument name type required description path parameters id string required the workday id of the resource parameters limit number optional parameters for the get direct reports for worker action parameters offset number optional parameters for the get direct reports for worker action parameters search string optional parameters for the get direct reports for worker action input example {"parameters" {"limit" 20,"offset" 9,"search" "search"},"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 primaryworkphone string response data data ismanager boolean response data data primaryworkemail string response data data businesstitle string response data data primarysupervisoryorganization object response data data primarysupervisoryorganization id string response data data primarysupervisoryorganization descriptor string response data data primarysupervisoryorganization href string response data data id string response data data descriptor 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 history items for worker retrieves all history items for the worker endpoint url /api/common/v1/gms/workers/{{id}}/history method get input argument name type required description path parameters id string required the workday id of the resource parameters limit number optional parameters for the get history items for worker action parameters offset number optional parameters for the get history items for worker action input example {"parameters" {"limit" 20,"offset" 9},"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 subject object response data data subject id string response data data subject descriptor string response data data subject href 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 effective string response data data due string response data data initiated string response data data descriptor 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 leave status get leave status ids endpoint url /api/absencemanagement/v1/gms/values/leave/status 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 total number output field total data array response data data id string response data data descriptor string response data data 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" {"total" 0,"data" \[{}]}} get organization by id retrieves an organization instance endpoint url /api/common/v1/gms/organizations/{{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 id string unique identifier href string output field href 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" {"id" "string","href" "string","descriptor" "lorem ipsum dolor sit ame"}} get organizations retrieves a collection of organizations endpoint url /api/common/v1/gms/organizations 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 id string response data data href 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 organizations for worker retrieves all organizations for a specific worker endpoint url /api/common/v1/gms/workers/{{id}}/organizations method get input argument name type required description path parameters id string required parameters for the get organizations for worker action 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},"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 organizationtype object response data data organizationtype id string response data data organizationtype descriptor string response data data organizationtype href string response data data id string response data data href 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 pay slips for worker retrieves all pay slips for a worker with the specified id endpoint url /api/common/v1/gms/workers/{{id}}/payslips 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 input example {"parameters" {"limit" 20,"offset" 9},"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 gross string response data data status object response data data status id string response data data status descriptor string response data data status href string response data data net string response data data date string response data data descriptor 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 time off entires for worker retrieves a collection of time off entries for a specific worker endpoint url /api/common/v1/gms/workers/{{id}}/timeoffentries 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 input example {"parameters" {"limit" 20,"offset" 9},"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 units string response data data employee object response data data employee id string response data data employee descriptor string response data data employee href string response data data unitoftime object response data data unitoftime id string response data data unitoftime descriptor string response data data unitoftime href string response data data timeoffrequest object response data data timeoffrequest status string response data data timeoffrequest id string response data data timeoffrequest href string response data data timeoffrequest descriptor string response data data date string response data data timeoff object response data data timeoff plan object response data data timeoff plan id string response data data timeoff plan descriptor string response data data timeoff plan href string response data data timeoff id string response data data timeoff 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}} get values time off status get time off status values endpoint url /api/absencemanagement/v1/gms/values/leave/status 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 total number output field total data array response data data id string response data data descriptor string response data data 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" {"total" 0,"data" \[{}]}} get worker by id retrieves a worker instance with the specific id endpoint url /api/common/v1/gms/workers/{{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 primaryworkemail string output field primaryworkemail ismanager boolean output field ismanager primaryworkphone string output field primaryworkphone location object output field location location id string unique identifier location descriptor string output field location descriptor location href string output field location href primarysupervisoryorganization object output field primarysupervisoryorganization primarysupervisoryorganization id string unique identifier primarysupervisoryorganization descriptor string output field primarysupervisoryorganization descriptor primarysupervisoryorganization href string output field primarysupervisoryorganization href primaryworkaddresstext string output field primaryworkaddresstext yearsofservice string output field yearsofservice businesstitle string output field businesstitle supervisoryorganizationsmanaged string output field supervisoryorganizationsmanaged dateofbirth string output field dateofbirth id string unique identifier href string output field href 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" {"primaryworkemail" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ","ismanager"\ true,"primaryworkphone" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ","location" {"id" "^(? (? \[0 9a f]{32})|(? \[0 9]+\\\\$\[0 9]+)|(\\\s+=\\\s+))$","descriptor" "string","href" "string get workers retrieves a collection of workers and current staffing information endpoint url /api/common/v1/gms/workers 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 search string optional searches workers by name or worker id the search is case insensitive you can include space delimited search strings for an or search input example {"parameters" {"limit" 20,"offset" 9,"search" "search"}} output parameter type description status code number http status code of the response reason string response reason phrase data array response data data primaryworkphone string response data data ismanager boolean response data data primaryworkemail string response data data businesstitle string response data data primarysupervisoryorganization object response data data primarysupervisoryorganization id string response data data primarysupervisoryorganization descriptor string response data data primarysupervisoryorganization href string response data data id string response data data descriptor 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 workers eligible absence types retrieves all the eligible absence types for the specified worker id for a category type endpoint url /api/absencemanagement/v1/gms/workers/{{id}}/eligibleabsencetypes method get input argument name type required description path parameters id string required parameters for the get workers eligible absence types action parameters category string optional the workday id of the absence type category valid values leave of absence type 17bd6531c90c100016d74f8dfae007d0, absence table 17bd6531c90c100016da3f5b554007d2, time off 17bd6531c90c100016d4b06f2b8a07ce parameters effective string optional the effective date for which eligible absence types need to be returned for the worker 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" {"category" "17bd6531c90c100016d74f8dfae007d0","effective" "2023 10 28t07 00 00 000z","limit" 20,"offset" 9},"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 unitoftime object response data data unitoftime id string response data data unitoftime descriptor string response data data unitoftime href string response data data positionbased boolean response data data position array response data data position descriptor string response data data position id string response data data absencereasons array response data data absencereasons descriptor string response data data absencereasons id string response data data reasonrequired boolean response data data displaystartandendtime boolean response data data id string response data data category object response data data category id string response data data category descriptor string response data data category href string response data data additionalfields array response data data additionalfields required boolean response data data additionalfields descriptor string response data data additionalfields id 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}} get workers eligible absense types by subresource retrieves information about an eligible absence type for the worker with the specified id endpoint url /api/absencemanagement/v1/gms/workers/{{id}}/eligibleabsencetypes/{{subresourceid}} method get input argument name type required description path parameters id string required the workday id of the resource path parameters subresourceid string required the workday id of the subresource input example {"path parameters" {"id" "16536","subresourceid" "sub resource id"}} output parameter type description status code number http status code of the response reason string response reason phrase unitoftime object time value unitoftime id string unique identifier unitoftime descriptor string output field unitoftime descriptor unitoftime href string output field unitoftime href positionbased boolean output field positionbased position array output field position position descriptor string output field position descriptor position id string unique identifier absencereasons array response reason phrase absencereasons descriptor string response reason phrase absencereasons id string unique identifier reasonrequired boolean response reason phrase displaystartandendtime boolean time value id string unique identifier category object output field category category id string unique identifier category descriptor string output field category descriptor category href string output field category href additionalfields array output field additionalfields additionalfields required boolean output field additionalfields required additionalfields descriptor string output field additionalfields descriptor additionalfields id string unique identifier dailydefaultquantity string output field dailydefaultquantity 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" {"unitoftime" {"id" "^(? (? \[0 9a f]{32})|(? \[0 9]+\\\\$\[0 9]+)|(\\\s+=\\\s+))$","descriptor" "string","href" "string"},"positionbased"\ true,"position" \[{}],"absencereasons" \[{}],"reasonrequired"\ true,"displaystartandendtime"\ true,"id" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ","category" {"id" "^( get wql queries returns the data from a wql query endpoint url /api/wql/v1/gms/data 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 query string optional the wql query that retrieves the data input example {"parameters" {"limit" 20,"offset" 9,"query" "select worker from allworkers"}} output parameter type description status code number http status code of the response reason string response reason phrase data array response data data id string response data data descriptor 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}} post wql query returns the data from a wql query the read only post request accommodates queries greater than 2,048 characters you can only view data you have security access to endpoint url /api/wql/v1/gms/data method post input argument name type required description query string optional parameter for post wql query input example {"json body" {"query" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo quo lorem etiam eu "}} output parameter type description status code number http status code of the response reason string response reason phrase query string output field query 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" {"query" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co "}} 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