Search code examples
javadynamics-crm-2016http-methodx-http-method-override

Java and MS CRM 2016 Web API Updates


i have a java application and i am trying to update an opportunity via the crm web api. When i try to use a Non-Standard HTTP Method like PATCH (which is neccessary for the update) and override it with the "X-HTTP-Method-Override" like i found it in various example codes, it doesnt work.

Code for the opportunity update:

public int updateOpportunity(OpportunityDaoModel model) throws IOException, URISyntaxException {
JSONObject opportunity = new JSONObject();
opportunity.put("name", model.getTopic());

HttpURLConnection connection = null;
URL url = new URL(RESOURCE + "/api/data/"+API_VERSION+"/opportunities(" + model.getCrmguid() + ")");
connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("POST");
connection.setRequestProperty("X-HTTP-Method-Override", "PATCH");
connection.setRequestProperty("OData-MaxVersion", "4.0");
connection.setRequestProperty("OData-Version", "4.0");
connection.setRequestProperty("Accept", "application/json");
connection.addRequestProperty("Authorization", "Bearer " + token);
connection.setUseCaches(false);
connection.setRequestProperty("Content-Type", "application/json");
connection.setDoOutput(true);
connection.connect();

OutputStreamWriter out = new OutputStreamWriter(connection.getOutputStream());
out.write(opportunity.toString());
out.flush();
out.close();
int responseCode = connection.getResponseCode();
return responseCode;
}

After executing this method i get the following error:

{
 "error":{
   "code":"","message":"Unmapped Request found, PathTemplate:~/entityset/key, HttpVerb:POST","innererror":{
     "message":"Unmapped Request found, PathTemplate:~/entityset/key, HttpVerb:POST","type":"Microsoft.Crm.CrmHttpException","stacktrace":"   at Microsoft.Crm.Extensibility.OData.EntityController.HandleUnmappedRequest(ODataPath path)\r\n   at lambda_method(Closure , Object , Object[] )\r\n   at System.Web.Http.Controllers.ReflectedHttpActionDescriptor.ActionExecutor.<>c__DisplayClass10.<GetExecutor>b__9(Object instance, Object[] methodParameters)\r\n   at System.Web.Http.Controllers.ReflectedHttpActionDescriptor.ExecuteAsync(HttpControllerContext controllerContext, IDictionary`2 arguments, CancellationToken cancellationToken)\r\n--- End of stack trace from previous location where exception was thrown ---\r\n   at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task)\r\n   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   at System.Web.Http.Controllers.ApiControllerActionInvoker.<InvokeActionAsyncCore>d__0.MoveNext()\r\n--- End of stack trace from previous location where exception was thrown ---\r\n   at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task)\r\n   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   at System.Web.Http.Controllers.ActionFilterResult.<ExecuteAsync>d__2.MoveNext()\r\n--- End of stack trace from previous location where exception was thrown ---\r\n   at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task)\r\n   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   at System.Web.Http.Dispatcher.HttpControllerDispatcher.<SendAsync>d__1.MoveNext()"
   }
 }
}

After i didn't find any information on the web for this error i tried a different entry and wanted to use the single attribute update via PUT. This succeeds for normal attributes (like the name attribute on many entities) but when i try to update a lookup field i get a different error. But first my method:

Code for the single attribute update:

public int updateAttribute(String entity, String id, String attribute, String value) throws IOException, URISyntaxException {
JSONObject opportunity = new JSONObject();
HttpURLConnection connection = null;
String urlString = "";
if(attribute.contains("@odata.bind")) { // lookup value
    urlString = RESOURCE + "/api/data/"+API_VERSION+"/"+entity+"(" + id + ")";
        opportunity.put(attribute, value);
} else { // text value
        urlString = RESOURCE + "/api/data/"+API_VERSION+"/"+entity+"(" + id + ")/" + attribute;
        opportunity.put("value", value);
}
URL url = new URL(urlString);
connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("PUT");
connection.setRequestProperty("OData-MaxVersion", "4.0");
connection.setRequestProperty("OData-Version", "4.0");
connection.setRequestProperty("Accept", "application/json");
connection.addRequestProperty("Authorization", "Bearer " + token);
connection.setUseCaches(false);
connection.setRequestProperty("Content-Type", "application/json");
connection.setDoOutput(true);
connection.connect();

OutputStreamWriter out = new     OutputStreamWriter(connection.getOutputStream());
out.write(opportunity.toString());
out.flush();
out.close();
int responseCode = connection.getResponseCode();
return responseCode;
}

i call this method via

 updateAttribute("opportunities", model.getCrmguid(), "lookupentityid@odata.bind", "/entityendpointwiths("+model.getProgress()+")");

The error message:

{
 "error":{
    "code":"","message":"Operation not supported on opportunity","innererror":{
    "message":"Operation not supported on opportunity","type":"Microsoft.Crm.CrmHttpException","stacktrace":"   at Microsoft.Crm.Extensibility.OData.EntityController.PutEntity(String entityName, String key, EdmEntityObject entity)\r\n   at lambda_method(Closure , Object , Object[] )\r\n   at System.Web.Http.Controllers.ReflectedHttpActionDescriptor.ActionExecutor.<>c__DisplayClass10.<GetExecutor>b__9(Object instance, Object[] methodParameters)\r\n   at System.Web.Http.Controllers.ReflectedHttpActionDescriptor.ExecuteAsync(HttpControllerContext controllerContext, IDictionary`2 arguments, CancellationToken cancellationToken)\r\n--- End of stack trace from previous location where exception was thrown ---\r\n   at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task)\r\n   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   at System.Web.Http.Controllers.ApiControllerActionInvoker.<InvokeActionAsyncCore>d__0.MoveNext()\r\n--- End of stack trace from previous location where exception was thrown ---\r\n   at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task)\r\n   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   at System.Web.Http.Controllers.ActionFilterResult.<ExecuteAsync>d__2.MoveNext()\r\n--- End of stack trace from previous location where exception was thrown ---\r\n   at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task)\r\n   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   at System.Web.Http.Dispatcher.HttpControllerDispatcher.<SendAsync>d__1.MoveNext()"
    }
  }
 }

Thank you for any help.

Kind regards, Dennis


Solution

  • If anyone else should be in this position i am happy to present you my answer. Instead of using the x-http-override header you should use the HTTPPatch-Class of java.

    method:

    public String updateAttribute(String entity, String id, List<Map<String, Object>> parameters) throws IOException, URISyntaxException {
    JSONObject object = new JSONObject();
        for (Map<String, Object> map : parameters) {
            for (Map.Entry<String, Object> entry : map.entrySet()) {
                String key = entry.getKey();
                Object value = entry.getValue();
                object.put(key, value);
            }
        }
    
        String urlString = "";
        urlString = RESOURCE + "/api/data/"+API_VERSION+"/"+entity+"(" + id + ")/";
        StringEntity stringEntity = new StringEntity(object.toString());
    
        URL url = new URL(urlString);
        HttpPatch httpPatch = new HttpPatch(urlString);
        httpPatch.addHeader("OData-MaxVersion", "4.0");
        httpPatch.addHeader("OData-Version", "4.0");
        httpPatch.addHeader("Accept", "application/json");
        httpPatch.addHeader("Authorization", "Bearer " + token);
        httpPatch.addHeader("Content-Type", "application/json");
        httpPatch.setEntity(stringEntity);
    
        CloseableHttpClient httpClient = HttpClients.createDefault();
        HttpResponse httpResponse = httpClient.execute(httpPatch);
    
    int responseCode =  httpResponse.getStatusLine().getStatusCode();
    
    if (responseCode > 299) {
        InputStream inputStream = httpResponse.getEntity().getContent();
        ByteArrayOutputStream result = new ByteArrayOutputStream();
        byte[] buffer = new byte[1024];
        int length;
        while ((length = inputStream.read(buffer)) != -1) {
            result.write(buffer, 0, length);
        }
    
        throw new IOException(result.toString("UTF-8"));
    }
    
    return responseCode;
    }
    

    Calling the method via:

    List<Map<String,Object>> opportunityParameterList = new ArrayList<>();
    Map<String, Object> opportunityParameters = new HashMap<>();      
    opportunityParameters.put("name", opportunityDaoModel.getTopic());
    opportunityParameters.put("lookupfield@odata.bind", "/lookupentityendpoint("+opportunityDaoModel.getProgress()+")");
    opportunityParameterList.add(opportunityParameters);
    this.crmHelper.updateAttribute("opportunities", opportunityDaoModel.getCrmguid(), opportunityParameterList);