Get Swagger Collection Document

The Get Swagger Collection Document API returns a swagger collection that contains references to individual IDO swagger documents.
GET /dynamic/api-docs-collection
http://localhost/IDORequestService/ido/dynamic/api-docs-collection?search=UserNames

Parameters

Name In Required Description
search Query No Searches a string against the entity, category, swagger endpoint, or description within the swagger collection
pageNumber Query No Specifies the page number

If this parameter is excluded or left blank, the server defaults the value to 1.
pageSize Query No Specifies the number of items to show per page.

If this parameter is excluded or left blank, the server defaults the value to 10.

Headers

Name Description
Authorization If the API is called directly, then the Mongoose security token is obtained through a call to the GetSecurityToken API.

If the API is called through the ION API, then a valid OAuth2.0 bearer token is provided by ION API.
X-Infor-MongooseConfig The name of a configuration that is available on the application server

Request data

None

Response data

{
    "info": {
        "description": "Infor Mongoose",
        "title": "Infor Mongoose Swagger Collection",
        "version": "1.0"
    },
    "entityName": "Business Class",
    "entityType": "Business Class",
    "paging": {
        "total": 30,
        "pageNumber": 1,
        "pageSize": 30
    },
    "swaggerCollection": {
        "swagger": [
            {
                "category": "dynamic",
                "entity": "AccessAs",
                "desc": "Access As IDO",
                "swaggerEndpoint": "../api-docs-collection/AccessAs"
            },
            {
                "category": "dynamic",
                "entity": "ActiveBGTask",
                "desc": "ActiveBGTask",
                "swaggerEndpoint": "../api-docs-collection/ActiveBGTask"
            },
            {
                "category": "dynamic",
                "entity": "UserNames",
                "desc": "UserNames",
                "swaggerEndpoint": "../api-docs-collection/UserNames"
            }
        ]
    }
}

Example

This example code retrieves the swagger collection that contains a list of IDO swagger document endpoints.

string json = string.Empty;
using ( HttpClient client = new HttpClient() )
{
   string requestUrl = $"http://localhost/IDORequestService/ido/dynamic/api-docs-collection";
 
   // provide the configuration name in the X-Infor-MongooseConfig header
   client.DefaultRequestHeaders.TryAddWithoutValidation(
   "X-Infor-MongooseConfig",
   "Mongoose" );
 
   HttpResponseMessage response = client.GetAsync( requestUrl ).Result;
 
   using ( HttpContent content = response.Content )
   {
      Task<string> result = content.ReadAsStringAsync();
      json = result.Result;
   }
}