Endpoints
API endpoints are formed by appending the endpoint to the server base URI.
<Server Base URI>/<endpoint>
- ActivityStream
- api/tags
- assetdetail.v1
- attachments.img
- loc-2.v1
- loc.v1
- meta.v1
- API/ProjectRoles Endpoint
- query.v1
- rest-1.v1/Data
- rest-1.v1/Hist
- rest-1.v1/New
Comparison of Query Endpoints
| query.v1 | rest-1.v1/Data |
|---|---|
| Read-only | Read, write, and update |
| Allows retrieval of arbitrarily nested master/detail and hierarchical relationships. (For example, you can retrieve all the Schedules in a Scope, all the Iterations in the Schedules, and all the Workitems in the iterations, all in one go.) | One root Asset Type per HTTP call. |
| Multiple queries - When HTTP round-trip time dominates the query response time, it can be useful to submit many queries in one HTTP transaction. This endpoint accepts an arbitrary number of independent queries. They are submitted to the retrieval subsystem in parallel. | Single queries - This endpoint supports only one query per HTTP transaction. |
| JSON serialization - The response format is a simple name-to-value mapping of attributes to their values. It contains very little metadata, and yields a usable object when deserialized by most JSON decoders. It is not necessary to write code that "unpacks" the returned data. | XML serialization |
| Queries are expressed in a readable style using YAML or JSON. | Queries are expressed in a REST syntax, with the Asset Type and ID encoded in the URL, and the query terms encoded into the URL query string. This encoding is not human-oriented, especially when URL query escaping is applied. |
| Available since 13.2, Summer 2013. | Available since 7.1, Spring 2007. |