Workday v3
10 min
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 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 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 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 perioddate string optional contains the specified date used to match to a period containing the date the default is today's date output parameter type description status code number http status code of the response reason string response reason phrase data array response data periodlabel string output field periodlabel submittext string output field submittext totals array output field totals totalnumber string output field totalnumber quantity string output field quantity label string output field label certifytext string output field certifytext 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 } } ] 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