Deployment Zone API
{ urn:com.soa.dz.api } DeploymentZoneAPI
The Deployment Zones service allows you to retrieve a list of deployment zones for the platform.
GET/deploymentzonesgetDeploymentZones
Parameters
Name
Type
Description
Model
BindingType
query
string
ContextID
query
The Context Id. If this parameter is included, the deployment zones permissions will be checked against this context. Tenant context will be used otherwise. The OrgKey will supersede this context.
string
OrgKey
query
The Context Organization Key. If this parameter is included, the deployment zones permissions will be checked against this context. Tenant Org context will be used otherwise.
string
Reponse
Produces text/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xml
Status Code
Reason
Model
200
Success
rss
rss {
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
channel( rssChannel )
version( string )
}
rssChannel {
image( rssImage )
copyright( string )
item( rssItem )
skipHours( rssSkipHours )
lastBuildDate( string )
link( anyURI )
rating( string )
description( string )
generator( string )
language( string )
title( string )
managingEditor( string )
webMaster( string )
pubDate( string )
ttl( int )
skipDays( rssSkipDays )
cloud( rssCloud )
textInput( rssTextInput )
docs( anyURI )
category( rssCategory )
}
rssImage {
link( anyURI )
width( int )
description( string )
title( string )
url( string )
height( int )
}
rssItem {
comments( anyURI )
enclosure( rssEnclosure )
author( string )
link( anyURI )
description( string )
guid( rssGuid )
source( rssSource )
title( string )
category( rssCategory )
pubDate( string )
}
rssEnclosure {
length( string )
type( string )
url( string )
}
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
hour( Collection of string )
}
rssSkipDays {
day( Collection of string )
}
rssCloud {
path( string )
protocol( string )
port( int )
registerProcedure( string )
domain( string )
}
rssTextInput {
name( string )
link( anyURI )
description( string )
title( string )
}
GET/deploymentzoneslistDeploymentZones
Parameters
Name
Type
Description
Model
Implementation
query
string
Environment
query
string
APIImplementationPattern
query
string
DzoneID
query
string
ContextID
query
The Context Id. If this parameter is included, the deployment zones permissions will be checked against this context. Tenant context will be used otherwise. The OrgKey will supersede this context.
string
OrgKey
query
The Context Organization Key. If this parameter is included, the deployment zones permissions will be checked against this context.
string
Reponse
Produces application/vnd.soa.v81+jsonapplication/vnd.soa.v81+xmlapplication/vnd.soa.v84+xmlapplication/vnd.soa.v84+json
Status Code
Reason
Model
200
Success
DeploymentZoneInfoList
DeploymentZoneInfoList {
DeploymentZoneInfo {
DeploymentZoneAccessPoint {
DZoneEnvImplAssociation {
DeploymentZoneInfo( Collection of DeploymentZoneInfo )
}
DeploymentZoneInfo {
Description( string )
ContainerName( string )
AddressOverrideBehavior( string )
DeploymentZoneID( string )
DeploymentZoneAccessPoint( Collection of DeploymentZoneAccessPoint )
ContainerKey( string )
VirtualHostSupported( boolean )
DZoneEnvImplAssociations( Collection of DZoneEnvImplAssociation )
HostName( string )
Name( string )
Location( string )
RandomHostNameBehavior( string )
}
DeploymentZoneAccessPoint {
Address( string )
Protocol( string )
Name( string )
}
DZoneEnvImplAssociation {
Environment( string )
Implementation( string )
}
POST/deploymentzonesaddDeploymentZone
Parameters
Accepts application/json application/xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
body
entity
DeploymentZoneInfo
DeploymentZoneInfo {
DeploymentZoneAccessPoint {
DZoneEnvImplAssociation {
Description( string )
ContainerName( string )
AddressOverrideBehavior( string )
DeploymentZoneID( string )
DeploymentZoneAccessPoint( Collection of DeploymentZoneAccessPoint, required )
ContainerKey( string )
VirtualHostSupported( boolean )
DZoneEnvImplAssociations( Collection of DZoneEnvImplAssociation, required )
HostName( string )
Name( string, required )
Location( string )
RandomHostNameBehavior( string )
}
DeploymentZoneAccessPoint {
Address( string )
Protocol( string )
Name( string )
}
DZoneEnvImplAssociation {
Environment( string, required )
Implementation( string, required )
}
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
DeploymentZoneInfo
DeploymentZoneInfo {
DeploymentZoneAccessPoint {
DZoneEnvImplAssociation {
Description( string )
ContainerName( string )
AddressOverrideBehavior( string )
DeploymentZoneID( string )
DeploymentZoneAccessPoint( Collection of DeploymentZoneAccessPoint )
ContainerKey( string )
VirtualHostSupported( boolean )
DZoneEnvImplAssociations( Collection of DZoneEnvImplAssociation )
HostName( string )
Name( string )
Location( string )
RandomHostNameBehavior( string )
}
DeploymentZoneAccessPoint {
Address( string )
Protocol( string )
Name( string )
}
DZoneEnvImplAssociation {
Environment( string )
Implementation( string )
}
GET/deploymentzones/{dzInfoID}getDeploymentZoneInfo
Parameters
Name
Type
Description
Model
dzInfoID
path
string
Reponse
Produces application/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
DeploymentZoneInfo
DeploymentZoneInfo {
DeploymentZoneAccessPoint {
DZoneEnvImplAssociation {
Description( string )
ContainerName( string )
AddressOverrideBehavior( string )
DeploymentZoneID( string )
DeploymentZoneAccessPoint( Collection of DeploymentZoneAccessPoint )
ContainerKey( string )
VirtualHostSupported( boolean )
DZoneEnvImplAssociations( Collection of DZoneEnvImplAssociation )
HostName( string )
Name( string )
Location( string )
RandomHostNameBehavior( string )
}
DeploymentZoneAccessPoint {
Address( string )
Protocol( string )
Name( string )
}
DZoneEnvImplAssociation {
Environment( string )
Implementation( string )
}
PUT/deploymentzones/{DZoneID}updateDeploymentZone
Parameters
Accepts application/json application/xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
DZoneID
path
string
body
entity
DeploymentZoneInfo
DeploymentZoneInfo {
DeploymentZoneAccessPoint {
DZoneEnvImplAssociation {
Description( string )
ContainerName( string )
AddressOverrideBehavior( string )
DeploymentZoneID( string )
DeploymentZoneAccessPoint( Collection of DeploymentZoneAccessPoint, required )
ContainerKey( string )
VirtualHostSupported( boolean )
DZoneEnvImplAssociations( Collection of DZoneEnvImplAssociation, required )
HostName( string )
Name( string, required )
Location( string )
RandomHostNameBehavior( string )
}
DeploymentZoneAccessPoint {
Address( string )
Protocol( string )
Name( string )
}
DZoneEnvImplAssociation {
Environment( string, required )
Implementation( string, required )
}
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
DeploymentZoneInfo
DeploymentZoneInfo {
DeploymentZoneAccessPoint {
DZoneEnvImplAssociation {
Description( string )
ContainerName( string )
AddressOverrideBehavior( string )
DeploymentZoneID( string )
DeploymentZoneAccessPoint( Collection of DeploymentZoneAccessPoint )
ContainerKey( string )
VirtualHostSupported( boolean )
DZoneEnvImplAssociations( Collection of DZoneEnvImplAssociation )
HostName( string )
Name( string )
Location( string )
RandomHostNameBehavior( string )
}
DeploymentZoneAccessPoint {
Address( string )
Protocol( string )
Name( string )
}
DZoneEnvImplAssociation {
Environment( string )
Implementation( string )
}
DELETE/deploymentzones/{DZoneID}deleteDeploymentZoneInfo
Parameters
Name
Type
Description
Model
DZoneID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
PUT/deploymentzones/{DZoneID}/associationsupdateDeploymentZoneAssociations
Parameters
Accepts application/json application/xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
DZoneID
path
string
body
entity
DZoneEnvImplAssociations
DZoneEnvImplAssociations {
DZoneEnvImplAssociation {
DZoneEnvImplAssociation( Collection of DZoneEnvImplAssociation, required )
}
DZoneEnvImplAssociation {
Environment( string, required )
Implementation( string, required )
}
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
DZoneEnvImplAssociations
DZoneEnvImplAssociations {
DZoneEnvImplAssociation {
DZoneEnvImplAssociation( Collection of DZoneEnvImplAssociation )
}
DZoneEnvImplAssociation {
Environment( string )
Implementation( string )
}
GET/deploymentzones/{DZoneID}/associationsgetDeploymentZoneAssociations
Parameters
Name
Type
Description
Model
DZoneID
path
string
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
DZoneEnvImplAssociations
DZoneEnvImplAssociations {
DZoneEnvImplAssociation {
DZoneEnvImplAssociation( Collection of DZoneEnvImplAssociation )
}
DZoneEnvImplAssociation {
Environment( string )
Implementation( string )
}