GetPropertyInformation

The GetPropertyInformation API returns a list of properties and their attributes from an IDO collection.

GET	`/info/{ido}`
http://localhost/IDORequestService/ido/info/UserNames

Parameters


Name	In	Required?	Description
ido	Path	Yes	The name of the IDO collection

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 the 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

{
    "Message": null,
    "Success": false,
   "Keys": [
      "UserId"
   ],
    "Properties": [
        {
            "BooleanFalseValue": "",
            "BooleanTrueValue": "",
            "CaseFormat": "",
            "ClrTypeName": "Decimal",
            "ColumnDataType": "TokenType",
            "DataType": "Decimal",
            "DateFormat": "",
            "DecimalPos": 0,
            "DefaultIMECharset": "",
            "DefaultValue": "",
            "DomainIDOName": "",
            "DomainListProperties": "",
            "DomainProperty": "",
            "InputMask": "",
            "IsItemWarnings": false,
            "JustifyFormat": "R",
            "LabelStringID": "sUserID",
            "Length": 11,
            "Name": "UserId",
            "PropertyClass": "Token",
            "RORecord": false,
            "ReadOnly": true,
            "Required": true
        },
        { ... }
    ],
    "SubCollections": [
        {
            "IDOName": "MGCore.UserGroupMaps",
            "LinkBy": [
                {
                    "Child": "UserId",
                    "Parent": "UserId"
                }
            ],
            "Name": "UserGroupMaps"
        },
        {  ... }
    ]
}

Example

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

string json = string.Empty;
 
using ( HttpClient client = new HttpClient() )
{
   string ido = "UserNames";
   string requestUrl = $"http://server/IDORequestService/ido/info/{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();
      json = result.Result;
   }
}