Execute IDO Swagger Document Post Operation

The Execute IDO Swagger Document Post Operation API executes a strongly typed API for the specified IDO collection. This API is only applicable for strongly typed APIs that are UpdateCollection or InvokeIDOMethod.
GET /dynamic/api-docs-collection/{ido}/{operationID}
http://localhost/IDORequestService/ido/dynamic/api-docs-collection/UserNames/CreateUser

Parameters

Name In Required Description
ido Path Yes The name of the IDO collection that is associated with the strongly typed API
operationID Path Yes The name of the strongly typed API to be executed
refresh Query No Instructs the system to refresh the collection after the update is complete
Valid values are True or False.
Note: Use this parameter only if the strongly typed API is an UpdateCollection API.
parameter1 to parameter50 Query No Passes the parameters required by the method being invoke
Note: Use these parameters only if the strongly typed API is an InvokeIDOMethod 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 when the strongly typed API is an UpdateCollectio API

{
    "RefreshItems": [
        {
            "Action": 1,
            "ItemId": "PBT=[UserNames] UserNames.DT=[2022-05-23 11:42:40.977] UserNames.ID=[64e98785-32ed-44f1-82eb-16d3719299e9]",
            "ItemNo": 0,
            "Properties": [
                {
                    "Name": "Username",
                    "Value": "jdoe",
                    "OriginalValue": null,
                    "Modified": false,
                    "IsNull": false,
                    "IsNestedCollection": false
                },
                {
                    "Name": "InWorkflow",
                    "Value": "0",
                    "OriginalValue": null,
                    "Modified": false,
                    "IsNull": false,
                    "IsNestedCollection": false
                }
            ],
            "UpdateLocking": 0
        }
    ],
    "Success": true,
    "Message": null
}

Response data when the strongly typed API is an InvokeIDOMethod API

{
    "ReturnValue": "0",
    "Parameters": [
        "mpalanca",
        "4",
        "1",
        "",
        ""
    ],
    "Success": true,
    "Message": null
}

Example

This example code executes a strongly typed API that invokes the GetUserAttributes method from the UserNames IDO.

string json = string.Empty;
using ( HttpClient client = new HttpClient() )
{
   string requestUrl = $"http://localhost/IDORequestService/ido/dynamic/api-docs-collection/UserNames/GetUserAttributes?parameter1=sa&parameter2=&parameter3=&parameter4=&parameter5=";
 
   // provide token in the Authorization header
   client.DefaultRequestHeaders.TryAddWithoutValidation(
      "Authorization",
      "b/XdI6IQzCviZOGJ0E+002DoKUFOPmVDkwpQDbQjm3w/=…" );
 
   HttpResponseMessage response = client.PostAsync( requestUrl, null ).Result;
 
   using ( HttpContent content = response.Content )
   {
      Task<string> result = content.ReadAsStringAsync();
      json = result.Result;
   }
}