BCPAC RESTful Resources

Resources

There is a WADL document available that describes the resources API.

name path methods description
AboutResource
  • /about
  • GET
About resource implementation.
BCCommonSharedCacheResource
  • /bccommonshrcache/invalidatecache
  • POST
BLUEcloud shared cache resource implementation.
HealthCheckResource
  • /healthcheck/alive
  • /healthcheck/check
  • GET
  • GET
Note that the root path here ("healthcheck") needs to be kept in synch with a test in ValidateOriginAppFilter method specialIsHealthCheck. If you change the path, then also change that method!
SecurityResource
  • /v1/security/session
  • DELETE, GET
VersionResource
  • /v1/version
  • GET

Data Types

JSON

type description
AboutWs1Dto About Webservice1 DTO.
HealthCheckWs1Dto Used for Health Check returns.

Note that this MUST support an XML return, not just JSon, so if you change this, make sure you test the XML return handling as well as the JSon. (I.E. test with header 'Accept' set to 'application/json' as well as testing with 'Accept' set to 'application/xml' or 'text/xml')

InvalidateCacheWs1Dto Invalidate CacheWs1Dto.
SessionWs1Dto
WSVersion
WSVersionWs1Dto

XML

Default Namespace (schema)
type description
sessionWs1Dto