Sonatype Nexus Indexer Lucene REST API

Data

  • Default Namespace
  • XML Schema File: ns0.xsd

The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.

The following elements are members of this namespace:

The following types are members of this namespace:

Element search-results

REST Response object for a list of search results, contains the typical 'data' parameter, which is a list of search results.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <search-results> <totalCount> <!--content of type 'int'--> ... </totalCount> <from> <!--content of type 'int'--> ... </from> <count> <!--content of type 'int'--> ... </count> <tooManyResults> <!--content of type 'boolean'--> ... </tooManyResults> <data> <artifact> <!--content of type 'nexus-artifact'--> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <groupId> <!--content of type 'string'--> ... </groupId> <artifactId> <!--content of type 'string'--> ... </artifactId> <version> <!--content of type 'string'--> ... </version> <classifier> <!--content of type 'string'--> ... </classifier> <packaging> <!--content of type 'string'--> ... </packaging> <extension> <!--content of type 'string'--> ... </extension> <repoId> <!--content of type 'string'--> ... </repoId> <contextId> <!--content of type 'string'--> ... </contextId> <pomLink> <!--content of type 'string'--> ... </pomLink> <artifactLink> <!--content of type 'string'--> ... </artifactLink> </artifact> <artifact> <!--(another 'nexus-artifact' type)--> </artifact> <!--...more "artifact" elements...--> </data> </search-results>

Example JSON

{ "totalCount" : ..., "from" : ..., "count" : ..., "tooManyResults" : false, "data" : [ { "resourceURI" : "...", "groupId" : "...", "artifactId" : "...", "version" : "...", "classifier" : "...", "packaging" : "...", "extension" : "...", "repoId" : "...", "contextId" : "...", "pomLink" : "...", "artifactLink" : "..." }, ... ] }

Type nexus-artifact

Artifact details sent back on search requests.

Child Elements

name (type) min/max
occurs
description
resourceURI (string) 0/1 The URL that can be used to retrieve the artifact.
groupId (string) 0/1 The group id of the artifact.
artifactId (string) 0/1 The artifact id of the artifact.
version (string) 0/1 The version of the artifact.
classifier (string) 0/1 The classifier of the artifact.
packaging (string) 0/1 The packaging of the artifact.
extension (string) 0/1 The extension of the artifact.
repoId (string) 0/1 The repository id where the artifact is stored.
contextId (string) 0/1 The indexing context where the artifact is indexed.
pomLink (string) 0/1 URL that would give you the pom file.
artifactLink (string) 0/1 URL that would give you the artifact file.

Type nexusResponse

Class NexusResponse.

Type searchResponse

REST Response object for a list of search results, contains the typical 'data' parameter, which is a list of search results.

Child Elements

name (type) min/max
occurs
description
totalCount (int) 1/1 The total number of results.
from (int) 1/1 The starting index of the results.
count (int) 1/1 The number of results in this response.
tooManyResults (boolean) 1/1 Flag that states if too many results were found.
artifact (nexus-artifact) 0/unbounded Field data.