IDOInfo

The IDOInfo API returns the property metadata for an IDO collection.
GET /{responsetype}/idoinfo/{ido}
http://localhost/IDORequestService/MGRESTService.svc/xml/idoinfo/UserNames

Parameters

Name In Required? Description
responsetype Path Yes Response request data format

Specify either of these values:

  • xml
  • json
ido Path Yes The name of the IDO collection

Headers

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

If the API is called through 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

This header is required only when using the Mongoose API through the ION API.

Request data

None

Response data in XML format 

<ArrayOfRestIdoItemPropInfo xmlns="http://schemas.datacontract.org/2004/07/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <RestIdoItemPropInfo>
    <defaultValue/>
    <labelStringID>sUserID</labelStringID>
    <name>UserId</name>
    <required>true</required>
    <dataType>Decimal</dataType>
    <length>11</length>
    <readOnly>true</readOnly>
  </RestIdoItemPropInfo>
  <RestIdoItemPropInfo>
    <defaultValue/>
    <labelStringID>sUsername</labelStringID>
    <name>Username</name>
    <required>true</required>
    <dataType>String</dataType>
    <length>128</length>
    <readOnly>false</readOnly>
  </RestIdoItemPropInfo>
  <RestIdoItemPropInfo>
    ...
  </RestIdoItemPropInfo>
</ArrayOfRestIdoItemPropInfo>

Response data in JSON format 

 [
   {
      "defaultValue": "",
      "labelStringID": "sUserID",
      "name": "UserId",
      "required": true,
      "dataType": "Decimal",
      "length": 11,
      "readOnly": true
   },
	 {
		"defaultValue": "",
		"labelStringID": "sUsername",
		"name": "Username",
		"required": true,
		"dataType": "String",
		"length": 128,
		"readOnly": false
	 },
	 { ... }
]

Example

This example code retrieves an array of properties and their attributes from a specified IDO. 

string xml = string.Empty;
 
using ( var client = new HttpClient() )
{
   // optionally, you can use json as the response type
   string ido = "UserNames";
   string requestUrl = $"http://server/IDORequestService/MGRESTService.svc/xml/idoinfo/{ido}";
 
   // provide token in the Authorization header
   client.DefaultRequestHeaders.TryAddWithoutValidation(
      "Authorization",
      "b/XdI6IQzCviZOGJ0E+002DoKUFOPmVDkwpQDbQj…==" );
 
   // send the get request
   HttpResponseMessage response = client.GetAsync( requestUrl ).Result;
 
   using ( HttpContent content = response.Content )
   {
      Task<string> result = content.ReadAsStringAsync();
      // get the xml response
      xml = result.Result;
   }
}