Contact Free trial Login

API Mocking Service Release Notes


October 5, 2019

DateTime elements appeared with null values in responses from the mocking service, even when API specifications provided example responses that contained values for these elements.


September 7, 2019


Version 2 of the mocking service is replacing Version 1. You must migrate any API-specification project that meets both of these conditions:

  • The mocking service was switched on for the project before January 10, 2019.

  • The mocking service has been running continuously since it was switched on.

Dates for the Deprecation and End of Life of Version 1

  • On November 29, 2019, Version 1 of the mocking service will be deprecated. Starting on that date, third-party tools must include this header in requests that they send to the mocking service to test endpoints in API specifications being developed in API Designer:


    The header must have this value:

    I understand that version 1 of the mocking service is deprecated and that I need to upgrade before February 1, 2020.

  • Starting February 1, 2020, Version 1 of the mocking service will no longer send responses to requests. If you have not migrated your projects to use Version 2 of the mocking service by this date, the mocking service will return the HTTP status code 301 and provide a link to this document.

Information About Version 2 and How to Migrate

For information about the new features in Version 2 of the mocking service and about how to migrate your projects, see Migrate API-Specification Projects to Version 2 of the Mocking Service.

New Feature

The new behavioral header MS2-Status-Code-Selection gives you two options for controlling how the mocking service selects a status code for responses to requests. See Add Behavioral Headers to Simulated API Calls for details.


August 10, 2019

This release includes minor bug fixes.


July 13, 2019

Fixed Issues

  • Executing the Get command in RAML produces an empty response in the example data.

  • Request and response are not showing up in the mocking service.


June 15, 2019

This release contains one new feature and two fixes.

New Feature

  • Use behavioral headers with the mocking service to modify in various ways how the mocking service behaves. See Add Behavioral Headers to Simulated API Calls.

  • Now, the mocking service supports XML serialization facets, such as wrapped, attribute, and name, when generating an XML response that is based on a RAML example.

Fixed Issues

  • The mocking service included invalid tags in returned XML when the data type contained an array.

  • The mocking service converted null values to string "null" values.


May 18, 2019

  • The API Console and the mocking service were adding invalid tags to XML examples.

  • Though multiple examples were defined for an endpoint, the mocking service always used the same example, rather than randomly selecting one to use.

  • When an OAS API specification did not define any consuming media type for a specific endpoint, the mocking service failed.


February 23, 2019

The following issues were resolved in this release: * For an API specification written in RAML, the mocking service returned content that was in YAML, although the returned content should have been in XML. * The mocking service returned a misleading error message when baseURI was invalid.


January 10, 2019

The following issues were resolved in this release:

  • [SE-8276] - Issues with Design Center

  • [SE-8614] - Request header 'Accept' failing when application/xml is present before application/json

  • [SE-8666] - Mocking service for OAuth 2.0 requires users to provide both authorization header and access token

  • [SE-8745] - Mocking service required parameters are allowed to be left out

  • [SE-8790] - Mocking Server Validation on Message Body

  • [SE-8999] - RAML in Design Center: Unexpected token A in JSON at position 1

  • [SE-9588] - Mock Service returns 404 for paths with hyphens in 3rd level resource name

  • [SE-9830] - Mock service api always return 400

  • [SE-9990] - JSON Schema defined inline in Design Center RAML gives error, OK on Studio

  • [SE-10045] - Incorrect Datetime-only format error when trying on mocking service from design center

  • [SE-10194] - RAML issue with optional enum type headers

  • [SE-10222] - additionalProperties=false in RAML are ignored by Design Center and exchange Mocking services.


August 21, 2018

This release fixes the following issue:

  • The mocking service did not return messages for the 400 response in the correct styling.


June 30, 2018

This release fixes the following issue:

  • TLS 1.0 and 1.1 were still supported. Now, only 1.2 is supported.


May 19, 2018

The parser is now at version 1.1.42.


April 21, 2018

  • Invoking a resource that required the uriParameter (e.g., “/master/{attname}”) returned the example response for root instead of the defined example.

  • Invoking a resource that required a uriParameter and then using the example parameter in a GET or PUT method resulted in a response containing the complete API specification.


March 24, 2018

This release bumps the parser and includes bug fixes.


Bumped parser to 1.1.41.

Fixed Issues

  • Parsing no longer returns an Error for XML and Schema valid.

  • Fixed an issue with getting validation errors while building RAML for XML with Attributes and Inner text.

  • Fixed an issue that prevented some methods that return an Array from correctly showing the response example.


February 24, 2018

This release fixes several bugs.

Fixed Issues

  • A problem that prevented validation datetime query parameters with format RFC3339.

  • The issue causing RAML with a null response to return "message": in the HTTP response with 0 length.

  • The multipleOf facet validation issue.


January 13, 2018

This release resolves a few issues:

Resolved Issues

  • Fixed a problem related to a URI parameter name containing a hyphen (-) character.

  • Fixed an issue with making a request that has a empty body of type application/json.

  • Fixed a bug that returned a 400 "body: unknown type any" when using a body with an example that has no type definition.


December 16, 2017

This release introduces the following improvements and resolved issues:


  • Using the mocking service from a proxy application overrides the mocking service of the API itself.

  • The Authorization header check for path simulation has been removed.

  • When you don’t specify the main example for a DataType, the mocking service provides the examples defined for each property.

Resolved Issues

  • Using a proxy application, the mocking service now validates the Body of the method when you try to POST it.

  • Using a base URI ending with / no longer causes a 404 error.

  • The mocking service now recognizes object type as an enum in a URI parameter.

  • Enforcement of a required data type has been fixed. An absent data type or one that does not include all required fields is rejected.

  • The problem related to using the RAML anonymous security scheme has been fixed.


October 21, 2017

This release focuses on bug fixes.


  • Enhanced the Mocking Server to respond with random examples if more than one is available.

  • A successful mock creation POST request now returns a 201 response status code instead of 200.

Resolved Issues

Fixed to work properly when the RAML has URI parameters.


August 26, 2017

This release focuses on bug fixes.

Resolved Issues

  • Examples defined in datatypes were not displayed properly.

  • Mocking server was returning 404 for calls with query parameters.


July 15, 2017

This release focuses on bug fixes and closing gaps for RAML 1.0 support.

Resolved Issues

Fixed an issue preventing API Notebook text from expanding properly.

Was this article helpful?

💙 Thanks for your feedback!

Leave feedback…

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.