Sonatype Nexus Licensing 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 accessContentResponse

Response wrapper for the license content response.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <accessContentResponse> <data> <!--content of type 'accessContent'--> <date> <!--content of type 'string'--> ... </date> <ipAddress> <!--content of type 'string'--> ... </ipAddress> <timestamp> <!--content of type 'long'--> ... </timestamp> </data> <data> <!--(another 'accessContent' type)--> </data> <!--...more "data" elements...--> </accessContentResponse>

Example JSON

{ "data" : [ { "date" : "...", "ipAddress" : "...", "timestamp" : ... }, ... ] }

Element licenseContentResponse

Response wrapper for the license content response.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <licenseContentResponse> <data> <!--content of type 'licenseContents'--> <contactCountry> <!--content of type 'string'--> ... </contactCountry> <contactEmail> <!--content of type 'string'--> ... </contactEmail> <contactPhone> <!--content of type 'string'--> ... </contactPhone> <contactCompany> <!--content of type 'string'--> ... </contactCompany> <contactName> <!--content of type 'string'--> ... </contactName> <effectiveDate> <!--content of type 'string'--> ... </effectiveDate> <expirationDate> <!--content of type 'string'--> ... </expirationDate> <licenseType> <!--content of type 'string'--> ... </licenseType> <licensedUserCount> <!--content of type 'string'--> ... </licensedUserCount> <maxLicensedUsers> <!--content of type 'string'--> ... </maxLicensedUsers> <licenseServiceUrl> <!--content of type 'string'--> ... </licenseServiceUrl> <fingerprint> <!--content of type 'string'--> ... </fingerprint> </data> </licenseContentResponse>

Example JSON

{ "data" : { "contactCountry" : "...", "contactEmail" : "...", "contactPhone" : "...", "contactCompany" : "...", "contactName" : "...", "effectiveDate" : "...", "expirationDate" : "...", "licenseType" : "...", "licensedUserCount" : "...", "maxLicensedUsers" : "...", "licenseServiceUrl" : "...", "fingerprint" : "..." } }

Type accessContent

The parameters set by the currently installed license

Child Elements

name (type) min/max
occurs
description
date (string) 0/1 (no documentation provided)
ipAddress (string) 0/1 (no documentation provided)
timestamp (long) 1/1 (no documentation provided)

Type accessContentResponseDTO

Response wrapper for the license content response.

Child Elements

name (type) min/max
occurs
description
data (accessContent) 0/unbounded (no documentation provided)

Type licenseContentResponseDTO

Response wrapper for the license content response.

Child Elements

name (type) min/max
occurs
description
data (licenseContents) 0/1 (no documentation provided)

Type licenseContents

The parameters set by the currently installed license

Child Elements

name (type) min/max
occurs
description
contactCountry (string) 0/1 Get the contact's country.
contactEmail (string) 0/1 Get the contact's email address.
contactPhone (string) 0/1 Get the contact's phone number.
contactCompany (string) 0/1 Get the contact's company.
contactName (string) 0/1 Get the contact's Name.
effectiveDate (string) 0/1 Get the date the license goes into effect.
expirationDate (string) 0/1 Get the date the license expires.
licenseType (string) 0/1 Get the type of license.
licensedUserCount (string) 0/1 Get the current number of users that have accessed the system.
maxLicensedUsers (string) 0/1 Get the maximum number of users allowed to access the system.
licenseServiceUrl (string) 0/1 (no documentation provided)
fingerprint (string) 0/1 (no documentation provided)