Constructing a REST endpoint URI follows the rule:
[GACL-HOST] = http://host:port/ [REST-CONTEXT] = /rs/level-0 endpoint URI = [GACL-HOST] + [REST-CONTEXT] + [SERVICE-PATH] + [METHOD-PATH] + ([QUERY-PARAMS])
[SERVICE-PATH] = /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
[SERVICE-PATH] = /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
Implements a REST api to PublicAuthenticationService, to prepare the offering of REST services with authentication.
Service Base-URI:
http://host:port/rs/level-0//auth/..
Delegates to PublicAuthenticationService#authenticate(String, String).
| URI | //auth/login?username=...&password=... | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
string value of the delegate's return value.
(Java Type: String) |
Delegates to PublicAuthenticationService#logout().
| URI | //auth/logout |
| METHOD | GET |
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
| PARAMETERS | N/A |
| RETURNS |
string value of the delegate's return value.
(Java Type: String) |
Delegates to Set) or Set) depending on whether username and password where specified or not.
| URI | //auth/apiKey?username=&password=&requiredRole=... | ||||||||||||||||||||||||
| METHOD | GET | ||||||||||||||||||||||||
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||||||||
| RETURNS |
the string value of the delegate's return value.
(Java Type: String) |
Delegates to PublicAuthenticationService#isAuthenticated().
| URI | //auth/authenticated |
| METHOD | GET |
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
| PARAMETERS | N/A |
| RETURNS |
string value of the delegate's return value.
(Java Type: String) |
Delegates to PublicAuthenticationService#getUserDisplayName().
| URI | //auth/userDisplayName |
| METHOD | GET |
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
| PARAMETERS | N/A |
| RETURNS |
string value of the delegate's return value.
(Java Type: String) |
Delegates to PublicAuthenticationService#getUserRoles().
| URI | //auth/userRoles |
| METHOD | GET |
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
| PARAMETERS | N/A |
| RETURNS |
string value of the delegate's return value (space delimited string list).
(Java Type: String) |
Implements a REST styled interface on top of the SOAP api using JAX-RS
Service Base-URI:
http://host:port/rs/level-0//categories/..
Returns the names of available category views,
| URI | //categories/categoryViewNames/{locale}/{targetIdentifier} | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
A list of available viewnames.
(Java Type: datatypes.NameList) |
| URI | //categories/categoryView/{locale}/{viewName} | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
The cateogry view for the given name or 'null' if not existing.
(Java Type: datatypes.CategoryView) |
Returns the plain category information (without any view or child relationship).
| URI | //categories/plainCategory/{locale}/{categoryName} | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
The plain category (without any view or child relationship).
(Java Type: datatypes.Category) |
Returns all plain categories (without any view or child relationship).
| URI | //categories/plainCategories/{locale} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
All plain categories (without any view or child relationship).
(Java Type: datatypes.CategoryList) |
Returns the names of the categories that the given file belongs to.
| URI | //categories/referencingNamesOnFile/{sha1OrMd5} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
the category names that reference this identifier.
(Java Type: datatypes.NameList) |
Returns the names of the categories that the given package file belongs to.
| URI | //categories/referencingNamesOnPackageById/{sha1OrMd5} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
the category names that reference this identifier.
(Java Type: datatypes.NameList) |
Returns the names of the categories that the given package file belongs to.
| URI | //categories/referencingNamesOnPackage/{packageName} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
the category names that reference this identifier.
(Java Type: datatypes.NameList) |
Implements a REST styled interface on top of the SOAP api using JAX-RS
Service Base-URI:
http://host:port/rs/level-0//files/..
Allows to query the GRID whether a file is known to be good.
| URI | //files/isKnownGood/{sha1OrMd5} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
'true' if the file is good, 'false' if not, 'null' (HTTP 204 No Content) if it's unknown.
(Java Type: String) |
Allows to query the GRID whether a file is known to be good.
| URI | //files/isKnownGood/{sha1}-{md5} | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
'true' if the file is good, 'false' if not, 'null' (HTTP 204 No Content) if it's unknown.
(Java Type: String) |
Allows to query the GRID whether a file is known to be good and not included in the high risk category.
| URI | //files/isPureWhite/{sha1OrMd5} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
'true' if the file is good, 'false' if not, 'null' (HTTP 204 No Content) if it's unknown.
(Java Type: String) |
Allows to query the GRID whether a file is known to be good and not included in the high risk category.
| URI | //files/isPureWhite/{sha1}-{md5} | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
'true' if the file is good, 'false' if not, 'null' (HTTP 204 No Content) if it's unknown.
(Java Type: String) |
Allows to query the GRID whether a file is tagged with a set of tags.
| URI | //files/isTaggedWith/{sha1OrMd5}?tag=... | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
'true' if the file is tagged with all given tags, 'false' if not, 'null' (HTTP 204 No Content) if it's unkown.
(Java Type: String) |
Allows to query the GRID whether a file is tagged with a set of tags.
| URI | //files/isTaggedWith/{sha1}-{md5}?tag=... | ||||||||||||||||||||||||
| METHOD | GET | ||||||||||||||||||||||||
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||||||||
| RETURNS |
'true' if the file is tagged with all given tags, 'false' if not, 'null' (HTTP 204 No Content) if it's unkown.
(Java Type: String) |
Returns the file information (containing last modified and tags) on the specified file.
| URI | //files/info/{sha1OrMd5} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
'true' if the file is tagged with all given tags, 'false' if not, 'null' (HTTP 204 No Content) if it's unkown.
(Java Type: datatypes.FileInformation) |
||||||||||||
| EXAMPLE |
Response [application/xml, application/json]:
application/xml
application/json
|
Returns the file information (containing last modified and tags) on the specified file.
| URI | //files/info/{sha1}-{md5} | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
'true' if the file is tagged with all given tags, 'false' if not, 'null' (HTTP 204 No Content) if it's unkown.
(Java Type: datatypes.FileInformation) |
||||||||||||||||||
| EXAMPLE |
Response [application/xml, application/json]:
application/xml
application/json
|
Returns the file information (containing info and attached metadata) on the specified file.
| URI | //files/details/{sha1OrMd5} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
'true' if the file is tagged with all given tags, 'false' if not, 'null' (HTTP 204 No Content) if it's unkown.
(Java Type: datatypes.FileDetails) |
||||||||||||
| EXAMPLE |
Response [application/xml, application/json]:
application/xml
application/json
|
Returns the file details (containing info and attached metadata) on the specified file.
| URI | //files/details/{sha1}-{md5} | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
'true' if the file is tagged with all given tags, 'false' if not, 'null' (HTTP 204 No Content) if it's unkown.
(Java Type: datatypes.FileDetails) |
||||||||||||||||||
| EXAMPLE |
Response [application/xml, application/json]:
application/xml
application/json
|
Implements a REST styled interface on top of the SOAP api using JAX-RS
Service Base-URI:
http://host:port/rs/level-0//packages/..
Returns all known vendor names.
| URI | //packages/vendorNames/{pageNumber} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
A page of known vendor names or 'null' if no page exists under the given number.
(Java Type: datatypes.NameListPage) |
Returns the displayname for the given reference name.
| URI | //packages/vendorDisplayName/{name} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
a collection of displaynames for the given names, never 'null'.
(Java Type: String) |
Returns all known package family names.
| URI | //packages/packageFamilyNames/{pageNumber} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
A page of known package family names or 'null' if no page exists under the given number.
(Java Type: datatypes.NameListPage) |
Returns the displayname for the given reference name.
| URI | //packages/packageFamilyDisplayName/{packageFamilyName} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
the displayname for the given name, never 'null'.
(Java Type: String) |
Returns all known package family names for the given vendor.
| URI | //packages/packageFamilyNamesForVendor/{vendorName}/{pageNumber} | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
A page of known package family names or 'null' if no page exists under the given number.
(Java Type: datatypes.NameListPage) |
Returns all package names that are members of the given package family.
| URI | //packages/packageNamesInFamily/{packageFamilyName}/{pageNumber} | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
A page of package names or 'null' if no page exists under the given number.
(Java Type: datatypes.NameListPage) |
Returns the displayname for the given reference name.
| URI | //packages/packageDisplayName/{name} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
the displayname for the given name, never 'null'.
(Java Type: String) |
Returns true if the given package is tagged with the specified tags.
| URI | //packages/isPackageTaggedWithById/{sha1OrMd5}?tag=... | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
'true' if the tags apply to the package, 'false' if not, 'null' (HTTP 204 No Content)
if the package is unknown or the file id references a ordinary file not a package.
(Java Type: String) |
Returns true if the given package is tagged with the specified tags.
| URI | //packages/isPackageTaggedWithByName/{packageName}?tag=... | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [text/plain] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
'true' if the tags apply to the package, 'false' if not, 'null' (HTTP 204 No Content)
if the package is unknown.
(Java Type: String) |
Returns all known files that are tagged with the given list of tags.
| URI | //packages/packageNamesTaggedWith/{pageNumber}?tag=... | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
A page of package names for the packages tagged with the given tags or
'null' if no page exists under the given number.
(Java Type: datatypes.NameListPage) |
Returns all known packages that are matched by the given tag expression.
| URI | //packages/matchingPackageNames/{pageNumber}?tagQueryExpression=...&tagQueryExpressionVersion= | ||||||||||||||||||||||||
| METHOD | GET | ||||||||||||||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||||||||
| RETURNS |
A page of package names for the packages, matching the given expression or
'null' if no page exists under the given number.
(Java Type: datatypes.NameListPage) |
Returns the names of all packages that reference the given file directly.
A package references a file if the file is a direct child of the package.
| URI | //packages/referencingPackageNamesById/{sha1OrMd5}/{pageNumber} | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
A page of package names or 'null' if no page exists under the given number.
(Java Type: datatypes.NameListPage) |
Returns the names of all packages that reference the given package directly.
| URI | //packages/referencingPackageNames/{packageName}/{pageNumber} | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
A page of package names or 'null' if no page exists under the given name or pageNumber.
(Java Type: datatypes.NameListPage) |
Returns the ids of all files contained inside the given package.
| URI | //packages/filesContainedInPackageById/{sha1OrMd5}/{pageNumber} | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
the ids of all files contained inside the given package.
(Java Type: datatypes.NamedFileIdentifierListPage) |
Returns the ids of all files contained inside the given package.
| URI | //packages/filesContainedInPackageByName/{packageName}/{pageNumber} | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
the ids of all files contained inside the given package.
(Java Type: datatypes.NamedFileIdentifierListPage) |
Returns the names of all packages contained inside the given package.
| URI | //packages/packagesContainedInPackageById/{sha1OrMd5}/{pageNumber} | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
the names of all packages contained inside the given package.
(Java Type: datatypes.NameListPage) |
Returns the names of all packages contained inside the given package.
| URI | //packages/packagesContainedInPackageByName/{packageName}/{pageNumber} | ||||||||||||||||||
| METHOD | GET | ||||||||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||||||||
| PARAMETERS |
|
||||||||||||||||||
| RETURNS |
the names of all packages contained inside the given package.
(Java Type: datatypes.NameListPage) |
Returns the package information of the given package.
| URI | //packages/packageInformationById/{sha1OrMd5} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
the package information of the given package or 'null' if
no package exists under the specified arguments.
(Java Type: datatypes.PackageInformation) |
||||||||||||
| EXAMPLE |
Response [application/xml, application/json]:
application/xml
application/json
|
Returns the package information of the given package.
| URI | //packages/packageInformationByName/{packageName} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
the package information of the given package or 'null' if
no package exists under the specified arguments.
(Java Type: datatypes.PackageInformation) |
||||||||||||
| EXAMPLE |
Response [application/xml, application/json]:
application/xml
application/json
|
Returns the package details of the given package.
| URI | //packages/packageDetailsById/{sha1OrMd5} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
the package details of the given package or 'null' if
no package exists under the specified arguments.
(Java Type: datatypes.PackageDetails) |
||||||||||||
| EXAMPLE |
Response [application/xml, application/json]:
application/xml
application/json
|
Returns the package details of the given package.
| URI | //packages/packageDetailsByName/{packageName} | ||||||||||||
| METHOD | GET | ||||||||||||
| FORMAT |
Produces: [application/xml, application/json] Accepts: [application/x-www-form-urlencoded] |
||||||||||||
| PARAMETERS |
|
||||||||||||
| RETURNS |
the package details of the given package or 'null' if
no package exists under the specified arguments.
(Java Type: datatypes.PackageDetails) |
||||||||||||
| EXAMPLE |
Response [application/xml, application/json]:
application/xml
application/json
|