Child pages
  • REST API Plugin

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Feel free to ask questions and provide feedback in our plugins forum.

REST API Versions

As REST API evolves from one TeamCity version to another there can be incompatible changes in the protocol.
Under http://teamcity:8111/app/rest/ URL the latest version is available.
Under http://teamcity:8111/app/rest/<version> URL, other versions CAN be available. Our general policy is to supply TeamCity with ONE previous version.
In TeamCity 7.x you can use "6.0" instead of <version> to get previous version of the protocol.
In TeamCity 8.0 you can use "6.0" or "7.0" instead of <version> to get previous versions of the protocol.

Breaking changes in the API are described in Upgrade Notes sections of corresponding TeamCity version documentation.
Please note that additions to the objects returned (such as new XML attributes or elements) are not considered major changes and does not cause the protocol version to increment.
Also, the endpoints marked with "Experiments" comment in application.wadl can change in future versions without special notice.

General Notes

When posting XML, be sure to specify HTTP header "Content-Type: application/xml".
Requests that response with collections (.../projects, .../buildTypes, .../builds, .../changes) serve partial items with only the most important item fields. Use URL constructed with the value of "href" item attribute to get the full item data.

...

You can get details on errors and REST request processing in logs\teamcity-rest.log server log.
Please turn on debug logging (e.g. set Logging Preset to "debug-rest" on Administration/Diagnostics page or modify Log4J "jetbrains.buildServer.server.rest" category) to get details about each processed request.

REST API Versions

As REST API evolves from one TeamCity version to another there can be incompatible changes into the protocol.
Under http://teamcity:8111/app/rest/ URL the latest version is available.
Under http://teamcity:8111/app/rest/<version> URL, other versions CAN be available. Our general policy is to supply TeamCity with ONE previous version.
In TeamCity 7.x you can use "6.0" instead of <version> to get previous version of the protocol.
In TeamCity 8.0 you can use "6.0" or "7.0" instead of <version> to get previous versions of the protocol.

Please note that additions to the objects returned (such as new XML attributes or elements) are not considered major changes and does not cause the protocol version to increment.

Sources

If you need to extend the plugin with your functionality, you can base your plugin on the current REST API plugin code, but ensure that your plugin does not interfere with the bundled REST plugin. To achieve this, change teamcity-plugin.xml file to have different plugin name and different value for "api.path" parameter. Once this is done, your patched plugin and original REST api plugin can work in the single TeamCity installation.

...