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 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 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 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 location object output field location country object output field country descriptor string output field descriptor id string unique identifier descriptor string output field descriptor businesstitle string output field businesstitle worker object output field worker id string unique identifier descriptor string output field descriptor supervisoryorganization object output field supervisoryorganization id string unique identifier descriptor string output field descriptor nextpayperiodstartdate string date value jobtype object type of the resource descriptor string output field descriptor jobprofile object output field jobprofile id string unique identifier descriptor string output field descriptor 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" { "location" {}, "businesstitle" "sample business title", "worker" {}, "supervisoryorganization" {}, "nextpayperiodstartdate" "2020 01 27t16 00 00 000z", "jobtype" {}, "jobprofile" {}, "id" "string", "descriptor" "lorem ipsum dolor sit ame" } } ] get jobs retrieves a collection of jobs endpoint url /api/payroll/v2/gms/jobs 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 location object output field location country object output field country descriptor string output field descriptor id string unique identifier descriptor string output field descriptor businesstitle string output field businesstitle worker object output field worker id string unique identifier descriptor string output field descriptor supervisoryorganization object output field supervisoryorganization id string unique identifier descriptor string output field descriptor nextpayperiodstartdate string date value jobtype object type of the resource descriptor string output field descriptor jobprofile object output field jobprofile id string unique identifier descriptor string output field descriptor id string unique identifier 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 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 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 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 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 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" {}, "workinstantmessengers" "http //example com", "homephones" "http //example com", "preferredname" "http //example com", "workemails" "http //example com", "workaddresses" "http //example com", "workwebaddresses" "http //example com", "homeaddresses" "http //example com", "legalname" "http //example com", "socialnetworks" "http //example com", "workphones" "http //example com" } } ] 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 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 universal id string optional the universal id of the person you want to retrieve output parameter type description status code number http status code of the response reason string response reason phrase data array response data 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 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 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 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 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 workdayobjectvalue object value for the parameter id string unique identifier descriptor string output field descriptor href string output field href requestdate string date value resolution object output field resolution id string unique identifier descriptor string output field descriptor href string output field href description string output field description questionnaireresponses object output field questionnaireresponses totalscore string score value creationdate string date value questionnairetarget object output field questionnairetarget id string unique identifier descriptor string output field descriptor href string output field href surveytarget array output field surveytarget id string unique identifier descriptor string output field descriptor businessprocesstype object type 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" { "workdayobjectvalue" {}, "requestdate" "2023 10 28t07 00 00 000z", "resolution" {}, "description" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ", "questionnaireresponses" {}, "initiator" {}, "onbehalfof" {}, "requestid" "lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co ", "completiondate" "2023 10 28t07 00 00 000z", "requestevent" {}, "requesttype" {}, "resolutiondetails" {}, "status" {}, "subtype" {}, "id" "string" } } ] 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 completedonorafter string optional parameter for get requests completedonorbefore string optional parameter for get requests initiatedonorafter string optional parameter for get requests initiatedonorbefore string optional parameter for get requests initiator array optional the wid for the person who initiated the request 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 onbehalfof string optional the workday id of the person this request is being initiated on behalf of requestid string optional the id of the request based on the id generator format requestsubtype array optional the workday id of the request subtype you can specify more than 1 requesttype query parameter requesttype array optional the workday id of the request type you can specify more than 1 requesttype query parameter resolution array optional the workday id of the resolution of the request resolutiondetails array optional the workday id of the resolution details workdayobjectvalue array optional the workday id of the business object associated with the request output parameter type description status code number http status code of the response reason string response reason phrase data array response data requestevent object output field requestevent id string unique identifier descriptor string output field descriptor href string output field href completiondate string date value onbehalfof object output field onbehalfof id string unique identifier descriptor string output field descriptor href string output field href requestid string unique identifier initiator object output field initiator id string unique identifier descriptor string output field descriptor href string output field href resolution object output field resolution id string unique identifier descriptor string output field descriptor href string output field href subtype object type of the resource 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" { "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