Skip to main content

 

 
Go Search
Home
Getting Started
Knowledge Base
Training
Discussions
Downloads
Platform SDK
  

 
 
VersionOne Community > Platform SDK

 Platform SDK Overview


The VersionOne Integration Platform is an open-source toolkit for building applications that integrate with the VersionOne Application.  This platform is illustrated in the diagram below
 
SDK Components
 
From this diagram we observe that an external application or integration can interact with the VersionOne server using one of the following methods
  • via the Core API (VersionOne API), which is a REST-based API accessed using HTTP GET and POST methods with XML document payloads.
  • via the APIClient library (contained within the SDK download), which provides http and XML document plumbing.
  • via the Object Model library, which provides a strongly-typed object model
We also see that each layer builds on the previous layer.  The higher layers make development simpler and faster, but with that simplification comes a loss of power/expressiveness.   Most projects should only need the Object Model Library, but there is the ability to 'drop down' to using the APIClient directly for more advanced capabilities - and there's always the option to work directly against the API.
 

How to determine which level to develop against?

 
In order to determine which entry point to use, you first need to determine your development language.  If you are not developing in C# or Java you need to use the Core API
 
Developers using Java need to use the Legacy APIClient. (this is a temporary solution until the Java SDK is complete)
 
Developers using C# need to consider the server build version.  If the server build version is not 8.0.1197 or better, you need to use the Legacy APIClient Libraries.
 
Developers using C#, with a server build version of 8.0.1197 or better need to consider the type of application being developed.  If you are developing an integration with another system or a utility application, consider using the Object Model Library first.  If you are developing a reporting application, have a need for complex query/filtering, or you have an application that would benefit from server side ordering, the new APIClient , which is contained within the SDK download, is better suited for your needs. 
 
 
 
 

 Documentation

Title
Integrations
SDK
Core API
Legacy API Client
 
Participate in the VersionOne-dev discussion list for Platform SDK topics.
 

 Downloads

Name
collapse V1: Java SDK
    VersionOne.JavaSDK-8.3.zipdoc
collapse V1: SDK
    VersionOne.SDK-8.3.zipdoc
    VersionOne.SDK-8.0.zipdoc
collapse V1: API Client
    VersionOne.Java.APIClient-8.0.zipdoc
    VersionOne.Java.APIClient.Source-8.0.zip
    VersionOne.APIClient-7.1.zipdoc
    VersionOne.APIClient.Source-7.1.zip
collapse V1: Bugzilla Integration
    V1BugzillaIntegration.8.3.zipwatch videodoc
    V1BugzillaIntegration.8.0.zipwatch videodoc
collapse V1: CruiseControl.NET
    ccnet.VersionOnePublisher.plugin-8.1.zipwatch videodoc
    ccnet.VersionOnePublisher.plugin.Source-8.1.zip
collapse V1: Eclipse Plugin
    V1EclipsePlugin-source.8.0.zip
    V1EclipsePlugin.8.0.zipdoc
collapse V1: Effort Reporting Tool
    VersionOne.EffortReporting-8.1.zipdoc
    VersionOne.EffortReporting.Source-8.1.zip
collapse V1: Firefox
    V1Ubiquity.aspxdoc
collapse V1: Fit Integration
    V1FitIntegration.8.3.zipwatch videodoc
    V1FitIntegration.8.0.zipwatch videodoc
collapse V1: Jira Integration
    V1JiraIntegration.8.3.zipwatch videodoc
    V1JiraIntegration.8.0.zipwatch videodoc
collapse V1: Perforce Integration
    V1PerforceIntegration.8.3.zipdoc
collapse V1: QTP Integration
    V1QtpIntegration.8.3.zipwatch videodoc
    V1QtpIntegration.8.0.zipwatch videodoc
collapse V1: Quality Center
    V1QualityCenter.8.3.zipwatch videodoc
collapse V1: Requestor
    VersionOne.Requestor-7.1.zipdoc
    VersionOne.Requestor.Source-7.1.zip
collapse V1: Service Host
    VersionOne.ServiceHost.source.8.3.zipdoc
    VersionOne.ServiceHost.source.8.0.zipdoc
    VersionOne.ServiceHost.source.7.1.zipdoc
collapse V1: Subversion Integration
    V1SvnIntegration.8.3.zipwatch videodoc
    V1SvnIntegration.8.0.zipwatch videodoc
collapse V1: Visual Studio Add-In
    VersionOne.VSAddin.Source-7.x.zip
    VersionOne.VSAddin.Setup-7.x.zipdoc
collapse V1: Visual Studio Team System
    V1TFS-8.2.zipwatch videodoc
    V1TFS.Source-8.2.zip