Version 2

This section presents the updated version of the Mongoose REST API.

Base URL

All endpoints are accessible using HTTP(s) and are located at this URL:

http://<serverName>/IDORequestService/ido

Generic API documentation

Generic swagger API documentation is available for the Mongoose REST API. This document fully describes each API operation and includes both required and optional parameters, Request Data examples, and so on. You can access this document using this endpoint:

http://<serverName>/IDORequestService/ido/api-docs

Dynamic API documentation

Dynamic swagger collection documentation is also available for the REST API. This set contains references to individual IDO swagger documents which are generated using the REST API Wizard. You can access this set using this endpoint:

http://serverName/IDORequestService/ido/dynamic/api-docs-collection

Swagger API documentation for a specific IDO can also be accessed. The endpoint for this document returns an IDO swagger document that contains custom APIs specific for the given IDO. This document is generated using the REST API Wizard. You can access the document using this endpoint:

http://serverName/IDORequestService/ido/dynamic/api-docs-collection/IDOName

Content type

Each endpoint requires the request and response data to either be empty or JSON-formatted. No other content types are supported.