DeleteItems

The DeleteItems API removes multiple records from a specified IDO collection at one time.

DELETE	`/{responsetype}/{ido}/deleteitems`
http://localhost/IDORequestService/MGRESTService.svc/xml/UserNames/deleteitems

Parameters


Name	In	Required?	Description
responsetype	Path	Yes	Response request data format Specify any 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.

Reqiest data in XML format

<?xml version="1.0"?>
<ArrayOfIDOUpdateItem
	xmlns:xsd="http://www.w3.org/2001/XMLSchema"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://www.infor.com">
  <IDOUpdateItem>
    <Action>Delete</Action>
    <ItemId>PBT=[UserNames] UserNames.DT=[2019-07-24 13:58:55.860] UserNames.ID=[4b5b7da7-dd7c-47d7-8746-2ce193bfc43a]</ItemId>
    <Properties>
      <UpdateProperty>
        <IsNull>false</IsNull>
        <Modified>false</Modified>
        <Name>_ItemId</Name>
      </UpdateProperty>
    </Properties>
  </IDOUpdateItem>
  <IDOUpdateItem>
    <Action>Delete</Action>
    <ItemId>PBT=[UserNames] UserNames.DT=[2019-07-24 13:58:55.997] UserNames.ID=[3faaaaab-47ef-4643-8255-756976238911]</ItemId>
    <Properties>
      <UpdateProperty>
        <IsNull>false</IsNull>
        <Modified>false</Modified>
        <Name>_ItemId</Name>
      </UpdateProperty>
    </Properties>
  </IDOUpdateItem>
</ArrayOfIDOUpdateItem>

Request data in JSON format

[
   {
      "Action": 4,
      "ItemId": "PBT=[UserNames] UserNames.DT=[2019-07-24 13:58:55.860] UserNames.ID=[4b5b7da7-dd7c-47d7-8746-2ce193bfc43a]",
      "Properties": [
         {
            "IsNull": false,
            "Modified": false,
            "Name": "_ItemId",
            "Value": null
         }
      ]
   },
   {
      "Action": 4,
      "ItemId": "PBT=[UserNames] UserNames.DT=[2019-07-24 13:58:55.997] UserNames.ID=[3faaaaab-47ef-4643-8255-756976238911]",
      "Properties": [
         {
            "IsNull": false,
            "Modified": false,
            "Name": "_ItemId",
            "Value": null
         }
      ]
   }
]

Response data in XML format

<MGRestUpdateResponse
	xmlns="http://schemas.datacontract.org/2004/07/"
	xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Message>Delete successful.</Message>
  <MessageCode>202</MessageCode>
</MGRestUpdateResponse>

Response data in JSON format

{
   "Message": "Delete successful.",
   "MessageCode": 202
}

Example

This example code deletes multiple users that have the given _ItemID property values.

string xml = string.Empty;
 
using ( HttpClient client = new HttpClient() )
{
   // optionally, you can use json as the response type        
   string ido = "UserNames";
   string requestUrl = $"http://server/IDORequestService/MGRESTService.svc/xml/{ido}/deleteitems";
 
   // provide token in the Authorization header
   client.DefaultRequestHeaders.TryAddWithoutValidation(
      "Authorization",
      "b/XdI6IQzCviZOGJ0E+002DoKUFOPmVDkwpQDbQj…==" );
 
   List<IDOUpdateItem> idoItems = new List<IDOUpdateItem>();
 
   UpdateProperty itemId = new UpdateProperty
   {
      Name = "ItemId",
      Value = null,
      IsNull = false,
      Modified = false
   };
 
   IDOUpdateItem idoItem = new IDOUpdateItem
   {
      Action = UpdateAction.Delete,
      Properties = new[] { itemId },
      ItemId = "PBT=[UserNames] UserNames.DT=[2019-07-24 13:58:55.860] UserNames.ID=[4b5b7da7-dd7c-47d7-8746-2ce193bfc43a]"
   };
   idoItems.Add( idoItem );
 
   itemId = new UpdateProperty
   {
      Name = "ItemId",
      Value = null,
      IsNull = false,
      Modified = false
   };
 
   idoItem = new IDOUpdateItem
   {
      Action = UpdateAction.Delete,
      Properties = new[] { itemId },
      ItemId = "PBT=[UserNames] UserNames.DT=[2019-07-24 13:58:55.997] UserNames.ID=[3faaaaab-47ef-4643-8255-756976238911]"
   };
   idoItems.Add( idoItem );
 
   XDocument xdoc = new XDocument( new XDeclaration( "1.0", "utf-8", "yes" ) );
   using ( XmlWriter writer = xdoc.CreateWriter() )
   {
      DataContractSerializer serializer = new DataContractSerializer( idoItems.GetType() );
      serializer.WriteObject( writer, idoItems );
   }
 
   // pass the List<IDOUpdateItem> as the request data and send the delete request
   HttpResponseMessage response = client.PostAsync( requestUrl, new StringContent( xdoc.ToString(), Encoding.UTF8, "application/xml" ) ).Result;
 
   using ( HttpContent content = response.Content )
   {
      Task<string> result = content.ReadAsStringAsync();
      xml = result.Result;
   }
}

You can use these classes to construct the Request Data as demonstrated in the previous code snippets:

public class IDOUpdateItem
{
   public UpdateAction Action { get; set; }
   public string ItemId { get; set; }
   public int ItemNo { get; set; }
   public UpdateProperty[] Properties { get; set; }
   public UpdateLocking UpdateLocking { get; set; }
}
 
public class UpdateProperty
{
   public string Name { get; set; }
   public string Value { get; set; }
   public string OriginalValue { get; set; }
   public bool Modified { get; set; }
   public bool IsNull { get; set; }
}
 
public enum UpdateAction
{
   Insert = 1,
   Update = 2,
   Delete = 4
}
 
public enum UpdateLocking
{
   Row = 0,
   Property = 1
}