|Core API Winter 2012|
Core API Winter 2012
The VersionOne Data API allows programmatic access to the information stored in your VersionOne system. Through the Data API, you can query for simple or complex sets of information, update the information, and execute system-defined operations.
Simple queries can request the value of a single attribute on a single asset, or multiple attributes on a single asset. Complex queries can request multiple assets meeting a certain criteria, have the results sorted in a particular way, and even ask for a portion (a "page") of the overall results.
Using the VersionOne Data API involves sending HTTP requests to specific URLs. GET requests are used to query information, and receive an XML response. POST requests are used to update information, and include an XML payload to describe the update. POST requests are also used to execute operations, which change data in ways that cannot be accomplished with a simple update (such as re-opening a closed Story).
The Meta API provides a facility for retrieving information about the VersionOne business objects. This includes getting information about the asset types, attribute definitions, relationships and operations. For an overview on the information model see the API Documentation VersionOne Information Model section.
Meta allows a client of the API to discover various pieces of information such as which attribute definitions are required, what content is valid for an attribute, and which attributes belong to which asset types. For example Meta will indicate that the Story asset type has an attribute definition called Estimate which is a Numeric attribute type and is not required.
Each asset type contains a collection of attribute definitions, a collection of operations, and a number of useful attribute definitions for things like sorting. Each attribute definition describes the type of data it can contain as well as whether it is required, read only, and multi value. Each operation contains a reference to an attribute definition that can be used to determine whether the specific operation can be executed on a given asset or not.
Localization allows a client to retrieve the suggested localization of a specific string or word. Often other VersionOne APIs will return unlocalized strings such as suggested names or error messages. These unlocalized strings may be passed to the Localization API which will attempt to translate the string into a locale specific string.