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