REST Interfaces

REST services are less structured than SOAP services and are primarily implemented to offer the ability for quick tests, simplified access or using a lighter weighted protocol that may optionally be cached externally using a caching HTTP proxy server.
REST services form a subset of the features offered by SOAP.

All REST interfaces are implemented using the JAX-RS technology and published inside the JEE environment via the class "com.trendmicro.grid.acl.l0.JaxRsApplication" under the web path /rs/level-0/ (= [REST-CONTEXT]).

Note: Services can be identified easily inside the ApiDocs by looking for classes that implement the interface com.trendmicro.grid.acl.RestService. The class descriptions contain written information on what the methods do. Look at the WADL or reference below to learn how to invoke them.

The table below contains a human readable reference on all offered services.
A machine readable description (WADL) on the REST services can be obtained from http://host:port/rs/level-0/application.wadl

Note: In order to build a REST endpoint address out of the information above, follow the rule:

[REST-CONTEXT] = /rs/level-0/
endpoint       = [URL Path] + [Method Path] + ([Query Params])

Examples:

• Method getCategoryView(...):

  [URL Path]     = http://host:port/[REST-CONTEXT]/categories
  [Method Path]  = ./categoryView/{locale}/{viewName}
  [Query Params] = none
  
  endpoint = http://host:port/rs/level-0/categories/categoryView/{locale}/{viewName}
  

  Default View (en_US):
  http://host:port/rs/level-0/categories/categoryView/us_EN/default

• Method getCategoryViews(...):

  [URL Path]     = http://host:port/[REST-CONTEXT]/categories
  [Method Path]  = ./categoryView/{locale}
  [Query Params] = ?viewName=...
  
  endpoint = http://host:port/rs/level-0/categories/categoryView/{locale}?viewName=...
  

  Sample Views 1 & 2 (en_US):
  http://host:port/rs/level-0/categories/categoryView/us_EN?viewName=sample1&viewName=sample2