Sonatype Nexus Staging 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 orderRequest

Example XML

<?xml version="1.0" encoding="UTF-8"?> <orderRequest> <data> <orderedProfile> <!--content of type 'string'--> ... </orderedProfile> <orderedProfile> <!--(another 'string' type)--> </orderedProfile> <!--...more "orderedProfile" elements...--> </data> </orderRequest>

Example JSON

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

Element profileRequest

Example XML

<?xml version="1.0" encoding="UTF-8"?> <profileRequest> <data> <!--content of type 'stagingProfile'--> <dropNotifyEmails> <!--content of type 'string'--> ... </dropNotifyEmails> <promotionNotifyEmails> <!--content of type 'string'--> ... </promotionNotifyEmails> <promoteRuleSets> <!--content of type 'string'--> ... </promoteRuleSets> <promoteRuleSets> <!--(another 'string' type)--> </promoteRuleSets> <!--...more "promoteRuleSets" elements...--> <mode> <!--content of type 'string'--> ... </mode> <dropNotifyRoles> <!--content of type 'string'--> ... </dropNotifyRoles> <dropNotifyRoles> <!--(another 'string' type)--> </dropNotifyRoles> <!--...more "dropNotifyRoles" elements...--> <repositoryType> <!--content of type 'string'--> ... </repositoryType> <inProgress> <!--content of type 'boolean'--> ... </inProgress> <repositoryTargetId> <!--content of type 'string'--> ... </repositoryTargetId> <repositoryTemplateId> <!--content of type 'string'--> ... </repositoryTemplateId> <name> <!--content of type 'string'--> ... </name> <promotionNotifyCreator> <!--content of type 'boolean'--> ... </promotionNotifyCreator> <stagedRepositoryIds> <!--content of type 'string'--> ... </stagedRepositoryIds> <stagedRepositoryIds> <!--(another 'string' type)--> </stagedRepositoryIds> <!--...more "stagedRepositoryIds" elements...--> <dropNotifyCreator> <!--content of type 'boolean'--> ... </dropNotifyCreator> <targetGroups> <!--content of type 'string'--> ... </targetGroups> <targetGroups> <!--(another 'string' type)--> </targetGroups> <!--...more "targetGroups" elements...--> <order> <!--content of type 'int'--> ... </order> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <closeRuleSets> <!--content of type 'string'--> ... </closeRuleSets> <closeRuleSets> <!--(another 'string' type)--> </closeRuleSets> <!--...more "closeRuleSets" elements...--> <finishNotifyCreator> <!--content of type 'boolean'--> ... </finishNotifyCreator> <deployURI> <!--content of type 'string'--> ... </deployURI> <autoStagingDisabled> <!--content of type 'boolean'--> ... </autoStagingDisabled> <repositoriesSearchable> <!--content of type 'boolean'--> ... </repositoriesSearchable> <id> <!--content of type 'string'--> ... </id> <promotionNotifyRoles> <!--content of type 'string'--> ... </promotionNotifyRoles> <promotionNotifyRoles> <!--(another 'string' type)--> </promotionNotifyRoles> <!--...more "promotionNotifyRoles" elements...--> <finishNotifyRoles> <!--content of type 'string'--> ... </finishNotifyRoles> <finishNotifyRoles> <!--(another 'string' type)--> </finishNotifyRoles> <!--...more "finishNotifyRoles" elements...--> <stagingRepositoryIds> <!--content of type 'string'--> ... </stagingRepositoryIds> <stagingRepositoryIds> <!--(another 'string' type)--> </stagingRepositoryIds> <!--...more "stagingRepositoryIds" elements...--> <promotionTargetRepository> <!--content of type 'string'--> ... </promotionTargetRepository> <finishNotifyEmails> <!--content of type 'string'--> ... </finishNotifyEmails> </data> </profileRequest>

Example JSON

{ "data" : { "dropNotifyEmails" : "...", "promotionNotifyEmails" : "...", "promoteRuleSets" : [ "...", ... ], "mode" : "...", "dropNotifyRoles" : [ "...", ... ], "repositoryType" : "...", "inProgress" : false, "repositoryTargetId" : "...", "repositoryTemplateId" : "...", "name" : "...", "promotionNotifyCreator" : false, "stagedRepositoryIds" : [ "...", ... ], "dropNotifyCreator" : false, "targetGroups" : [ "...", ... ], "order" : ..., "resourceURI" : "...", "closeRuleSets" : [ "...", ... ], "finishNotifyCreator" : false, "deployURI" : "...", "autoStagingDisabled" : false, "repositoriesSearchable" : false, "id" : "...", "promotionNotifyRoles" : [ "...", ... ], "finishNotifyRoles" : [ "...", ... ], "stagingRepositoryIds" : [ "...", ... ], "promotionTargetRepository" : "...", "finishNotifyEmails" : "..." } }

Element promoteRequest

Example XML

<?xml version="1.0" encoding="UTF-8"?> <promoteRequest> <data> <!--content of type 'stagingPromote'--> <targetRepositoryId> <!--content of type 'string'--> ... </targetRepositoryId> <description> <!--content of type 'string'--> ... </description> <stagedRepositoryId> <!--content of type 'string'--> ... </stagedRepositoryId> </data> </promoteRequest>

Example JSON

{ "data" : { "targetRepositoryId" : "...", "description" : "...", "stagedRepositoryId" : "..." } }

Element stagingRuleSetRequest

Example XML

<?xml version="1.0" encoding="UTF-8"?> <stagingRuleSetRequest> <data> <!--content of type 'stagingRuleSet'--> <rules> <stagingRule> <!--content of type 'stagingRule'--> <typeId> <!--content of type 'string'--> ... </typeId> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <properties> <stagingRuleProperty> <!--content of type 'stagingRuleProperty'--> <key> <!--content of type 'string'--> ... </key> <value> <!--content of type 'string'--> ... </value> </stagingRuleProperty> <stagingRuleProperty> <!--(another 'stagingRuleProperty' type)--> </stagingRuleProperty> <!--...more "stagingRuleProperty" elements...--> </properties> <enabled> <!--content of type 'boolean'--> ... </enabled> <name> <!--content of type 'string'--> ... </name> <typeName> <!--content of type 'string'--> ... </typeName> </stagingRule> <stagingRule> <!--(another 'stagingRule' type)--> </stagingRule> <!--...more "stagingRule" elements...--> </rules> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <description> <!--content of type 'string'--> ... </description> </data> </stagingRuleSetRequest>

Example JSON

{ "data" : { "rules" : [ { "typeId" : "...", "resourceURI" : "...", "properties" : [ { "key" : "...", "value" : "..." }, ... ], "enabled" : false, "name" : "...", "typeName" : "..." }, ... ], "resourceURI" : "...", "id" : "...", "name" : "...", "description" : "..." } }

Type stagingProfile

Child Elements

name (type) min/max
occurs
description
dropNotifyEmails (string) 0/1 (no documentation provided)
promotionNotifyEmails (string) 0/1 (no documentation provided)
promoteRuleSets (string) 0/unbounded (no documentation provided)
mode (string) 0/1 (no documentation provided)
dropNotifyRoles (string) 0/unbounded (no documentation provided)
repositoryType (string) 0/1 (no documentation provided)
inProgress (boolean) 1/1 (no documentation provided)
repositoryTargetId (string) 0/1 (no documentation provided)
repositoryTemplateId (string) 0/1 (no documentation provided)
name (string) 0/1 (no documentation provided)
promotionNotifyCreator (boolean) 1/1 (no documentation provided)
stagedRepositoryIds (string) 0/unbounded (no documentation provided)
dropNotifyCreator (boolean) 1/1 (no documentation provided)
targetGroups (string) 0/unbounded (no documentation provided)
order (int) 1/1 (no documentation provided)
resourceURI (string) 0/1 (no documentation provided)
closeRuleSets (string) 0/unbounded (no documentation provided)
finishNotifyCreator (boolean) 1/1 (no documentation provided)
deployURI (string) 0/1 (no documentation provided)
autoStagingDisabled (boolean) 1/1 (no documentation provided)
repositoriesSearchable (boolean) 1/1 (no documentation provided)
id (string) 0/1 (no documentation provided)
promotionNotifyRoles (string) 0/unbounded (no documentation provided)
finishNotifyRoles (string) 0/unbounded (no documentation provided)
stagingRepositoryIds (string) 0/unbounded (no documentation provided)
promotionTargetRepository (string) 0/1 (no documentation provided)
finishNotifyEmails (string) 0/1 (no documentation provided)

Type stagingProfileOrderRequestDTO

Child Elements

name (type) min/max
occurs
description
orderedProfile (string) 0/unbounded (no documentation provided)

Type stagingProfileRequestDTO

Child Elements

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

Type stagingPromote

Child Elements

name (type) min/max
occurs
description
targetRepositoryId (string) 0/1 (no documentation provided)
description (string) 0/1 (no documentation provided)
stagedRepositoryId (string) 0/1 (no documentation provided)

Type stagingPromoteRequestDTO

Child Elements

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

Type stagingRule

Child Elements

name (type) min/max
occurs
description
typeId (string) 0/1 (no documentation provided)
resourceURI (string) 0/1 (no documentation provided)
stagingRuleProperty (stagingRuleProperty) 0/unbounded (no documentation provided)
enabled (boolean) 1/1 (no documentation provided)
name (string) 0/1 (no documentation provided)
typeName (string) 0/1 (no documentation provided)

Type stagingRuleProperty

Child Elements

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

Type stagingRuleSet

Child Elements

name (type) min/max
occurs
description
stagingRule (stagingRule) 0/unbounded (no documentation provided)
resourceURI (string) 0/1 (no documentation provided)
id (string) 0/1 (no documentation provided)
name (string) 0/1 (no documentation provided)
description (string) 0/1 (no documentation provided)

Type stagingRuleSetRequestDTO

Child Elements

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