The VersionOne Software Development Kit (SDK) was introduced in Releases 8.0 (.Net) and 8.3 (Java), respectively. Due to extensions in the Core API (added support for attachments, configuration, etc) your VersionOne server must be running build 8.0.1197.4 or greater for .Net and build 8.3.3014.0 or greater for Java. If you are using a release prior to the respective minimums, or if you are developing a language other than .NET or Java, please use the Legacy APIClient or the Core API. If you are using the VersionOne:Agile Team product, please read Knowledge Base article Q11418 for additional information.
Our goal when creating the SDK was to significantly reduce the learning curve for building integrations with VersionOne. We figured you shouldn't need a degree in V1 to be able to integrate with our product; instead any developer should be able to 'pick it up and knock it out'.
The SDK is comprised of two components
The VersionOne Object Model libraries are .Net and Java libraries created to provide a strongly-typed model on top of our APIClient. This allows developers to easily and quickly develop VersionOne integrations and complementary applications/utilities using domain objects (Project, Story, Iteration, etc) instead of more abstract objects (Asset, Attribute). This library is built on top of the APIClient, which is a .NET library that allows object-oriented access to the Core API without concern for the underlying RESTful API or the HTTP/XML plumbing. Through the APIClient, you can query for simple or complex sets of information, update the information, and execute system-defined operations.
Samples
The SDK ships with several sample application that demonstrate how to use the VersionOne SDK to build integrations/applications. Although they provide value in themselves, their primary purpose is to as a learning tool.
CreateEntity is a command-line sample that is able to create Stories, Defects, Themes, Goals, Requests, and Issues in a specific project.
DumpEntity is a command-line sample that given a specific entity id displays all property values including related item's names.
DumpProjects is a command-line sample that is able to display all visible projects recursively and optionally display the stories and/or defects within each project.
V1Attachments is a standalone utility that allows you to attach a file to any asset in VersionOne; this includes but is not limited to, a Story, Defect, Task, or Test. This utility can be used directly or you can create a shortcut in the appropriate Windows subdirectory to add VersionOne to the list of "Send To" options available on the right click menu.
The VersionOne Estimation Tool allows you to easily divide VersionOne items into an arbitrary number of groupings or "buckets" and then apply estimate values to all of the items based on which bucket it is in.
The V1Screenshot utility allows you to easily attach an image currently on your windows clipboard to an item within VersionOne, without having to save to disk and add as an attachment. In addition to uploading the image file as an attachment, it can add the image to the tab menu on the VersionOne details page for easy access.
The VersionOne Search (V1Search) is a standalone web application that allows individuals across your organization to search for VersionOne assets across all projects. V1Search is built on top of Lucene.NET, a powerful opensource information retrieval engine. This technology also supports a rich query parser that allows users to create queries that mix terms, logical expressions, and wildcards to narrow their searches.
V1TaskManager is a task tray utility that allows you to view and update key properties of tasks, tests, defects and stories. The utility also allows you to take ownership of items as well as take effort and close items.
V1TortoiseSVN helps you add Workitem IDs into TortoiseSVN check-in popup by showing a window which lists Stories, Defects, Tasks, and Tests assigned to you. It provides quick access to the workitem's IDs to add to the check-in comment to be read by the VersionOne Subversion Integration (V1SVN).