API Guide Taleo Business Edition
API GuideTaleo Business EditionDecember 2009
WelcomeAudience and BackgroundCopyright NoticeCONFIDENTIAL INFORMATION OF TALEO.UNAUTHORIZED USE IS STRICTLY PROHIBITED.Taleo is a trademark of Taleo Inc. Taleo. All rights reserved.These Release Notes are protected by copyright and other intellectual property law and is subject to theconfidentiality and other restrictions specified in the Agreement.Taleo4140 Dublin Boulevard, Suite 400Dublin, CA 94568United StatesTel.: 925.452.3000Fax: 925.452.3001www.taleo.comTaleo Business Edition API GuidePage 2
WelcomeAudience and BackgroundContentsCOPYRIGHT NOTICE . 2WELCOME . 8Audience and Background . 8Required Knowledge and Skills. 8Support. 9INTRODUCTION . 9Security and User Authentication. 9Obtaining the Taleo Business Edition WSDLs . 10Importing the WSDLs to Your Development Platform . 10Getting Started. 10Error Tracing. 11API SIMPLE DATA OBJECTS (BEANS).11Important Notes on Data Transfer: . 12Required Fields. 12XML Data Types . 13ACCOUNT API CALLS.13createAccount Element: . 14deleteAccount Element: . 16getAccountById Element: . 17getAccountHistory Element:. 18searchAccount Element: . 20updateAccount Element: . 23ATTACHMENT API CALLS .25createAttachment Element: . 25createEntityAttachment Element:. 27deleteAttachment Element: . 28getAttachment Element:. 29getAttachmentData Element:. 31getAttachments Element: . 32getEntityAttachments Element: . 33Taleo Business Edition API GuidePage 3
WelcomeAudience and BackgroundupdateAttachment Element: . 34BACKGROUND CHECK API CALLS.36createBackgroundCheck Element:. 37deleteBackgroundCheck Element:. 38getBackgroundCheckById Element:. 39getBackgroundChecksByCandidate Element:. 41updateBackgroundCheck Element: . 42CANDIDATE API CALLS.44createCandidate Element: . 47deleteCandidate Element: . 49getCandidateById Element: . 50getCandidateDetailsById Element: . 53getCandidateHistory Element:. 57getCandidatesByRequisition Element:. 58getCandidateWorkHistory Element:. 60getCandReqStatus Element: . 62searchCandidate Element:. 65submitCandidate Element: . 68removeCandidate Element: . 69updateCandidate Element: . 71upsertCandidateToRequisitions Element: . 73CANDIDATE ROLLING ENTITY CALLS .76deleteRollingEntity Element: . 77getRollingEntities Element:. 78upsertRollingEntity Element: . 83CONTACT API CALLS .84createContact Element: . 86deleteContact Element: . 88getContactById Element: . 89updateContact Element:. 95CONTACT LOG API CALLS.97createContactLog Element: . 97deleteContactLog Element: . 99getContactLogById Element: . 100getContactLogsByEntity Element:. 101Taleo Business Edition API GuidePage 4
WelcomeAudience and BackgroundupdateContactLog Element: . 103EMAIL LOG API CALLS.104createEmailLog Element: . 104createEmailSentLog Element:. 106EMPLOYEE API CALLS .107createEmployee Element:. 110deleteEmployee Element:. 113deleteEmployeeByNumber Element: . 114getEmployeeById Element:. 115getEmployeeByNumber Element: . 117searchEmployee Element: . 119updateEmployee Element: . 122upsertEmployee Element:. 125EVENT API CALLS.128createEvent Element:. 130deleteEvent Element:. 132getEventByEntity Element: . 133getEventById Element:. 134getPublicEvents Element: . 136updateEvent Element: . 137INTERVIEW API CALLS .139createInterview Element: . 140deleteInterview Element: . 142getInterviewsByCandidate Element: . 143getInterviewById Element: . 144updateInterview Element: . 146LINK API CALLS.148createLink Element: . 148removeLink Element: . 150LOGIN API CALLS .151getUrl Element . 151login Element: . 152logout Element:. 153Taleo Business Edition API GuidePage 5
WelcomeAudience and BackgroundgetLoginToken Element: . 154METADATA / PICKLIST API CALLS.155getLookup Element:. 156getMetadata Element:. 158OFFER API CALLS .160createOffer Element: . 161deleteOffer Element: . 163getBinaryOffer Element: . 164getOfferByID . 165getOffers Element:. 166setBinaryOffer. 168updateOffer Element: . 169REFERENCE API CALLS .171createReference Element: . 172deleteReference Element: . 173getReferencesByCandidate Element: . 174getReferenceById Element: . 176updateReference Element: . 177REQUISITION API CALLS.180createRequisition Element: . 181createRequisitionTemplate Element: . 182deleteRequisition Element: . 184getRequisitionById Element: . 185getRequisitionHistory Element: . 188getRequisitions Element: . 63postRequisition Element:. 190searchRequisition Element: . 192unpostRequisition Element: . 195updateRequisition Element: . 197RESUME API CALLS.199getBinaryResume Element:. 199parseResume Element: . 200parseResumeIntoCandidate Element: . 202setBinaryResume Element:. 203Taleo Business Edition API GuidePage 6
WelcomeAudience and BackgroundSEARCH API CALLS.205System-Wide Search Definition: . 205SYSTEM API CALLS.207getEnabledServices Element:. 207getSystemProps Element:. 208TASK API CALLS .211createTask Element: . 213deleteTask Element: . 215getTaskByEntity Element: . 216getTaskById Element: . 217getTaskByUser Element: . 219updateTask Element: . 220USER API CALLS.222createUser Element: . 226createUserWithPermissions Element:. 227deleteUser Element: . 230getUserById Element: . 231getUserHistory Element:. 232searchUser Element:. 234updateUser Element: . 237USER ASSOCIATION CALLS.239getAssociatedUsers Element: . 239removeAssociatedUser Element:. 241setAssociatedUser Element: . 242Taleo Business Edition API GuidePage 7
WelcomeAudience and BackgroundWelcomeAudience and BackgroundThis guide is intended for developers who plan to utilize the Taleo Business Editionplatform API for integration with third-party products and services.The Taleo Business Edition SOAP API provides programmatic access to the TaleoBusiness Edition application. The API provides the same functions and capabilities as alogged in user of the system would have access to. Developers are able to build customapplications and services in their platform of choice that supports the open standard“Web Services” methodology via the utilization of: Simple Object Access Protocol (SOAP) calls Taleo defined Web Services Definition Language (WSDL), and XML Schema Definition language (XSD)All areas are defined within this document.Required Knowledge and SkillsUse of this guide assumes you are already familiar with the following: Taleo Business Edition (click Knowledgebase & Help sections from your instance) HTML (details at http://www.w3schools.com/html/default.asp) XML and XHTML (details at http://www.w3schools.com/xml/default.asp) Web Services (details at http://www.w3schools.com/webservices/default.asp) SOAP (details at: http://www.w3schools.com/soap/default.asp)A SOAP client can be written in a wide range of development tools and platforms, such as Java,Visual Basic, Perl, C#, PHP, .NET, etc. As such, Taleo does not provide platform code support orsample code to developers. The API is inherent to the application, not a supported module, andTaleo assumes that developers are experts in their platform of choice with utilizing web services.A sample client-side API Toolkit using the IBM Apache Foundation Axis implementation isavailable for reference at tegration-webapi.php if valued. Additional documentation and details on IBM Apache Foundation Axis isavailable at: http://ws.apache.org/axis/. Please note that the API Toolkit requires JDK 1.4 orabove, which can be downloaded from http://java.sun.com.Simple SOAP-based sample test cases have been provided within the API Guide to provideassistance and direction in making Taleo Business Edition API calls.Taleo Business Edition API GuidePage 8
IntroductionSupportSupportContact Taleo Business Edition Support for any technical issues as they pertain to the API attbe.support@taleo.com.IntroductionThe Taleo Business Edition Web API provides for simple integration between Taleo and othersystems by means of SOAP-based web services procedure calls. The API uses SOAP over HTTPSto receive requests and send responses, allowing seamless integration between Taleo and otherenterprise applications regardless of the programming language used by the client.Security and User AuthenticationOnly Taleo Premium Service customers can access the Taleo Web API. If you are a trialcustomer, or current Taleo subscriber interested in evaluating the Web API, please contact yoursales representative to request Premium Service for access.Taleo Business Edition API exposes all SOAP methods using SSL, however an SSL certificate is notrequired by the client application.Client applications must make a login call to the Taleo Web API providing valid credentials of anexisting defined user within the Taleo Business Edition user interface. Either a new user willneed to be created within the application, or an existing user can be utilized. Client applicationsthat access the Taleo Business Edition API are subjected to the same Access Control restrictionsas defined within the application; please validate what controls you will need the API to use anddefine a user with the appropriate controls accordingly.Credentials needed to log in to the API include (in login call order): Company Code User Name PasswordIf login is successful, the call will return a session ID to be used in all subsequent calls to the APIas the very first parameter.Taleo Business Edition API GuidePage 9
IntroductionObtaining the Taleo Business Edition WSDLsObtaining the Taleo Business Edition WSDLsAs with all standards-based SOAP API’s, the Taleo Business Edition API definition is available onthe Web Service as an XML-formatted WSDL file. Two WSDL’s are required for integrating withTaleo Business Edition:1. DispatcherAPI: http://tbe.taleo.net/wsdl/DispatcherAPI.wsdl2. WebAPI: http://tbe.taleo.net/wsdl/WebAPI.wsdlThe DispatcherAPI WSDL provides one simple function: request the organization code andreceive a response URL of where the account/zone is located in the pool of Taleo BusinessEdition servers. The reason for the Dispatcher is that accounts/zones may be moved to a newserver pool for optimal load balancing. The Dispatcher ensures that the client application willalways find the organization zone URL.The WebAPI WSDL defines all of the Taleo Business Edition calls. For more information onWSDL(s), see: http://www.w3.org/TR/wsdl.Free online WSDL readers are available if required. The following is one found on W3:http://www.w3.org/2000/06/webdata/xslt?xslfile e m Submit#op.d1e1025.Importing the WSDLs to Your Development PlatformAfter you obtain the two Taleo Business Edition WSDLs, import them into your developmentenvironment for building your Web service applications. The import process depends on thedevelopment environment, programmatic language and tools. For example, the Microsoft VisualStudio development environment handles the tasks automatically.A good start would be to practice WSDL import and web service call initiations with a genericweb service tool prior to actual coding. Using a tool like SOAPUI (http://soapui.org), whichcomes in a freeware and premium licensed version, allows users to create web service projects,practice requests and test cases. It is highly recommended to go down this path first.NOTE: Taleo assumes you are familiar with basic programming concepts and already have aprogramming development environment set up on your computer.Getting StartedA typical scenario of using the Taleo Web API is:Taleo Business Edition API GuidePage 10
API Simple Data Objects (Beans)Error Tracing1.2.3.4.5.Customer builds a SOAP client to interact with Taleo Web API.The very first call is made to the Dispatcher API to present valid company code andobtain entry URL to be used in all subsequent calls. This call is always made to t/rpcrouter.SOAP client makes login call to the received company code URL and present validcredentials of an existing user.Customer’s SOAP client sends various requests to the Taleo Web API This mayinclude, for example, searching through the candidates or requisitions database,requesting detailed information on a particular candidate or requisition, creation ofa new candidate record, etc.At the end of the session, customer’s SOAP client logs out of Taleo.Refer to the ‘Login API Calls’ section for details on logging in and logging out of Taleo BusinessEdition.Error TracingMost issues can be resolved in minutes if the XML error can be provided. Web API errors mayoccur during the communication process, which will not provide the error log within TaleoBusiness Edition for Taleo’s support team to analyze. In addition, a programmer is shielded fromthe XML trace. As such, it is essential to trace the communication between the client and TaleoBusiness Edition API, through third-party tools like tcpmon (https://tcpmon.dev.java.net/).tcpmon is an open-source utility for monitoring the data flowing on a TCP connection. tcpmon isused by placing it in-between a client and a server. The client is made to connect to tcpmon, andtcpmon forwards the data to server along-with displaying it in its GUI.Note: It is up to the client programmer to be sure that any value assigned to a string field of abean is compliant with the W3C XML spec. Please ensure control or bad characters (i.e. #xC) areshielded from field elements.API Simple Data Objects (Beans)The Taleo Web API uses the following simple data objects to send and receive information: accountBean attachmentBean backgroundCheckBean calendarEventBean candidateBean contactBean contactLogBean employeeBeanTaleo Business Edition API GuidePage 11
API Simple Data Objects (Beans)Important Notes on Data Transfer: tBeantaskBeanuserBeanImportant Notes on Data Transfer: Binary candidate resumes and offer letters are sent and received as array of byteswrapped into ByteArr.Values from pick lists, such as candidate Source or State/Region are transferred asstrings, although on the server side they are stored as ID numbers. This is done becauseserver side ID numbers are meaningless for external clients. These string values can beERP codes assigned to lookup values or display labels. This also assumes that all valuesfrom pick lists have unique display labels.To identify user Web API uses login name. For instance, to assign requisition’sapprovers, Web API takes a list of login names.There are several fields which cannot be modified by the client, for example: an object’sunique id #, creation date, and last modified date. These fields are marked “read-only”in the tables below.When an object is created or modified, the same policy is applied as if the object iscreated/modified by a user using Taleo through the standard browser interface. Forinstance, an attached file must meet security requirements, all mandatory fieldsspecified for a given candidate must be present, etc. If required conditions are not metin any given transaction sent by the client, the operation will fail and a SOAP failureresponse will be generated.Arrays of returned objects are wrapped in special beans such as SearchResultsArr andHistoryBeanArr.Required FieldsFields marked as “required” in Administration section (both standard and custom) are alsorequired in Web API. Fields which are always required are marked in the sections below. If theWeb API client is trying to create an object without supplying all required fields, an exceptionwill be thrown.Taleo Business Edition API GuidePage 12
Account API CallsXML Data TypesXML Data TypesTaleo Bus
Taleo Business Edition API exposes all SOAP methods using SSL, however an SSL certificate is not required by the client application. Client applications must make a login call to the Taleo Web API providing valid credentials of an existing defined user within the Taleo Busines
User Guide Taleo Connect Client 7.5 1-1 Introduction Taleo Connect Taleo Connect Taleo Connect Server The Taleo Connect Server is the server-side portion of the Taleo Connect Platform embedded within the Taleo products. It enables the products to expose their integration offering through a secure gateway using system-to-system type messages.
For example, an application written using the Taleo Recruiting 7.5 API shipped with the Taleo Enterprise Edition 7.5 release will continue to work with all future minor versions (i.e. Taleo Enterprise Edition 7.5 SP1), and with the next major version of the product (i.e. Taleo Enterprise 10 and later), using that same API.
Getting Started The Taleo API User Guide Taleo Web Services 12B 4 to work with a given data dictionary mapping version will work with that same mapping version in future minor versions and the next future major version of the product. Taleo does not guarantee that an application written against one API version will work with future API
and the Taleo user interface. Knowledge of the Taleo Connect Client is not required, but would greatly help to understand and visualize the Data Model made available through the Taleo API. The API consists of a set of callable methods, and some API endpoints. Its documentation is divided in two parts:
This guide is intended for developers who plan to utilize the Taleo Business Edition platform API for integration with third-party products and services. The Taleo Business Edition SOAP API provides programmatic access to the Taleo Business Edition application. The API provides the same functions and capabilities as a logged in user of
www.taleo.com – info@taleo.com 1.877.818.2536 – U.S. 1.888.922.5665 – International ABOUT TALEO Taleo (NASDAQ: TLEO) is the leader in on demand, web-based talent management solutions that empower organizations of all sizes, around the world to assess, acquire, develop and
Oracle Taleo Enterprise Integration Taleo Connect Client User Guide Feature Pack 13C Part Number: E51437-04 March 2014. Taleo Connect Client User Guide
API An Application Programming Interface (API) is a set of routines, protocols, and tools for building applications. A Plex API in the Plex Developer Portal is a collection of related endpoints analogous to one or more Plex software modules. authorization code grant An OAuth 2.0 authentication flow where access is delegated to a client application.
