Get IDO Swagger Document

The Get IDO Swagger Document API returns an IDO swagger document that contains strongly typed APIs. These strongly typed APIs are generated using the REST API Wizard for the specified IDO collection.
GET /dynamic/api-docs-collection/{ido}
http://localhost/IDORequestService/ido/dynamic/api-docs-collection/UserNames

Parameters

Name In Required Description
ido Path Yes The name of the IDO collection that is associated with the strongly typed API

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

{
   "swagger": "2.0",
   "info": {
      "description": "UserNames",
      "version": "v2",
      "title": "UserNames",
      "contact": {
         "name": "Infor",
         "url": "https://www.inforxtreme.com"
      }
   },
   "basePath": "/YEL1_DEV/MONGOOSE_DEV/IDORequestService/ido/dynamic",
   "tags": [
      {
         "name": "default",
         "description": ""
      }
   ],
   "schemes": [
      "https"
   ],
   "paths": {
      "/GetMyUserAttributes": {
         "post": {
            "tags": [
               "default"
            ],
            "summary": "GetMyUserAttributes",
            "description": "Get My User Attributes",
            "operationId": "GetMyUserAttributes",
            "consumes": [
               "application/json"
            ],
            "produces": [
               "application/json"
            ],
            "parameters": [
               {
                  "name": "X-Infor-MongooseConfig",
                  "in": "header",
                  "required": false,
                  "description": "Mongoose configuration to log into; required when using the service through ION API, not needed otherwise.",
                  "type": "string"
               }
            ],
            "responses": {
               "200": {
                  "description": "See Success and Message in the response for result status.",
                  "schema": {
                     "$ref": "#/definitions/InvokeMethodResponse"
                  }
               },
               "401": {
                  "$ref": "#/responses/Unauthorized"
               }
            }
         }
      },
      "/GetUserNames": {
         "get": {
            "tags": [
               "default"
            ],
            "summary": "GetUserNamesOnly",
            "description": "Get Usernames Only",
            "operationId": "GetUserNamesOnly",
            "produces": [
               "application/json"
            ],
            "parameters": [
               {
                  "name": "X-Infor-MongooseConfig",
                  "in": "header",
                  "required": false,
                  "description": "Mongoose configuration to log into; required when using the service through ION API, not needed otherwise.",
                  "type": "string"
               }
            ],
            "responses": {
               "200": {
                  "description": "See Success and Message in the response for result status.",
                  "schema": {
                     "$ref": "#/definitions/LoadCollectionResponse"
                  }
               },
               "401": {
                  "$ref": "#/responses/Unauthorized"
               }
            }
         }
      }
   },
   "definitions": { ... },
   "responses": { ... }
}

Example

This example code retrieves the IDO swagger document that contains strongly typed APIs. These strongly typed APIs are generated for the AccessAs IDO.
string json = string.Empty;
using ( HttpClient client = new HttpClient() )
{
   string requestUrl = $"http://localhost/IDORequestService/ido/dynamic/api-docs-collection/AccessAs";
 
   // provide 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;
   }
}