Loading... Loading ...
Notice: This documentation was generated by the free version of MireDot. As such, not all features are supported.
expand / collapse all

IDS Restful API

authorization

Most operations require a sessionId from making a login call to ICAT. The sessionId is then used to check that the operation on the data is permitted by following the general rule that if you are allowed that access to the metadata then you are allowed the same access to the data.

Error handling

In the case of an error the returned json will be of the form: {"code":"NotFoundException", "message":"One of the data files requested has been deleted"}. Clients should always check the status code and if status/100 is not 2 then an error has occurred.

Testing

The @GET calls can be tried on a web browser and curl can be used to make any of the calls. For example a url of the form: https://example.com:443/ids/getApiVersion will return some text such as 1.5.0

  • Deprecated.

    Deprecated:

    {{baseUrl.value || ' '}}
       {{role}}{{$last ? '' : ', '}}

    Body

    Accept:
    no type

    Returns
    Content-Type:
    no type

    Response Headers

    Status codes

  • Interfaces not documented

    MireDot believes that the Java methods below correspond to REST interfaces, but somehow had problems parsing/processing these interfaces and therefore excluded them from the generated documentation. We would very much appreciate it if you would send us the interfaces (not the implementations) and the types used (returntype, parameters). This will allow us to further improve MireDot and better document your interfaces in the future.

Below is a list of potential problems detected by MireDot. They can be severe or not. Some of them wil result in low quality documentation, some are real implementation issues. With each warning, the Java method causing the problem is documented.

    • method:

    not shown here because this documentation was generated by the free version of MireDot. As such, not all features are supported.