/api{dynamicPath}

  • Mount Point: /resource/rest/api{dynamicPath}

The following operations are supported on this resource:

DELETE

  • Aliases: GET

Helper method for requests without a body. No content-type needed for the request.

Parameters

name description type default
dynamicPath (no documentation provided) path
search (no documentation provided) query
sort (no documentation provided) query
pagination (no documentation provided) query
X-VMS-API-AuthToken (no documentation provided) header
Content-Type (no documentation provided) header
Accept (no documentation provided) header

Output Payload

element produceable content type(s)
(custom)
  • application/json
description
generated Response object

Exceptions

name description
AbstractBaseException if application exception happened

POST

  • Aliases: PUT

Handler for generic HTTP requests to REST API.

Parameters

name description type default
dynamicPath (no documentation provided) path
search (no documentation provided) query
sort (no documentation provided) query
pagination (no documentation provided) query
X-VMS-API-AuthToken (no documentation provided) header
Content-Type (no documentation provided) header
Accept (no documentation provided) header

Input Payload

element consumeable content type(s)
(custom)
  • */*
  • application/xml
  • application/json
description
input stream for the request body

Output Payload

element produceable content type(s)
(custom)
  • application/json
description
generated Response object

Exceptions

name description
AbstractBaseException if application exception happened
URISyntaxException if URI cannot be generated for PUT method