Topology API
{ http://akana.com/wsdl/lc/1.0 } TopologyAPI
This API provides operations to maintain topologies.
POST/topologiesCreate a new topology
Create a new topology. The topology name must be unique.
Parameters
Accepts application/json
Name
Type
Description
Model
body
entity
topology
topology {
tenants {
credentials {
atomLink {
properties {}
environments {
configuration {}
promotionProfiles {}
filters {
classifierCriteria {
valueSetValue {
tenants( Collection of tenants )
environments( Collection of environments )
name( string, required )
links( Collection of atomLink )
filters( Collection of filters )
properties( Collection of properties )
}
tenants {
address( string )
userAuthenticationSource( boolean )
credentials( credentials )
displayName( string )
tenantOrgKey( string )
local( boolean )
ldapDomain( string )
connected( boolean )
name( string, required )
links( Collection of atomLink )
id( string, required )
consoleAddress( string )
properties( Collection of properties )
}
credentials {
password( string )
links( Collection of atomLink )
user( string )
email( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI, required )
title( string )
type( string )
lang( string )
base( anyURI )
}
properties {}
environments {
initialEnvironment( boolean )
configuration( configuration )
displayName( string )
name( string, required )
description( string )
links( Collection of atomLink )
promotionProfiles( Collection of promotionProfiles )
tenant( string, required )
}
configuration {}
promotionProfiles {}
filters {
classifier-criteria( Collection of classifierCriteria )
name( string )
links( Collection of atomLink )
}
classifierCriteria {
values( Collection of valueSetValue )
classifierName( string )
}
valueSetValue {
regularExpression( boolean )
value( string )
}
Reponse
Produces application/json
Status Code
Reason
Model
201
Topology Created
any
400
Invalid topology
409
Topology already exists
PUT/topologiesUpdate a topology
Update an existing topology. Care should be taken to preserve environment names.
Parameters
Accepts application/json
Name
Type
Description
Model
preserveAssets
query
Indicates that assets associated with any removed environments should be preserved (defaults to false)
boolean
body
entity
topology
topology {
tenants {
credentials {
atomLink {
properties {}
environments {
configuration {}
promotionProfiles {}
filters {
classifierCriteria {
valueSetValue {
tenants( Collection of tenants )
environments( Collection of environments )
name( string, required )
links( Collection of atomLink )
filters( Collection of filters )
properties( Collection of properties )
}
tenants {
address( string )
userAuthenticationSource( boolean )
credentials( credentials )
displayName( string )
tenantOrgKey( string )
local( boolean )
ldapDomain( string )
connected( boolean )
name( string, required )
links( Collection of atomLink )
id( string, required )
consoleAddress( string )
properties( Collection of properties )
}
credentials {
password( string )
links( Collection of atomLink )
user( string )
email( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI, required )
title( string )
type( string )
lang( string )
base( anyURI )
}
properties {}
environments {
initialEnvironment( boolean )
configuration( configuration )
displayName( string )
name( string, required )
description( string )
links( Collection of atomLink )
promotionProfiles( Collection of promotionProfiles )
tenant( string, required )
}
configuration {}
promotionProfiles {}
filters {
classifier-criteria( Collection of classifierCriteria )
name( string )
links( Collection of atomLink )
}
classifierCriteria {
values( Collection of valueSetValue )
classifierName( string )
}
valueSetValue {
regularExpression( boolean )
value( string )
}
Reponse
Produces application/json
Status Code
Reason
Model
200
Topology updated
any
400
Invalid topology
404
Topology not found
GET/topologiesGet all topologies
Get all defined topologies
Reponse
Produces application/json
Status Code
Reason
Model
200
Retrieved
DELETE/topologies/{topology-name}Delete a topology
Delete the specified topology.
Parameters
Name
Type
Description
Model
topology-name
path
Name of the topology to remove
string
Reponse
Status Code
Reason
Model
200
Topology deleted
any
404
Topology not found
GET/topologies/{topology-name}Get the specified Topology
Get the topology specified by the topology name
Parameters
Name
Type
Description
Model
topology-name
path
Name of the topology to retrieve
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Topology found
topology
topology {
tenants {
credentials {
atomLink {
properties {}
environments {
configuration {}
promotionProfiles {}
filters {
classifierCriteria {
valueSetValue {
tenants( Collection of tenants )
environments( Collection of environments )
name( string )
links( Collection of atomLink )
filters( Collection of filters )
properties( Collection of properties )
}
tenants {
address( string )
userAuthenticationSource( boolean )
credentials( credentials )
displayName( string )
tenantOrgKey( string )
local( boolean )
ldapDomain( string )
connected( boolean )
name( string )
links( Collection of atomLink )
id( string )
consoleAddress( string )
properties( Collection of properties )
}
credentials {
password( string )
links( Collection of atomLink )
user( string )
email( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
properties {}
environments {
initialEnvironment( boolean )
configuration( configuration )
displayName( string )
name( string )
description( string )
links( Collection of atomLink )
promotionProfiles( Collection of promotionProfiles )
tenant( string )
}
configuration {}
promotionProfiles {}
filters {
classifier-criteria( Collection of classifierCriteria )
name( string )
links( Collection of atomLink )
}
classifierCriteria {
values( Collection of valueSetValue )
classifierName( string )
}
valueSetValue {
regularExpression( boolean )
value( string )
}
404
Topology not found
GET/topologies/{topology-name}/filtersGet the filters for Topology
Get the AssetFilters for the specified topology
Parameters
Name
Type
Description
Model
topology-name
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Retrieved
404
Topology not found
POST/topologies/{topology-name}/filtersAdd Filter
Add an AssetFilter to the specified Topology
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
body
entity
Reponse
Produces application/json
Status Code
Reason
Model
201
AssetFilter added
any
400
Invalid AssetFilter
404
Topology not found
409
AssetFilter already exists
DELETE/topologies/{topology-name}/assetsDelete all assets in a Topology
Delete all assets in a Topology. This will also delete all mapping information between environments
Parameters
Name
Type
Description
Model
topology-name
path
string
Reponse
Status Code
Reason
Model
200
Assets Deleted
any
404
Topology Not found
PUT/topologies/{topology-name}/filtersUpdate a filter
Update an existing AssetFilter
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
body
entity
Reponse
Produces application/json
Status Code
Reason
Model
200
AssetFilter Updated
any
400
Invalid AssetFilter
404
Topology not found
PUT/topologies/{topology-name}/environmentsUpdate an Environment
Update an existing Environment in the specified Topology
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
body
entity
Reponse
Produces application/json
Status Code
Reason
Model
200
Environment Updated
any
400
Invalid Environment
404
Topology or Environment not found
GET/topologies/{topology-name}/environmentsGet all Environments for Topology
Get all the Environments defined for the specified Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Environments retrieved
404
Topology not found
POST/topologies/{topology-name}/tenantsAdd Tenant
Add a Tenant to the specified Environment in the specified Topology
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
body
entity
Reponse
Produces application/json
Status Code
Reason
Model
201
Tenant added
any
400
Invalid Tenant
404
Topology not found
409
Tenant already exists
GET/topologies/{topology-name}/tenantsGet all Tenants for a Topology
Get all Tenants defined for the specified Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Tenants retrieved
404
Topology not found
PUT/topologies/{topology-name}/tenantsUpdate a Tenant
Update an existing Tenant in the specified Topology
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
body
entity
Reponse
Produces application/json
Status Code
Reason
Model
200
Tenant Updated
any
400
Invalid Tenant
404
Topology or Tenant not found
GET/topologies/{topology-name}/propertiesGet the properties for the specified Topology
Get the properties for the topology specified by the topology name
Parameters
Name
Type
Description
Model
topology-name
path
Name of the topology
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Properties retrieved
404
Topology not found
PUT/topologies/{topology-name}/propertiesSet the properties for the specified Topology
Set the properties for the topology specified by the topology name
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
Name of the topology
string
body
entity
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Properties updated
404
Topology not found
POST/topologies/{topology-name}/environmentsAdd Environment
Add an Environment to the specified Topology
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
body
entity
Reponse
Produces application/json
Status Code
Reason
Model
201
Environment added
any
400
Invalid Environment
404
Topology not found
409
Environment already exists
GET/topologies/{topology-name}/environments/{environment-name}Get an Environment
Get the specified Environment for the specified Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Environment found
404
Topology or Environment not found
GET/topologies/{topology-name}/filters/{filter-name}Get an AssetFilter
Get the specified AssetFilter for the specified Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
filter-name
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
AssetFilter Found
404
Topology or AssetFilter not found
DELETE/topologies/{topology-name}/filters/{filter-name}Delete an AssetFilter
Delete the specified AssetFilter from the specified Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
filter-name
path
string
Reponse
Status Code
Reason
Model
200
AssetFilter Deleted
any
404
Topology or AssetFilter Not found
DELETE/topologies/{topology-name}/tenants/{tenant-name}Delete a Tenant
Delete the specified Tenant from the specified Topology
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
tenant-name
path
string
Reponse
Status Code
Reason
Model
200
Tenant Deleted
any
404
Topology or Tenant not found
GET/topologies/{topology-name}/tenants/{tenant-name}Get a Tenant
Get the specified Tenant from the specified Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
tenant-name
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Tenant found
404
Topology or Tenant not found
DELETE/topologies/{topology-name}/environments/{environment-name}Delete an Environment
Delete the specified environment.
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
preserveAssets
query
Indicates that assets associated with the removed environments should be preserved (defaults to false)
boolean
Reponse
Status Code
Reason
Model
200
Deleted
any
404
Topology or Environment not found
POST/topologies/{topology-name}/environments/{environment-name}/profilesAdd PromotionProfile
Add a PromotionProfile to the specified Environment in the specified Topology
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
body
entity
profile
profile {
deploymentZoneConfigurations {}
resourceMappings {
targetResource {}
sourceResource {}
rules {}
approvalProcesses {
policyMappings {
sourcePolicy {}
sourcePolicyFilter {
targetPolicy {}
processMappings {
sourceProcess {}
targetProcess {}
assetNotifications {
atomLink {
scriptMappings {
sourceScript {}
targetScript {}
properties {}
deploymentZoneConfigurations( Collection of deploymentZoneConfigurations )
resourceMappings( Collection of resourceMappings )
targetEnvironment( string, required )
description( string )
rules( Collection of rules )
filterNames( Collection of string )
approvalProcesses( Collection of approvalProcesses )
policyMappings( Collection of policyMappings )
name( string, required )
processMappings( Collection of processMappings )
assetNotifications( Collection of assetNotifications )
links( Collection of atomLink )
scriptMappings( Collection of scriptMappings )
properties( Collection of properties )
}
deploymentZoneConfigurations {}
resourceMappings {
targetResource( targetResource )
sourceResource( sourceResource )
}
targetResource {}
sourceResource {}
rules {}
approvalProcesses {
approvals( Collection of string )
type( string )
}
policyMappings {
sourcePolicy( sourcePolicy )
sourcePolicyFilter( sourcePolicyFilter )
targetPolicy( targetPolicy )
}
sourcePolicy {}
sourcePolicyFilter {
policyType( string )
policySubtype( string )
}
targetPolicy {}
processMappings {
sourceProcess( sourceProcess )
targetProcess( targetProcess )
}
sourceProcess {}
targetProcess {}
assetNotifications {
propertyName( string )
environments( Collection of string )
propertyValue( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI, required )
title( string )
type( string )
lang( string )
base( anyURI )
}
scriptMappings {
sourceScript( sourceScript )
targetScript( targetScript )
}
sourceScript {}
targetScript {}
properties {}
Reponse
Produces application/json
Status Code
Reason
Model
201
PromotionProfile added
any
400
Invalid PromotionProfile
404
Topology or Environment not found
409
PromotionProfile already exists
PUT/topologies/{topology-name}/environments/{environment-name}/profilesUpdate a PromotionProfile
Update an existing PromotionProfile in the specified Environment in the specified Topology
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
body
entity
profile
profile {
deploymentZoneConfigurations {}
resourceMappings {
targetResource {}
sourceResource {}
rules {}
approvalProcesses {
policyMappings {
sourcePolicy {}
sourcePolicyFilter {
targetPolicy {}
processMappings {
sourceProcess {}
targetProcess {}
assetNotifications {
atomLink {
scriptMappings {
sourceScript {}
targetScript {}
properties {}
deploymentZoneConfigurations( Collection of deploymentZoneConfigurations )
resourceMappings( Collection of resourceMappings )
targetEnvironment( string, required )
description( string )
rules( Collection of rules )
filterNames( Collection of string )
approvalProcesses( Collection of approvalProcesses )
policyMappings( Collection of policyMappings )
name( string, required )
processMappings( Collection of processMappings )
assetNotifications( Collection of assetNotifications )
links( Collection of atomLink )
scriptMappings( Collection of scriptMappings )
properties( Collection of properties )
}
deploymentZoneConfigurations {}
resourceMappings {
targetResource( targetResource )
sourceResource( sourceResource )
}
targetResource {}
sourceResource {}
rules {}
approvalProcesses {
approvals( Collection of string )
type( string )
}
policyMappings {
sourcePolicy( sourcePolicy )
sourcePolicyFilter( sourcePolicyFilter )
targetPolicy( targetPolicy )
}
sourcePolicy {}
sourcePolicyFilter {
policyType( string )
policySubtype( string )
}
targetPolicy {}
processMappings {
sourceProcess( sourceProcess )
targetProcess( targetProcess )
}
sourceProcess {}
targetProcess {}
assetNotifications {
propertyName( string )
environments( Collection of string )
propertyValue( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI, required )
title( string )
type( string )
lang( string )
base( anyURI )
}
scriptMappings {
sourceScript( sourceScript )
targetScript( targetScript )
}
sourceScript {}
targetScript {}
properties {}
Reponse
Produces application/json
Status Code
Reason
Model
200
PromotionProfile Updated
any
400
Invalid PromotionProfile
404
Topology or Environment not found
PUT/topologies/{topology-name}/environments/{environment-name}/configurationUpdate the Environment configuration
Update the configuration for the specified Environment in the specified Topology
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
body
entity
environmentConfiguration
environmentConfiguration {
atomLink {
properties {}
apiImplementationProfiles {}
links( Collection of atomLink )
properties( Collection of properties )
apiImplementationProfiles( Collection of apiImplementationProfiles )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI, required )
title( string )
type( string )
lang( string )
base( anyURI )
}
properties {}
apiImplementationProfiles {}
Reponse
Produces application/json
Status Code
Reason
Model
200
Configuration Updated
any
400
Invalid configuration
404
Topology or Environment not found
DELETE/topologies/{topology-name}/environments/{environment-name}/configurationDelete the Environment's configuration
Delete the Configuration from the specified Environment in the specified Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
Reponse
Status Code
Reason
Model
200
Configuration Deleted
any
404
Topology or Environment not found
GET/topologies/{topology-name}/environments/{environment-name}/profilesGet all PromotionProfiles for an Environment
Get all PromotionProfiles defined for the specified Environment for the specified Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
PromotionProfiles retrieved
404
Topology or Environment not found
GET/topologies/{topology-name}/environments/{environment-name}/configurationGet the environment configuration
Get the configuration for the specified Environment for the specified Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
PromotionProfile found
environmentConfiguration
environmentConfiguration {
atomLink {
properties {}
apiImplementationProfiles {}
links( Collection of atomLink )
properties( Collection of properties )
apiImplementationProfiles( Collection of apiImplementationProfiles )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
properties {}
apiImplementationProfiles {}
404
Topology or Environment not found
GET/topologies/{topology-name}/tenants/{tenant-name}/credentialsGet Credentials for Tenant
Get the Credentials for the specified Tenant in the specified Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
tenant-name
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Credentials retrieved
404
Topology or Tenant not found
PUT/topologies/{topology-name}/environments/{environment-name}/contextUpdate the context information for the Environment
Update the context information for the specified Environment, this information is used in validating dependencies of promoted assets
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
body
entity
environmentContext
environmentContext {
processes {
apiVersions {
policies {}
resources {
atomLink {
services {
scripts {
businesses {
properties {}
processes( Collection of processes )
apiVersions( Collection of apiVersions )
policies( Collection of policies )
resources( Collection of resources )
links( Collection of atomLink )
services( Collection of services )
scripts( Collection of scripts )
businesses( Collection of businesses )
properties( Collection of properties )
}
processes {
organizationId( string )
processId( string )
processName( string )
}
apiVersions {
organizationId( string )
lastUpdated( dateTime )
apiName( string )
apiVersion( string )
businessId( string )
apiVersionId( string )
apiId( string )
}
policies {}
resources {
resourceId( string )
businessId( string )
resourceName( string )
parentResourceId( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI, required )
title( string )
type( string )
lang( string )
base( anyURI )
}
services {
serviceVersion( string )
organizationId( string )
lastUpdated( dateTime )
virtual( boolean )
serviceQname( string )
serviceId( string )
serviceName( string )
}
scripts {
organizationId( string )
scriptId( string )
scriptName( string )
}
businesses {
organizationId( string )
name( string )
description( string )
id( string )
parentId( string )
}
properties {}
Reponse
Produces application/json
Status Code
Reason
Model
200
Environment context Updated
any
400
Invalid EnvironmentContext
404
Topology or Environment not found
GET/topologies/{topology-name}/environments/{environment-name}/contextGet the context information
Get the context information for the specified Environment for the specified Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
EnvironmentContext retrieved
environmentContext
environmentContext {
processes {
apiVersions {
policies {}
resources {
atomLink {
services {
scripts {
businesses {
properties {}
processes( Collection of processes )
apiVersions( Collection of apiVersions )
policies( Collection of policies )
resources( Collection of resources )
links( Collection of atomLink )
services( Collection of services )
scripts( Collection of scripts )
businesses( Collection of businesses )
properties( Collection of properties )
}
processes {
organizationId( string )
processId( string )
processName( string )
}
apiVersions {
organizationId( string )
lastUpdated( dateTime )
apiName( string )
apiVersion( string )
businessId( string )
apiVersionId( string )
apiId( string )
}
policies {}
resources {
resourceId( string )
businessId( string )
resourceName( string )
parentResourceId( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
services {
serviceVersion( string )
organizationId( string )
lastUpdated( dateTime )
virtual( boolean )
serviceQname( string )
serviceId( string )
serviceName( string )
}
scripts {
organizationId( string )
scriptId( string )
scriptName( string )
}
businesses {
organizationId( string )
name( string )
description( string )
id( string )
parentId( string )
}
properties {}
404
Topology or Environment not found
DELETE/topologies/{topology-name}/environments/{environment-name}/contextDelete the Environment's context information
Delete the context information for the specified Environment in the specified Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
Reponse
Status Code
Reason
Model
200
Environment context Deleted
any
404
Topology or Environment not found
DELETE/topologies/{topology-name}/environments/{environment-name}/assetsDelete assets for an Environment
Delete all assets associated with the specified environment. This will also delete all mapping information for assets associated with the specified environment
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
Reponse
Status Code
Reason
Model
200
Assets Deleted
any
404
Topology or Environment Not found
DELETE/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}Delete a PromotionProfile
Delete the specified PromotionProfile from the specified Environment in the specified Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
profile-name
path
string
Reponse
Status Code
Reason
Model
200
PromotionProfile Deleted
any
404
Topology, Environment or PromotionProfile not found
GET/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}Get a PromotionProfile
Get the PromotionProfile for the specified Environment for the specified Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
profile-name
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
PromotionProfile found
profile
profile {
deploymentZoneConfigurations {}
resourceMappings {
targetResource {}
sourceResource {}
rules {}
approvalProcesses {
policyMappings {
sourcePolicy {}
sourcePolicyFilter {
targetPolicy {}
processMappings {
sourceProcess {}
targetProcess {}
assetNotifications {
atomLink {
scriptMappings {
sourceScript {}
targetScript {}
properties {}
deploymentZoneConfigurations( Collection of deploymentZoneConfigurations )
resourceMappings( Collection of resourceMappings )
targetEnvironment( string )
description( string )
rules( Collection of rules )
filterNames( Collection of string )
approvalProcesses( Collection of approvalProcesses )
policyMappings( Collection of policyMappings )
name( string )
processMappings( Collection of processMappings )
assetNotifications( Collection of assetNotifications )
links( Collection of atomLink )
scriptMappings( Collection of scriptMappings )
properties( Collection of properties )
}
deploymentZoneConfigurations {}
resourceMappings {
targetResource( targetResource )
sourceResource( sourceResource )
}
targetResource {}
sourceResource {}
rules {}
approvalProcesses {
approvals( Collection of string )
type( string )
}
policyMappings {
sourcePolicy( sourcePolicy )
sourcePolicyFilter( sourcePolicyFilter )
targetPolicy( targetPolicy )
}
sourcePolicy {}
sourcePolicyFilter {
policyType( string )
policySubtype( string )
}
targetPolicy {}
processMappings {
sourceProcess( sourceProcess )
targetProcess( targetProcess )
}
sourceProcess {}
targetProcess {}
assetNotifications {
propertyName( string )
environments( Collection of string )
propertyValue( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
scriptMappings {
sourceScript( sourceScript )
targetScript( targetScript )
}
sourceScript {}
targetScript {}
properties {}
404
Topology, Environment or PromotionProfile not found
PUT/topologies/{topology-name}/tenants//{tenant-name}/credentialsUpdate Tenant Credentials
Update the Credentials for the specified Tenant in the specified Topology
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
tenant-name
path
string
body
entity
Reponse
Produces application/json
Status Code
Reason
Model
200
Credentials Updated
any
400
Invalid Credentials
404
Topology or Tenant not found
POST/topologies/{topology-name}/environments/{environment-name}/context/syncSyncs the context information from the specified environment
Sync the latest context information from the specified Environment for the specified Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
EnvironmentContext synchronized
environmentContext
environmentContext {
processes {
apiVersions {
policies {}
resources {
atomLink {
services {
scripts {
businesses {
properties {}
processes( Collection of processes )
apiVersions( Collection of apiVersions )
policies( Collection of policies )
resources( Collection of resources )
links( Collection of atomLink )
services( Collection of services )
scripts( Collection of scripts )
businesses( Collection of businesses )
properties( Collection of properties )
}
processes {
organizationId( string )
processId( string )
processName( string )
}
apiVersions {
organizationId( string )
lastUpdated( dateTime )
apiName( string )
apiVersion( string )
businessId( string )
apiVersionId( string )
apiId( string )
}
policies {}
resources {
resourceId( string )
businessId( string )
resourceName( string )
parentResourceId( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
services {
serviceVersion( string )
organizationId( string )
lastUpdated( dateTime )
virtual( boolean )
serviceQname( string )
serviceId( string )
serviceName( string )
}
scripts {
organizationId( string )
scriptId( string )
scriptName( string )
}
businesses {
organizationId( string )
name( string )
description( string )
id( string )
parentId( string )
}
properties {}
404
Topology or Environment not found
DELETE/topologies/{topology-name}/environments/{environment-name}/assets/{asset-id}Remove an asset and its mappings from an environment
Remove the specified asset from the specified environment. Note that this removes the asset only from Lifecycle Coordinator but not from the actual environment itself
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
asset-id
path
Id of the asset in the specified environment
string
Reponse
Produces application/octet-stream
Status Code
Reason
Model
200
Asset removed from environment
any
404
Topology, environment or asset not found
GET/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/deploymentsGet all DeploymentZoneConfigurations for a PromotionProfile
Get all DeploymentZoneConfigurations defined for the specified PromotionProfile in the specified Environment and Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
profile-name
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
DeploymentZoneConfigurations retrieved
404
Topology, Environment or PromotionProfile not found
PUT/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/rulesUpdate a the mapping rules
Update the mapping Rules for a PromotionProfile in the specified Environment in the specified Topology
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
profile-name
path
string
body
entity
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Rules Updated
any
400
Invalid Rules
404
Topology, Environment or PromotionProfile not found
PUT/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/mappingsAdd or replace the specified mappings
The specified mappings will be added to or replace matching existing mappings for the source and target environments
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
profile-name
path
string
body
entity
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Mappings Updated
any
400
Invalid Mappings
404
Topology, Environment or PromotionProfile not found
GET/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/rulesGet Rules for PromotionProfile
Get the Rules defined for the specified PromotionProfile in the specified Environment and Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
profile-name
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Rules retrieved
404
Topology, Environment or PromotionProfile not found
GET/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/mappingsGet stored mappings for the PromotionProfile
Get the mappings stored for between the source and target environments
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
profile-name
path
string
type
query
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Mappings retrieved
404
Topology, Environment or PromotionProfile not found
PUT/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/scriptSet the mapping script
Add or replace the mapping script for the specified PromotionProfile
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
profile-name
path
string
body
entity
base64Binary
Reponse
Produces application/json
Status Code
Reason
Model
200
Script added or updated
any
400
Invalid input
404
Topology, environment or profile not found
GET/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/scriptGet the mapping script
Get the contents of the mapping script for the specified PromotionProfile
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
profile-name
path
string
Reponse
Produces multipart/form-data
Status Code
Reason
Model
200
Script Found
any
404
Topology, environment, profile or script not found
DELETE/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/scriptDelete the mapping script
Delete the mapping script from the specified PromotionProfile
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
profile-name
path
string
Reponse
Status Code
Reason
Model
200
Script Deleted
any
404
Topology, environment or profile not found
GET/topologies/{topology-name}/environments/{environment-name}/assets/{asset-id}/packageGet the promoted archive for the specified asset
Request promotion of an api version from the specified Environment in the specified Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
asset-id
path
string
iteration
query
Iteration of the asset from which the archive is to be retrieved, if not specified the archive of the latest version will be retrieved
string
Reponse
Produces application/octet-stream
Status Code
Reason
Model
200
Package retrieved
any
404
Topology, environment,asset or iteration not found
POST/topologies/{topology-name}/environments/{environment-name}/assets/apis/{api-version-id}/promotePromote an API
Request promotion of an api version from the specified Environment in the specified Topology
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
api-version-id
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Promotion requested
any
400
Promotion was not allowed for this asset
404
Topology, environment or asset not found
POST/topologies/{topology-name}/environments/{environment-name}/assets/apps/{app-version-id}/promotePromote an App
Request promotion of an application version from the specified Environment in the specified Topology
Parameters
Accepts application/json
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
app-version-id
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Promotion requested
any
400
Promotion was not allowed for this asset
404
Topology, environment or asset not found
GET/topologies/{topology-name}/environments/{environment-name}/profiles/{profile-name}/deployments/{deploymentzone-configuration-name}/rulesGet Rules for DepolymentZoneConfiguration
Get the Rules defined for the specified DeploymentZoneConfiguration in the specified PromotionProfile in the specified Environment and Topology
Parameters
Name
Type
Description
Model
topology-name
path
string
environment-name
path
string
profile-name
path
string
deploymentzone-configuration-name
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Rules retrieved
404
Topology, Environment, PromotionProfile or DeploymentZoneConfiguration not found
