GRID REST Reference

TODO: Add some general introduction

Building REST URLs

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])

Examples:

REST Service Reference

Service PublicAuthenticationRestService

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/..

Service Method authenticate(..)

Delegates to PublicAuthenticationService#authenticate(String, String).

URI //auth/login?username=...​&password=...
METHOD GET
FORMAT Produces: [text/plain]
Accepts: [application/x-www-form-urlencoded]
PARAMETERS
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Query "username" Yes String The query parameter containing the username.
Query "password" Yes String The query parameter containing the password.
RETURNS string value of the delegate's return value.
(Java Type: String)

Service Method logout(..)

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)

Service Method getApiKey(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Query "username" No String The query parameter containing the username (optional, defaults to "").
Query "password" No String The query parameter containing the password (optional, defaults to "").
Query "requiredRole" Yes SortedSet<String> The set of required roles (see delegate for more info).
RETURNS the string value of the delegate's return value.
(Java Type: String)

Service Method isAuthenticated(..)

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)

Service Method getUserDisplayName(..)

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)

Service Method getUserRoles(..)

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)

Service PublicCategoryRestService

Implements a REST styled interface on top of the SOAP api using JAX-RS

Service Base-URI:

http://host:port/rs/level-0//categories/..

Service Method getCategoryViewNames(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "locale" Yes String The locale (language &amp; country) of the requester (views are regional!).
Path "targetIdentifier" Yes String Optional identifier specifying the requesting target application type. Is set to "default" if left empty or if it is not existing.
RETURNS A list of available viewnames.
(Java Type: datatypes.NameList)

Service Method getCategoryView(..)

URI //categories/categoryView/{locale}/{viewName}
METHOD GET
FORMAT Produces: [application/xml, application/json]
Accepts: [application/x-www-form-urlencoded]
PARAMETERS
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "locale" Yes String The locale (language &amp; country) of the requester.
Path "viewName" Yes String The name of the view to return.
RETURNS The cateogry view for the given name or 'null' if not existing.
(Java Type: datatypes.CategoryView)

Service Method getPlainCategory(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "locale" Yes String The locale (language &amp; country) of the requester.
Path "categoryName" Yes String The name of the category to return.
RETURNS The plain category (without any view or child relationship).
(Java Type: datatypes.Category)

Service Method getPlainCategories(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "locale" Yes String The locale (language &amp; country) of the requester.
RETURNS All plain categories (without any view or child relationship).
(Java Type: datatypes.CategoryList)

Service Method getReferencingCategoryNamesOnFile(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1OrMd5" Yes String the SHA1 or MD5 hash to test against categorization.
RETURNS the category names that reference this identifier.
(Java Type: datatypes.NameList)

Service Method getReferencingCategoryNamesOnPackageById(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1OrMd5" Yes String the SHA1 or MD5 hash to test against categorization.
RETURNS the category names that reference this identifier.
(Java Type: datatypes.NameList)

Service Method getReferencingCategoryNamesOnPackageByName(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "packageName" Yes String the name of the package to test against categorization.
RETURNS the category names that reference this identifier.
(Java Type: datatypes.NameList)

Service PublicFileRestService

Implements a REST styled interface on top of the SOAP api using JAX-RS

Service Base-URI:

http://host:port/rs/level-0//files/..

Service Method isFileKnownGood(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1OrMd5" Yes String The SHA1 or MD5 hash (as hexadecimal string) of the file to query.
RETURNS 'true' if the file is good, 'false' if not, 'null' (HTTP 204 No Content) if it's unknown.
(Java Type: String)

Service Method isFileKnownGood(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1" Yes String The SHA1 hash (as hexadecimal string) of the file to query.
Path "md5" Yes String The MD5 hash (as hexadecimal string) of the file to query.
RETURNS 'true' if the file is good, 'false' if not, 'null' (HTTP 204 No Content) if it's unknown.
(Java Type: String)

Service Method isFilePureWhite(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1OrMd5" Yes String The SHA1 or MD5 hash (as hexadecimal string) of the file to query.
RETURNS 'true' if the file is good, 'false' if not, 'null' (HTTP 204 No Content) if it's unknown.
(Java Type: String)

Service Method isFilePureWhite(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1" Yes String The SHA1 hash (as hexadecimal string) of the file to query.
Path "md5" Yes String The MD5 hash (as hexadecimal string) of the file to query.
RETURNS 'true' if the file is good, 'false' if not, 'null' (HTTP 204 No Content) if it's unknown.
(Java Type: String)

Service Method isFileTaggedWith(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1OrMd5" Yes String The SHA1 or MD5 hash (as hexadecimal string) of the file to query.
Query "tag" Yes List<String> $esc.xml($parameter.comment)
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)

Service Method isFileTaggedWith(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1" Yes String The SHA1 hash (as hexadecimal string) of the file to query.
Path "md5" Yes String The MD5 hash (as hexadecimal string) of the file to query.
Query "tag" Yes List<String> $esc.xml($parameter.comment)
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)

Service Method getFileInformation(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1OrMd5" Yes String The SHA1 or MD5 hash (as hexadecimal string) of the file to query.
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
 firstSeen="2014-02-10T01:05:51.690-08:00" lastProcessed="2014-02-10T01:05:51.690-08:00"
 lastRetrieved="2014-02-10T01:05:51.690-08:00" tags="installer executable signed clean"/>
application/json
{
  "@firstSeen" : 1392023152159,
  "@lastRetrieved" : 1392023152159,
  "@lastProcessed" : 1392023152159,
  "@tags" : [ "installer", "executable", "signed", "clean" ],
  "@sourcePackageCount" : null,
  "@sourceSiteCount" : null
}

Service Method getFileInformation(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1" Yes String The SHA1 hash (as hexadecimal string) of the file to query.
Path "md5" Yes String The MD5 hash (as hexadecimal string) of the file to query.
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
 firstSeen="2014-02-10T01:05:52.393-08:00" lastProcessed="2014-02-10T01:05:52.393-08:00"
 lastRetrieved="2014-02-10T01:05:52.393-08:00" tags="installer executable signed clean"/>
application/json
{
  "@firstSeen" : 1392023152440,
  "@lastRetrieved" : 1392023152440,
  "@lastProcessed" : 1392023152440,
  "@tags" : [ "installer", "executable", "signed", "clean" ],
  "@sourcePackageCount" : null,
  "@sourceSiteCount" : null
}

Service Method getFileDetails(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1OrMd5" Yes String The SHA1 or MD5 hash (as hexadecimal string) of the file to query.
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
<ns3:fileDetails xmlns:ns2="http://grid.trendmicro.com/metadata/1.0"
    <identifier md5="CCBCC20FB306ED5116E16650A1274AE3"
     sha1="F4AD398B3D6C82AE3DEEFF57CC67B6B22FE7DB85"/>
    <ns2:metadata>
        <ns2:meta name="companyName" value="Microsoft Corp."/>
        <ns2:meta name="originalFileName" value="word.exe"/>
        <ns2:meta name="internalName" value="word.exe"/>
        <ns2:meta name="fileSize" numericValues="98404.0"/>
        <ns2:meta name="fileVersion" value="12.0.6514.5000"/>
        <ns2:meta name="productName" value="2007 Microsoft Office System"/>
        <ns2:meta binaryValue="eLHG/CKFT4hPt9WMqGV1884okx6qOcDMNpn+ZaIqR+g=" name="sha256"/>
        <ns2:meta
         binaryValue="tRNJTKNrNoyjuVgGkZ2Qj1rOHoyeICfrwS1lIGg/vvTMRaHocToOkHNYB67Hfn/q9VqwHxbRu7ZjCGc9fH6DAA=="
         name="sha512"/>
        <ns2:meta booleanValues="true" name="scanPassed"/>
    </ns2:metadata>
    <information firstSeen="2014-02-10T01:05:52.472-08:00"
     lastProcessed="2014-02-10T01:05:52.472-08:00" lastRetrieved="2014-02-10T01:05:52.472-08:00"
     tags="clean"/>
</ns3:fileDetails>
application/json
{
  "identifier" : {
    "@sha1" : "C700EA57D2C6029C5BE38D6C4B405D5DB589EC49",
    "@md5" : "99FA799FD3B21F08F237395864D86BD4"
  },
  "metadata" : {
    "all" : {
      "companyName" : {
        "name" : "companyName",
        "value" : "Microsoft Corp.",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      },
      "originalFileName" : {
        "name" : "originalFileName",
        "value" : "word.exe",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      },
      "internalName" : {
        "name" : "internalName",
        "value" : "word.exe",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      },
      "fileSize" : {
        "name" : "fileSize",
        "value" : null,
        "booleanValues" : null,
        "numericValues" : [ 24676.0 ],
        "dateValues" : null,
        "binaryValue" : null
      },
      "fileVersion" : {
        "name" : "fileVersion",
        "value" : "12.0.6514.5000",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      },
      "productName" : {
        "name" : "productName",
        "value" : "2007 Microsoft Office System",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      },
      "sha256" : {
        "name" : "sha256",
        "value" : null,
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : "ymVyb2eKKjCiZ5y5lGllUdnbQ/9jfXZell0ytRpPM18="
      },
      "sha512" : {
        "name" : "sha512",
        "value" : null,
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : "hM2Y0SPbqJI5HmIT1z9zCNNlMS5tTqRCBBEzBsF4epIhYbV40PqN+uuNTK4WvTHmM8WCOTDVo+CJJXDifMz0Aw=="
      },
      "scanPassed" : {
        "name" : "scanPassed",
        "value" : null,
        "booleanValues" : [ true ],
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      }
    },
    "meta" : [ {
      "name" : "companyName",
      "value" : "Microsoft Corp.",
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    }, {
      "name" : "originalFileName",
      "value" : "word.exe",
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    }, {
      "name" : "internalName",
      "value" : "word.exe",
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    }, {
      "name" : "fileSize",
      "value" : null,
      "booleanValues" : null,
      "numericValues" : [ 24676.0 ],
      "dateValues" : null,
      "binaryValue" : null
    }, {
      "name" : "fileVersion",
      "value" : "12.0.6514.5000",
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    }, {
      "name" : "productName",
      "value" : "2007 Microsoft Office System",
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    }, {
      "name" : "sha256",
      "value" : null,
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : "ymVyb2eKKjCiZ5y5lGllUdnbQ/9jfXZell0ytRpPM18="
    }, {
      "name" : "sha512",
      "value" : null,
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : "hM2Y0SPbqJI5HmIT1z9zCNNlMS5tTqRCBBEzBsF4epIhYbV40PqN+uuNTK4WvTHmM8WCOTDVo+CJJXDifMz0Aw=="
    }, {
      "name" : "scanPassed",
      "value" : null,
      "booleanValues" : [ true ],
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    } ]
  },
  "information" : {
    "@firstSeen" : 1392023152628,
    "@lastRetrieved" : 1392023152628,
    "@lastProcessed" : 1392023152628,
    "@tags" : [ "clean" ],
    "@sourcePackageCount" : null,
    "@sourceSiteCount" : null
  }
}

Service Method getFileDetails(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1" Yes String The SHA1 hash (as hexadecimal string) of the file to query.
Path "md5" Yes String The MD5 hash (as hexadecimal string) of the file to query.
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
<ns3:fileDetails xmlns:ns2="http://grid.trendmicro.com/metadata/1.0"
    <identifier md5="D2B24F13B212C145C4D5058A84D9F646"
     sha1="8B862759818001949BB85364699770ACFEAE3FAE"/>
    <ns2:metadata>
        <ns2:meta name="companyName" value="Microsoft Corp."/>
        <ns2:meta name="originalFileName" value="word.exe"/>
        <ns2:meta name="internalName" value="word.exe"/>
        <ns2:meta name="fileSize" numericValues="71780.0"/>
        <ns2:meta name="fileVersion" value="12.0.6514.5000"/>
        <ns2:meta name="productName" value="2007 Microsoft Office System"/>
        <ns2:meta binaryValue="JPwHnczja6ZOFwUs/FsqNEP3Klc4CaqdHpLs1w+vMr0=" name="sha256"/>
        <ns2:meta
         binaryValue="0Rz+d6COO3jSf77zXIXLurLL8p8bRZW0QDsDoGYYl9fjH8JjKGSJAkmWyj0hoN7uq2TTPtHhcOMouaY+teF4uA=="
         name="sha512"/>
        <ns2:meta booleanValues="true" name="scanPassed"/>
    </ns2:metadata>
    <information firstSeen="2014-02-10T01:05:52.831-08:00"
     lastProcessed="2014-02-10T01:05:52.831-08:00" lastRetrieved="2014-02-10T01:05:52.831-08:00"
     tags="clean"/>
</ns3:fileDetails>
application/json
{
  "identifier" : {
    "@sha1" : "0FF65A7D0DA9CF860B23A57B8266C4678A4501EA",
    "@md5" : "66529B36E49F7E48649F5F65FDF5A8CB"
  },
  "metadata" : {
    "all" : {
      "companyName" : {
        "name" : "companyName",
        "value" : "Microsoft Corp.",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      },
      "originalFileName" : {
        "name" : "originalFileName",
        "value" : "word.exe",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      },
      "internalName" : {
        "name" : "internalName",
        "value" : "word.exe",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      },
      "fileSize" : {
        "name" : "fileSize",
        "value" : null,
        "booleanValues" : null,
        "numericValues" : [ 95332.0 ],
        "dateValues" : null,
        "binaryValue" : null
      },
      "fileVersion" : {
        "name" : "fileVersion",
        "value" : "12.0.6514.5000",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      },
      "productName" : {
        "name" : "productName",
        "value" : "2007 Microsoft Office System",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      },
      "sha256" : {
        "name" : "sha256",
        "value" : null,
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : "gEdwUjd4KaXkQuZ9BlUL2tfZvBadH7lJyiYpyYFwxKY="
      },
      "sha512" : {
        "name" : "sha512",
        "value" : null,
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : "pgz3rP4GJGT+9L7phrM42zueKurQXtUGh1rntdUSDVWPQQO9GJOqdFT6g4bakywKmbdtnS+MvJa3GKnaDoVbTg=="
      },
      "scanPassed" : {
        "name" : "scanPassed",
        "value" : null,
        "booleanValues" : [ true ],
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      }
    },
    "meta" : [ {
      "name" : "companyName",
      "value" : "Microsoft Corp.",
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    }, {
      "name" : "originalFileName",
      "value" : "word.exe",
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    }, {
      "name" : "internalName",
      "value" : "word.exe",
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    }, {
      "name" : "fileSize",
      "value" : null,
      "booleanValues" : null,
      "numericValues" : [ 95332.0 ],
      "dateValues" : null,
      "binaryValue" : null
    }, {
      "name" : "fileVersion",
      "value" : "12.0.6514.5000",
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    }, {
      "name" : "productName",
      "value" : "2007 Microsoft Office System",
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    }, {
      "name" : "sha256",
      "value" : null,
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : "gEdwUjd4KaXkQuZ9BlUL2tfZvBadH7lJyiYpyYFwxKY="
    }, {
      "name" : "sha512",
      "value" : null,
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : "pgz3rP4GJGT+9L7phrM42zueKurQXtUGh1rntdUSDVWPQQO9GJOqdFT6g4bakywKmbdtnS+MvJa3GKnaDoVbTg=="
    }, {
      "name" : "scanPassed",
      "value" : null,
      "booleanValues" : [ true ],
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    } ]
  },
  "information" : {
    "@firstSeen" : 1392023152987,
    "@lastRetrieved" : 1392023152987,
    "@lastProcessed" : 1392023152987,
    "@tags" : [ "clean" ],
    "@sourcePackageCount" : null,
    "@sourceSiteCount" : null
  }
}

Service PublicPackageRestService

Implements a REST styled interface on top of the SOAP api using JAX-RS

Service Base-URI:

http://host:port/rs/level-0//packages/..

Service Method getVendorNames(..)

Returns all known vendor names.

URI //packages/vendorNames/{pageNumber}
METHOD GET
FORMAT Produces: [application/xml, application/json]
Accepts: [application/x-www-form-urlencoded]
PARAMETERS
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "pageNumber" No int 0 The number of the list page to return, starting from 0 for the first chunk.
RETURNS A page of known vendor names or 'null' if no page exists under the given number.
(Java Type: datatypes.NameListPage)

Service Method getVendorDisplayName(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "name" Yes String the name of the vendor to return the display name for.
RETURNS a collection of displaynames for the given names, never 'null'.
(Java Type: String)

Service Method getPackageFamilyNames(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "pageNumber" No int 0 The number of the list page to return, starting from 0 for the first chunk.
RETURNS A page of known package family names or 'null' if no page exists under the given number.
(Java Type: datatypes.NameListPage)

Service Method getPackageFamilyDisplayName(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "packageFamilyName" Yes String the name of the package family to return the display name for.
RETURNS the displayname for the given name, never 'null'.
(Java Type: String)

Service Method getPackageFamilyNamesForVendor(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "vendorName" Yes String the name of the vendor to query package families from.
Path "pageNumber" No int 0 The number of the list page to return, starting from 0 for the first chunk.
RETURNS A page of known package family names or 'null' if no page exists under the given number.
(Java Type: datatypes.NameListPage)

Service Method getPackageNamesInFamily(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "packageFamilyName" Yes String the name of the package family to query package names from.
Path "pageNumber" No int 0 The number of the list page to return, starting from 0 for the first chunk.
RETURNS A page of package names or 'null' if no page exists under the given number.
(Java Type: datatypes.NameListPage)

Service Method getPackageDisplayName(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "name" Yes String the name of the package to return the display name for.
RETURNS the displayname for the given name, never 'null'.
(Java Type: String)

Service Method isPackageTaggedWithById(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1OrMd5" Yes String The package file to verify.
Query "tag" Yes List<String> The tags to check against.
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)

Service Method isPackageTaggedWithByName(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "packageName" Yes String The package to verify.
Query "tag" Yes List<String> The tags to check against.
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)

Service Method getPackageNamesTaggedWith(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "pageNumber" No int 0 The number of the list page to return, starting from 0 for the first chunk.
Query "tag" Yes List<String> The tags to get the files for.
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)

Service Method getMatchingPackageNames(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "pageNumber" No int 0 The number of the list page to return, starting from 0 for the first chunk.
Query "tagQueryExpression" Yes String An expression following the tag query grammar used to identify packages.
Query "tagQueryExpressionVersion" No String The version of the expression (the most recent version is assumed if ommitted).
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)

Service Method getReferencingPackageNamesById(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1OrMd5" Yes String The file to return the referencing package names for.
Path "pageNumber" No int 0 The number of the list page to return, starting from 0 for the first page.
RETURNS A page of package names or 'null' if no page exists under the given number.
(Java Type: datatypes.NameListPage)

Service Method getReferencingPackageNames(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "packageName" Yes String The package name to return the names of referencing packages.
Path "pageNumber" No int 0 The number of the list page to return, starting from 0 for the first page.
RETURNS A page of package names or 'null' if no page exists under the given name or pageNumber.
(Java Type: datatypes.NameListPage)

Service Method getFilesContainedInPackageById(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1OrMd5" Yes String The id of the package file to look for its children.
Path "pageNumber" No int 0 The number of the list page to return, starting from 0 for the first page.
RETURNS the ids of all files contained inside the given package.
(Java Type: datatypes.NamedFileIdentifierListPage)

Service Method getFilesContainedInPackageByName(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "packageName" Yes String The name of the package to look for its children.
Path "pageNumber" No int 0 The number of the list page to return, starting from 0 for the first page.
RETURNS the ids of all files contained inside the given package.
(Java Type: datatypes.NamedFileIdentifierListPage)

Service Method getPackagesContainedInPackageById(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1OrMd5" Yes String The id of the package file to look for its children.
Path "pageNumber" No int 0 The number of the list page to return, starting from 0 for the first page.
RETURNS the names of all packages contained inside the given package.
(Java Type: datatypes.NameListPage)

Service Method getPackagesContainedInPackageByName(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "packageName" Yes String The name of the package to look for its children.
Path "pageNumber" No int 0 The number of the list page to return, starting from 0 for the first page.
RETURNS the names of all packages contained inside the given package.
(Java Type: datatypes.NameListPage)

Service Method getPackageInformationById(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1OrMd5" Yes String The id of the package file to look for.
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
<ns2:packageInformation xmlns:ns2="http://grid.trendmicro.com/services/level-0"
 familyName="microsoft:office" name="microsoft:office:2007:windows:x86:en_US"
 tags="office productivity email" vendorName="microsoft">
    <displayName>Microsoft Office 2007 EN (x86)</displayName>
    <packageFileInformation firstSeen="2014-02-10T01:05:53.190-08:00"
     lastProcessed="2014-02-10T01:05:53.190-08:00" lastRetrieved="2014-02-10T01:05:53.190-08:00"
     tags="installer executable signed clean"/>
</ns2:packageInformation>
application/json
{
  "displayName" : "Microsoft Office 2007 EN (x86)",
  "packageFileInformation" : {
    "@firstSeen" : 1392023153315,
    "@lastRetrieved" : 1392023153315,
    "@lastProcessed" : 1392023153315,
    "@tags" : [ "installer", "executable", "signed", "clean" ],
    "@sourcePackageCount" : null,
    "@sourceSiteCount" : null
  },
  "@name" : "microsoft:office:2007:windows:x86:en_US",
  "@familyName" : "microsoft:office",
  "@vendorName" : "microsoft",
  "@tags" : [ "office", "productivity", "email" ],
  "@containedFilesCount" : null
}

Service Method getPackageInformationByName(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "packageName" Yes String The name of the package to look for.
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
<ns2:packageInformation xmlns:ns2="http://grid.trendmicro.com/services/level-0"
 familyName="microsoft:office" name="microsoft:office:2007:windows:x86:en_US"
 tags="office productivity email" vendorName="microsoft">
    <displayName>Microsoft Office 2007 EN (x86)</displayName>
    <packageFileInformation firstSeen="2014-02-10T01:05:53.362-08:00"
     lastProcessed="2014-02-10T01:05:53.362-08:00" lastRetrieved="2014-02-10T01:05:53.362-08:00"
     tags="installer executable signed clean"/>
</ns2:packageInformation>
application/json
{
  "displayName" : "Microsoft Office 2007 EN (x86)",
  "packageFileInformation" : {
    "@firstSeen" : 1392023153425,
    "@lastRetrieved" : 1392023153425,
    "@lastProcessed" : 1392023153425,
    "@tags" : [ "installer", "executable", "signed", "clean" ],
    "@sourcePackageCount" : null,
    "@sourceSiteCount" : null
  },
  "@name" : "microsoft:office:2007:windows:x86:en_US",
  "@familyName" : "microsoft:office",
  "@vendorName" : "microsoft",
  "@tags" : [ "office", "productivity", "email" ],
  "@containedFilesCount" : null
}

Service Method getPackageDetailsById(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "sha1OrMd5" Yes String The id of the package file to look for.
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
<ns3:packageDetails xmlns:ns2="http://grid.trendmicro.com/metadata/1.0"
    <packageFamily basename="microsoft:office">
        <vendor firstSeen="2014-02-10T01:05:53.487-08:00" name="microsoft">
            <displayName>Microsoft</displayName>
            <ns2:metadata>
                <ns2:meta name="vendorReputation" value="high"/>
            </ns2:metadata>
        </vendor>
        <displayName>Microsoft Office</displayName>
        <ns2:metadata>
            <ns2:meta name="familyProductType">
                <ns2:v>office-suite</ns2:v>
                <ns2:v>productivity</ns2:v>
                <ns2:v>email</ns2:v>
            </ns2:meta>
        </ns2:metadata>
    </packageFamily>
    <packageInformation familyName="microsoft:office" name="microsoft:office:2007:windows:x86:en_US"
     tags="office productivity email" vendorName="microsoft">
        <displayName>Microsoft Office 2007 EN (x86)</displayName>
        <packageFileInformation firstSeen="2014-02-10T01:05:53.487-08:00"
         lastProcessed="2014-02-10T01:05:53.487-08:00" lastRetrieved="2014-02-10T01:05:53.487-08:00"
         tags="installer executable signed clean"/>
    </packageInformation>
    <ns2:metadata>
        <ns2:meta name="scanVendors">
            <ns2:v>SCANNER_ALPHA_GEN</ns2:v>
            <ns2:v>SCANNER_BETA_GEN</ns2:v>
            <ns2:v>SCANNER_DIGISIG</ns2:v>
            <ns2:v>SCANNER_KASPERSKY</ns2:v>
            <ns2:v>SCANNER_MCAFEE</ns2:v>
            <ns2:v>SCANNER_MICROSOFT</ns2:v>
            <ns2:v>SCANNER_SOPHOS</ns2:v>
            <ns2:v>SCANNER_SYMANTEC</ns2:v>
        </ns2:meta>
        <ns2:meta booleanValues="true true true true true true true true" name="scanPassed"/>
        <ns2:meta name="scanVendorsVersion">
            <ns2:v>[01.34]ENG[8.910-1002]LPTPTN[5.101.00][[PATTERN_OUTDATED](5014 hrs 37 mins since
             last update)]</ns2:v>
            <ns2:v>[02.52]ENG[8.910-1002]LPTPTN[5.101.00][[PATTERN_OUTDATED](5014 hrs 37 mins since
             last update)]</ns2:v>
            <ns2:v>[31.45][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]</ns2:v>
            <ns2:v>[08.27]ENG[4.110-2000][[PATTERN_OUTDATED](5014 hrs 37 mins since last
             update)]</ns2:v>
            <ns2:v>[10.52]ENG[6.930-4001][[PATTERN_OUTDATED](5014 hrs 37 mins since last
             update)]</ns2:v>
            <ns2:v>[121.36]ENG[1.2110-1000][[PATTERN_OUTDATED](5014 hrs 37 mins since last
             update)]</ns2:v>
            <ns2:v>[01.72]ENG[6.20][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]</ns2:v>
        </ns2:meta>
    </ns2:metadata>
    <fileMetadata>
        <identifier md5="B6CFA61A7DAB2819DCE5FF66DC9E9400"
         sha1="02144C7E7E57FEAC87EFFCC59200BC1D4185853D"/>
        <ns2:metadata>
            <ns2:meta name="companyName" value="Microsoft Corp."/>
            <ns2:meta name="originalFileName" value="Setup.exe"/>
            <ns2:meta name="internalName" value="Microsoft Office Setup"/>
            <ns2:meta name="fileSize" numericValues="71780.0"/>
            <ns2:meta name="fileVersion" value="12.0.6514.5000"/>
            <ns2:meta name="productName" value="2007 Microsoft Office System"/>
            <ns2:meta binaryValue="a5uDirKFMFcjKLwKgHUFRrIJTkdaqjOHdPZDx29rYDc=" name="sha256"/>
            <ns2:meta
             binaryValue="ze6ZLGuXM11HSKcoqb2ZSN4W2JZWJbhWXZ+CorQph0e/rnZ57spY8O5lngIQJa5MVg4zUik7xxgkM+JenDpITg=="
             name="sha512"/>
            <ns2:meta booleanValues="true" name="scanPassed"/>
        </ns2:metadata>
    </fileMetadata>
</ns3:packageDetails>
application/json
{
  "packageFamily" : {
    "vendor" : {
      "displayName" : "Microsoft",
      "metadata" : {
        "all" : {
          "vendorReputation" : {
            "name" : "vendorReputation",
            "value" : "high",
            "booleanValues" : null,
            "numericValues" : null,
            "dateValues" : null,
            "binaryValue" : null
          }
        },
        "meta" : [ {
          "name" : "vendorReputation",
          "value" : "high",
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : null
        } ]
      },
      "@firstSeen" : 1392023153987,
      "@name" : "microsoft"
    },
    "displayName" : "Microsoft Office",
    "metadata" : {
      "all" : {
        "familyProductType" : {
          "name" : "familyProductType",
          "value" : null,
          "v" : [ {
            "value" : "office-suite"
          }, {
            "value" : "productivity"
          }, {
            "value" : "email"
          } ],
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : null
        }
      },
      "meta" : [ {
        "name" : "familyProductType",
        "value" : null,
        "v" : [ {
          "value" : "office-suite"
        }, {
          "value" : "productivity"
        }, {
          "value" : "email"
        } ],
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      } ]
    },
    "@basename" : "microsoft:office"
  },
  "packageInformation" : {
    "displayName" : "Microsoft Office 2007 EN (x86)",
    "packageFileInformation" : {
      "@firstSeen" : 1392023153987,
      "@lastRetrieved" : 1392023153987,
      "@lastProcessed" : 1392023153987,
      "@tags" : [ "installer", "executable", "signed", "clean" ],
      "@sourcePackageCount" : null,
      "@sourceSiteCount" : null
    },
    "@name" : "microsoft:office:2007:windows:x86:en_US",
    "@familyName" : "microsoft:office",
    "@vendorName" : "microsoft",
    "@tags" : [ "office", "productivity", "email" ],
    "@containedFilesCount" : null
  },
  "metadata" : {
    "all" : {
      "scanVendors" : {
        "name" : "scanVendors",
        "value" : null,
        "v" : [ {
          "value" : "SCANNER_ALPHA_GEN"
        }, {
          "value" : "SCANNER_BETA_GEN"
        }, {
          "value" : "SCANNER_DIGISIG"
        }, {
          "value" : "SCANNER_KASPERSKY"
        }, {
          "value" : "SCANNER_MCAFEE"
        }, {
          "value" : "SCANNER_MICROSOFT"
        }, {
          "value" : "SCANNER_SOPHOS"
        }, {
          "value" : "SCANNER_SYMANTEC"
        } ],
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      },
      "scanPassed" : {
        "name" : "scanPassed",
        "value" : null,
        "booleanValues" : [ true, true, true, true, true, true, true, true ],
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      },
      "scanVendorsVersion" : {
        "name" : "scanVendorsVersion",
        "value" : null,
        "v" : [ {
          "value" : "[01.34]ENG[8.910-1002]LPTPTN[5.101.00][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
        }, {
          "value" : "[02.52]ENG[8.910-1002]LPTPTN[5.101.00][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
        }, {
          "value" : "[31.45][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
        }, {
          "value" : "[08.27]ENG[4.110-2000][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
        }, {
          "value" : "[10.52]ENG[6.930-4001][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
        }, {
          "value" : "[121.36]ENG[1.2110-1000][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
        }, {
          "value" : "[01.72]ENG[6.20][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
        } ],
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      }
    },
    "meta" : [ {
      "name" : "scanVendors",
      "value" : null,
      "v" : [ {
        "value" : "SCANNER_ALPHA_GEN"
      }, {
        "value" : "SCANNER_BETA_GEN"
      }, {
        "value" : "SCANNER_DIGISIG"
      }, {
        "value" : "SCANNER_KASPERSKY"
      }, {
        "value" : "SCANNER_MCAFEE"
      }, {
        "value" : "SCANNER_MICROSOFT"
      }, {
        "value" : "SCANNER_SOPHOS"
      }, {
        "value" : "SCANNER_SYMANTEC"
      } ],
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    }, {
      "name" : "scanPassed",
      "value" : null,
      "booleanValues" : [ true, true, true, true, true, true, true, true ],
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    }, {
      "name" : "scanVendorsVersion",
      "value" : null,
      "v" : [ {
        "value" : "[01.34]ENG[8.910-1002]LPTPTN[5.101.00][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
      }, {
        "value" : "[02.52]ENG[8.910-1002]LPTPTN[5.101.00][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
      }, {
        "value" : "[31.45][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
      }, {
        "value" : "[08.27]ENG[4.110-2000][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
      }, {
        "value" : "[10.52]ENG[6.930-4001][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
      }, {
        "value" : "[121.36]ENG[1.2110-1000][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
      }, {
        "value" : "[01.72]ENG[6.20][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
      } ],
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    } ]
  },
  "fileMetadata" : {
    "identifier" : {
      "@sha1" : "7A5F44C0F1B6DEFBB779C4AB0D6D9C6A3A57A1DD",
      "@md5" : "3633F84601BD6D63937D9E2271C3FB44"
    },
    "metadata" : {
      "all" : {
        "companyName" : {
          "name" : "companyName",
          "value" : "Microsoft Corp.",
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : null
        },
        "originalFileName" : {
          "name" : "originalFileName",
          "value" : "Setup.exe",
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : null
        },
        "internalName" : {
          "name" : "internalName",
          "value" : "Microsoft Office Setup",
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : null
        },
        "fileSize" : {
          "name" : "fileSize",
          "value" : null,
          "booleanValues" : null,
          "numericValues" : [ 24676.0 ],
          "dateValues" : null,
          "binaryValue" : null
        },
        "fileVersion" : {
          "name" : "fileVersion",
          "value" : "12.0.6514.5000",
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : null
        },
        "productName" : {
          "name" : "productName",
          "value" : "2007 Microsoft Office System",
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : null
        },
        "sha256" : {
          "name" : "sha256",
          "value" : null,
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : "RMB2KhIezAJJCxyn/y4kGG3ufI6kHU2nn6WRMTOTlfQ="
        },
        "sha512" : {
          "name" : "sha512",
          "value" : null,
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : "CEfvOddkessoSEKiRYV1vYz77ZSbEgvkPXxsY+GEyjAYV8Tt39sXk62vNFwlr1VPXu3s5HxBAknO/rGTHMEC6Q=="
        },
        "scanPassed" : {
          "name" : "scanPassed",
          "value" : null,
          "booleanValues" : [ true ],
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : null
        }
      },
      "meta" : [ {
        "name" : "companyName",
        "value" : "Microsoft Corp.",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      }, {
        "name" : "originalFileName",
        "value" : "Setup.exe",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      }, {
        "name" : "internalName",
        "value" : "Microsoft Office Setup",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      }, {
        "name" : "fileSize",
        "value" : null,
        "booleanValues" : null,
        "numericValues" : [ 24676.0 ],
        "dateValues" : null,
        "binaryValue" : null
      }, {
        "name" : "fileVersion",
        "value" : "12.0.6514.5000",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      }, {
        "name" : "productName",
        "value" : "2007 Microsoft Office System",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      }, {
        "name" : "sha256",
        "value" : null,
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : "RMB2KhIezAJJCxyn/y4kGG3ufI6kHU2nn6WRMTOTlfQ="
      }, {
        "name" : "sha512",
        "value" : null,
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : "CEfvOddkessoSEKiRYV1vYz77ZSbEgvkPXxsY+GEyjAYV8Tt39sXk62vNFwlr1VPXu3s5HxBAknO/rGTHMEC6Q=="
      }, {
        "name" : "scanPassed",
        "value" : null,
        "booleanValues" : [ true ],
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      } ]
    }
  }
}

Service Method getPackageDetailsByName(..)

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
Parameter Type Name Required Java Type Default /
Fixed Values
Description
Path "packageName" Yes String The name of the package to look for.
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
<ns3:packageDetails xmlns:ns2="http://grid.trendmicro.com/metadata/1.0"
    <packageFamily basename="microsoft:office">
        <vendor firstSeen="2014-02-10T01:05:54.315-08:00" name="microsoft">
            <displayName>Microsoft</displayName>
            <ns2:metadata>
                <ns2:meta name="vendorReputation" value="high"/>
            </ns2:metadata>
        </vendor>
        <displayName>Microsoft Office</displayName>
        <ns2:metadata>
            <ns2:meta name="familyProductType">
                <ns2:v>office-suite</ns2:v>
                <ns2:v>productivity</ns2:v>
                <ns2:v>email</ns2:v>
            </ns2:meta>
        </ns2:metadata>
    </packageFamily>
    <packageInformation familyName="microsoft:office" name="microsoft:office:2007:windows:x86:en_US"
     tags="office productivity email" vendorName="microsoft">
        <displayName>Microsoft Office 2007 EN (x86)</displayName>
        <packageFileInformation firstSeen="2014-02-10T01:05:54.315-08:00"
         lastProcessed="2014-02-10T01:05:54.315-08:00" lastRetrieved="2014-02-10T01:05:54.315-08:00"
         tags="installer executable signed clean"/>
    </packageInformation>
    <ns2:metadata>
        <ns2:meta name="scanVendors">
            <ns2:v>SCANNER_ALPHA_GEN</ns2:v>
            <ns2:v>SCANNER_BETA_GEN</ns2:v>
            <ns2:v>SCANNER_DIGISIG</ns2:v>
            <ns2:v>SCANNER_KASPERSKY</ns2:v>
            <ns2:v>SCANNER_MCAFEE</ns2:v>
            <ns2:v>SCANNER_MICROSOFT</ns2:v>
            <ns2:v>SCANNER_SOPHOS</ns2:v>
            <ns2:v>SCANNER_SYMANTEC</ns2:v>
        </ns2:meta>
        <ns2:meta booleanValues="true true true true true true true true" name="scanPassed"/>
        <ns2:meta name="scanVendorsVersion">
            <ns2:v>[01.34]ENG[8.910-1002]LPTPTN[5.101.00][[PATTERN_OUTDATED](5014 hrs 37 mins since
             last update)]</ns2:v>
            <ns2:v>[02.52]ENG[8.910-1002]LPTPTN[5.101.00][[PATTERN_OUTDATED](5014 hrs 37 mins since
             last update)]</ns2:v>
            <ns2:v>[31.45][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]</ns2:v>
            <ns2:v>[08.27]ENG[4.110-2000][[PATTERN_OUTDATED](5014 hrs 37 mins since last
             update)]</ns2:v>
            <ns2:v>[10.52]ENG[6.930-4001][[PATTERN_OUTDATED](5014 hrs 37 mins since last
             update)]</ns2:v>
            <ns2:v>[121.36]ENG[1.2110-1000][[PATTERN_OUTDATED](5014 hrs 37 mins since last
             update)]</ns2:v>
            <ns2:v>[01.72]ENG[6.20][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]</ns2:v>
        </ns2:meta>
    </ns2:metadata>
    <fileMetadata>
        <identifier md5="375F79DD52032DE8BD9B5055169D6E77"
         sha1="378AA91095530326C29E76E2DCDC3B4568C86FE5"/>
        <ns2:metadata>
            <ns2:meta name="companyName" value="Microsoft Corp."/>
            <ns2:meta name="originalFileName" value="Setup.exe"/>
            <ns2:meta name="internalName" value="Microsoft Office Setup"/>
            <ns2:meta name="fileSize" numericValues="70756.0"/>
            <ns2:meta name="fileVersion" value="12.0.6514.5000"/>
            <ns2:meta name="productName" value="2007 Microsoft Office System"/>
            <ns2:meta binaryValue="DQJxt+RPDwgpFGb3vcjqu6KR2l9f89k+2OqZHOt5VB8=" name="sha256"/>
            <ns2:meta
             binaryValue="radH09tWNc8nieta8oL4K1eVR7Dyk24W5D4GvcP3l5ykrn8m9MM7wCAtsU+915kPCZPiSene6iDb0tGzU656Sg=="
             name="sha512"/>
            <ns2:meta booleanValues="true" name="scanPassed"/>
        </ns2:metadata>
    </fileMetadata>
</ns3:packageDetails>
application/json
{
  "packageFamily" : {
    "vendor" : {
      "displayName" : "Microsoft",
      "metadata" : {
        "all" : {
          "vendorReputation" : {
            "name" : "vendorReputation",
            "value" : "high",
            "booleanValues" : null,
            "numericValues" : null,
            "dateValues" : null,
            "binaryValue" : null
          }
        },
        "meta" : [ {
          "name" : "vendorReputation",
          "value" : "high",
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : null
        } ]
      },
      "@firstSeen" : 1392023154784,
      "@name" : "microsoft"
    },
    "displayName" : "Microsoft Office",
    "metadata" : {
      "all" : {
        "familyProductType" : {
          "name" : "familyProductType",
          "value" : null,
          "v" : [ {
            "value" : "office-suite"
          }, {
            "value" : "productivity"
          }, {
            "value" : "email"
          } ],
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : null
        }
      },
      "meta" : [ {
        "name" : "familyProductType",
        "value" : null,
        "v" : [ {
          "value" : "office-suite"
        }, {
          "value" : "productivity"
        }, {
          "value" : "email"
        } ],
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      } ]
    },
    "@basename" : "microsoft:office"
  },
  "packageInformation" : {
    "displayName" : "Microsoft Office 2007 EN (x86)",
    "packageFileInformation" : {
      "@firstSeen" : 1392023154784,
      "@lastRetrieved" : 1392023154784,
      "@lastProcessed" : 1392023154784,
      "@tags" : [ "installer", "executable", "signed", "clean" ],
      "@sourcePackageCount" : null,
      "@sourceSiteCount" : null
    },
    "@name" : "microsoft:office:2007:windows:x86:en_US",
    "@familyName" : "microsoft:office",
    "@vendorName" : "microsoft",
    "@tags" : [ "office", "productivity", "email" ],
    "@containedFilesCount" : null
  },
  "metadata" : {
    "all" : {
      "scanVendors" : {
        "name" : "scanVendors",
        "value" : null,
        "v" : [ {
          "value" : "SCANNER_ALPHA_GEN"
        }, {
          "value" : "SCANNER_BETA_GEN"
        }, {
          "value" : "SCANNER_DIGISIG"
        }, {
          "value" : "SCANNER_KASPERSKY"
        }, {
          "value" : "SCANNER_MCAFEE"
        }, {
          "value" : "SCANNER_MICROSOFT"
        }, {
          "value" : "SCANNER_SOPHOS"
        }, {
          "value" : "SCANNER_SYMANTEC"
        } ],
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      },
      "scanPassed" : {
        "name" : "scanPassed",
        "value" : null,
        "booleanValues" : [ true, true, true, true, true, true, true, true ],
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      },
      "scanVendorsVersion" : {
        "name" : "scanVendorsVersion",
        "value" : null,
        "v" : [ {
          "value" : "[01.34]ENG[8.910-1002]LPTPTN[5.101.00][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
        }, {
          "value" : "[02.52]ENG[8.910-1002]LPTPTN[5.101.00][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
        }, {
          "value" : "[31.45][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
        }, {
          "value" : "[08.27]ENG[4.110-2000][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
        }, {
          "value" : "[10.52]ENG[6.930-4001][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
        }, {
          "value" : "[121.36]ENG[1.2110-1000][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
        }, {
          "value" : "[01.72]ENG[6.20][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
        } ],
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      }
    },
    "meta" : [ {
      "name" : "scanVendors",
      "value" : null,
      "v" : [ {
        "value" : "SCANNER_ALPHA_GEN"
      }, {
        "value" : "SCANNER_BETA_GEN"
      }, {
        "value" : "SCANNER_DIGISIG"
      }, {
        "value" : "SCANNER_KASPERSKY"
      }, {
        "value" : "SCANNER_MCAFEE"
      }, {
        "value" : "SCANNER_MICROSOFT"
      }, {
        "value" : "SCANNER_SOPHOS"
      }, {
        "value" : "SCANNER_SYMANTEC"
      } ],
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    }, {
      "name" : "scanPassed",
      "value" : null,
      "booleanValues" : [ true, true, true, true, true, true, true, true ],
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    }, {
      "name" : "scanVendorsVersion",
      "value" : null,
      "v" : [ {
        "value" : "[01.34]ENG[8.910-1002]LPTPTN[5.101.00][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
      }, {
        "value" : "[02.52]ENG[8.910-1002]LPTPTN[5.101.00][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
      }, {
        "value" : "[31.45][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
      }, {
        "value" : "[08.27]ENG[4.110-2000][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
      }, {
        "value" : "[10.52]ENG[6.930-4001][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
      }, {
        "value" : "[121.36]ENG[1.2110-1000][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
      }, {
        "value" : "[01.72]ENG[6.20][[PATTERN_OUTDATED](5014 hrs 37 mins since last update)]"
      } ],
      "booleanValues" : null,
      "numericValues" : null,
      "dateValues" : null,
      "binaryValue" : null
    } ]
  },
  "fileMetadata" : {
    "identifier" : {
      "@sha1" : "AB4588ED6FFEA443DA97D4078B74F1CC18B894E4",
      "@md5" : "A276B7520C6E86075B4467B3425E9DB0"
    },
    "metadata" : {
      "all" : {
        "companyName" : {
          "name" : "companyName",
          "value" : "Microsoft Corp.",
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : null
        },
        "originalFileName" : {
          "name" : "originalFileName",
          "value" : "Setup.exe",
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : null
        },
        "internalName" : {
          "name" : "internalName",
          "value" : "Microsoft Office Setup",
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : null
        },
        "fileSize" : {
          "name" : "fileSize",
          "value" : null,
          "booleanValues" : null,
          "numericValues" : [ 55396.0 ],
          "dateValues" : null,
          "binaryValue" : null
        },
        "fileVersion" : {
          "name" : "fileVersion",
          "value" : "12.0.6514.5000",
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : null
        },
        "productName" : {
          "name" : "productName",
          "value" : "2007 Microsoft Office System",
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : null
        },
        "sha256" : {
          "name" : "sha256",
          "value" : null,
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : "oxc85QzT0Cu0v3TpDNCkvt4iyfoYBNPHh84mnOiCsSw="
        },
        "sha512" : {
          "name" : "sha512",
          "value" : null,
          "booleanValues" : null,
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : "HP9+R+4O1D7/aG9cwMp79q4OQoARKNHHppMFGSjB2OXNGnCF9xeb1WKQKIM2zoQzzpIlFjTcCv7E0v6NQSiFJw=="
        },
        "scanPassed" : {
          "name" : "scanPassed",
          "value" : null,
          "booleanValues" : [ true ],
          "numericValues" : null,
          "dateValues" : null,
          "binaryValue" : null
        }
      },
      "meta" : [ {
        "name" : "companyName",
        "value" : "Microsoft Corp.",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      }, {
        "name" : "originalFileName",
        "value" : "Setup.exe",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      }, {
        "name" : "internalName",
        "value" : "Microsoft Office Setup",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      }, {
        "name" : "fileSize",
        "value" : null,
        "booleanValues" : null,
        "numericValues" : [ 55396.0 ],
        "dateValues" : null,
        "binaryValue" : null
      }, {
        "name" : "fileVersion",
        "value" : "12.0.6514.5000",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      }, {
        "name" : "productName",
        "value" : "2007 Microsoft Office System",
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      }, {
        "name" : "sha256",
        "value" : null,
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : "oxc85QzT0Cu0v3TpDNCkvt4iyfoYBNPHh84mnOiCsSw="
      }, {
        "name" : "sha512",
        "value" : null,
        "booleanValues" : null,
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : "HP9+R+4O1D7/aG9cwMp79q4OQoARKNHHppMFGSjB2OXNGnCF9xeb1WKQKIM2zoQzzpIlFjTcCv7E0v6NQSiFJw=="
      }, {
        "name" : "scanPassed",
        "value" : null,
        "booleanValues" : [ true ],
        "numericValues" : null,
        "dateValues" : null,
        "binaryValue" : null
      } ]
    }
  }
}