fixed

Changes in API v1

Currently, the result of API v1 modification may depend on the order of JSON/XML fields specified in the request. This behavior is getting fixed.

Once the fix of the API is released:

  • The order of the fields sent with the API v1 POST request will not affect the result.
  • The order of the fields in the API v1 response will slightly change.

📘

The fix will be rolled out to all public clouds in February 2024.

An example of the old behavior.
The following 2 requests to create a team iteration may produce different results:

POST /api/v1/TeamIteration  
{  
  "team": { "id": 1 },  "name": "T1",  
  "startDate": "2024-02-06",  
  "endDate": "2024-02-12"  
}
POST /api/v1/TeamIteration  
{  
  "team": { "id": 1 },  "name": "T1",  
  "endDate": "2024-02-12",  
  "startDate": "2024-02-06"  
}

With the update, the order of the specified fields (here, endDate and startDate) will not affect the result of the request execution.

An example of the response change.

The response for userStoriesendpoint before the change:

The response for userStoriesendpoint after the change: