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 artifact-info
REST Response object for a artifact-info resource request, contains the typical 'data' parameter, which is the content items requested.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<artifact-info>
<data>
<!--content of type 'artifact-info-resource'-->
<presentLocally>
<!--content of type 'boolean'-->
...
</presentLocally>
<repositoryId>
<!--content of type 'string'-->
...
</repositoryId>
<repositoryName>
<!--content of type 'string'-->
...
</repositoryName>
<repositoryPath>
<!--content of type 'string'-->
...
</repositoryPath>
<mimeType>
<!--content of type 'string'-->
...
</mimeType>
<uploader>
<!--content of type 'string'-->
...
</uploader>
<uploaded>
<!--content of type 'long'-->
...
</uploaded>
<lastChanged>
<!--content of type 'long'-->
...
</lastChanged>
<size>
<!--content of type 'long'-->
...
</size>
<sha1Hash>
<!--content of type 'string'-->
...
</sha1Hash>
<md5Hash>
<!--content of type 'string'-->
...
</md5Hash>
<data>
<repositories>
<!--content of type 'repository-url-resource'-->
<repositoryId>
<!--content of type 'string'-->
...
</repositoryId>
<repositoryName>
<!--content of type 'string'-->
...
</repositoryName>
<path>
<!--content of type 'string'-->
...
</path>
<artifactUrl>
<!--content of type 'string'-->
...
</artifactUrl>
<canView>
<!--content of type 'boolean'-->
...
</canView>
</repositories>
<repositories>
<!--(another 'repository-url-resource' type)-->
</repositories>
<!--...more "repositories" elements...-->
</data>
<canDelete>
<!--content of type 'boolean'-->
...
</canDelete>
</data>
</artifact-info>
Example JSON
{
"data" : {
"presentLocally" : false,
"repositoryId" : "...",
"repositoryName" : "...",
"repositoryPath" : "...",
"mimeType" : "...",
"uploader" : "...",
"uploaded" : ...,
"lastChanged" : ...,
"size" : ...,
"sha1Hash" : "...",
"md5Hash" : "...",
"data" : [ {
"repositoryId" : "...",
"repositoryName" : "...",
"path" : "...",
"artifactUrl" : "...",
"canView" : false
}, ... ],
"canDelete" : false
}
}
Element searchNGResponse
- Type: searchNGResponse
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"?>
<searchNGResponse>
<totalCount>
<!--content of type 'int'-->
...
</totalCount>
<from>
<!--content of type 'int'-->
...
</from>
<count>
<!--content of type 'int'-->
...
</count>
<tooManyResults>
<!--content of type 'boolean'-->
...
</tooManyResults>
<collapsed>
<!--content of type 'boolean'-->
...
</collapsed>
<repoDetails>
<repositoryDetail>
<!--content of type 'repositoryDetail'-->
<repositoryId>
<!--content of type 'string'-->
...
</repositoryId>
<repositoryName>
<!--content of type 'string'-->
...
</repositoryName>
<repositoryContentClass>
<!--content of type 'string'-->
...
</repositoryContentClass>
<repositoryKind>
<!--content of type 'string'-->
...
</repositoryKind>
<repositoryPolicy>
<!--content of type 'string'-->
...
</repositoryPolicy>
<repositoryURL>
<!--content of type 'string'-->
...
</repositoryURL>
</repositoryDetail>
<repositoryDetail>
<!--(another 'repositoryDetail' type)-->
</repositoryDetail>
<!--...more "repositoryDetail" elements...-->
</repoDetails>
<data>
<nexusNGArtifact>
<!--content of type 'nexusNGArtifact'-->
<groupId>
<!--content of type 'string'-->
...
</groupId>
<artifactId>
<!--content of type 'string'-->
...
</artifactId>
<version>
<!--content of type 'string'-->
...
</version>
<latestSnapshot>
<!--content of type 'string'-->
...
</latestSnapshot>
<latestSnapshotRepositoryId>
<!--content of type 'string'-->
...
</latestSnapshotRepositoryId>
<latestRelease>
<!--content of type 'string'-->
...
</latestRelease>
<latestReleaseRepositoryId>
<!--content of type 'string'-->
...
</latestReleaseRepositoryId>
<highlightedFragment>
<!--content of type 'string'-->
...
</highlightedFragment>
<artifactHits>
<artifactHit>
<!--content of type 'artifactHit'-->
<repositoryId>
<!--content of type 'string'-->
...
</repositoryId>
<artifactLinks>
<artifactLink>
<!--content of type 'artifactLink'-->
<classifier>
<!--content of type 'string'-->
...
</classifier>
<extension>
<!--content of type 'string'-->
...
</extension>
</artifactLink>
<artifactLink>
<!--(another 'artifactLink' type)-->
</artifactLink>
<!--...more "artifactLink" elements...-->
</artifactLinks>
</artifactHit>
<artifactHit>
<!--(another 'artifactHit' type)-->
</artifactHit>
<!--...more "artifactHit" elements...-->
</artifactHits>
</nexusNGArtifact>
<nexusNGArtifact>
<!--(another 'nexusNGArtifact' type)-->
</nexusNGArtifact>
<!--...more "nexusNGArtifact" elements...-->
</data>
</searchNGResponse>
Example JSON
{
"totalCount" : ...,
"from" : ...,
"count" : ...,
"tooManyResults" : false,
"collapsed" : false,
"repoDetails" : [ {
"repositoryId" : "...",
"repositoryName" : "...",
"repositoryContentClass" : "...",
"repositoryKind" : "...",
"repositoryPolicy" : "...",
"repositoryURL" : "..."
}, ... ],
"data" : [ {
"groupId" : "...",
"artifactId" : "...",
"version" : "...",
"latestSnapshot" : "...",
"latestSnapshotRepositoryId" : "...",
"latestRelease" : "...",
"latestReleaseRepositoryId" : "...",
"highlightedFragment" : "...",
"artifactHits" : [ {
"repositoryId" : "...",
"artifactLinks" : [ {
"classifier" : "...",
"extension" : "..."
}, ... ]
}, ... ]
}, ... ]
}
Element search-results
- Type: searchResponse
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>
<highlightedFragment>
<!--content of type 'string'-->
...
</highlightedFragment>
</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" : "...",
"highlightedFragment" : "..."
}, ... ]
}
Type artifactHit
Artifact hit details sent back on search requests.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
repositoryId (string) | 0/1 | The repository ID. |
artifactLink (artifactLink) | 0/unbounded | Field artifactLinks. |
Type artifact-info-resource
Details about the requested item, that should be useful in finding how the item was retrieved.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
presentLocally (boolean) | 1/1 | The flag that marks item as locally present (hosted/cached). |
repositoryId (string) | 0/1 | The repository where the artifact is stored. |
repositoryName (string) | 0/1 | The repository name where the artifact is stored. |
repositoryPath (string) | 0/1 | The path in repository where the artifact is stored. |
mimeType (string) | 0/1 | The MIME type of the artifact. |
uploader (string) | 0/1 | User id that uploaded the artifact. |
uploaded (long) | 1/1 | When the artifact was uploaded. |
lastChanged (long) | 1/1 | When the artifact was changed for the last time. |
size (long) | 1/1 | Artifact size on disk. |
sha1Hash (string) | 0/1 | Sha1 Hash. |
md5Hash (string) | 0/1 | Md5 Hash. |
repositories (repository-url-resource) | 0/unbounded | Field repositories. |
canDelete (boolean) | 1/1 | Informs if current user has what is needed to delete this artifact. |
Type artifactInfoResourceResponse
- Extends: nexusIndexerResponse
REST Response object for a artifact-info resource request, contains the typical 'data' parameter, which is the content items requested.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (artifact-info-resource) | 0/1 | List of describe items, that will contain useful information about the retrieved data. |
Type artifactLink
Artifact hit link details sent back on search requests.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
classifier (string) | 0/1 | The classifier of the artifact. |
extension (string) | 0/1 | The extension of the artifact. |
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. |
highlightedFragment (string) | 0/1 | A HTML highlighted fragment of the matched hit. |
Type nexusNGArtifact
Artifact details sent back on search requests.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
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. |
latestSnapshot (string) | 0/1 | The latest snapshot version of the artifact. |
latestSnapshotRepositoryId (string) | 0/1 | The repository of latest snapshot version of the artifact. |
latestRelease (string) | 0/1 | The latest release version of the artifact. |
latestReleaseRepositoryId (string) | 0/1 | The repository of latest release version of the artifact. |
highlightedFragment (string) | 0/1 | A HTML highlighted fragment of the matched hit. |
artifactHit (artifactHit) | 0/unbounded | Field artifactHits. |
Type repositoryDetail
Artifact repository details sent back on search requests.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
repositoryId (string) | 0/1 | The repository ID. |
repositoryName (string) | 0/1 | The repository name. |
repositoryContentClass (string) | 0/1 | The repository content class. |
repositoryKind (string) | 0/1 | The repository kind (hosted, proxy, group). |
repositoryPolicy (string) | 0/1 | The repository policy (RELEASE or SNAPSHOT). |
repositoryURL (string) | 0/1 | The repository base URL. |
Type repository-url-resource
The repository url information for a given artifact.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
repositoryId (string) | 0/1 | The repository where the artifact is stored. |
repositoryName (string) | 0/1 | The repository where the artifact is stored. |
path (string) | 0/1 | The artifact path. |
artifactUrl (string) | 0/1 | The artifact url. |
canView (boolean) | 1/1 | Tells if the users has view access to a given artifact. |
Type searchNGResponse
- Extends: nexusIndexerResponse
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 grand total number of results found on index. |
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. |
collapsed (boolean) | 1/1 | Flag that states if result set is collapsed, and shows latest versions only. |
repositoryDetail (repositoryDetail) | 0/unbounded | Field repoDetails. |
nexusNGArtifact (nexusNGArtifact) | 0/unbounded | Field data. |
Type searchResponse
- Extends: nexusIndexerResponse
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. |