HTTP Example:POST /{BASE}/resource/{uuid}
| API Example: ResourceWebService.postLocal({'uuid': }); |
Creates new local resource with given uuid. - Output:
- javax.ws.rs.core.Response - HTTP response (body is a String message)
- HTTP return codes:
- 201 - new resource created
- 200 - resource already exists
- 500 - Internal Error
- HTTP response headers:
- Location - the url of the new/found resource
|
HTTP Example:GET /{BASE}/resource/{uuid}
Accept: …
| API Example: ResourceWebService.getLocal({'uuid': , 'Accept': }); |
Returns a link to a local resource (data or content) with the given uuid
and an accepted return type - Output:
- javax.ws.rs.core.Response - a link to a local resource's data or content
- Header parameters:
- Accept
- HTTP return codes:
- 303 - resource can be found in the requested format under Location
- 404 - resource cannot be found
- 406 - resource cannot be found in the given format
- 500 - Internal Error
- HTTP response headers:
- Location - (for HTTP 303) the url of the resource in the
requested format
- Content-Type - (for HTTP 406) a list of available types
(content and meta)
- HTTP request headers:
- Accept - accepted mimetypes; value must follow the pattern
(.+/.+(;rel=(content|meta))?,)+
|
HTTP Example:PUT /{BASE}/resource/{uuid}
Content-Type: …
| API Example: ResourceWebService.putLocal({'uuid': , 'Content-Type': }); |
Returns a Link where the given data (metadata or content) can be put to
the local resource - Output:
- javax.ws.rs.core.Response - a link where the data can be put (depends on Content-Type)
- Header parameters:
- Content-Type
- HTTP return codes:
- 303 - resource in given format can be put under Location
- 404 - resource cannot be found
- 415 - Content-Type is not supported
- 500 - Internal Error
- HTTP response headers:
- Location - (for HTTP 303) the url where data can be put
- HTTP request headers:
- Content-Type - type of the body; value must follow the
pattern .+/.+(;rel=(content|meta))?
|
HTTP Example:DELETE /{BASE}/resource/{uuid}
| API Example: ResourceWebService.deleteResourceLocal({'uuid': }); |
Delete local resource with given uuid - Output:
- javax.ws.rs.core.Response - HTTP response (success or error)
- HTTP return codes:
- 200 - resource deleted
- 404 - resource not found
|