Sonatype Nexus OSS 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 artifact-resolution

REST Response object received after requesting an artifact resolve, contains the typical 'data' parameter, which is the artifact resolve details.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <artifact-resolution> <data> <!--content of type 'artifact-resolve-resource'--> <groupId> <!--content of type 'string'--> ... </groupId> <artifactId> <!--content of type 'string'--> ... </artifactId> <version> <!--content of type 'string'--> ... </version> <baseVersion> <!--content of type 'string'--> ... </baseVersion> <classifier> <!--content of type 'string'--> ... </classifier> <extension> <!--content of type 'string'--> ... </extension> <snapshot> <!--content of type 'boolean'--> ... </snapshot> <snapshotBuildNumber> <!--content of type 'long'--> ... </snapshotBuildNumber> <snapshotTimeStamp> <!--content of type 'long'--> ... </snapshotTimeStamp> <fileName> <!--content of type 'string'--> ... </fileName> <sha1> <!--content of type 'string'--> ... </sha1> <repositoryPath> <!--content of type 'string'--> ... </repositoryPath> </data> </artifact-resolution>

Example JSON

{ "data" : { "groupId" : "...", "artifactId" : "...", "version" : "...", "baseVersion" : "...", "classifier" : "...", "extension" : "...", "snapshot" : false, "snapshotBuildNumber" : ..., "snapshotTimeStamp" : ..., "fileName" : "...", "sha1" : "...", "repositoryPath" : "..." } }

Element components-list

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

Example XML

<?xml version="1.0" encoding="UTF-8"?> <components-list> <data> <component> <!--content of type 'plexus-component-list-resource'--> <roleHint> <!--content of type 'string'--> ... </roleHint> <description> <!--content of type 'string'--> ... </description> </component> <component> <!--(another 'plexus-component-list-resource' type)--> </component> <!--...more "component" elements...--> </data> </components-list>

Example JSON

{ "data" : [ { "roleHint" : "...", "description" : "..." }, ... ] }

Element configs-list

REST Response object for a list of Nexus configuration objects, contains the typical 'data' parameter, which is a list of the configuration items.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <configs-list> <data> <configs-list-item> <!--content of type 'configs-list-item'--> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <name> <!--content of type 'string'--> ... </name> </configs-list-item> <configs-list-item> <!--(another 'configs-list-item' type)--> </configs-list-item> <!--...more "configs-list-item" elements...--> </data> </configs-list>

Example JSON

{ "data" : [ { "resourceURI" : "...", "name" : "..." }, ... ] }

Element content

REST Response object for a content resource request, contains the typical 'data' parameter, which is a list of the content items requested.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <content> <data> <content-item> <!--content of type 'content-list-resource'--> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <relativePath> <!--content of type 'string'--> ... </relativePath> <text> <!--content of type 'string'--> ... </text> <leaf> <!--content of type 'boolean'--> ... </leaf> <lastModified> <!--content of type 'dateTime'--> ... </lastModified> <sizeOnDisk> <!--content of type 'long'--> ... </sizeOnDisk> </content-item> <content-item> <!--(another 'content-list-resource' type)--> </content-item> <!--...more "content-item" elements...--> </data> </content>

Example JSON

{ "data" : [ { "resourceURI" : "...", "relativePath" : "...", "text" : "...", "leaf" : false, "lastModified" : "...", "sizeOnDisk" : ... }, ... ] }

Element contentDescribe

REST Response object for a content resource request, contains the typical 'data' parameter, which is a list of the content items requested.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <contentDescribe> <data> <!--content of type 'content-list-describe-resource'--> <requestUrl> <!--content of type 'string'--> ... </requestUrl> <processingTimeMillis> <!--content of type 'long'--> ... </processingTimeMillis> <request> <!--content of type 'content-list-describe-request-resource'--> <requestUrl> <!--content of type 'string'--> ... </requestUrl> <requestPath> <!--content of type 'string'--> ... </requestPath> <requestContext> <requestContextItem> <!--content of type 'string'--> ... </requestContextItem> <requestContextItem> <!--(another 'string' type)--> </requestContextItem> <!--...more "requestContextItem" elements...--> </requestContext> </request> <response> <!--content of type 'content-list-describe-response-resource'--> <responseType> <!--content of type 'string'--> ... </responseType> <responseActualClass> <!--content of type 'string'--> ... </responseActualClass> <responsePath> <!--content of type 'string'--> ... </responsePath> <responseUid> <!--content of type 'string'--> ... </responseUid> <originatingRepositoryId> <!--content of type 'string'--> ... </originatingRepositoryId> <originatingRepositoryName> <!--content of type 'string'--> ... </originatingRepositoryName> <originatingRepositoryMainFacet> <!--content of type 'string'--> ... </originatingRepositoryMainFacet> <processedRepositoriesList> <processedRepositoriesListItem> <!--content of type 'string'--> ... </processedRepositoriesListItem> <processedRepositoriesListItem> <!--(another 'string' type)--> </processedRepositoriesListItem> <!--...more "processedRepositoriesListItem" elements...--> </processedRepositoriesList> <appliedMappings> <appliedMappingItem> <!--content of type 'string'--> ... </appliedMappingItem> <appliedMappingItem> <!--(another 'string' type)--> </appliedMappingItem> <!--...more "appliedMappingItem" elements...--> </appliedMappings> <properties> <propertyItem> <!--content of type 'string'--> ... </propertyItem> <propertyItem> <!--(another 'string' type)--> </propertyItem> <!--...more "propertyItem" elements...--> </properties> <attributes> <attributeItem> <!--content of type 'string'--> ... </attributeItem> <attributeItem> <!--(another 'string' type)--> </attributeItem> <!--...more "attributeItem" elements...--> </attributes> <sources> <sourceItem> <!--content of type 'string'--> ... </sourceItem> <sourceItem> <!--(another 'string' type)--> </sourceItem> <!--...more "sourceItem" elements...--> </sources> </response> </data> </contentDescribe>

Example JSON

{ "data" : { "requestUrl" : "...", "processingTimeMillis" : ..., "request" : { "requestUrl" : "...", "requestPath" : "...", "requestContext" : [ "...", ... ] }, "response" : { "responseType" : "...", "responseActualClass" : "...", "responsePath" : "...", "responseUid" : "...", "originatingRepositoryId" : "...", "originatingRepositoryName" : "...", "originatingRepositoryMainFacet" : "...", "processedRepositoriesList" : [ "...", ... ], "appliedMappings" : [ "...", ... ], "properties" : [ "...", ... ], "attributes" : [ "...", ... ], "sources" : [ "...", ... ] } } }

Element error-report-request

REST Request object for generating an error report, contains the typical 'data' parameter, which is an error report item.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <error-report-request> <data> <!--content of type 'error-report-request-dto'--> <title> <!--content of type 'string'--> ... </title> <description> <!--content of type 'string'--> ... </description> <saveErrorReportingSettings> <!--content of type 'boolean'--> ... </saveErrorReportingSettings> <errorReportingSettings> <!--content of type 'error-reporting-settings'--> <jiraUsername> <!--content of type 'string'--> ... </jiraUsername> <jiraPassword> <!--content of type 'string'--> ... </jiraPassword> <useGlobalProxy> <!--content of type 'boolean'--> ... </useGlobalProxy> <reportErrorsAutomatically> <!--content of type 'boolean'--> ... </reportErrorsAutomatically> </errorReportingSettings> </data> </error-report-request>

Example JSON

{ "data" : { "title" : "...", "description" : "...", "saveErrorReportingSettings" : false, "errorReportingSettings" : { "jiraUsername" : "...", "jiraPassword" : "...", "useGlobalProxy" : false, "reportErrorsAutomatically" : false } } }

Element error-report-response

REST Response object received after generating an error report, contains the typical 'data' parameter, which is the error report response item.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <error-report-response> <data> <!--content of type 'error-report-response-dto'--> <jiraUrl> <!--content of type 'string'--> ... </jiraUrl> </data> </error-report-response>

Example JSON

{ "data" : { "jiraUrl" : "..." } }

Element feeds-list

REST Response object for a list of Nexus feed items, contains the typical 'data' parameter, which is a list of the feed items.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <feeds-list> <data> <feeds-list-item> <!--content of type 'feed-list-resource'--> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <name> <!--content of type 'string'--> ... </name> </feeds-list-item> <feeds-list-item> <!--(another 'feed-list-resource' type)--> </feeds-list-item> <!--...more "feeds-list-item" elements...--> </data> </feeds-list>

Example JSON

{ "data" : [ { "resourceURI" : "...", "name" : "..." }, ... ] }

Element global-settings

REST Response object for a global configuration request, contains the typical 'data' parameter, which is the global configuration item requested.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <global-settings> <data> <!--content of type 'global-settings-item'--> <securityEnabled> <!--content of type 'boolean'--> ... </securityEnabled> <securityAnonymousAccessEnabled> <!--content of type 'boolean'--> ... </securityAnonymousAccessEnabled> <securityAnonymousUsername> <!--content of type 'string'--> ... </securityAnonymousUsername> <securityAnonymousPassword> <!--content of type 'string'--> ... </securityAnonymousPassword> <securityRealms> <securityRealmItem> <!--content of type 'string'--> ... </securityRealmItem> <securityRealmItem> <!--(another 'string' type)--> </securityRealmItem> <!--...more "securityRealmItem" elements...--> </securityRealms> <globalConnectionSettings> <!--content of type 'remote-connection-settings'--> <connectionTimeout> <!--content of type 'int'--> ... </connectionTimeout> <retrievalRetryCount> <!--content of type 'int'--> ... </retrievalRetryCount> <queryString> <!--content of type 'string'--> ... </queryString> <userAgentString> <!--content of type 'string'--> ... </userAgentString> </globalConnectionSettings> <systemNotificationSettings> <!--content of type 'system-notification-settings'--> <enabled> <!--content of type 'boolean'--> ... </enabled> <emailAddresses> <!--content of type 'string'--> ... </emailAddresses> <roles> <!--content of type 'string'--> ... </roles> <roles> <!--(another 'string' type)--> </roles> <!--...more "roles" elements...--> </systemNotificationSettings> <smtpSettings> <!--content of type 'smtp-settings'--> <host> <!--content of type 'string'--> ... </host> <port> <!--content of type 'int'--> ... </port> <username> <!--content of type 'string'--> ... </username> <password> <!--content of type 'string'--> ... </password> <systemEmailAddress> <!--content of type 'string'--> ... </systemEmailAddress> <sslEnabled> <!--content of type 'boolean'--> ... </sslEnabled> <tlsEnabled> <!--content of type 'boolean'--> ... </tlsEnabled> </smtpSettings> <globalHttpProxySettings> <!--content of type 'remote-http-proxy-settings'--> <proxyHostname> <!--content of type 'string'--> ... </proxyHostname> <proxyPort> <!--content of type 'int'--> ... </proxyPort> <authentication> <!--content of type 'authentication-settings'--> <username> <!--content of type 'string'--> ... </username> <password> <!--content of type 'string'--> ... </password> <ntlmHost> <!--content of type 'string'--> ... </ntlmHost> <ntlmDomain> <!--content of type 'string'--> ... </ntlmDomain> </authentication> <nonProxyHosts> <!--content of type 'string'--> ... </nonProxyHosts> <nonProxyHosts> <!--(another 'string' type)--> </nonProxyHosts> <!--...more "nonProxyHosts" elements...--> </globalHttpProxySettings> <globalRestApiSettings> <!--content of type 'rest-api-settings'--> <forceBaseUrl> <!--content of type 'boolean'--> ... </forceBaseUrl> <baseUrl> <!--content of type 'string'--> ... </baseUrl> </globalRestApiSettings> <errorReportingSettings> <!--content of type 'error-reporting-settings'--> <jiraUsername> <!--content of type 'string'--> ... </jiraUsername> <jiraPassword> <!--content of type 'string'--> ... </jiraPassword> <useGlobalProxy> <!--content of type 'boolean'--> ... </useGlobalProxy> <reportErrorsAutomatically> <!--content of type 'boolean'--> ... </reportErrorsAutomatically> </errorReportingSettings> </data> </global-settings>

Example JSON

{ "data" : { "securityEnabled" : false, "securityAnonymousAccessEnabled" : false, "securityAnonymousUsername" : "...", "securityAnonymousPassword" : "...", "securityRealms" : [ "...", ... ], "globalConnectionSettings" : { "connectionTimeout" : ..., "retrievalRetryCount" : ..., "queryString" : "...", "userAgentString" : "..." }, "systemNotificationSettings" : { "enabled" : false, "emailAddresses" : "...", "roles" : [ "...", ... ] }, "smtpSettings" : { "host" : "...", "port" : ..., "username" : "...", "password" : "...", "systemEmailAddress" : "...", "sslEnabled" : false, "tlsEnabled" : false }, "globalHttpProxySettings" : { "proxyHostname" : "...", "proxyPort" : ..., "authentication" : { "username" : "...", "password" : "...", "ntlmHost" : "...", "ntlmDomain" : "..." }, "nonProxyHosts" : [ "...", ... ] }, "globalRestApiSettings" : { "forceBaseUrl" : false, "baseUrl" : "..." }, "errorReportingSettings" : { "jiraUsername" : "...", "jiraPassword" : "...", "useGlobalProxy" : false, "reportErrorsAutomatically" : false } } }

Element global-settings-list

REST Response object for a global configuration list request, contains the typical 'data' parameter, which is a list of the global configuration items requested.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <global-settings-list> <data> <global-settings-list-item> <!--content of type 'global-configuration-list-item'--> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <name> <!--content of type 'string'--> ... </name> </global-settings-list-item> <global-settings-list-item> <!--(another 'global-configuration-list-item' type)--> </global-settings-list-item> <!--...more "global-settings-list-item" elements...--> </data> </global-settings-list>

Example JSON

{ "data" : [ { "resourceURI" : "...", "name" : "..." }, ... ] }

Element log-config

REST Response object for the log config request, contains the typical 'data' parameter, which is the log configuration.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <log-config> <data> <!--content of type 'log-config-resource'--> <rootLoggerLevel> <!--content of type 'string'--> ... </rootLoggerLevel> <rootLoggerAppenders> <!--content of type 'string'--> ... </rootLoggerAppenders> <fileAppenderLocation> <!--content of type 'string'--> ... </fileAppenderLocation> <fileAppenderPattern> <!--content of type 'string'--> ... </fileAppenderPattern> </data> </log-config>

Example JSON

{ "data" : { "rootLoggerLevel" : "...", "rootLoggerAppenders" : "...", "fileAppenderLocation" : "...", "fileAppenderPattern" : "..." } }

Element logs-list

REST Response object for a log list resource request, contains the typical 'data' parameter, which is a list of the log items requested.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <logs-list> <data> <logs-list-item> <!--content of type 'logs-list-resource'--> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <name> <!--content of type 'string'--> ... </name> <size> <!--content of type 'long'--> ... </size> <mimeType> <!--content of type 'string'--> ... </mimeType> </logs-list-item> <logs-list-item> <!--(another 'logs-list-resource' type)--> </logs-list-item> <!--...more "logs-list-item" elements...--> </data> </logs-list>

Example JSON

{ "data" : [ { "resourceURI" : "...", "name" : "...", "size" : ..., "mimeType" : "..." }, ... ] }

Element mirror-list-request

REST Request object to persist list of mirrors associated with a repository, contains the typical 'data' parameter, which is the list of mirrors.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <mirror-list-request> <data> <mirrorResource> <!--content of type 'mirror-resource'--> <id> <!--content of type 'string'--> ... </id> <url> <!--content of type 'string'--> ... </url> </mirrorResource> <mirrorResource> <!--(another 'mirror-resource' type)--> </mirrorResource> <!--...more "mirrorResource" elements...--> </data> </mirror-list-request>

Example JSON

{ "data" : [ { "id" : "...", "url" : "..." }, ... ] }

Element mirror-list-response

REST Response object for a list of mirrors associated with a repository, contains the typical 'data' parameter, which is the list of mirrors.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <mirror-list-response> <data> <mirrorResource> <!--content of type 'mirror-resource'--> <id> <!--content of type 'string'--> ... </id> <url> <!--content of type 'string'--> ... </url> </mirrorResource> <mirrorResource> <!--(another 'mirror-resource' type)--> </mirrorResource> <!--...more "mirrorResource" elements...--> </data> </mirror-list-response>

Example JSON

{ "data" : [ { "id" : "...", "url" : "..." }, ... ] }

Element mirror-status-list-response

REST Response object for a list of mirror statuses associated with a repository, contains the typical 'data' parameter, which is the list of mirrors statuses.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <mirror-status-list-response> <data> <mirrorResource> <!--content of type 'mirror-status-resource'--> <status> <!--content of type 'string'--> ... </status> </mirrorResource> <mirrorResource> <!--(another 'mirror-status-resource' type)--> </mirrorResource> <!--...more "mirrorResource" elements...--> </data> </mirror-status-list-response>

Example JSON

{ "data" : [ { "status" : "..." }, ... ] }

Element nfc-info

REST Response object for an NFC resource item, contains the typical 'data' parameter, which is the NFC resource item.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <nfc-info> <data> <!--content of type 'nfc-resource'--> <nfcContents> <nfc-repo-info> <!--content of type 'nfc-repository-resource'--> <repositoryId> <!--content of type 'string'--> ... </repositoryId> <nfcStats> <!--content of type 'nfc-stats'--> <size> <!--content of type 'long'--> ... </size> <hits> <!--content of type 'long'--> ... </hits> <misses> <!--content of type 'long'--> ... </misses> </nfcStats> <nfcPaths> <path> <!--content of type 'string'--> ... </path> <path> <!--(another 'string' type)--> </path> <!--...more "path" elements...--> </nfcPaths> </nfc-repo-info> <nfc-repo-info> <!--(another 'nfc-repository-resource' type)--> </nfc-repo-info> <!--...more "nfc-repo-info" elements...--> </nfcContents> </data> </nfc-info>

Example JSON

{ "data" : { "nfcContents" : [ { "repositoryId" : "...", "nfcStats" : { "size" : ..., "hits" : ..., "misses" : ... }, "nfcPaths" : [ "...", ... ] }, ... ] } }

Element privilege

REST response object to persist a privilege.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <privilege> <data> <!--content of type 'privilege'--> <name> <!--content of type 'string'--> ... </name> <type> <!--content of type 'string'--> ... </type> <description> <!--content of type 'string'--> ... </description> <methods> <method> <!--content of type 'string'--> ... </method> <method> <!--(another 'string' type)--> </method> <!--...more "method" elements...--> </methods> <repositoryTargetId> <!--content of type 'string'--> ... </repositoryTargetId> <repositoryId> <!--content of type 'string'--> ... </repositoryId> <repositoryGroupId> <!--content of type 'string'--> ... </repositoryGroupId> </data> </privilege>

Example JSON

{ "data" : { "name" : "...", "type" : "...", "description" : "...", "methods" : [ "...", ... ], "repositoryTargetId" : "...", "repositoryId" : "...", "repositoryGroupId" : "..." } }

Element repo-content-classes-list

REST Response object for a list of repository content classes, contains the typical 'data' parameter, which is the repository content class list.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repo-content-classes-list> <data> <repo-content-classes-list-item> <!--content of type 'repository-content-class-list-resource'--> <contentClass> <!--content of type 'string'--> ... </contentClass> <name> <!--content of type 'string'--> ... </name> </repo-content-classes-list-item> <repo-content-classes-list-item> <!--(another 'repository-content-class-list-resource' type)--> </repo-content-classes-list-item> <!--...more "repo-content-classes-list-item" elements...--> </data> </repo-content-classes-list>

Example JSON

{ "data" : [ { "contentClass" : "...", "name" : "..." }, ... ] }

Element repo-group

REST Response object for a repository group request, contains the typical 'data' parameter, which is the repository group object.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repo-group> <data> <!--content of type 'repository-group-resource'--> <repositories> <repo-group-member> <!--content of type 'repository-group-member-repository'--> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <resourceURI> <!--content of type 'string'--> ... </resourceURI> </repo-group-member> <repo-group-member> <!--(another 'repository-group-member-repository' type)--> </repo-group-member> <!--...more "repo-group-member" elements...--> </repositories> </data> </repo-group>

Example JSON

{ "data" : { "repositories" : [ { "id" : "...", "name" : "...", "resourceURI" : "..." }, ... ] } }

Element repo-group-list

REST Response object for a repository group list request, contains the typical 'data' parameter, which is the list of repository group objects.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repo-group-list> <data> <repo-group-list-item> <!--content of type 'repository-group-list-resource'--> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <contentResourceURI> <!--content of type 'string'--> ... </contentResourceURI> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <format> <!--content of type 'string'--> ... </format> <exposed> <!--content of type 'boolean'--> ... </exposed> </repo-group-list-item> <repo-group-list-item> <!--(another 'repository-group-list-resource' type)--> </repo-group-list-item> <!--...more "repo-group-list-item" elements...--> </data> </repo-group-list>

Example JSON

{ "data" : [ { "resourceURI" : "...", "contentResourceURI" : "...", "id" : "...", "name" : "...", "format" : "...", "exposed" : false }, ... ] }

Element repo-route

REST Response object for a repository route request, contains the typical 'data' parameter, which is the repository route object.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repo-route> <data> <!--content of type 'repository-route-resource'--> <id> <!--content of type 'string'--> ... </id> <groupId> <!--content of type 'string'--> ... </groupId> <ruleType> <!--content of type 'string'--> ... </ruleType> <pattern> <!--content of type 'string'--> ... </pattern> <repositories> <repository> <!--content of type 'repository-route-member-repo'--> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <resourceURI> <!--content of type 'string'--> ... </resourceURI> </repository> <repository> <!--(another 'repository-route-member-repo' type)--> </repository> <!--...more "repository" elements...--> </repositories> </data> </repo-route>

Example JSON

{ "data" : { "id" : "...", "groupId" : "...", "ruleType" : "...", "pattern" : "...", "repositories" : [ { "id" : "...", "name" : "...", "resourceURI" : "..." }, ... ] } }

Element repo-routes-list

REST Response object for a repository route list request, contains the typical 'data' parameter, which is the list of repository route objects.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repo-routes-list> <data> <repo-routes-list-item> <!--content of type 'repository-route-list-resource'--> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <groupId> <!--content of type 'string'--> ... </groupId> <ruleType> <!--content of type 'string'--> ... </ruleType> <pattern> <!--content of type 'string'--> ... </pattern> <repositories> <repo-routes-member> <!--content of type 'repository-route-member-repo'--> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <resourceURI> <!--content of type 'string'--> ... </resourceURI> </repo-routes-member> <repo-routes-member> <!--(another 'repository-route-member-repo' type)--> </repo-routes-member> <!--...more "repo-routes-member" elements...--> </repositories> </repo-routes-list-item> <repo-routes-list-item> <!--(another 'repository-route-list-resource' type)--> </repo-routes-list-item> <!--...more "repo-routes-list-item" elements...--> </data> </repo-routes-list>

Example JSON

{ "data" : [ { "resourceURI" : "...", "groupId" : "...", "ruleType" : "...", "pattern" : "...", "repositories" : [ { "id" : "...", "name" : "...", "resourceURI" : "..." }, ... ] }, ... ] }

Element repositories

REST Response object for a repository list request, contains the typical 'data' parameter, which is the list of repository objects.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repositories> <data> <repositories-item> <!--content of type 'repositories-item'--> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <contentResourceURI> <!--content of type 'string'--> ... </contentResourceURI> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <repoType> <!--content of type 'string'--> ... </repoType> <repoPolicy> <!--content of type 'string'--> ... </repoPolicy> <provider> <!--content of type 'string'--> ... </provider> <providerRole> <!--content of type 'string'--> ... </providerRole> <format> <!--content of type 'string'--> ... </format> <userManaged> <!--content of type 'boolean'--> ... </userManaged> <exposed> <!--content of type 'boolean'--> ... </exposed> <effectiveLocalStorageUrl> <!--content of type 'string'--> ... </effectiveLocalStorageUrl> <remoteUri> <!--content of type 'string'--> ... </remoteUri> </repositories-item> <repositories-item> <!--(another 'repositories-item' type)--> </repositories-item> <!--...more "repositories-item" elements...--> </data> </repositories>

Example JSON

{ "data" : [ { "resourceURI" : "...", "contentResourceURI" : "...", "id" : "...", "name" : "...", "repoType" : "...", "repoPolicy" : "...", "provider" : "...", "providerRole" : "...", "format" : "...", "userManaged" : false, "exposed" : false, "effectiveLocalStorageUrl" : "...", "remoteUri" : "..." }, ... ] }

Element repository

REST Response object for a repository request, contains the typical 'data' parameter, which is the repository object.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repository> <data> <!--content of type 'base-repository'--> <contentResourceURI> <!--content of type 'string'--> ... </contentResourceURI> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <provider> <!--content of type 'string'--> ... </provider> <providerRole> <!--content of type 'string'--> ... </providerRole> <format> <!--content of type 'string'--> ... </format> <repoType> <!--content of type 'string'--> ... </repoType> <exposed> <!--content of type 'boolean'--> ... </exposed> </data> </repository>

Example JSON

{ "data" : { "contentResourceURI" : "...", "id" : "...", "name" : "...", "provider" : "...", "providerRole" : "...", "format" : "...", "repoType" : "...", "exposed" : false } }

Element repository-meta-data

REST Response object for a repository metadata request, contains the typical 'data' parameter, which is the repository metadata object.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repository-meta-data> <data> <!--content of type 'repository-meta-resource'--> <id> <!--content of type 'string'--> ... </id> <repoType> <!--content of type 'string'--> ... </repoType> <format> <!--content of type 'string'--> ... </format> <sizeOnDisk> <!--content of type 'long'--> ... </sizeOnDisk> <freeSpaceOnDisk> <!--content of type 'long'--> ... </freeSpaceOnDisk> <fileCountInRepository> <!--content of type 'long'--> ... </fileCountInRepository> <notFoundCacheSize> <!--content of type 'long'--> ... </notFoundCacheSize> <notFoundCacheHits> <!--content of type 'long'--> ... </notFoundCacheHits> <notFoundCacheMisses> <!--content of type 'long'--> ... </notFoundCacheMisses> <localStorageErrorsCount> <!--content of type 'int'--> ... </localStorageErrorsCount> <remoteStorageErrorsCount> <!--content of type 'int'--> ... </remoteStorageErrorsCount> <groups> <string> <!--content of type 'string'--> ... </string> <string> <!--(another 'string' type)--> </string> <!--...more "string" elements...--> </groups> </data> </repository-meta-data>

Example JSON

{ "data" : { "id" : "...", "repoType" : "...", "format" : "...", "sizeOnDisk" : ..., "freeSpaceOnDisk" : ..., "fileCountInRepository" : ..., "notFoundCacheSize" : ..., "notFoundCacheHits" : ..., "notFoundCacheMisses" : ..., "localStorageErrorsCount" : ..., "remoteStorageErrorsCount" : ..., "groups" : [ "...", ... ] } }

Element repository-status

REST Response object for a repository status request, contains the typical 'data' parameter, which is the repository status objects.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repository-status> <data> <!--content of type 'repository-status'--> <id> <!--content of type 'string'--> ... </id> <repoType> <!--content of type 'string'--> ... </repoType> <format> <!--content of type 'string'--> ... </format> <localStatus> <!--content of type 'string'--> ... </localStatus> <remoteStatus> <!--content of type 'string'--> ... </remoteStatus> <proxyMode> <!--content of type 'string'--> ... </proxyMode> <dependentRepos> <dependentRepoItem> <!--content of type 'repository-dependent-status'--> <id> <!--content of type 'string'--> ... </id> <repoType> <!--content of type 'string'--> ... </repoType> <format> <!--content of type 'string'--> ... </format> <localStatus> <!--content of type 'string'--> ... </localStatus> </dependentRepoItem> <dependentRepoItem> <!--(another 'repository-dependent-status' type)--> </dependentRepoItem> <!--...more "dependentRepoItem" elements...--> </dependentRepos> </data> </repository-status>

Example JSON

{ "data" : { "id" : "...", "repoType" : "...", "format" : "...", "localStatus" : "...", "remoteStatus" : "...", "proxyMode" : "...", "dependentRepos" : [ { "id" : "...", "repoType" : "...", "format" : "...", "localStatus" : "..." }, ... ] } }

Element repository-status-list

REST Response object for a repository status list request, contains the typical 'data' parameter, which is the list of repository status objects.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repository-status-list> <data> <repository-status-list-item> <!--content of type 'repository-status-list-item'--> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <repoType> <!--content of type 'string'--> ... </repoType> <repoPolicy> <!--content of type 'string'--> ... </repoPolicy> <format> <!--content of type 'string'--> ... </format> <status> <!--content of type 'repository-status'--> <id> <!--content of type 'string'--> ... </id> <repoType> <!--content of type 'string'--> ... </repoType> <format> <!--content of type 'string'--> ... </format> <localStatus> <!--content of type 'string'--> ... </localStatus> <remoteStatus> <!--content of type 'string'--> ... </remoteStatus> <proxyMode> <!--content of type 'string'--> ... </proxyMode> <dependentRepos> <dependentRepoItem> <!--content of type 'repository-dependent-status'--> <id> <!--content of type 'string'--> ... </id> <repoType> <!--content of type 'string'--> ... </repoType> <format> <!--content of type 'string'--> ... </format> <localStatus> <!--content of type 'string'--> ... </localStatus> </dependentRepoItem> <dependentRepoItem> <!--(another 'repository-dependent-status' type)--> </dependentRepoItem> <!--...more "dependentRepoItem" elements...--> </dependentRepos> </status> </repository-status-list-item> <repository-status-list-item> <!--(another 'repository-status-list-item' type)--> </repository-status-list-item> <!--...more "repository-status-list-item" elements...--> </data> </repository-status-list>

Example JSON

{ "data" : [ { "resourceURI" : "...", "id" : "...", "name" : "...", "repoType" : "...", "repoPolicy" : "...", "format" : "...", "status" : { "id" : "...", "repoType" : "...", "format" : "...", "localStatus" : "...", "remoteStatus" : "...", "proxyMode" : "...", "dependentRepos" : [ { "id" : "...", "repoType" : "...", "format" : "...", "localStatus" : "..." }, ... ] } }, ... ] }

Element repositoryTypes

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

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repositoryTypes> <data> <repositoryType> <!--content of type 'nexus-repository-type-list-resource'--> <provider> <!--content of type 'string'--> ... </provider> <providerRole> <!--content of type 'string'--> ... </providerRole> <format> <!--content of type 'string'--> ... </format> <description> <!--content of type 'string'--> ... </description> </repositoryType> <repositoryType> <!--(another 'nexus-repository-type-list-resource' type)--> </repositoryType> <!--...more "repositoryType" elements...--> </data> </repositoryTypes>

Example JSON

{ "data" : [ { "provider" : "...", "providerRole" : "...", "format" : "...", "description" : "..." }, ... ] }

Element repo-target

REST Response object for a repository target, contains the typical 'data' parameter, which is the repository target.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repo-target> <data> <!--content of type 'repository-target-resource'--> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <contentClass> <!--content of type 'string'--> ... </contentClass> <patterns> <pattern> <!--content of type 'string'--> ... </pattern> <pattern> <!--(another 'string' type)--> </pattern> <!--...more "pattern" elements...--> </patterns> </data> </repo-target>

Example JSON

{ "data" : { "resourceURI" : "...", "id" : "...", "name" : "...", "contentClass" : "...", "patterns" : [ "...", ... ] } }

Element repo-targets-list

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

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repo-targets-list> <data> <repo-targets-list-item> <!--content of type 'repository-target-list-resource'--> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <contentClass> <!--content of type 'string'--> ... </contentClass> </repo-targets-list-item> <repo-targets-list-item> <!--(another 'repository-target-list-resource' type)--> </repo-targets-list-item> <!--...more "repo-targets-list-item" elements...--> </data> </repo-targets-list>

Example JSON

{ "data" : [ { "resourceURI" : "...", "id" : "...", "name" : "...", "contentClass" : "..." }, ... ] }

Element scheduled-task

REST Response object for a scheduled service configuration request, contains the typical 'data' parameter, which is the scheduled service configuration.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <scheduled-task> <data> <!--content of type 'scheduled-service-base-resource'--> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <enabled> <!--content of type 'boolean'--> ... </enabled> <typeId> <!--content of type 'string'--> ... </typeId> <alertEmail> <!--content of type 'string'--> ... </alertEmail> <schedule> <!--content of type 'string'--> ... </schedule> <properties> <scheduled-task-property> <!--content of type 'scheduled-service-property-resource'--> <id> <!--content of type 'string'--> ... </id> <value> <!--content of type 'string'--> ... </value> </scheduled-task-property> <scheduled-task-property> <!--(another 'scheduled-service-property-resource' type)--> </scheduled-task-property> <!--...more "scheduled-task-property" elements...--> </properties> </data> </scheduled-task>

Example JSON

{ "data" : { "id" : "...", "name" : "...", "enabled" : false, "typeId" : "...", "alertEmail" : "...", "schedule" : "...", "properties" : [ { "id" : "...", "value" : "..." }, ... ] } }

Element schedule-service-status

REST Response object for a scheduled service status request, contains the typical 'data' parameter, which is the scheduled service status.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <schedule-service-status> <data> <!--content of type 'scheduled-service-resource-status'--> <resource> <!--content of type 'scheduled-service-base-resource'--> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <enabled> <!--content of type 'boolean'--> ... </enabled> <typeId> <!--content of type 'string'--> ... </typeId> <alertEmail> <!--content of type 'string'--> ... </alertEmail> <schedule> <!--content of type 'string'--> ... </schedule> <properties> <scheduled-task-property> <!--content of type 'scheduled-service-property-resource'--> <id> <!--content of type 'string'--> ... </id> <value> <!--content of type 'string'--> ... </value> </scheduled-task-property> <scheduled-task-property> <!--(another 'scheduled-service-property-resource' type)--> </scheduled-task-property> <!--...more "scheduled-task-property" elements...--> </properties> </resource> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <status> <!--content of type 'string'--> ... </status> <nextRunTime> <!--content of type 'string'--> ... </nextRunTime> <lastRunTime> <!--content of type 'string'--> ... </lastRunTime> <lastRunResult> <!--content of type 'string'--> ... </lastRunResult> <created> <!--content of type 'string'--> ... </created> </data> </schedule-service-status>

Example JSON

{ "data" : { "resource" : { "id" : "...", "name" : "...", "enabled" : false, "typeId" : "...", "alertEmail" : "...", "schedule" : "...", "properties" : [ { "id" : "...", "value" : "..." }, ... ] }, "resourceURI" : "...", "status" : "...", "nextRunTime" : "...", "lastRunTime" : "...", "lastRunResult" : "...", "created" : "..." } }

Element schedules-list

REST Response object for a list of scheduled service items, contains the typical 'data' parameter, which is the list of scheduled services..

Example XML

<?xml version="1.0" encoding="UTF-8"?> <schedules-list> <data> <schedules-list-item> <!--content of type 'scheduled-service-list-resource'--> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <id> <!--content of type 'string'--> ... </id> <enabled> <!--content of type 'boolean'--> ... </enabled> <name> <!--content of type 'string'--> ... </name> <typeId> <!--content of type 'string'--> ... </typeId> <typeName> <!--content of type 'string'--> ... </typeName> <status> <!--content of type 'string'--> ... </status> <schedule> <!--content of type 'string'--> ... </schedule> <nextRunTime> <!--content of type 'string'--> ... </nextRunTime> <lastRunTime> <!--content of type 'string'--> ... </lastRunTime> <lastRunResult> <!--content of type 'string'--> ... </lastRunResult> <created> <!--content of type 'string'--> ... </created> </schedules-list-item> <schedules-list-item> <!--(another 'scheduled-service-list-resource' type)--> </schedules-list-item> <!--...more "schedules-list-item" elements...--> </data> </schedules-list>

Example JSON

{ "data" : [ { "resourceURI" : "...", "id" : "...", "enabled" : false, "name" : "...", "typeId" : "...", "typeName" : "...", "status" : "...", "schedule" : "...", "nextRunTime" : "...", "lastRunTime" : "...", "lastRunResult" : "...", "created" : "..." }, ... ] }

Element schedule-types

REST Response object for a scheduled service type list request, contains the typical 'data' parameter, which is the scheduled service type details.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <schedule-types> <data> <schedule-type> <!--content of type 'scheduled-service-type-resource'--> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <properties> <scheduled-task-property> <!--content of type 'scheduled-service-type-property-resource'--> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <type> <!--content of type 'string'--> ... </type> <helpText> <!--content of type 'string'--> ... </helpText> <required> <!--content of type 'boolean'--> ... </required> <regexValidation> <!--content of type 'string'--> ... </regexValidation> </scheduled-task-property> <scheduled-task-property> <!--(another 'scheduled-service-type-property-resource' type)--> </scheduled-task-property> <!--...more "scheduled-task-property" elements...--> </properties> </schedule-type> <schedule-type> <!--(another 'scheduled-service-type-resource' type)--> </schedule-type> <!--...more "schedule-type" elements...--> </data> </schedule-types>

Example JSON

{ "data" : [ { "id" : "...", "name" : "...", "properties" : [ { "id" : "...", "name" : "...", "type" : "...", "helpText" : "...", "required" : false, "regexValidation" : "..." }, ... ] }, ... ] }

Element smtp-settings-request

REST Request object for validating the nexus smtp settings, contains the typical 'data' parameter, which is the nexus stmp configuration.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <smtp-settings-request> <data> <!--content of type 'smtp-settings-resource'--> <testEmail> <!--content of type 'string'--> ... </testEmail> <host> <!--content of type 'string'--> ... </host> <port> <!--content of type 'int'--> ... </port> <username> <!--content of type 'string'--> ... </username> <password> <!--content of type 'string'--> ... </password> <systemEmailAddress> <!--content of type 'string'--> ... </systemEmailAddress> <sslEnabled> <!--content of type 'boolean'--> ... </sslEnabled> <tlsEnabled> <!--content of type 'boolean'--> ... </tlsEnabled> </data> </smtp-settings-request>

Example JSON

{ "data" : { "testEmail" : "...", "host" : "...", "port" : ..., "username" : "...", "password" : "...", "systemEmailAddress" : "...", "sslEnabled" : false, "tlsEnabled" : false } }

Element status

REST Response object for the nexus status, contains the typical 'data' parameter, which is the nexus status.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <status> <data> <!--content of type 'status-resource'--> <appName> <!--content of type 'string'--> ... </appName> <formattedAppName> <!--content of type 'string'--> ... </formattedAppName> <version> <!--content of type 'string'--> ... </version> <apiVersion> <!--content of type 'string'--> ... </apiVersion> <editionLong> <!--content of type 'string'--> ... </editionLong> <editionShort> <!--content of type 'string'--> ... </editionShort> <state> <!--content of type 'string'--> ... </state> <operationMode> <!--content of type 'string'--> ... </operationMode> <initializedAt> <!--content of type 'dateTime'--> ... </initializedAt> <startedAt> <!--content of type 'dateTime'--> ... </startedAt> <lastConfigChange> <!--content of type 'dateTime'--> ... </lastConfigChange> <firstStart> <!--content of type 'boolean'--> ... </firstStart> <instanceUpgraded> <!--content of type 'boolean'--> ... </instanceUpgraded> <configurationUpgraded> <!--content of type 'boolean'--> ... </configurationUpgraded> <configurationValidationResponse> <!--content of type 'status-configuration-validation-response'--> <valid> <!--content of type 'boolean'--> ... </valid> <modified> <!--content of type 'boolean'--> ... </modified> <validationErrors> <error> <!--content of type 'string'--> ... </error> <error> <!--(another 'string' type)--> </error> <!--...more "error" elements...--> </validationErrors> <validationWarnings> <warning> <!--content of type 'string'--> ... </warning> <warning> <!--(another 'string' type)--> </warning> <!--...more "warning" elements...--> </validationWarnings> </configurationValidationResponse> <errorCause> <!--content of type 'string'--> ... </errorCause> <clientPermissions> <!--content of type 'nexus-authentication-client-permissions'--> </clientPermissions> <baseUrl> <!--content of type 'string'--> ... </baseUrl> </data> </status>

Example JSON

{ "data" : { "appName" : "...", "formattedAppName" : "...", "version" : "...", "apiVersion" : "...", "editionLong" : "...", "editionShort" : "...", "state" : "...", "operationMode" : "...", "initializedAt" : "...", "startedAt" : "...", "lastConfigChange" : "...", "firstStart" : false, "instanceUpgraded" : false, "configurationUpgraded" : false, "configurationValidationResponse" : { "valid" : false, "modified" : false, "validationErrors" : [ "...", ... ], "validationWarnings" : [ "...", ... ] }, "errorCause" : "...", "clientPermissions" : { }, "baseUrl" : "..." } }

Element wastebasket

REST Response object for the nexus wastebasket info, contains the typical 'data' parameter, which is the nexus wastebasket info.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <wastebasket> <data> <!--content of type 'wastebasket-resource'--> <size> <!--content of type 'long'--> ... </size> <itemCount> <!--content of type 'long'--> ... </itemCount> </data> </wastebasket>

Example JSON

{ "data" : { "size" : ..., "itemCount" : ... } }

Type artifact-resolve-resource

A resource which contains full maven details of the requested artifact.

Child Elements

name (type) min/max
occurs
description
groupId (string) 0/1 The groupId of the requested artifact.
artifactId (string) 0/1 The artifactId of the requested artifact.
version (string) 0/1 The version of the requested artifact.
baseVersion (string) 0/1 The base version of the requested artifact.
classifier (string) 0/1 The classifier of the requested artifact.
extension (string) 0/1 The file extension of the requested artifact.
snapshot (boolean) 1/1 Flag that states if requested artifact is a snapshot.
snapshotBuildNumber (long) 1/1 The build number of the snapshot version of the requested artifact.
snapshotTimeStamp (long) 1/1 The timestamp portion of the snapshot version of the requested artifact.
fileName (string) 0/1 The filename of the requested artifact.
sha1 (string) 0/1 The sha1 hash of the requested artifact.
repositoryPath (string) 0/1 The path in the repository of the requested artifact.

Type artifactResolveResourceResponse

REST Response object received after requesting an artifact resolve, contains the typical 'data' parameter, which is the artifact resolve details.

Child Elements

name (type) min/max
occurs
description
data (artifact-resolve-resource) 0/1 The artifact details requested.

Type authenticationClientPermissions

Child Elements

name (type) min/max
occurs
description
loggedInUserSource (string) 0/1 (no documentation provided)
permission (clientPermission) 0/unbounded (no documentation provided)
loggedIn (boolean) 1/1 (no documentation provided)
loggedInUsername (string) 0/1 (no documentation provided)

Type authentication-settings

Remote authentication tokens used in remote authentications against HTTP Proxies and/or protected remote repositories.

Child Elements

name (type) min/max
occurs
description
username (string) 0/1 A username to be used in authentication.
password (string) 0/1 A password to be used in authentication.
ntlmHost (string) 0/1 The Windows NT Lan Manager to use for authentication.
ntlmDomain (string) 0/1 The Windows NT Lan Manager Domain to use for authentication.

Type base-repository

The repository base object, this could be extended by a new object if new fields are required.

Child Elements

name (type) min/max
occurs
description
contentResourceURI (string) 0/1 The URL to access the content resource of the repository.
id (string) 0/1 The id of the repository.
name (string) 0/1 The name of the repository.
provider (string) 0/1 The provider of the repository (i.e. maven, p2, obr, etc.).
providerRole (string) 0/1 The role of the repository (i.e. Repository, GroupRepository, etc.).
format (string) 0/1 The format of the repository.
repoType (string) 0/1 The type of the repository.
exposed (boolean) 1/1 Flag that states whether the repository should be available over the content resource.

Type clientPermission

Child Elements

name (type) min/max
occurs
description
id (string) 0/1 (no documentation provided)
value (int) 1/1 (no documentation provided)

Type configs-list-item

A Nexus configuration item, and the url needed to retrieve the configuration details.

Child Elements

name (type) min/max
occurs
description
resourceURI (string) 0/1 The url that can be accessed to retrieve details about the configuration.
name (string) 0/1 The name of the configuration item.

Type configurationsListResourceResponse

REST Response object for a list of Nexus configuration objects, contains the typical 'data' parameter, which is a list of the configuration items.

Child Elements

name (type) min/max
occurs
description
configs-list-item (configs-list-item) 0/unbounded Field data.

Type content-list-describe-request-resource

A set of request parameters that were used to retrieve the item.

Child Elements

name (type) min/max
occurs
description
requestUrl (string) 0/1 The request url that initially generated this request.
requestPath (string) 0/1 The path on the server that was requested.
requestContextItem (string) 0/unbounded Field requestContext.

Type content-list-describe-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
requestUrl (string) 0/1 The original request url used to access the resource.
processingTimeMillis (long) 1/1 The number of milliseconds that passed while retrieving the item.
request (content-list-describe-request-resource) 0/1 A set of request parameters for the item.
response (content-list-describe-response-resource) 0/1 A set of response parameters for the item.

Type contentListDescribeResourceResponse

REST Response object for a content resource request, contains the typical 'data' parameter, which is a list of the content items requested.

Child Elements

name (type) min/max
occurs
description
data (content-list-describe-resource) 0/1 List of describe items, that will contain useful information about the retrieved data.

Type content-list-describe-response-resource

A set of response parameters that were sent back with response.

Child Elements

name (type) min/max
occurs
description
responseType (string) 0/1 States the type of item that was returned (or NONE if not found).
responseActualClass (string) 0/1 The classname of the returned item.
responsePath (string) 0/1 The path of the item in the repository.
responseUid (string) 0/1 A string that uniquely defines this item in the system (or 'virtual' if this is an item from a virtual repository).
originatingRepositoryId (string) 0/1 The id of the repository this item was retrieved from (or null if this is an item from a virtual repository).
originatingRepositoryName (string) 0/1 The name of the repository this item was retrieved from (or null if this is an item from a virtual repository).
originatingRepositoryMainFacet (string) 0/1 The main facet (Repository implementation) of the repository this item was retrieved from (or null if this is an item from a virtual repository).
processedRepositoriesListItem (string) 0/unbounded Field processedRepositoriesList.
appliedMappingItem (string) 0/unbounded Field appliedMappings.
propertyItem (string) 0/unbounded Field properties.
attributeItem (string) 0/unbounded Field attributes.
sourceItem (string) 0/unbounded Field sources.

Type content-list-resource

A Content Item definition, including all data needed to properly access the item, and understand the item.

Child Elements

name (type) min/max
occurs
description
resourceURI (string) 0/1 The URI that can be used to directly access this item in the future.
relativePath (string) 0/1 The relative path in relation to the root of the repository.
text (string) 0/1 A name of the content item.
leaf (boolean) 1/1 Flag that states whether the content item is a file item (if true), otherwise it is a folder item, and can use the resourceURI to retrieve the contained content.
lastModified (dateTime) 0/1 Timestamp the item was last modified.
sizeOnDisk (long) 1/1 Size of the item on the disk.

Type contentListResourceResponse

REST Response object for a content resource request, contains the typical 'data' parameter, which is a list of the content items requested.

Child Elements

name (type) min/max
occurs
description
content-item (content-list-resource) 0/unbounded Field data.

Type error-reporting-settings

Connection parameters to allow Nexus to report errors to the Sonatype JIRA server.

Child Elements

name (type) min/max
occurs
description
jiraUsername (string) 0/1 Username of a valid jira account (if empty will use the default error reporting username).
jiraPassword (string) 0/1 Password of a valid jira account (if empty will use the default error reporting password).
useGlobalProxy (boolean) 1/1 Flag that states whether to use the global proxy configuration in Nexus.
reportErrorsAutomatically (boolean) 1/1 Flag if Nexus should automatically report any problem found.

Type errorReportRequest

REST Request object for generating an error report, contains the typical 'data' parameter, which is an error report item.

Child Elements

name (type) min/max
occurs
description
data (error-report-request-dto) 0/1 The error report object.

Type error-report-request-dto

Details required to generate an error report.

Child Elements

name (type) min/max
occurs
description
title (string) 0/1 The title of the error report.
description (string) 0/1 A detailed explanation of the error report.
saveErrorReportingSettings (boolean) 1/1 If true will overwrite currect error report settings with the credentials provided.
errorReportingSettings (error-reporting-settings) 0/1 The error report settings.

Type errorReportResponse

REST Response object received after generating an error report, contains the typical 'data' parameter, which is the error report response item.

Child Elements

name (type) min/max
occurs
description
data (error-report-response-dto) 0/1 The error report response object.

Type error-report-response-dto

The response data that is returned after generating an error report.

Child Elements

name (type) min/max
occurs
description
jiraUrl (string) 0/1 The JIRA server URL for the error report that was created.

Type feed-list-resource

Details about an RSS Feed that Nexus supplies.

Child Elements

name (type) min/max
occurs
description
resourceURI (string) 0/1 The URL that must be used to retrieve the feed data.
name (string) 0/1 The name of the feed.

Type feedListResourceResponse

REST Response object for a list of Nexus feed items, contains the typical 'data' parameter, which is a list of the feed items.

Child Elements

name (type) min/max
occurs
description
feeds-list-item (feed-list-resource) 0/unbounded Field data.

Type global-configuration-list-item

An item that contains details about a global configuration item, including the url required to retrieve the configuration details.

Child Elements

name (type) min/max
occurs
description
resourceURI (string) 0/1 The url that can be GET requested to retrieve the details of the global configuration.
name (string) 0/1 The name of the global configuration.

Type globalConfigurationListResourceResponse

REST Response object for a global configuration list request, contains the typical 'data' parameter, which is a list of the global configuration items requested.

Child Elements

name (type) min/max
occurs
description
global-settings-list-item (global-configuration-list-item) 0/unbounded Field data.

Type globalConfigurationResourceResponse

REST Response object for a global configuration request, contains the typical 'data' parameter, which is the global configuration item requested.

Child Elements

name (type) min/max
occurs
description
data (global-settings-item) 0/1 The global configuration details.

Type global-settings-item

List of all global configuration items in Nexus.

Child Elements

name (type) min/max
occurs
description
securityEnabled (boolean) 1/1 Flag that determines if security is enabled, if false, there will be no authc/authz checks performed on any requests to the systme.
securityAnonymousAccessEnabled (boolean) 1/1 Flag that, if true, will allow anonymous access while security is enabled.
securityAnonymousUsername (string) 0/1 The username to use for anonymous access (so that roles/privileges can be applied to the anonymous access users).
securityAnonymousPassword (string) 0/1 The password to use for anonymous access.
securityRealmItem (string) 0/unbounded Field securityRealms.
globalConnectionSettings (remote-connection-settings) 0/1 Global remote connection settings.
systemNotificationSettings (system-notification-settings) 0/1 System notification settings.
smtpSettings (smtp-settings) 0/1 SMTP settings for email notifications that Nexus generates.
globalHttpProxySettings (remote-http-proxy-settings) 0/1 Global HTTP Proxy Settings (will be applied to all repositories by default).
globalRestApiSettings (rest-api-settings) 0/1 Rest API configuration parameters.
errorReportingSettings (error-reporting-settings) 0/1 Error reporting configuration parameters.

Type log-config-resource

Set of parameters that describe how logging is configured.

Child Elements

name (type) min/max
occurs
description
rootLoggerLevel (string) 0/1 The root logger level (i.e. DEBUG, INFO, etc.).
rootLoggerAppenders (string) 0/1 The appenders that the root logger will use.
fileAppenderLocation (string) 0/1 Where the file will be stored.
fileAppenderPattern (string) 0/1 The pattern used to write to the file.

Type logConfigResourceResponse

REST Response object for the log config request, contains the typical 'data' parameter, which is the log configuration.

Child Elements

name (type) min/max
occurs
description
data (log-config-resource) 0/1 The log configuration parameters.

Type logs-list-resource

Details to retrieve a log file from the Nexus server.

Child Elements

name (type) min/max
occurs
description
resourceURI (string) 0/1 The url that can be GET requested to retrieve the log file content.
name (string) 0/1 The name of the file.
size (long) 1/1 The size of the file.
mimeType (string) 0/1 MIME type of the file.

Type logsListResourceResponse

REST Response object for a log list resource request, contains the typical 'data' parameter, which is a list of the log items requested.

Child Elements

name (type) min/max
occurs
description
logs-list-item (logs-list-resource) 0/unbounded Field data.

Type mirror-resource

Repository mirror configuration.

Child Elements

name (type) min/max
occurs
description
id (string) 0/1 The id of the repository mirror.
url (string) 0/1 The url of the repository mirror.

Type mirrorResourceListRequest

REST Request object to persist list of mirrors associated with a repository, contains the typical 'data' parameter, which is the list of mirrors.

Child Elements

name (type) min/max
occurs
description
mirrorResource (mirror-resource) 0/unbounded Field data.

Type mirrorResourceListResponse

REST Response object for a list of mirrors associated with a repository, contains the typical 'data' parameter, which is the list of mirrors.

Child Elements

name (type) min/max
occurs
description
mirrorResource (mirror-resource) 0/unbounded Field data.

Type mirror-status-resource

Repository mirror status.

Child Elements

name (type) min/max
occurs
description
status (string) 0/1 The status of the mirror.

Type mirrorStatusResourceListResponse

REST Response object for a list of mirror statuses associated with a repository, contains the typical 'data' parameter, which is the list of mirrors statuses.

Child Elements

name (type) min/max
occurs
description
mirrorResource (mirror-status-resource) 0/unbounded Field data.

Type nexus-authentication-client-permissions

Permissions that are granted to the user.

Type nexus-repository-type-list-resource

Repository type definition.

Child Elements

name (type) min/max
occurs
description
provider (string) 0/1 The repository provider.
providerRole (string) 0/1 The repository provider role.
format (string) 0/1 The repository format.
description (string) 0/1 The repository type description.

Type nexusRepositoryTypeListResourceResponse

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

Child Elements

name (type) min/max
occurs
description
repositoryType (nexus-repository-type-list-resource) 0/unbounded Field data.

Type nexusResponse

Class NexusResponse.

Type nfc-repository-resource

Details about NFC usage for a repository.

Child Elements

name (type) min/max
occurs
description
repositoryId (string) 0/1 The repository id that the nfc details are for.
nfcStats (nfc-stats) 0/1 NFC statistics.
path (string) 0/unbounded Field nfcPaths.

Type nfc-resource

Contains a list of items stored in the NFC.

Child Elements

name (type) min/max
occurs
description
nfc-repo-info (nfc-repository-resource) 0/unbounded Field nfcContents.

Type NFCResourceResponse

REST Response object for an NFC resource item, contains the typical 'data' parameter, which is the NFC resource item.

Child Elements

name (type) min/max
occurs
description
data (nfc-resource) 0/1 An object which contains the contents of the NFC.

Type nfc-stats

NFC Statistics.

Child Elements

name (type) min/max
occurs
description
size (long) 1/1 The number of paths stored in the NFC.
hits (long) 1/1 The number of checks against this NFC that have found matches
misses (long) 1/1 The number of checks against this NFC that have not found matches.

Type plexus-component-list-resource

Plexus component details.

Child Elements

name (type) min/max
occurs
description
roleHint (string) 0/1 The plexus role hint of the component.
description (string) 0/1 The plexus description of the component.

Type plexusComponentListResourceResponse

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

Child Elements

name (type) min/max
occurs
description
component (plexus-component-list-resource) 0/unbounded Field data.

Type privilege

Privilege details.

Child Elements

name (type) min/max
occurs
description
name (string) 0/1 The name of the privilege.
type (string) 0/1 The type of the privilege.
description (string) 0/1 The description of the privilege.
method (string) 0/unbounded Field method.
repositoryTargetId (string) 0/1 Target id for the privilege.
repositoryId (string) 0/1 Repository id of the privilege.
repositoryGroupId (string) 0/1 Group id of the privilege.

Type privilegeResourceRequest

REST response object to persist a privilege.

Child Elements

name (type) min/max
occurs
description
data (privilege) 0/1 Privilege details.

Type remote-connection-settings

The connections settings defines common connection properties, like retries count and timeouts.

Child Elements

name (type) min/max
occurs
description
connectionTimeout (int) 1/1 Connection timeout in milliseconds.
retrievalRetryCount (int) 1/1 The retry count before remote connection is declared unsuccesful.
queryString (string) 0/1 Query string that is appended to remote requests.
userAgentString (string) 0/1 User agent string that is used to customize Nexus user agent string user for remote HTTP requests.

Type remote-http-proxy-settings

The HTTP Proxy defines proxies used to access the internet.

Child Elements

name (type) min/max
occurs
description
proxyHostname (string) 0/1 The proxy hostname.
proxyPort (int) 1/1 The proxy port.
authentication (authentication-settings) 0/1 Authentication used to connect with proxy server.
nonProxyHosts (string) 0/unbounded Field nonProxyHosts.

Type repositories-item

Repository general details.

Child Elements

name (type) min/max
occurs
description
resourceURI (string) 0/1 URI used to manage the repository.
contentResourceURI (string) 0/1 URI used to access repository over /content URL (as maven would do for example).
id (string) 0/1 The id of the repository.
name (string) 0/1 The name of the repository.
repoType (string) 0/1 The type of the repository.
repoPolicy (string) 0/1 The policy of the repository.
provider (string) 0/1 The repository provider.
providerRole (string) 0/1 The role of the repository (classname).
format (string) 0/1 The format of the repository.
userManaged (boolean) 1/1 Flag that states if the repository is manageable by the user.
exposed (boolean) 1/1 Flag that states if the repository is exposed over the content url.
effectiveLocalStorageUrl (string) 0/1 The URL where the repository storage is on server.
remoteUri (string) 0/1 The remote URI of the repository.

Type repository-content-class-list-resource

Repository content class definition.

Child Elements

name (type) min/max
occurs
description
contentClass (string) 0/1 The content class.
name (string) 0/1 The name of the content class.

Type repositoryContentClassListResourceResponse

REST Response object for a list of repository content classes, contains the typical 'data' parameter, which is the repository content class list.

Child Elements

name (type) min/max
occurs
description
repo-content-classes-list-item (repository-content-class-list-resource) 0/unbounded Field data.

Type repository-dependent-status

Details of a repository that shadow another repository.

Child Elements

name (type) min/max
occurs
description
id (string) 0/1 The shadow repository id.
repoType (string) 0/1 The shadow repository type.
format (string) 0/1 The shadow repository format.
localStatus (string) 0/1 The shadow repository local status.

Type repository-group-list-resource

The basic set of details of a repository group.

Child Elements

name (type) min/max
occurs
description
resourceURI (string) 0/1 URL used to manage the repository group.
contentResourceURI (string) 0/1 URL used to manage content of the repository group.
id (string) 0/1 The id of the repository group.
name (string) 0/1 The name of the repository group.
format (string) 0/1 The format of the repository group.
exposed (boolean) 1/1 Flag that states if the repository group is available over the content resource.

Type repositoryGroupListResourceResponse

REST Response object for a repository group list request, contains the typical 'data' parameter, which is the list of repository group objects.

Child Elements

name (type) min/max
occurs
description
repo-group-list-item (repository-group-list-resource) 0/unbounded Field data.

Type repository-group-member-repository

A repository that is contained within a group.

Child Elements

name (type) min/max
occurs
description
id (string) 0/1 The repository id.
name (string) 0/1 The repository name.
resourceURI (string) 0/1 The URL used to manage the repository.

Type repository-group-resource

The set of items that define the repository group (extends repository base resource).

Child Elements

name (type) min/max
occurs
description
repo-group-member (repository-group-member-repository) 0/unbounded Field repositories.

Type repositoryGroupResourceResponse

REST Response object for a repository group request, contains the typical 'data' parameter, which is the repository group object.

Child Elements

name (type) min/max
occurs
description
data (repository-group-resource) 0/1 The repository group object.

Type repositoryListResourceResponse

REST Response object for a repository list request, contains the typical 'data' parameter, which is the list of repository objects.

Child Elements

name (type) min/max
occurs
description
repositories-item (repositories-item) 0/unbounded Field data.

Type repository-meta-resource

Details about the repository.

Child Elements

name (type) min/max
occurs
description
id (string) 0/1 The repository id.
repoType (string) 0/1 The repository type.
format (string) 0/1 The repository format.
sizeOnDisk (long) 1/1 The size on disk the repository consumes.
freeSpaceOnDisk (long) 1/1 The size available on disk where the repository is located.
fileCountInRepository (long) 1/1 The number of files held in the repository.
notFoundCacheSize (long) 1/1 The number of requested paths that are currently in the not found cache.
notFoundCacheHits (long) 1/1 The number of checks against the not found cache that have succeeded (and thus saved a remote check).
notFoundCacheMisses (long) 1/1 The number of checks against the not found cache that have failed (and thus required a remote check).
localStorageErrorsCount (int) 1/1 The number of errors reported by local storage.
remoteStorageErrorsCount (int) 1/1 The number of errors reported by remote storage.
string (string) 0/unbounded Field groups.

Type repositoryMetaResourceResponse

REST Response object for a repository metadata request, contains the typical 'data' parameter, which is the repository metadata object.

Child Elements

name (type) min/max
occurs
description
data (repository-meta-resource) 0/1 The repository metadata parameters.

Type repositoryResourceResponse

REST Response object for a repository request, contains the typical 'data' parameter, which is the repository object.

Child Elements

name (type) min/max
occurs
description
data (base-repository) 0/1 The repository object.

Type repository-route-list-resource

A repository route basic set of details, for display in lists (full details can be retrieved using the resourceURI).

Child Elements

name (type) min/max
occurs
description
resourceURI (string) 0/1 The URL used to manage this repository route.
groupId (string) 0/1 The group this route is attached to.
ruleType (string) 0/1 The type of rule (inclusive, exclusive, etc.).
pattern (string) 0/1 The pattern associated to this route.
repo-routes-member (repository-route-member-repo) 0/unbounded Field repositories.

Type repositoryRouteListResourceResponse

REST Response object for a repository route list request, contains the typical 'data' parameter, which is the list of repository route objects.

Child Elements

name (type) min/max
occurs
description
repo-routes-list-item (repository-route-list-resource) 0/unbounded Field data.

Type repository-route-member-repo

Repository details in a repository route.

Child Elements

name (type) min/max
occurs
description
id (string) 0/1 The repository id.
name (string) 0/1 The repository name.
resourceURI (string) 0/1 The URL that can be used to manage the repository.

Type repository-route-resource

Class RepositoryRouteResource.

Child Elements

name (type) min/max
occurs
description
id (string) 0/1 The id of the repository route.
groupId (string) 0/1 The group id that the route is applied on.
ruleType (string) 0/1 The rule type of the route (inclusive, exclusive, etc.).
pattern (string) 0/1 The regex pattern that will be matched to see if route is applied to request.
repository (repository-route-member-repo) 0/unbounded Field repositories.

Type repositoryRouteResourceResponse

REST Response object for a repository route request, contains the typical 'data' parameter, which is the repository route object.

Child Elements

name (type) min/max
occurs
description
data (repository-route-resource) 0/1 Repository Route details.

Type repository-status

Repository status parameters.

Child Elements

name (type) min/max
occurs
description
id (string) 0/1 The id of the repository.
repoType (string) 0/1 The type of the repository.
format (string) 0/1 The format of the repository.
localStatus (string) 0/1 The local status of the repository (user blocked for example)
remoteStatus (string) 0/1 The remote status of the repository (unreachable for example)
proxyMode (string) 0/1 The repository proxy mode (allow, blocked, etc.).
dependentRepoItem (repository-dependent-status) 0/unbounded Field dependentRepos.

Type repository-status-list-item

Some general details and status of the repostiory.

Child Elements

name (type) min/max
occurs
description
resourceURI (string) 0/1 The URI that can be used to manage the repository.
id (string) 0/1 The id of the repository.
name (string) 0/1 The name of the repository.
repoType (string) 0/1 The type of repository.
repoPolicy (string) 0/1 The repository policy.
format (string) 0/1 The repository format.
status (repository-status) 0/1 The repository status object.

Type repositoryStatusListResourceResponse

REST Response object for a repository status list request, contains the typical 'data' parameter, which is the list of repository status objects.

Child Elements

name (type) min/max
occurs
description
repository-status-list-item (repository-status-list-item) 0/unbounded Field data.

Type repositoryStatusResourceResponse

REST Response object for a repository status request, contains the typical 'data' parameter, which is the repository status objects.

Child Elements

name (type) min/max
occurs
description
data (repository-status) 0/1 Repository status details.

Type repository-target-list-resource

The repository target list details.

Child Elements

name (type) min/max
occurs
description
resourceURI (string) 0/1 URL that can be used to manage the repository target.
id (string) 0/1 The id of the repository target.
name (string) 0/1 The name of the repository target.
contentClass (string) 0/1 The content class of the repository target.

Type repositoryTargetListResourceResponse

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

Child Elements

name (type) min/max
occurs
description
repo-targets-list-item (repository-target-list-resource) 0/unbounded Field data.

Type repository-target-resource

The repository target configuration.

Child Elements

name (type) min/max
occurs
description
resourceURI (string) 0/1 The URL used to manage the repository target.
id (string) 0/1 The id of the repository target.
name (string) 0/1 The name of the repository target.
contentClass (string) 0/1 The content class of the repository target.
pattern (string) 0/unbounded Field patterns.

Type repositoryTargetResourceResponse

REST Response object for a repository target, contains the typical 'data' parameter, which is the repository target.

Child Elements

name (type) min/max
occurs
description
data (repository-target-resource) 0/1 The repository target details.

Type rest-api-settings

The rest api configuration settings.

Child Elements

name (type) min/max
occurs
description
forceBaseUrl (boolean) 1/1 Flag that states whether to forcefully set the baseUrl defined in rest responses.
baseUrl (string) 0/1 The baseUrl of the nexus server.

Type scheduled-service-base-resource

The scheduled service configuration.

Child Elements

name (type) min/max
occurs
description
id (string) 0/1 The id of the service.
name (string) 0/1 The name of the service.
enabled (boolean) 1/1 Flag that states if the service is enabled.
typeId (string) 0/1 The type id of the service.
alertEmail (string) 0/1 The email to send notifications to if the service fails.
schedule (string) 0/1 The schedule the service is run on.
scheduled-task-property (scheduled-service-property-resource) 0/unbounded Field properties.

Type scheduled-service-list-resource

Scheduled service list item details.

Child Elements

name (type) min/max
occurs
description
resourceURI (string) 0/1 The URL that can be used to manage the scheduled service.
id (string) 0/1 The id of the scheduled service.
enabled (boolean) 1/1 Flag that states if the service is enabled.
name (string) 0/1 The name of the scheduled service.
typeId (string) 0/1 The type id of the scheduled service.
typeName (string) 0/1 The type name of the scheduled service.
status (string) 0/1 The status of the scheduled service (running, broken, etc.).
schedule (string) 0/1 The type of schedule the service is run on (monthly, daily, etc.).
nextRunTime (string) 0/1 The next time the scheduled service will run.
lastRunTime (string) 0/1 The last time the scheduled service ran.
lastRunResult (string) 0/1 The result of the last service run.
created (string) 0/1 The date the service was created.

Type scheduledServiceListResourceResponse

REST Response object for a list of scheduled service items, contains the typical 'data' parameter, which is the list of scheduled services..

Child Elements

name (type) min/max
occurs
description
schedules-list-item (scheduled-service-list-resource) 0/unbounded Field data.

Type scheduled-service-property-resource

A configuration property for a scheduled service.

Child Elements

name (type) min/max
occurs
description
id (string) 0/1 The id of the property.
value (string) 0/1 The value of the property.

Type scheduledServiceResourceResponse

REST Response object for a scheduled service configuration request, contains the typical 'data' parameter, which is the scheduled service configuration.

Child Elements

name (type) min/max
occurs
description
data (scheduled-service-base-resource) 0/1 The scheduled service configuration.

Type scheduled-service-resource-status

Scheduled service status details.

Child Elements

name (type) min/max
occurs
description
resource (scheduled-service-base-resource) 0/1 The scheduled service configuration.
resourceURI (string) 0/1 The URL used to managed the scheduled service.
status (string) 0/1 The status of the scheduled service.
nextRunTime (string) 0/1 The next time the scheduled service will run.
lastRunTime (string) 0/1 The last time the scheduled service ran.
lastRunResult (string) 0/1 The result of the last service run.
created (string) 0/1 The date the service was created.

Type scheduledServiceResourceStatusResponse

REST Response object for a scheduled service status request, contains the typical 'data' parameter, which is the scheduled service status.

Child Elements

name (type) min/max
occurs
description
data (scheduled-service-resource-status) 0/1 The scheduled service status details.

Type scheduled-service-type-property-resource

Property that helps configure a scheduled service.

Child Elements

name (type) min/max
occurs
description
id (string) 0/1 The id of the property.
name (string) 0/1 The name of the property.
type (string) 0/1 The type of the property (string, date, checkbox, etc.).
helpText (string) 0/1 The help text for the property.
required (boolean) 1/1 Flag that states if the property is required to be set.
regexValidation (string) 0/1 Regular expression validation for the value of the property.

Type scheduled-service-type-resource

Scheduled service type, which you can create a scheduled task against.

Child Elements

name (type) min/max
occurs
description
id (string) 0/1 The id of the service type.
name (string) 0/1 The name of the service type.
scheduled-task-property (scheduled-service-type-property-resource) 0/unbounded Field properties.

Type scheduledServiceTypeResourceResponse

REST Response object for a scheduled service type list request, contains the typical 'data' parameter, which is the scheduled service type details.

Child Elements

name (type) min/max
occurs
description
schedule-type (scheduled-service-type-resource) 0/unbounded Field data.

Type smtp-settings

The connections settings for an smtp server.

Child Elements

name (type) min/max
occurs
description
host (string) 0/1 The smtp host.
port (int) 1/1 The smtp port.
username (string) 0/1 The smtp server username.
password (string) 0/1 The smtp server password.
systemEmailAddress (string) 0/1 The email address that emails will be sent from.
sslEnabled (boolean) 1/1 Flag that states whether to use ssl.
tlsEnabled (boolean) 1/1 Flag that states whether to use tls.

Type smtp-settings-resource

The smtp settings request.

Child Elements

name (type) min/max
occurs
description
testEmail (string) 0/1 Test email address to send a validation mail to.
host (string) 0/1 The smtp host.
port (int) 1/1 The smtp port.
username (string) 0/1 The smtp username.
password (string) 0/1 The smtp password.
systemEmailAddress (string) 0/1 The email address that nexus will send emails from.
sslEnabled (boolean) 1/1 Flag that states whether to use SSL.
tlsEnabled (boolean) 1/1 Flag that states whether to use TLS.

Type smtpSettingsResourceRequest

REST Request object for validating the nexus smtp settings, contains the typical 'data' parameter, which is the nexus stmp configuration.

Child Elements

name (type) min/max
occurs
description
data (smtp-settings-resource) 0/1 The nexus smtp configuration.

Type status-configuration-validation-response

Configuration validation status.

Child Elements

name (type) min/max
occurs
description
valid (boolean) 1/1 Flag that states if the nexus configuration is valid.
modified (boolean) 1/1 Flag that states if nexus had to modify the nexus configuration.
error (string) 0/unbounded Field validationErrors.
warning (string) 0/unbounded Field validationWarnings.

Type status-resource

Nexus status details.

Child Elements

name (type) min/max
occurs
description
appName (string) 0/1 The application name.
formattedAppName (string) 0/1 The formatted application name (html formatting).
version (string) 0/1 The version of the nexus instance.
apiVersion (string) 0/1 The version of the core nexus instance.
editionLong (string) 0/1 The long version of the nexus edition (i.e. Open Source or Professional).
editionShort (string) 0/1 The short version of the nexus edition (i.e. OSS or PRO).
state (string) 0/1 The state of the nexus instance.
operationMode (string) 0/1 The operation mode of the nexus instance.
initializedAt (dateTime) 0/1 The date the instance was first initialized.
startedAt (dateTime) 0/1 The date the instance was last started.
lastConfigChange (dateTime) 0/1 The last time the nexus configuration was updated.
firstStart (boolean) 1/1 Flag that states if this is the first time nexus was started.
instanceUpgraded (boolean) 1/1 Flag that states if the nexus instance has been upgraded.
configurationUpgraded (boolean) 1/1 Flag that states if the nexus configuration has been upgraded
configurationValidationResponse (status-configuration-validation-response) 0/1 Configuration validation status.
errorCause (string) 0/1 Errors occuring during nexus startup.
clientPermissions (nexus-authentication-client-permissions) 0/1 Permissions that are available to the current user.
baseUrl (string) 0/1 The base url of the nexus instance.

Type statusResourceResponse

REST Response object for the nexus status, contains the typical 'data' parameter, which is the nexus status.

Child Elements

name (type) min/max
occurs
description
data (status-resource) 0/1 Nexus status details.

Type system-notification-settings

The notification settings tell nexus who to notify when certain events occur (such as a proxy repository being auto-blocked).

Child Elements

name (type) min/max
occurs
description
enabled (boolean) 1/1 Flag that states whether to enable notifications.
emailAddresses (string) 0/1 Comma seperated list of email addresses to notify.
roles (string) 0/unbounded Field roles.

Type wastebasket-resource

Details about the nexus wastebasket.

Child Elements

name (type) min/max
occurs
description
size (long) 1/1 The size of the contents in the wastebasket.
itemCount (long) 1/1 The number of items in the wastebasket.

Type wastebasketResourceResponse

REST Response object for the nexus wastebasket info, contains the typical 'data' parameter, which is the nexus wastebasket info.

Child Elements

name (type) min/max
occurs
description
data (wastebasket-resource) 0/1 The wastebasket information.

Home

REST Endpoints

XML Data Elements

XML Data Types