Detailed Request Examples.

[Orangewithsugar]

Dear EMFCloud Team,

I hope this message finds you well. I am currently working with EMFCloud and I am looking for detailed examples of how to make various API requests to the ModelServer. Could you kindly provide some comprehensive examples or direct me to relevant documentation?

I would greatly appreciate any assistance you can offer, as this would be extremely helpful in furthering my understanding of the ModelServer API.

Thank you for your time and support!

Best regards.

[eneufeld]

Hi @Orangewithsugar ,
You can find the integration code of GLSP to the modelserver here: https://github.com/eclipse-emfcloud/emfcloud-modelserver-theia
You can find the extensive example here: https://github.com/eclipsesource/coffee-editor/

Do you have an EMF Model that you want to integrate?
Can you elaborate on your use case?

Best

[Orangewithsugar]

Ty for your reply, For this eg:

I'm failed to request like this, the request returns 200OK, but in modelserver's console :

Caused by: org.eclipse.emf.common.util.BasicEList$BasicIndexOutOfBoundsException: index=0, size=0
	at org.eclipse.emf.common.util.BasicEList.remove(BasicEList.java:601) ~[org.eclipse.emf.common_2.27.0.v20221121-1400.jar:?]
	at org.eclipse.emf.common.notify.impl.NotifyingListImpl.doRemove(NotifyingListImpl.java:756) ~[org.eclipse.emf.common_2.27.0.v20221121-1400.jar:?]
	at org.eclipse.emf.common.notify.impl.NotifyingListImpl.remove(NotifyingListImpl.java:737) ~[org.eclipse.emf.common_2.27.0.v20221121-1400.jar:?]
	at org.eclipse.emfcloud.modelserver.common.codecs.DefaultJsonCodec.decode(DefaultJsonCodec.java:78) ~[org.eclipse.emfcloud.modelserver.common_0.8.0.I20230217.jar:?]
	at org.eclipse.emfcloud.modelserver.common.codecs.DefaultJsonCodec.decode(DefaultJsonCodec.java:60) ~[org.eclipse.emfcloud.modelserver.common_0.8.0.I20230217.jar:?]
	at org.eclipse.emfcloud.modelserver.emf.common.codecs.DICodecsManager.decode(DICodecsManager.java:104) ~[org.eclipse.emfcloud.modelserver.emf_0.8.0.I20230217.jar:?]
	at org.eclipse.emfcloud.modelserver.emf.patch.EMFCommandHandler.getPatchCommand(EMFCommandHandler.java:60) ~[org.eclipse.emfcloud.modelserver.emf_0.8.0.I20230217.jar:?]
	at org.eclipse.emfcloud.modelserver.emf.patch.EMFCommandHandler.getPatchCommand(EMFCommandHandler.java:48) ~[org.eclipse.emfcloud.modelserver.emf_0.8.0.I20230217.jar:?]
	at org.eclipse.emfcloud.modelserver.emf.patch.PatchCommandHandler$RegistryImpl.lambda$2(PatchCommandHandler.java:70) ~[org.eclipse.emfcloud.modelserver.emf_0.8.0.I20230217.jar:?]
	at java.util.Optional.map(Optional.java:260) ~[?:?]
	at org.eclipse.emfcloud.modelserver.emf.patch.PatchCommandHandler$RegistryImpl.getPatchCommand(PatchCommandHandler.java:70) ~[org.eclipse.emfcloud.modelserver.emf_0.8.0.I20230217.jar:?]
	at org.eclipse.emfcloud.modelserver.emf.common.DefaultModelController.readPatchCommand(DefaultModelController.java:462) ~[org.eclipse.emfcloud.modelserver.emf_0.8.0.I20230217.jar:?]
	at org.eclipse.emfcloud.modelserver.emf.common.DefaultModelController.lambda$13(DefaultModelController.java:362) ~[org.eclipse.emfcloud.modelserver.emf_0.8.0.I20230217.jar:?]
	at java.util.Optional.ifPresentOrElse(Optional.java:196) ~[?:?]
	at org.eclipse.emfcloud.modelserver.emf.common.DefaultModelController.withModel(DefaultModelController.java:413) ~[org.eclipse.emfcloud.modelserver.emf_0.8.0.I20230217.jar:?]
	at org.eclipse.emfcloud.modelserver.emf.common.DefaultModelController.executeCommandV2(DefaultModelController.java:361) ~[org.eclipse.emfcloud.modelserver.emf_0.8.0.I20230217.jar:?]
	at org.eclipse.emfcloud.modelserver.emf.common.SingleThreadModelController.lambda$13(SingleThreadModelController.java:127) ~[org.eclipse.emfcloud.modelserver.emf_0.8.0.I20230217.jar:?]
	at org.eclipse.emfcloud.modelserver.emf.common.DefaultModelSynchronizer.lambda$1(DefaultModelSynchronizer.java:70) ~[org.eclipse.emfcloud.modelserver.emf_0.8.0.I20230217.jar:?]
	at org.eclipse.emfcloud.modelserver.emf.common.DefaultModelSynchronizer.lambda$2(DefaultModelSynchronizer.java:116) ~[org.eclipse.emfcloud.modelserver.emf_0.8.0.I20230217.jar:?]
	at java.util.concurrent.FutureTask.run(FutureTask.java:317) ~[?:?]
	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1144) ~[?:?]
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:642) ~[?:?]
	at java.lang.Thread.run(Thread.java:1575) ~[?:?]

what I request is :

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, """
{
    "data": {
        "type": "modelserver.emfcommand",
        "data": {
            "eClass": "http://www.eclipse.org/emfcloud/modelserver/command#//CompoundCommand",
            "type": "compound",
            "commands": [
               
            ]
        }
    }
}
""");
Request request = new Request.Builder()
  .url("http://localhost:8081/api/v2/models?modeluri=test.sysmlx")
  .method("PATCH", body)
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

Best Reguards.

[eneufeld]

@Orangewithsugar ,

I'm a bit lost.
The example you shared does not have commands inside the compoundcommand.
This probably leads to the error above.

What are you trying to achieve? Do you want to get the model from the ModelServer? Or do you want to update the model?

Best

[Orangewithsugar]

Yeah.. i mean eventhough i add the command inside it , it still failed with this exception.
I want to update the model.
Best

[eneufeld]

can you show me the full command you send or is what you shared above the full command?

If it is the full command, then the problem is that your command looks like this:

{
        "type": "modelserver.emfcommand",
        "data": {
            "eClass": "http://www.eclipse.org/emfcloud/modelserver/command#//CompoundCommand",
            "type": "compound",
            "commands": [
               
            ]
        }
    }

But as it is a compoundcommand then it needs children as it is just a collector of commands that should be executed as one, allowing for undoing them also at once, kind of a transaction.
So what you need is:

{
        "type": "modelserver.emfcommand",
        "data": {
            "eClass": "http://www.eclipse.org/emfcloud/modelserver/command#//CompoundCommand",
            "type": "compound",
            "commands": [
               {
                "eClass": "http://www.eclipse.org/emfcloud/modelserver/command#//Command",
                "type": "set",
                "owner": {
                    "eClass": "http://www.eclipsesource.com/modelserver/example/coffeemodel#//AutomaticTask",
                    "$ref": "test.sysmlx#//@myList.0"
                },
                "feature": "name",
                "dataValues": [
                    "Auto Brew"
                ]
              },
            ]
        }
    }

But of course the wrapping does not make sense in this example, as you could directly send the set command.
But basically the set command will update the name feature to the value "Auto Brew" for the class AutomaticTask expecting to find an object of this class in your model test.sysmlx, which should be on the root, in the list property myList as the first element.

The usage of a Json Patch with standard Json Pointer paths might be simpler?

[Orangewithsugar]

Yeah, i can successfully update the model using a Json Patch with standard Json Pointer paths.
I just wanna try if this way works too, Ty for you reply, I will try this ~
Best Reguards.