Sonatype Nexus Custom Metadata Plugin 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 customMetadataRequest

Envelope for a custom metadata request.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <customMetadataRequest> <data> <customMetadata> <!--content of type 'customMetadata'--> <namespace> <!--content of type 'string'--> ... </namespace> <key> <!--content of type 'string'--> ... </key> <value> <!--content of type 'string'--> ... </value> <readOnly> <!--content of type 'boolean'--> ... </readOnly> </customMetadata> <customMetadata> <!--(another 'customMetadata' type)--> </customMetadata> <!--...more "customMetadata" elements...--> </data> </customMetadataRequest>

Example JSON

{ "data" : [ { "namespace" : "...", "key" : "...", "value" : "...", "readOnly" : false }, ... ] }

Element customMetadataResponse

Envelope for a custom metadata list response.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <customMetadataResponse> <data> <customMetadata> <!--content of type 'customMetadata'--> <namespace> <!--content of type 'string'--> ... </namespace> <key> <!--content of type 'string'--> ... </key> <value> <!--content of type 'string'--> ... </value> <readOnly> <!--content of type 'boolean'--> ... </readOnly> </customMetadata> <customMetadata> <!--(another 'customMetadata' type)--> </customMetadata> <!--...more "customMetadata" elements...--> </data> </customMetadataResponse>

Example JSON

{ "data" : [ { "namespace" : "...", "key" : "...", "value" : "...", "readOnly" : false }, ... ] }

Element searchNGResponse

Example XML

<?xml version="1.0" encoding="UTF-8"?> <searchNGResponse> <count> <!--content of type 'int'--> ... </count> <totalCount> <!--content of type 'int'--> ... </totalCount> <collapsed> <!--content of type 'boolean'--> ... </collapsed> <repoDetails> <repositoryDetail> <!--content of type 'repositoryDetail'--> <repositoryContentClass> <!--content of type 'string'--> ... </repositoryContentClass> <repositoryName> <!--content of type 'string'--> ... </repositoryName> <repositoryId> <!--content of type 'string'--> ... </repositoryId> <repositoryPolicy> <!--content of type 'string'--> ... </repositoryPolicy> <repositoryURL> <!--content of type 'string'--> ... </repositoryURL> <repositoryKind> <!--content of type 'string'--> ... </repositoryKind> </repositoryDetail> <repositoryDetail> <!--(another 'repositoryDetail' type)--> </repositoryDetail> <!--...more "repositoryDetail" elements...--> </repoDetails> <data> <nexusNGArtifact> <!--content of type 'nexusNGArtifact'--> <latestReleaseRepositoryId> <!--content of type 'string'--> ... </latestReleaseRepositoryId> <latestSnapshotRepositoryId> <!--content of type 'string'--> ... </latestSnapshotRepositoryId> <artifactHits> <artifactHit> <!--content of type 'artifactHit'--> <repositoryId> <!--content of type 'string'--> ... </repositoryId> <artifactLinks> <artifactLink> <!--content of type 'artifactLink'--> <extension> <!--content of type 'string'--> ... </extension> <classifier> <!--content of type 'string'--> ... </classifier> </artifactLink> <artifactLink> <!--(another 'artifactLink' type)--> </artifactLink> <!--...more "artifactLink" elements...--> </artifactLinks> </artifactHit> <artifactHit> <!--(another 'artifactHit' type)--> </artifactHit> <!--...more "artifactHit" elements...--> </artifactHits> <artifactId> <!--content of type 'string'--> ... </artifactId> <highlightedFragment> <!--content of type 'string'--> ... </highlightedFragment> <latestRelease> <!--content of type 'string'--> ... </latestRelease> <latestSnapshot> <!--content of type 'string'--> ... </latestSnapshot> <groupId> <!--content of type 'string'--> ... </groupId> <version> <!--content of type 'string'--> ... </version> </nexusNGArtifact> <nexusNGArtifact> <!--(another 'nexusNGArtifact' type)--> </nexusNGArtifact> <!--...more "nexusNGArtifact" elements...--> </data> <from> <!--content of type 'int'--> ... </from> <tooManyResults> <!--content of type 'boolean'--> ... </tooManyResults> </searchNGResponse>

Example JSON

{ "count" : ..., "totalCount" : ..., "collapsed" : false, "repoDetails" : [ { "repositoryContentClass" : "...", "repositoryName" : "...", "repositoryId" : "...", "repositoryPolicy" : "...", "repositoryURL" : "...", "repositoryKind" : "..." }, ... ], "data" : [ { "latestReleaseRepositoryId" : "...", "latestSnapshotRepositoryId" : "...", "artifactHits" : [ { "repositoryId" : "...", "artifactLinks" : [ { "extension" : "...", "classifier" : "..." }, ... ] }, ... ], "artifactId" : "...", "highlightedFragment" : "...", "latestRelease" : "...", "latestSnapshot" : "...", "groupId" : "...", "version" : "..." }, ... ], "from" : ..., "tooManyResults" : false }

Element search-results

Example XML

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

Example JSON

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

Type artifactHit

Child Elements

name (type) min/max
occurs
description
repositoryId (string) 0/1 (no documentation provided)
artifactLink (artifactLink) 0/unbounded (no documentation provided)

Type artifactLink

Child Elements

name (type) min/max
occurs
description
extension (string) 0/1 (no documentation provided)
classifier (string) 0/1 (no documentation provided)

Type customMetadata

Custom metadata.

Child Elements

name (type) min/max
occurs
description
namespace (string) 0/1 Metadata namespace.
key (string) 0/1 Metadata key.
value (string) 0/1 Metadata value.
readOnly (boolean) 1/1 True if metadata is read only, false otherwise.

Type customMetadataRequest

Envelope for a custom metadata request.

Child Elements

name (type) min/max
occurs
description
customMetadata (customMetadata) 0/unbounded Metadata to be indexed.

Type customMetadataResponse

Envelope for a custom metadata list response.

Child Elements

name (type) min/max
occurs
description
customMetadata (customMetadata) 0/unbounded Found statements.

Type nexus-artifact

Child Elements

name (type) min/max
occurs
description
classifier (string) 0/1 (no documentation provided)
groupId (string) 0/1 (no documentation provided)
packaging (string) 0/1 (no documentation provided)
extension (string) 0/1 (no documentation provided)
artifactId (string) 0/1 (no documentation provided)
resourceURI (string) 0/1 (no documentation provided)
highlightedFragment (string) 0/1 (no documentation provided)
artifactLink (string) 0/1 (no documentation provided)
contextId (string) 0/1 (no documentation provided)
pomLink (string) 0/1 (no documentation provided)
repoId (string) 0/1 (no documentation provided)
version (string) 0/1 (no documentation provided)

Type nexusNGArtifact

Child Elements

name (type) min/max
occurs
description
latestReleaseRepositoryId (string) 0/1 (no documentation provided)
latestSnapshotRepositoryId (string) 0/1 (no documentation provided)
artifactHit (artifactHit) 0/unbounded (no documentation provided)
artifactId (string) 0/1 (no documentation provided)
highlightedFragment (string) 0/1 (no documentation provided)
latestRelease (string) 0/1 (no documentation provided)
latestSnapshot (string) 0/1 (no documentation provided)
groupId (string) 0/1 (no documentation provided)
version (string) 0/1 (no documentation provided)

Type repositoryDetail

Child Elements

name (type) min/max
occurs
description
repositoryContentClass (string) 0/1 (no documentation provided)
repositoryName (string) 0/1 (no documentation provided)
repositoryId (string) 0/1 (no documentation provided)
repositoryPolicy (string) 0/1 (no documentation provided)
repositoryURL (string) 0/1 (no documentation provided)
repositoryKind (string) 0/1 (no documentation provided)

Type searchNGResponse

Child Elements

name (type) min/max
occurs
description
count (int) 1/1 (no documentation provided)
totalCount (int) 1/1 (no documentation provided)
collapsed (boolean) 1/1 (no documentation provided)
repositoryDetail (repositoryDetail) 0/unbounded (no documentation provided)
nexusNGArtifact (nexusNGArtifact) 0/unbounded (no documentation provided)
from (int) 1/1 (no documentation provided)
tooManyResults (boolean) 1/1 (no documentation provided)

Type searchResponse

Child Elements

name (type) min/max
occurs
description
totalCount (int) 1/1 (no documentation provided)
tooManyResults (boolean) 1/1 (no documentation provided)
from (int) 1/1 (no documentation provided)
count (int) 1/1 (no documentation provided)
artifact (nexus-artifact) 0/unbounded (no documentation provided)