Workday Soap API VERSION 1

This handler executes an API call in WorkDay and returns the results. The 'Message' parameter is a JSON Object that represents the WorkDay call. This is transformed into an XML query structure to pass to WorkDay. The handler was written using the v33.0 API.

When building the field portion of the JSON object, some special conventions are used for key names:

Typically, the key is the XML element, and the value is the XML text. Example JSON: {"xmlElementTag": "XML Element Text"} Results XML: <xmlElementTag>XML Element Text</xmlElementTag>

If the XML element needs an attribute, make the value a hash, and within the hash use "content!" as the key to represent the XML text element, and @<property name> to represent a property. Example: {"field":{"content!":"Matthew", "@op":"equals"}} Results XML: <field op="equals">Matthew</field>

If the XML element needs to be nested, use a hash. Example JSON: {"xmlElementTag":{"nestedXmlElementTag":{"content!":"Matthew", "@op":"equals"}}} Results XML: <xmlElementTag><nestedXmlElementTag op="equals">Matthew</nestedXmlElementTag></xmlElementTag>

If the XML element needs to be nested but the parent element also has a value, put the nested Element within a "content!" key of the parent. Example JSON: {"field":{"content!":{"content!":"firstname","expression":{"content!":"Matthew", "@op":"equals"}}}} Results XML: <field>firstname<expression op="equals">Matthew</expression></field>


Error HandlingDetermine what to return if an error is encountered.
ServiceThe Service being called (e.g., Absence_Management, Recruiting, Human_Resources)
API VersionThe API version being used (e.g., v33.0)
OperationThe operation within the service being called (e.g., Get_Absence_Inputs, Get_Applicants, Get_Workers).
Include Reference DescriptorsIf the response should include Reference Descriptors
Message JSON object representing what will be transformed into the input for the WorkDay query. There are several unique key values that have various effects when creating the JSON object that generates the WorkDay XML. See this handlers info on the Kinetic Community website for more information.

Sample Configuration

Error HandlingError Message
API version:v33.0
Include Refernece Descriptors:


NameSample Result
Handler Error MessageError message if an error was encountered and Error Handling is set to "Error Message".
Results JSONThe HTTP response code
CountThe count of entities returned.


workdaysoapapi_v1 (2019-11-23)

  • Initial version. See README for details.