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 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 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 id string required the workday id of the resource fromdate string optional date value limit number optional the maximum number of objects in a single response the default is 20 the maximum is 100 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 todate string optional date value output parameter type description status code number http status code of the response reason string response reason phrase data array response data invoiceopportunity object output field invoiceopportunity name string name of the resource id string unique identifier 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 total number output field total 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 id string required the workday id of the resource subresourceid string optional the workday id of the subresource output parameter type description status code number http status code of the response reason string response reason phrase invoiceopportunity object output field invoiceopportunity name string name of the resource id string unique identifier 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 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" {}, "paymentreference" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ", "transactionamountsigned" "14708370", "transactiondate" "2023 10 28t07 00 00 000z", "applicationstatus" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ", "transactiontype" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ", "transactionstatus" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ", "transactionnumber" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ", "invoiceduedate" "2023 10 28t07 00 00 000z", "id" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co " } } ] get customer retrieves a customer instance endpoint url api/common/v1/gms/customers/{{id}} method get input argument name type required description id string required the workday id of the resource 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 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 id string required the workday id of the resource limit number optional parameter for get direct reports for worker offset number optional parameter for get direct reports for worker search string optional parameter for get direct reports for worker output parameter type description status code number http status code of the response reason string response reason phrase data array response data primaryworkphone string output field primaryworkphone ismanager boolean output field ismanager primaryworkemail string output field primaryworkemail businesstitle string output field businesstitle primarysupervisoryorganization object output field primarysupervisoryorganization id string unique identifier descriptor string output field descriptor href string output field href id string unique identifier descriptor string output field descriptor href string output field href total number output field total 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 id string required the workday id of the resource limit number optional parameter for get history items for worker offset number optional parameter for get history items for worker output parameter type description status code number http status code of the response reason string response reason phrase data array response data subject object output field subject id string unique identifier descriptor string output field descriptor href string output field href initiator object output field initiator id string unique identifier descriptor string output field descriptor href string output field href effective string output field effective due string output field due initiated string output field initiated descriptor string output field descriptor id string unique identifier href string output field href total number output field total 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 limit number optional the maximum number of objects in a single response the default is 20 the maximum is 100 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 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 id string unique identifier descriptor string output field descriptor href string output field href 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 id string required the workday id of the resource 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 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 limit number optional the maximum number of objects in a single response the default is 20 the maximum is 100 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 output parameter type description status code number http status code of the response reason string response reason phrase data array response data id string unique identifier href string output field href descriptor string output field descriptor total number output field total 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 id string required unique identifier limit number optional the maximum number of objects in a single response the default is 20 the maximum is 100 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 output parameter type description status code number http status code of the response reason string response reason phrase data array response data organizationtype object type of the resource id string unique identifier descriptor string output field descriptor href string output field href id string unique identifier href string output field href descriptor string output field descriptor total number output field total 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 id string required the workday id of the resource limit number optional the maximum number of objects in a single response the default is 20 the maximum is 100 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 output parameter type description status code number http status code of the response reason string response reason phrase data array response data gross string output field gross status object status value id string unique identifier descriptor string output field descriptor href string output field href net string output field net date string date value descriptor string output field descriptor id string unique identifier href string output field href total number output field total 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 id string required the workday id of the resource limit number optional the maximum number of objects in a single response the default is 20 the maximum is 100 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 output parameter type description status code number http status code of the response reason string response reason phrase data array response data units string output field units employee object output field employee id string unique identifier descriptor string output field descriptor href string output field href unitoftime object time value id string unique identifier descriptor string output field descriptor href string output field href timeoffrequest object output field timeoffrequest status string status value id string unique identifier href string output field href descriptor string output field descriptor date string date value timeoff object output field timeoff plan object output field plan id string unique identifier descriptor string output field descriptor href string output field href id string unique identifier href string output field href 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 limit number optional the maximum number of objects in a single response the default is 20 the maximum is 100 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 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 id string unique identifier descriptor string output field descriptor href string output field href 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 id string required the workday id of the resource 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 id string unique identifier descriptor string output field descriptor href string output field href primarysupervisoryorganization object output field primarysupervisoryorganization id string unique identifier descriptor string output field descriptor href string output field 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 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" {}, "primarysupervisoryorganization" {}, "primaryworkaddresstext" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ", "yearsofservice" "876632984", "businesstitle" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ", "supervisoryorganizationsmanaged" "http //example com", "dateofbirth" "2023 10 28t07 00 00 000z", "id" "string", "href" "string", "descriptor" "lorem ipsum dolor sit ame" } } ] 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 limit number optional the maximum number of objects in a single response the default is 20 the maximum is 100 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 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 output parameter type description status code number http status code of the response reason string response reason phrase data array response data primaryworkphone string output field primaryworkphone ismanager boolean output field ismanager primaryworkemail string output field primaryworkemail businesstitle string output field businesstitle primarysupervisoryorganization object output field primarysupervisoryorganization id string unique identifier descriptor string output field descriptor href string output field href id string unique identifier descriptor string output field descriptor href string output field href total number output field total 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 id string required unique identifier category string optional the workday id of the absence type category valid values leave of absence type 17bd6531c90c100016d74f8dfae007d0, absence table 17bd6531c90c100016da3f5b554007d2, time off 17bd6531c90c100016d4b06f2b8a07ce effective string optional the effective date for which eligible absence types need to be returned for the worker limit number optional the maximum number of objects in a single response the default is 20 the maximum is 100 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 output parameter type description status code number http status code of the response reason string response reason phrase data array response data unitoftime object time value id string unique identifier descriptor string output field descriptor href string output field href positionbased boolean output field positionbased position array output field position descriptor string output field descriptor id string unique identifier absencereasons array response reason phrase descriptor string output field descriptor id string unique identifier reasonrequired boolean response reason phrase displaystartandendtime boolean time value id string unique identifier category object output field category id string unique identifier descriptor string output field descriptor href string output field href additionalfields array output field additionalfields required boolean output field required descriptor string output field descriptor id string unique identifier 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 id string required the workday id of the resource subresourceid string required the workday id of the subresource output parameter type description status code number http status code of the response reason string response reason phrase unitoftime object time value id string unique identifier descriptor string output field descriptor href string output field href positionbased boolean output field positionbased position array output field position descriptor string output field descriptor id string unique identifier absencereasons array response reason phrase descriptor string output field descriptor id string unique identifier reasonrequired boolean response reason phrase displaystartandendtime boolean time value id string unique identifier category object output field category id string unique identifier descriptor string output field descriptor href string output field href additionalfields array output field additionalfields required boolean output field required descriptor string output field descriptor id string unique identifier dailydefaultquantity string output field dailydefaultquantity 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" {}, "positionbased" true, "position" \[], "absencereasons" \[], "reasonrequired" true, "displaystartandendtime" true, "id" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ", "category" {}, "additionalfields" \[], "dailydefaultquantity" "484858", "absencetypegroup" {}, "descriptor" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ", "calculatequantitybasedonstartandendtime" true, "entryoption" {}, "startandendtimerequired" true } } ] 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 limit number optional the maximum number of objects in a single response the default is 20 the maximum is 100 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 query string optional the wql query that retrieves the data output parameter type description status code number http status code of the response reason string response reason phrase data array response data id string unique identifier descriptor string output field descriptor href string output field href total number output field total 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 output parameter type description status code number http status code of the response reason string response reason phrase query string output field query 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 notes for more information on workday api click here! https //community workday com/sites/default/files/file hosting/restapi/index html