Asset Environment API
{ http://soa.com/wsdl/environment/1.0 } AssetEnvironmentAPI
The Asset Environment service provides operations for managing the promotion of assets to different environments.
GET/assetenvironments/{AssetID}getAssetEnvironments
Returns the asset environments for the given asset FDN
Request:
GET /assetenvironments/8ec423b6-9b1f-4491-aef3-e787f85fce3e.atmosphere?AssetType=API HTTP/1.1
Accept: application/json
Response:
HTTP/1.1 200 OK
{
"AssetEnvironment" : [ {
"AssetType" : "API",
"EnvironmentName" : "Development",
"Url" : "http://abc.com/d",
"Status" : "Promoted"
}, {
"AssetType" : "API",
"EnvironmentName" : "QA",
"Url" : "http://abc.com/q",
"Status" : "Promoted"
}, {
"AssetType" : "API",
"EnvironmentName" : "Staging",
"Url" : "http://abc.com/s",
"Status" : "Not Promoted"
} ]
}
Parameters
Name
Type
Description
Model
AssetID
path
The asset's Id.
string
AssetType
query
The asset type
string
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v84+jsonapplication/vnd.soa.v84+xml
Status Code
Reason
Model
200
Success
AssetEnvironments
AssetEnvironments {
AssetEnvironment {
AssetEnvironment( Collection of AssetEnvironment )
}
AssetEnvironment {
Status( string )
AssetType( string )
EnvironmentDisplayName( string )
EnvironmentName( string )
Version( string )
TargetEnvironments( Collection of AssetEnvironment )
AssetId( string )
Url( anyURI )
}
POST/assetenvironments/{AssetID}promote
Promotes the given asset to the next environment.
Request:
POST /assetenvironments/2211616d-6252-4c82-8563-b668b21b70b2.atmosphere HTTP/1.1
Content-Type: application/json
{
"AssetType" : "API",
"EnvironmentName" : "QA"
}
Response:
HTTP/1.1 200 OK
{
"AssetType" : "API",
"EnvironmentName" : "Staging",
"Url" : "http://abc.com/s",
"Status" : "Promoted"
}
Parameters
Accepts application/json application/xml application/vnd.soa.v84+json application/vnd.soa.v84+xml
Name
Type
Description
Model
AssetID
path
The asset Id.
string
body
entity
AssetEnvironment
AssetEnvironment {
Status( string )
AssetType( string )
EnvironmentDisplayName( string )
EnvironmentName( string )
Version( string )
TargetEnvironments( Collection of AssetEnvironment )
AssetId( string )
Url( anyURI )
}
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v84+jsonapplication/vnd.soa.v84+xml
Status Code
Reason
Model
200
Success
AssetEnvironment
AssetEnvironment {
Status( string )
AssetType( string )
EnvironmentDisplayName( string )
EnvironmentName( string )
Version( string )
TargetEnvironments( Collection of AssetEnvironment )
AssetId( string )
Url( anyURI )
}