The GET request configuration to view the high level catalog APIs is shown below.

A sample of the response received is shown below.

Status 200 OK
{
"items":[
{
"href":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/cfw/API/v1",
"description":"API Summary for version V1"
},
{
"href":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/cfw/API/v2",
"description":"API Summary for version V2"
}
],
"totalResults":2
}

The GET request configuration to view the v1 catalog APIs is shown below.

A sample of the response received is shown below.

Status 200 OK
{
"items":[
{
"href":"cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/API",
"description":"APIs for Self Service Application for version V1",
"type":"SSA"
},
{
"href":"cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/API",
"description":"APIs for Administrative functions for version V1",
"type":"Admin"
}
],
"goBack":"cloudcompany.com/em/websvcs/restful/extws/cloudservices/cfw/API",
"totalResults":2
}

The GET request configuration to view the v2 catalog APIs is shown below.

A sample of the response received is shown below.

Status 200 OK
{
"items":[{
"href":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/API",
"description":"APIs for Self Service Application for version V2",
"type":"SSA"
},
{
"href":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/API",
"description":"APIs for administrative functions for version V2",
"type":"Admin"
} ],
"goBack":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/cfw/API",
"totalResults":2
}

The GET request configuration to view the v1 catalog APIs for SSA portal is shown below.

A sample of the response received is shown below.

Status 200 OK
{
"v1":{
"canonicalLink":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1",
"serviceRequests":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1
/servicerequests",
"userPreferences":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1
/mypreferences"
}
}

The v2 endpoint provides further refined overview of v2 side user REST APIs grouped according to entities. For example, all the Service instance related REST APIs are listed together for entity=serviceinstances.

REST APIs with variable inputs, are marked with attribute “templated" and curly brackets.

The GET request configuration to view the v2 catalog user APIs is shown below.

A sample of the response received is shown below.

{
"items": [
{
"totalResults": 5,
"resource": "services",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services",
"method": "GET",
"description": "Get all the service offerings"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services",
"method": "POST",
"description": "Create a service"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/{
id}",
"method": "GET",
"templated": true,
"description": "Get details of a service"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/{
id}/metadata",
"method": "GET",
"templated": true,
"description": "Get the metadata for a service"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/{
id}/metrics",
"method": "PUT",
"templated": true,
"description": "Get the metrics for a service"
}
]
},
{
"totalResults": 11,
"resource": "userpreferences",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences",
"method": "GET"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/general",
"method": "GET",
"description": "Get the general user preferences"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/general/metadata",
"method": "GET",
"description": "Get the metadata for general user preferences"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/services",
"method": "GET",
"description": "Get the service user preferences"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/services/{service-family}",
"method": "GET",
"templated": true,
"description": "Get the user preferences for a service family"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/services/{service-family}/metadata",
"method": "GET",
"templated": true,
"description": "Get the metadata for user preference at family level"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/services/{service-family}/{service-type}",
"method": "GET",
"templated": true,
"description": "Get the user preferences for a service type"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/services/{service-family}/{service-type}/metadata",
"method": "GET",
"templated": true,
"description": "Get the metadata for user preference at service type level"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/general",
"method": "PUT",
"description": "Update general user preference"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/{service-family}",
"method": "PUT",
"templated": true,
"description": "Update family level user preferences"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/services/{service-family}/{service-type}",
"method": "PUT",
"templated": true,
"description": "Update service type level user preferences"
}
]
},
{
"totalResults": 4,
"resource": "servicerequests",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicereq
uests",
"method": "GET",
"description": "Get service requests"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicereq
uests/{id}",
"method": "PUT",
"templated": true,
"description": "Reschedule the request"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicereq
uests/{id}",
"method": "GET",
"templated": true,
"description": "Get the details of request"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicereq
uests/{id}",
"method": "DELETE",
"templated": true,
"description": "Delete the request"
}
]
},
{
"totalResults": 5,
"resource": "serviceinstances",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceins
tances",
"method": "GET",
"description": "Get the service instances"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceins
tances/{id}",
"method": "GET",
"templated": true,
"description": "Get details of a service instance"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceins
tances/{id}/actions",
"method": "GET",
"templated": true,
"description": "Get actions for a service instance"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceins
tances/{id}/actions/{action-id}",
"method": "GET",
"templated": true,
"description": "Get metadata details of action"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceins
tances/{id}/actions/{action-id}",
"method": "PUT",
"templated": true,
"description": "Perform the action on the service instance"
}
]
}
],
"goBack": "https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/API",
"totalResults": 4
}

The v2 endpoint provides further refined overview of v2 side admin REST APIs grouped according to entities. For example, all the Service instance related REST APIs are listed together for entity=serviceinstances.

REST APIs with variable inputs, are marked with attribute “templated" and curly brackets.

The GET request configuration to view the v2 catalog admin APIs is shown below.

A sample of the response received is shown below.

{
"items": [
{
"totalResults": 6,
"resource": "resourceproviders",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resource
providers",
"method": "GET",
"description": "Get all the resource providers"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resource
providers",
"method": "POST",
"description": "Create/Add a resource provider"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resource
providers/{id}",
"method": "GET",
"templated": true,
"description": "Get details of a resource provider"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resource
providers/{id}",
"method": "DELETE",
"templated": true,
"description": "Delete/Remove a resource provider"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resource
providers/{id}",
"method": "PUT",
"templated": true,
"description": "Edit a resource provider"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resource
providers/{id}/metrics",
"method": "GET",
"templated": true,
"description": "Get metrics for a resource provider"
}
]
},
{
"totalResults": 3,
"resource": "servicetemplates",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicet
emplates",
"method": "GET",
"description": "Get all service templates"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicet
emplates",
"method": "POST",
"description": "Create a service template"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicet
emplates/{id}",
"method": "PUT",
"templated": true,
"description": "Edit a service template"
}
]
},
{
"totalResults": 4,
"resource": "settings",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/settings
/general",
"method": "GET",
"description": "Get all general settings"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/settings
/general",
"method": "PUT",
"description": "Update general settings"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/settings
/service/{service-type}",
"method": "GET",
"templated": true,
"description": "Get all settings for a service type"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/settings
/service/{service-type}",
"method": "PUT",
"templated": true,
"description": "Update settings for a service type"
}
]
},
{
"totalResults": 5,
"resource": "instancesizes",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/instance
sizes",
"method": "GET",
"description": "Get all instance sizes"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/instance
sizes/service/{service-type}",
"method": "GET",
"templated": true,
"description": "Get all instance sizes for a service type"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/instance
sizes/service/{service-type}/metadata",
"method": "GET",
"templated": true,
"description": "Get metada for instance sizes for a service type"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/instance
sizes/service/{service-type}/{instance-name}",
"method": "GET",
"templated": true,
"description": "Get details of an instance size"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/instance
sizes/service/{service-type}/{instance-name}",
"method": "PUT",
"templated": true
}
]
},
{
"totalResults": 5,
"resource": "servicerequests",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicer
equests",
"method": "GET",
"description": "Get all requests"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicer
equests/{id}",
"method": "PUT",
"templated": true,
"description": "Reschedule a request"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicer
equests/{id}",
"method": "GET",
"templated": true,
"description": "Get details of a request"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicer
equests/{id}",
"method": "DELETE",
"templated": true,
"description": "Delete a request"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicer
equests",
"method": "DELETE",
"description": "Delete bulk requests"
}
]
},
{
"totalResults": 12,
"resource": "serviceinstances",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances",
"method": "GET",
"description": "Get all service instances"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/{id}",
"method": "GET",
"templated": true,
"description": "Get details of a service instance"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/{id}/actions",
"method": "GET",
"templated": true,
"description": "Get all the actions on a service instance"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/{id}/actions/{action-id}",
"method": "GET",
"templated": true,
"description": "Get the details of action"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/{id}/actions/{action-id}",
"method": "PUT",
"templated": true,
"description": "Perform the action on the service instance"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/{id}/start",
"method": "PUT",
"templated": true,
"description": "Start the service instance"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/{id}/stop",
"method": "PUT",
"templated": true,
"description": "Stop the service instance"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/{id}/delete",
"method": "PUT",
"templated": true,
"description": "Delete the service instance"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances",
"method": "DELETE",
"description": "Delete service instances"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/start",
"method": "PUT",
"description": "Start multiple service instances"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/stop",
"method": "PUT",
"description": "Stop multiple service instances"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/delete",
"method": "PUT",
"description": "Delete multiple service instances"
}
]
}
],
"goBack": "https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/API",
"totalResults": 6
}

A GET operation is issued to view all the Resource Providers.

A sample of the response received is shown below.

{
"name": "Resource Providers",
"type": "Resource Provider",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/"
},
"cfwItems": [
{
"id": "1",
"name": "MyPaasZone",
"type": "self_service_zone",
"guid": "AC3D1D12E0A0AB1B28C377ED691E9E98",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/1"
}
},
{
"id": "2",
"name": "MyXaasProvider",
"type": "cfw_samplexaas_rsrc_provider",
"guid": "20CC7F446482F477BED8336489852A4B",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/2"
}
},
{
"id": "3",
"name": "MyXaasPool",
"type": "cfw_samplexaas_rsrc_pool",
"guid": "FEF39B5F2A0C518283F7A5E781EE8C8B",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/3"
}
},
{
"id": "4",
"name": "MyWebLogicProvider",
"type": "mwaas_zone",
"guid": "425AA08582AD7AE95D52C24662867315",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/4"
}
},
{
"id": "21",
"name": "MySchemaPool",
"type": "schaas_pool",
"guid": "446AD900E64F525149A3B1D79E0037AC",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/21"
}
}
],
"totalResults": 5
}

A GET operation is issued to view all the Types of Resource Providers.

A sample of the response received is shown below.

{
"name" : "Resource Provider Types",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s"
},
"cfwItems" : [ {
"type" : "cfw_samplexaas_rsrc_pool",
"displayName" : "CFW XaaS Test Rsrc Pool",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s/cfw_samplexaas_rsrc_pool"
}
}, {
"type" : "cfw_samplexaas_rsrc_provider",
"displayName" : "CFW XaaS Test Rsrc Provider",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s/cfw_samplexaas_rsrc_provider"
}
}, {
"type" : "cfw_samplexaas_rsrcprov_no_member",
"displayName" : "CFW XaaS Test Rsrc With No Member",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s/cfw_samplexaas_rsrcprov_no_member"
}
}, {
"type" : "mwaas_zone",
"displayName" : "Middleware Pool",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s/mwaas_zone"
}
}, {
"type" : "oracle_cloud_zone",
"displayName" : "Database Pool",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s/oracle_cloud_zone"
}
}, {
"type" : "oracle_nimbula_site",
"displayName" : "Oracle Nimbula Site",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
5.6 67
s/oracle_nimbula_site"
}
}, {
"type" : "pdbaas_pool",
"displayName" : "Pluggable Database Pool",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s/pdbaas_pool"
}
}, {
"type" : "schaas_pool",
"displayName" : "Schema Pool",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s/schaas_pool"
}
}, {
"type" : "self_service_zone",
"displayName" : "PaaS Infrastructure Zone",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s/self_service_zone"
}
} ],
"totalResults" : 0
}

The table below shows the POST configuration to create a Resource Provider.

{
"name": "My Xaas Provider_200",
"characteristics": [
{
"name": "example.sysman.cfw.samplexaas.storagetype",
"value": [
"file",
"db"
]
}
],
"memberTargetType": "cfw_samplexaas_rsrc",
"members": [
"Sample7"
],
"placementConstraints": [
{
"name": "NUMBER_OF_SERVICE_INSTANCES",
"value": "20"
}
],
"type": "cfw_samplexaas_rsrc_provider",
"useExistingTarget": false,
"memberConstraints": [
{
"name": "ORACLE.SYSMAN.CFW.LOCATION",
"values": [
"us-east"
]
},
{
"name": "ORACLE.SYSMAN.SAMPLEXAAS.STORAGETYPE",
"values": [
"file"
]
}
]
}

A sample of the response received is shown below.

{
"message": "Resource Provider with name \"My Xaas Provider_200\" and type
\"cfw_samplexaas_rsrc_provider\" created successfully.",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/24"
}
}

The table below shows the POST configuration to create a PaaS Infrastructure zone Resource Provider.

{ "useExistingTarget" :false,
"name" :"MyPaasZone02",
"type" :"self_service_zone",
"memberTargetType" :"host",
 "members": [ "yourhost1.yourcompany.com" ],
 "credentials": [ { "name": "normal_credential_guid", "value": "VGSINGH" } ],
"placementConstraints": [ { "name": "MAX_CPU_UTILIZATION",
"value": [ "80" ] }, { "name": "MAX_MEMORY_ALLOCATION",
"value": [ "80" ] } ], "memberConstraints": [] }

A sample of the response received is shown below.

{ "message" : "ResourceProvider with name \"MyPaasZone02\" and type \"self_service_zone\" created successfully.",
"canonicalLink" : { "href" : "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/41" }}

The table below shows the POST configuration to create a Database Schema Pool.

{ "name" : "MyDBSchemaPool",
"useExistingTarget" : false,
"type" : "schaas_pool",
"description" : "MyDatabaseSchemaPool", 
"memberTargetType" : "oracle_database",
"members" : [ "Oemrep_Database" ], 
"parentResourceProviderId" : "1",
"credentials" : [ { "name" : "host_credential_guid", "value" : "VGSINGH" } ],
"placementConstraints" :
[ { "name" : "MAX_SERVICES", "value" : [ "100" ] }, { "name" : "MAX_CPU_USAGE", "value" : [ "0" ] }, 
{ "name" : "MAX_MEMORY_USAGE", "value" : [ "0" ] }, { "name" : "USE_WORKLOAD", "value" : [ "false" ] },
{ "name" : "ENFORCE_CPU", "value" : [ "false" ] } ], 
"memberConstraints" : [ { "name" : "ORACLE.SYSMAN.SSA.CONFIGURATION", "value" : [ "oracle_database" ] },
{ "name" : "ORACLE.SYSMAN.CFW.PLATFORM", "value" : [ "226" ] },
{ "name" : "ORACLE.SYSMAN.CFW.VERSION", "value" : [ "11.2.0.3.0" ] } ],
"characteristics" : [ { "name" : "ORACLE.SYSMAN.CFW.ORCL_GTP_CONTACT", "value" : [ "admin@cloudcompany.com" ] },
{ "name" : "ORACLE.SYSMAN.CFW.ORCL_GTP_COST_CENTER", "value" : [ "GTB" ] },
{ "name" : "ORACLE.SYSMAN.CFW.ORCL_GTP_DEPARTMENT", "value" : [ "ST" ] },
{ "name" : "ORACLE.SYSMAN.CFW.ORCL_GTP_LIFECYCLE_STATUS", "value" : [ "Development" ] },
{ "name" : "ORACLE.SYSMAN.CFW.ORCL_GTP_LINE_OF_BUS", "value" : [ "LOB" ] },
{ "name" : "ORACLE.SYSMAN.CFW.ORCL_GTP_LOCATION", "value" : [ "EAST" ] },
{ "name" : "ORACLE.SYSMAN.CFW.ORCL_GTP_SITE", "value" : [ "LOCAL" ] } ]}

A sample of the response received is shown below.

{ "message" : "ResourceProvider with name \"MyDBSchemaPool\" and type \"schaas_pool\" created successfully.",
"canonicalLink" : { "href" : "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/61" }}

The table below shows the POST configuration to create a sample Adapter Instance.

{ name" : "MySmplVMAdapter_0409123048",
"type" : "iaas_adapter",
"placementConstraints" : [ { "name" : "MAX_VM_INSTANCES", "value" : "10" } ],
"vmadapter" : { "name" : "SAMPLEADAPTER", "paaszone" : "MyPaasZone", "connection" : { "endpoints" : [ { "purpose" : "login_url", "url" : "/login_url/example", "username" : "ssa_user", "password" : "ssa_passwd", "domain" : "domain", "custom" : [ { "name" : "CloudType", "value" : "CloudTypeVal" }, { "name" : "custom_param1", "value" : "custom_param1Val" } ] } ],
"virtualizationContainers" : [ { "name" : "Zone" } ] }, "useproxies" : [ "testnm" ], "stagingservers" : { "location" : "script/location", "credentialGuid" : "25D30ADD427484310DBC8CF6211A383B" } }}

A sample of the response received is shown below.

{ "message" : "ResourceProvider with name \"MySmplVMAdapter_0409123047\" and type \"iaas_adapter\" created successfully.",
"canonicalLink" : { "href" : "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/63" }}

A POST operation is issued on Resource Providers collection resource to filter Resource Provider targets in the system.

{
"type": "self_service_zone",
"memberTargetType": "cfw_samplexaas_rsrc"
}

A sample of the response received is shown below.

{
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/filt
eredtargets"
},
"targets": [
"Sample10",
"Sample1",
"Sample3",
"Sample2",
"Sample5",
"Sample4",
"Sample7",
"Sample6",
"Sample9",
"Sample8"
],
"memberTargetType": "cfw_samplexaas_rsrc"
}

A GET operation is issued to view the Resource Provider type metadata.

A sample of the response received is shown below.

{
"type" : "mwaas_zone",
"memberTargetTypes" : [ "host" ],
"parentResourceProviderType" : "self_service_zone",
"placementPolicyName" : "First_Pick",
"placementConstraints" : [ {
"name" : "MAX_INSTANCES",
"displayName" : "Maximum Number of WebLogic Servers (per host)",
"description" : "Maximum Number of WebLogic Servers (per host)",
"valueType" : "INTEGER",
"operator" : "eq"
} ],
"characteristics" : [ {
"name" : "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.BASEINSTALLDIR",
"displayName" : "Middleware Home Base Directory",
"description" : "All Oracle Homes would be created from this Base Install Directory.",
"isComposite" : false,
"possibleValues" : [ ],
"isMandatory" : false,
"isUnique" : false
}, {
"name" : "EXAMPLE.SYSMAN.CFW.ORCL_GTP_CONTACT",
"displayName" : "Contact",
"description" : null,
"isComposite" : false,
"possibleValues" : [ ],
"isMandatory" : false,
"isUnique" : true
}, {
"name" : "EXAMPLE.SYSMAN.CFW.ORCL_GTP_COST_CENTER",
"displayName" : "Cost Center",
"description" : null,
"isComposite" : false,
"possibleValues" : [ ],
"isMandatory" : false,
"isUnique" : true
}, {
"name" : "EXAMPLE.SYSMAN.CFW.ORCL_GTP_DEPARTMENT",
"displayName" : "Department",
"description" : null,
"isComposite" : false,
"possibleValues" : [ ],
"isMandatory" : false,
"isUnique" : true
}, {
"name" : "EXAMPLE.SYSMAN.CFW.ORCL_GTP_LIFECYCLE_STATUS",
"displayName" : "Lifecycle Status",
"description" : null,
"isComposite" : false,
"possibleValues" : [ "Development", "MissionCritical", "Production", "Stage", "Test" ],
5.15 76
"isMandatory" : false,
"isUnique" : true
}, {
"name" : "EXAMPLE.SYSMAN.CFW.ORCL_GTP_LINE_OF_BUS",
"displayName" : "Line of Business",
"description" : null,
"isComposite" : false,
"possibleValues" : [ ],
"isMandatory" : false,
"isUnique" : true
}, {
"name" : "EXAMPLE.SYSMAN.CFW.ORCL_GTP_LOCATION",
"displayName" : "Location",
"description" : null,
"isComposite" : false,
"possibleValues" : [ ],
"isMandatory" : false,
"isUnique" : true
}, {
"name" : "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.ASHAREDHOME",
"displayName" : "Shared Oracle Home",
"description" : "When set to Yes, all Hosts in this MW Pool would use this Shared Home even if
other Oracle Homes present on these Hosts. Otherwise, Oracle Home on each Host will be used.",
"isComposite" : false,
"possibleValues" : [ "0", "1" ],
"isMandatory" : false,
"isUnique" : false
}, {
"name" : "EXAMPLE.SYSMAN.EMAS.MWAAS_ZONE",
"displayName" : "oracle.sysman.emas.mwaas_zone",
"description" : null,
"isComposite" : false,
"possibleValues" : [ ],
"isMandatory" : true,
"isUnique" : true
} ],
"memberConstraints" : [ {
"name" : "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.PLATFORM",
"displayName" : "Operating System and Platform",
"description" : null,
"isComposite" : false,
"possibleValues" : [ "197", "59", "212", "209", "46", "226", "912", "208", "233", "23", "267" ]
} ]
}

A GET operation is issued to view the metadata for creating a PaaS Infrastructure Zone.

A sample of the response received is shown below.

{ "type": "self_service_zone",
"memberTargetTypes": [ "host" ], 
"placementConstraints": [
 { "name": "MAX_MEMORY_ALLOCATION",
 "displayName": "MaximumMemoryAllocation(%)",
 "description": "MaximumMemoryAllocation constraint per host in a paas infrastructure zone",
 "valueType": "INTEGER",
 "operator": "eq" },
 { "name": "MAX_CPU_UTILIZATION",
 "displayName": "MaximumCPUUtilization(%)", 
 "description": "MaximumCPU utilization(%) constraint for a physical resource 
provider",
 "valueType": "INTEGER",
 "operator": "eq" } ],
"characteristics": [ { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_CONTACT",
"displayName": "Contact", 
"description": null,
"isComposite": false,
"possibleValues": [],
"isUnique": true, 
"isMandatory": false },
{ "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_COST_CENTER",
"displayName": "CostCenter",
"description": null,
"isComposite": false, 
"possibleValues": [],
"isUnique": true, 
"isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_DEPARTMENT",
 "displayName": "Department", 
"description": null, 
"isComposite": false,
 "possibleValues": [],
 "isUnique": true, 
"isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_LIFECYCLE_STATUS", 
"displayName": "LifecycleStatus",
 "description": null,
 "isComposite": false, 
"possibleValues": [ "Development", "MissionCritical",
 "Production", "Stage", "Test" ],
 "isUnique": true,
 "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_LINE_OF_BUS",
 "displayName": "Line ofBusiness", 
"description": null,
 "isComposite": false,
 "possibleValues": [],
 "isUnique": true,
 "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_LOCATION",
 "displayName": "Location",
 "description": null,
 "isComposite": false,
 "possibleValues": [],
 "isUnique": true,
 "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_SITE",
 "displayName": "Site",
 "description": null,
 "isComposite": false,
 "possibleValues": [],
 "isUnique": true,
 "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.SELF_SERVICE_ZONE",
 "displayName": "oracle.sysman.cfw.self_service_zone",
 "description": null,
 "isComposite": false,
 "possibleValues": [],
 "isUnique": true,
 "isMandatory": true } ],
 "credentials": [ { "name": "normal_credential_guid",
 "displayName": "Host credentials", 
"description": "HostCredentials to be used for provisioning in thisPaaSInfrastructureZone.The credentials provided should be of global credential type (valid across the members in the zone) and owned by the current user",
 "authenticatingTargetType":
 "host", "isMandatory": true } ],
 "memberConstraints": []}

A GET operation is issued to view the metadata for creating a Schema Pool.

A sample of the response received is shown below.

{ "type": "schaas_pool",
 "memberTargetTypes": [ "oracle_database", "rac_database" ],
 "parentResourceProviderType": "self_service_zone",
 "placementPolicyName": "First_Pick",
 "placementConstraints": [ { "name": "ENFORCE_CPU", "displayName": "EnableResourceManager forCPU", "description": "Whether to enable resource manager which can be used to createConsumerGroups.", "valueType": "BOOLEAN", "operator": "eq" },
 { "name": "MAX_CPU_USAGE", "displayName": "MaximumCPU allocation (%)", "description": "Defines the maximum limit of theCPU permissible for each database, beyond which a service request can not be placed.", "valueType": "INTEGER", "operator": "eq" },
 { "name": "USE_WORKLOAD", "displayName": "Associate workload with the request", "description": "Whether to associate workload with the request which represents the expectedCPU, memory and storage requirements for each service.", "valueType": "BOOLEAN", "operator": "eq" },
 { "name": "MAX_SERVICES", "displayName": "MaximumNumber of database services", "description": "Maximum number of services per database.", "valueType": "INTEGER", "operator": "eq" },
 { "name": "MAX_MEMORY_USAGE", "displayName": "Maximum memory allocation (%)", "description": "Memory represents the summation ofSystemGlobalArea (SGA) allocated for each database.", "valueType": "INTEGER", "operator": "eq" } ],
 "characteristics": [ { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_CONTACT", "displayName": "Contact", "description": null, "isComposite": false, "possibleValues": [], "isUnique": true, "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_COST_CENTER", "displayName": "CostCenter", "description": null, "isComposite": false, "possibleValues": [], "isUnique": true, "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_DEPARTMENT", "displayName": "Department", "description": null, "isComposite": false, "possibleValues": [], "isUnique": true, "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_LIFECYCLE_STATUS", "displayName": "LifecycleStatus", "description": null, "isComposite": false, "possibleValues": [ "Development", "MissionCritical", "Production", "Stage", "Test" ], "isUnique": true, "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_LINE_OF_BUS", "displayName": "Line ofBusiness", "description": null, "isComposite": false, "possibleValues": [], "isUnique": true, "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_LOCATION", "displayName": "Location", "description": null, "isComposite": false, "possibleValues": [], "isUnique": true, "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_SITE", "displayName": "Site", "description": null, "isComposite": false, "possibleValues": [], "isUnique": true, "isMandatory": false },
 { "name": "ORACLE.SYSMAN.SSA.SCHAAS_POOL", "displayName": "oracle.sysman.ssa.schaas_pool", "description": null, "isComposite": false, "possibleValues": [], "isUnique": true, "isMandatory": true } ],
 "credentials": [ { "name": "gi_credential_guid", "displayName": "GridInfrastructureCredentials", "description": "GridInfrastructure credentials are optional.", "authenticatingTargetType": "host", "isMandatory": false },
 { "name": "database_credential_guid", "displayName": "DatabaseCredentials", "description": "The database credentials that will be used for performing database operations like schema creation.The database credentials requireSYSDBA privileges.", "authenticatingTargetType": "oracle_database", "isMandatory": false },
 { "name": "host_credential_guid", "displayName": "HostCredentials", "description": "Host credentials to be specified that will be used to perform instance creation operations.", "authenticatingTargetType": "host", "isMandatory": true } ],
 "memberConstraints": [ { "name": "ORACLE.SYSMAN.SSA.CONFIGURATION", "displayName": "DatabaseConfiguration", "description": "DatabaseConfiguration of the resource provider member.", "isComposite": false, "possibleValues": [ "rac_database", "oracle_database" ] },
 { "name": "ORACLE.SYSMAN.CFW.PLATFORM", "displayName": "Platform", "description": "Platform", "isComposite": false, "possibleValues": [ "197", "59", "212", "209", "46", "226", "912", "208", "233", "23", "267" ] },
 { "name": "ORACLE.SYSMAN.CFW.VERSION", "displayName": "Version", "description": "Version", "isComposite": false, "possibleValues": [ "10.2.0.1.0", "10.2.0.2.0", "10.2.0.3.0", "10.2.0.4.0", "10.2.0.5.0", "11.1.0.6.0", "11.1.0.7.0", "11.2.0.1.0", "11.2.0.2.0", "11.2.0.3.0", "11.2.0.4.0", "12.1.0.1.0", "12.1.0.2.0" ] } ]}

A GET operation is issued to view details of the Resource Provider.

A sample of the response received is shown below.

{
"name": "My Xaas Provider_001",
"type": "cfw_samplexaas_rsrc_provider",
"memberTargetType": "cfw_samplexaas_rsrc",
"members": [
"Sample2"
],
"credentials": [],
"placementConstraints": [
{
"name": "NUMBER_OF_SERVICE_INSTANCES",
"value": [
"20"
]
},
{
"name": "TEST_CONSTRAINT_WITH_STRING_VALUE",
"value": [
"\"string_value\""
]
}
],
"memberConstraints": [],
"characteristics": [
{
"name": "ORACLE.SYSMAN.SXAAS.CFW_SAMPLEXAAS_RSRC_PROVIDER",
"value": [
"C277DA7F0CB329507172B4C44E0A6DF9"
]
}
],
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/22"
}
}

A PUT operation is issued on a Resource Provider resource to update an existing instance of Resource Provider in the system.

{
"placementConstraints": [{"name": " NUMBER_OF_SERVICE_INSTANCES ", "value":
"70"}],
}

A sample of the response received is shown below.

Status 200 OK
{
message: "Resource Provider with ID "121" updated successfully."
}

The DELETE request configuration is shown in the table below.

A sample of the response received is shown below.

Status 200 OK
{
"message":"Resource Provider with ID \"21\" deleted successfully."
}

The GET request configuration to view the configuration of a resource provider is shown below.

A sample of the response received is shown below.

{
  "hosts" : {
    "configurations" : [ {
      "name" : "vm_networks",
      "type" : "VECTOR",
      "description" : "Network.",
      "displayName" : "vm_networks",
      "values" : [ ],
      "required" : false,
      "secret" : false
    }, {
      "name" : "platform",
      "type" : "STRING",
      "value" : "",
      "displayName" : "platform",
      "required" : false,
      "secret" : false
    }, {
      "name" : "hostPrefix",
      "type" : "STRING",
      "description" : "Host Name Prefix.",
      "value" : "rest_",
      "displayName" : "Host Name Prefix",
      "required" : false,
      "secret" : false
    }, {
      "name" : "postInstallScript",
      "type" : "STRING",
      "value" : "",
      "displayName" : "postInstallScript",
      "required" : false,
      "secret" : false
    }, {
      "name" : "cluster_storages",
      "type" : "VECTOR",
      "description" : "Cluster Storage.",
      "displayName" : "cluster_storages",
      "values" : [ ],
      "required" : false,
      "secret" : false
    }, {
      "name" : "agent_base",
      "type" : "STRING",
      "description" : "Agent Install Base Directory Location",
      "value" : "bsl",
      "displayName" : "Installation Base Directory",
      "required" : false,
      "secret" : false
    }, {
      "name" : "cluster_networks",
      "type" : "VECTOR",
      "description" : "Cluster Network",
      "displayName" : "cluster_networks",
      "values" : [ ],
      "required" : false,
      "secret" : false
    }, {
      "name" : "resourceProviderId",
      "type" : "STRING",
      "value" : "1",
      "displayName" : "resourceProviderId",
      "required" : false,
      "secret" : false
    }, {
      "name" : "postInstallScriptOnOMS",
      "type" : "STRING",
      "value" : "",
      "displayName" : "postInstallScriptOnOMS",
      "required" : false,
      "secret" : false
    }, {
      "name" : "agent_install_creds",
      "type" : "STRING",
      "description" : "Agent Port",
      "value" : "15513B9C0C6E4EB9E053CE74B10A171B",
      "displayName" : "Named Credential",
      "required" : false,
      "secret" : false
    }, {
      "name" : "priv_delegation_setting",
      "type" : "STRING",
      "value" : "/usr/bin/sudo -u %RUNAS% %COMMAND%",
      "displayName" : "priv_delegation_setting",
      "required" : false,
      "secret" : false
    }, {
      "name" : "vm_instance_sizes",
      "type" : "VECTOR",
      "description" : "Instance Size.",
      "displayName" : "vm_instance_sizes",
      "values" : [ "EXTRA_LARGE" ],
      "required" : false,
      "secret" : false
    }, {
      "name" : "agent_port",
      "type" : "STRING",
      "description" : "Agent Port",
      "value" : "3872",
      "displayName" : "Port",
      "required" : false,
      "secret" : false
    }, {
      "name" : "preInstallScript",
      "type" : "STRING",
      "value" : "",
      "displayName" : "preInstallScript",
      "required" : false,
      "secret" : false
    }, {
      "name" : "custom_params",
      "type" : "VECTOR",
      "description" : "Custom parameters for VM configuration.",
      "displayName" : "custom_params",
      "values" : [ ],
      "required" : false,
      "secret" : false
    }, {
      "name" : "vm_server_templates",
      "type" : "VECTOR",
      "description" : "Server Template.",
      "displayName" : "vm_server_templates",
      "values" : [ "paas-tmpl" ],
      "required" : false,
      "secret" : false
    }, {
      "name" : "preInstallScriptOnOMS",
      "type" : "STRING",
      "value" : "",
      "displayName" : "preInstallScriptOnOMS",
      "required" : false,
      "secret" : false
    }, {
      "name" : "numberOfHost",
      "type" : "STRING",
      "description" : "Number Of Host",
      "value" : "3",
      "displayName" : "Number Of Host",
      "required" : false,
      "secret" : false
    }, {
      "name" : "vm_storages",
      "type" : "VECTOR",
      "description" : "Storage.",
      "displayName" : "vm_storages",
      "values" : [ ],
      "required" : false,
      "secret" : false
    }, {
      "name" : "runPreInstallScriptAsRoot",
      "type" : "STRING",
      "value" : "",
      "displayName" : "runPreInstallScriptAsRoot",
      "required" : false,
      "secret" : false
    }, {
      "name" : "runPostInstallScriptAsRoot",
      "type" : "STRING",
      "value" : "",
      "displayName" : "runPostInstallScriptAsRoot",
      "required" : false,
      "secret" : false
    } ]
  },
  "swprovisioning" : {
    "configurations" : [ {
      "name" : "resourceProviderId",
      "type" : "STRING",
      "value" : "1",
      "displayName" : "resourceProviderId",
      "required" : false,
      "secret" : false
    } ]
  }
}

The GET request configuration to view the metric of a resource provider is shown below.

A sample of the response received is shown below.

Status 200 OK
{
count: "0"
hasMore: "false"
limit: "0"
offset: "0"
totalResults: "0"
metricColumns: [6]
0: {
name: "services"
}-
1: {
name: "sample"
}-
2: {
name: "memory"
}-
3: {
name: "storageStatus"
}-
4: {
name: "cpu"
}-
5: {
name: "storage"
}-
}

The table below shows the POST configuration to provision a resource.

{ "saveOnly" : false,
 "setDefault" : true,
 "hosts" : { "templateGuid" : "13462942A66F0B2DE053CE74B10AFCC2",
 "configurations" : [ { "name" : "hostPrefix", "value" : "rest_" },
 { "name" : "numberOfHost", "value" : "5" },
 { "name" : "agent_install_creds", "value" : "131EFD3114423E7AE053CE74B10A5A76" },
 { "name" : "agent_base", "value" : "bsl" },
 { "name" : "priv_delegation_setting", "value" : "/usr/bin/sudo -u %RUNAS% %COMMAND%" },
 { "name" : "agent_port", "value" : "3872" },
 { "name" : "priv_delegation_setting_template_name", "value" : "" },
 { "name" : "network_purpose_vm", "subvalues" : [ { "name" : "Public", "value" : "192.168.1.0/24" } ] },
 { "name" : "storage_purpose_cluster", "subvalues" : [ { "name" : "Shared", "value" : "smisko_0" } ] },
 { "name" : "storage_purpose_vm", "subvalues" : [ { "name" : "Dedicated", "value" : "smisko_0" } ] },
 { "name" : "network_purpose_cluster", "subvalues" : [ { "name" : "ClusterPrivate", "value" : "192.168.1.0/24" },
 { "name" : "ClusterPublic", "value" : "192.168.1.0/24" } ] },
 { "name" : "vm_instance_sizes", "values" : [ "EXTRA_LARGE" ] },
 { "name" : "vm_server_templates", "values" : [ "paas-tmpl" ] } ] },
 "swprovisioning" : { "configurations" : [ { "name" : "param01", "value" : "param_01_val" }, { "name" : "param01", "value" : "param_02_val" } ] }}

A sample of the response received is shown below.

{ "status" : "SCHEDULED", "details" : "134821EBDA7472BFE053CE74B10A11B8"}

The DELETE request configuration for de-provisioning a resource is shown in the table below.

{"members":["rest_-bf51c965-fff0-400c-a982-2c71b2afb150","rest_-13ce4c70-e1b4-4bd9-8b43-6952d619e674"]}

A sample of the response received is shown below.

{ "details": "133C8EC6EAC86122E053CE74B10A4DEF", "status": "SCHEDULED"}

The POST request configuration to view the metadata required to provision a resource provider is shown below.

A sample of the response received is shown below.

{
  "hosts" : {
    "templateGuid" : "1552104D74F47F29E053CE74B10A08D9",
    "configurations" : [ {
      "name" : "platform",
      "type" : "STRING",
      "value" : "",
      "displayName" : "platform",
      "required" : false,
      "secret" : false
    }, {
      "name" : "hostPrefix",
      "type" : "STRING",
      "description" : "Host Name Prefix.",
      "value" : "MySmplAdptr0505013358",
      "displayName" : "Host Name Prefix",
      "required" : false,
      "secret" : false
    }, {
      "name" : "network_purpose_vm",
      "type" : "VECTOR",
      "description" : "Purpose Network Instance",
      "displayName" : "network_purpose_vm",
      "required" : false,
      "secret" : false,
      "possibleValues" : [ {
        "value" : "192.168.1.0/25",
        "displayName" : "192.168.1.0/25"
      }, {
        "value" : "192.168.1.0/24",
        "displayName" : "192.168.1.0/24"
      }, {
        "value" : "192.168.1.0/26",
        "displayName" : "192.168.1.0/26"
      }, {
        "value" : "192.168.1.0/27",
        "displayName" : "192.168.1.0/27"
      } ],
      "subvalues" : [ {
        "name" : "Public",
        "type" : "STRING",
        "displayName" : "Public",
        "required" : true,
        "secret" : false
      } ]
    }, {
      "name" : "postInstallScript",
      "type" : "STRING",
      "value" : "",
      "displayName" : "postInstallScript",
      "required" : false,
      "secret" : false
    }, {
      "name" : "storage_purpose_cluster",
      "type" : "VECTOR",
      "description" : "Purpose Storage Cluster",
      "displayName" : "storage_purpose_cluster",
      "required" : false,
      "secret" : false,
      "possibleValues" : [ {
        "value" : "smisko_3",
        "displayName" : "smisko_3"
      }, {
        "value" : "smisko_2",
        "displayName" : "smisko_2"
      }, {
        "value" : "smisko_1",
        "displayName" : "smisko_1"
      }, {
        "value" : "smisko_0",
        "displayName" : "smisko_0"
      } ],
      "subvalues" : [ ]
    }, {
      "name" : "network_purpose_cluster",
      "type" : "VECTOR",
      "description" : "Purpose Network Cluster",
      "displayName" : "network_purpose_cluster",
      "required" : false,
      "secret" : false,
      "possibleValues" : [ {
        "value" : "192.168.1.0/25",
        "displayName" : "192.168.1.0/25"
      }, {
        "value" : "192.168.1.0/24",
        "displayName" : "192.168.1.0/24"
      }, {
        "value" : "192.168.1.0/26",
        "displayName" : "192.168.1.0/26"
      }, {
        "value" : "192.168.1.0/27",
        "displayName" : "192.168.1.0/27"
      } ],
      "subvalues" : [ ]
    }, {
      "name" : "agent_base",
      "type" : "STRING",
      "description" : "Agent Install Base Directory Location",
      "value" : "/scratch/oracle/",
      "displayName" : "Installation Base Directory",
      "required" : false,
      "secret" : false
    }, {
      "name" : "resourceProviderId",
      "type" : "STRING",
      "value" : "1",
      "displayName" : "resourceProviderId",
      "required" : false,
      "secret" : false
    }, {
      "name" : "postInstallScriptOnOMS",
      "type" : "STRING",
      "value" : "",
      "displayName" : "postInstallScriptOnOMS",
      "required" : false,
      "secret" : false
    }, {
      "name" : "agent_install_creds",
      "type" : "STRING",
      "description" : "Agent Port",
      "value" : "15513B9C0C6E4EB9E053CE74B10A171B",
      "displayName" : "Named Credential",
      "required" : false,
      "secret" : false
    }, {
      "name" : "storage_purpose_vm",
      "type" : "VECTOR",
      "description" : "Purpose Storage Instance",
      "displayName" : "storage_purpose_vm",
      "required" : false,
      "secret" : false,
      "possibleValues" : [ {
        "value" : "smisko_3",
        "displayName" : "smisko_3"
      }, {
        "value" : "smisko_2",
        "displayName" : "smisko_2"
      }, {
        "value" : "smisko_1",
        "displayName" : "smisko_1"
      }, {
        "value" : "smisko_0",
        "displayName" : "smisko_0"
      } ],
      "subvalues" : [ {
        "name" : "Dedicated",
        "type" : "STRING",
        "displayName" : "Dedicated",
        "required" : true,
        "secret" : false
      } ]
    }, {
      "name" : "priv_delegation_setting",
      "type" : "STRING",
      "value" : "/usr/bin/sudo -u %RUNAS% %COMMAND%",
      "displayName" : "priv_delegation_setting",
      "required" : false,
      "secret" : false
    }, {
      "name" : "vm_instance_sizes",
      "type" : "VECTOR",
      "description" : "Instance Size.",
      "displayName" : "vm_instance_sizes",
      "values" : [ "EXTRA_LARGE", "TINY", "SMALL" ],
      "required" : false,
      "secret" : false,
      "possibleValues" : [ {
        "value" : "TINY",
        "displayName" : "TINY"
      }, {
        "value" : "EXTRA_LARGE",
        "displayName" : "EXTRA_LARGE"
      }, {
        "value" : "SMALL",
        "displayName" : "SMALL"
      } ]
    }, {
      "name" : "agent_port",
      "type" : "STRING",
      "description" : "Agent Port",
      "value" : "3872",
      "displayName" : "Port",
      "required" : false,
      "secret" : false
    }, {
      "name" : "preInstallScript",
      "type" : "STRING",
      "value" : "",
      "displayName" : "preInstallScript",
      "required" : false,
      "secret" : false
    }, {
      "name" : "vm_server_templates",
      "type" : "VECTOR",
      "description" : "Server Template.",
      "displayName" : "vm_server_templates",
      "values" : [ "paas-tmpl", "paas-tmpl2" ],
      "required" : false,
      "secret" : false,
      "possibleValues" : [ {
        "value" : "paas-tmpl",
        "displayName" : "paas-tmpl"
      }, {
        "value" : "paas-tmpl2",
        "displayName" : "paas-tmpl2"
      } ]
    }, {
      "name" : "preInstallScriptOnOMS",
      "type" : "STRING",
      "value" : "",
      "displayName" : "preInstallScriptOnOMS",
      "required" : false,
      "secret" : false
    }, {
      "name" : "numberOfHost",
      "type" : "STRING",
      "description" : "Number Of Host",
      "value" : "",
      "displayName" : "Number Of Host",
      "required" : false,
      "secret" : false
    }, {
      "name" : "runPreInstallScriptAsRoot",
      "type" : "STRING",
      "value" : "",
      "displayName" : "runPreInstallScriptAsRoot",
      "required" : false,
      "secret" : false
    }, {
      "name" : "runPostInstallScriptAsRoot",
      "type" : "STRING",
      "value" : "",
      "displayName" : "runPostInstallScriptAsRoot",
      "required" : false,
      "secret" : false
    } ]
  },
  "swprovisioning" : {
    "configurations" : [ ]
  }
}

A GET operation is issued to view all the Service Templates.

A sample of the response received is shown below.

{
"name": "Service Templates",
"type": "Service Template",
"totalResults": 3,
"cfwItems": [
{
"id": "1",
"name": "Orchestration",
"guid": "06F28ABA2E0178CBE053CE74B10AAC2D",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/1"
},
"description": "Create a set of Oracle VM instances with customized configuration for multitier
applications"
},
{
"id": "2",
"name": "Simple Orchestration",
"guid": "06F28ABA2E0478CBE053CE74B10AAC2D",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/2"
},
"description": "Create one or more Oracle VM instances with default configuration and minimum
inputs"
},
{
"id": "3",
"name": "VM Instance",
"guid": "06F28ABA2E0778CBE053CE74B10AAC2D",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/3"
},
"description": "Create an Oracle VM Instance"
}
],
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/"
},
"selfLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/"
}
}

A GET operation is issued to view all the Service Template types.

A sample of the response received is shown below.

[
{
"name": "SCHEMA",
"displayName": "SchaaS Create Executable",
"serviceType": "SCHEMA",
"serviceTemplateTypeId": "61"
},
{
"name": "MW_SOAAAS_CREATE_INSTANCE",
"displayName": "SOAaaS Orchestration",
"serviceType": "SOA_SERVICE",
"serviceTemplateTypeId": "24"
},
{
"name": "MW_WLAAS_EXECUTABLE_CREATE",
"displayName": "WebLogic Service - Physical",
"serviceType": "WLAAS",
"serviceTemplateTypeId": "28"
},
{
"name": "MW_OSBAAS_CREATE_INSTANCE",
"displayName": "OSBaaS Orchestration",
"serviceType": "OSB_SERVICE",
"serviceTemplateTypeId": "21"
},
{
"name": "DB",
"displayName": "DbaaS Create Executable",
"serviceType": "DB",
"serviceTemplateTypeId": "41"
},
{
"name": "PDB",
"displayName": "PdbaaS Create Executable",
"serviceType": "PDB",
"serviceTemplateTypeId": "54"
},
{
"name": "ORACLE_NIMBULA_CREATE_SIMPLE_ORCHESTRATION_EXECUTABLE",
"displayName": "Simple Orchestration Custom Service Template",
"serviceType": "ORACLE_NIMBULA_ORCHESTRATION_SERVICE",
"serviceTemplateTypeId": "3"
},
{
"name": "ORACLE_NIMBULA_CREATE_ORCHESTRATION_EXECUTABLE",
"displayName": "Orchestration Custom Service Template",
"serviceType": "ORACLE_NIMBULA_ORCHESTRATION_SERVICE",
"serviceTemplateTypeId": "1"
},
{
"name": "ORACLE_NIMBULA_CREATE_VIRTUAL_MACHINE_EXECUTABLE",
"displayName": "ORACLE_NIMBULA_CREATE_VIRTUAL_MACHINE_EXECUTABLE",
"serviceType": "ORACLE_NIMBULA_VIRTUAL_MACHINE_SERVICE",
"serviceTemplateTypeId": "11"
}
]

A POST operation is issued to view the metadata required for creating a Service Template.

{
"serviceType": "WLAAS",
"serviceTemplateTypeId": "28"
}

A sample of the response received is shown below.

{
"serviceType": "WLAAS",
"serviceTemplateTypeId": "28",
"rscProvAssocOption": [
"byRscLookupChars"
],
"selectedExecutableName": {
"name": "MW_WLAAS_EXECUTABLE_CREATE",
"type": "STRING",
"value": "MwaaS_Setup_Domain_Deploy_App",
"defaultValue": "MwaaS_Setup_Domain_Deploy_App",
"required": true,
"secret": false
},
"payloads": [
{
"name": "DEFAULT_PAYLOAD",
"value": "<user_input>",
"required": true
}
],
"characteristics": [
{
"name": "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.ENABLEHA",
"displayName": "Distribute WebLogic Servers on Available Hosts?",
"values": [
"No",
"Yes"
],
"required": false,
"visible": true,
"editable": true
},
{
"name": "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.ENABLELBR",
"displayName": "Enable Load Balancer?",
"values": [
"No",
"Yes"
],
"required": false,
"visible": true,
"editable": true
},
{
"name": "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.EXPOSEADMINURLS",
"displayName": "Expose WebLogic Admin Console and Fusion Middleware Control to SSA
User?",
"values": [
"No",
"Yes"
],
"required": false,
"visible": true,
"editable": true
}
]
}

A POST operation is issued to view the Resource Provider characteristics required for creating a Service Template.

{
"serviceType": "WLAAS",
"serviceTemplateTypeId": "28",
"rscProvAssocOption": [
"byRscLookupChars"
],
"payloads": [
{
"name": "DEFAULT_PAYLOAD",
"value": "test"
}
],
"characteristics": [
{
"name": "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.ENABLEHA",
"value":"Yes"
},
{
"name": "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.ENABLELBR",
"value":"Yes"
},
{
"name": "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.EXPOSEADMINURLS",
"value": "Yes"
}
]
}

A sample of the response received is shown below.

{
"lookupCharacteristics": [
{
"characteristics": [
{
"name": "EXAMPLE.SYSMAN.EMAS.MWAAS_ZONE",
"displayName": "example.sysman.emas.mwaas_zone",
"targetType": {
"targetType": "mwaas_zone",
"parentTargetType": "self_service_zone",
"targetTypeName": "Middleware Pool",
"parentTargetTypeName": "PaaS Infrastructure Zone"
}
}
],
"purposeId": 1
}
]
}

A POST operation is issued to view the configurations required for creating a Service Template.

{
"serviceType": "WLAAS",
"serviceTemplateTypeId": "28",
"rscProvAssocOption": [
"byRscLookupChars"
],
"payloads": [
{
"name": "DEFAULT_PAYLOAD",
"value": "test"
}
],
"characteristics": [
{
"name": "ORACLE.SYSMAN.EMAS.MWC.WLAAS.ENABLEHA",
"value": "Yes"
},
{
"name": "ORACLE.SYSMAN.EMAS.MWC.WLAAS.ENABLELBR",
"value": "Yes"
},
{
"name": "ORACLE.SYSMAN.EMAS.MWC.WLAAS.EXPOSEADMINURLS",
"value": "Yes"
}
],
"resourceprovider": {
"lookupCharacteristics": [
{
"characteristics": [
{
"name": "ORACLE.SYSMAN.EMAS.MWAAS_ZONE",
"value": "425AA08582AD7AE95D52C24662867315"
}
],
"purposeId": 1
}
]
}
}

A sample of the response received is shown below.

[
{
"name": "agentInstallUserPwd",
"type": "STRING",
"description": "Agent Install User Password to override",
"required": false,
"secret": true
},
{
"name": "hostForResourceProvisioningScript",
"type": "STRING",
"description": "Resource management script will be executed on this host.",
"required": false,
"secret": false
},
{
"name": "portRangeStart",
"type": "STRING",
"description": "Lower Bound for choosing Free Ports",
"required": false,
"secret": false
},
{
"name": "wlsUserPassword",
"type": "STRING",
"description": "Password for the WebLogic Server",
"required": false,
"secret": true
},
{
"name": "rootPwd",
"type": "STRING",
"description": "Root Password to override",
"required": false,
"secret": true
},
{
"name": "wlsUserName",
"type": "STRING",
"description": "Username for the WebLogic Server",
"required": false,
"secret": false
},
{
"name": "wlsUserPassword2",
"type": "STRING",
"description": "Re-enter Password for the WebLogic Server",
"required": false,
"secret": true
},
{
"name": "namedHostCredForVirtualFlow",
"type": "STRING",
"description": "Enter name of the host credential to use for provisioning operations",
"required": false,
"secret": false
},
{
"name": "startupArguments",
"type": "STRING",
"description": "Enter memory and java arguments to start the server. Example: -Xms1280m -
Xmx1280m -XX:PermSize=128m -XX:MaxPermSize=256m -
Dweblogic.security.SSL.ignoreHostnameVerification=true",
"required": false,
"secret": false
},
{
"name": "namedCredforHostList",
"type": "STRING",
"description": "This will be used for the above hosts",
"required": false,
"secret": false
},
{
"name": "serviceName",
"type": "STRING",
"description": "Service Instance Name",
"required": true,
"secret": true
},
{
"name": "cpuUsagePerInstance",
"type": "STRING",
"description": "CPU required by each additional instance in percentage",
"required": false,
"secret": false
},
{
"name": "portRangeEnd",
"type": "STRING",
"description": "Upper Bound for choosing Free Ports",
"required": false,
"secret": false
},
{
"name": "memoryUsagePerInstance",
"type": "STRING",
"description": "Memory required by each additional instance in GB",
"required": false,
"secret": false
},
{
"name": "hostListForScripts",
"type": "STRING",
"description": "Use ',' to separate multiple target hosts",
"required": false,
"secret": false
},
{
"name": "topology",
"type": "STRING",
"description": "For physical provisioning it is auto populated based on the profile
selected. For virtual provisioning it is defaulted to 'Single Cluster'. Please change based on the
actual topology of the assembly. ",
"required": false,
"secret": false
},
{
"name": "namedCredforRsrcProvHost",
"type": "STRING",
"description": "Enter the EM Named Credentials to be used for the above host in the \"Host
for Executing Resource Management Script\" field.",
"required": false,
"secret": false
},
{
"name": "isScriptExecuteOnAdminServer",
"type": "STRING",
"description": "Choose 'Yes' to execute scripts on Admin Server host besides the hosts
entered above",
"required": false,
"secret": false
}
]

A POST operation is issued to create a Service template.

{
"name": "SampleXaas Template",
"description": "Xaas template",
"serviceType": "CFW_SAMPLEXAAS_SERVICE",
"serviceTemplateTypeId": "82",
"rscProvAssocOption": [
"byRscLookupChars"
],
"roles": [
"SSA01",
"SSA02",
"SSA03",
"SSA04",
"SSA05"
],
"characteristics": [
{
"name": "ORACLE.SYSMAN.SAMPLEXAAS.SAMPLEINSTANCETYPE",
"values": [
"Cfw_Xaas_DB_Service"
]
},
{
"name": "ORACLE.SYSMAN.SAMPLEXAAS.STORAGE_OP_BW",
"values": [
"10"
]
}
],
"resourceproviders": {
"lookupCharacteristics": [
{
"characteristics": [
{
"name": "ORACLE.SYSMAN.SAMPLEXAAS.STORAGETYPE",
"displayName": "storage_type",
"value": "db"
}
],
"purposeId": 1
}
]
},
"configurations": [
{
"name": "service_instance_name",
"value": "xaas_inst_name"
},
{
"name": "service_type",
"value": "CFW_SAMPLEXAAS_SERVICE"
},
{
4.22 48
"name": "service_param2",
"value": "p2"
},
{
"name": "service_param1",
"value": "p1"
},
{
"name": "storage_type",
"value": "file"
}
]
}

A sample of the response received is shown below.

Status 200 OK
{"message": "Service template with id \"0780653DF4C64F83E053CE74B10ABD91\" created successfully."
}

A PUT operation is issued to update a Service template.

{
"displayName": "updatedDisplayName",
"description": "updated via API",
"rolesToAdd": [
"SSA04",
"SSA05",
"SSA06",
],
"rolesToRemove": [
"SSA01",
"SSA02",
"SSA03",
],
"configurations": [
{
"name": "service_instance_name",
"value": "inst_name_${tstmp}"
},
{
"name": "service_type",
"value": "CFW_SAMPLEXAAS_SERVICE"
},
{
"name": "service_param2",
"value": "sp2_up"
},
{
"name": "service_param1",
"value": "sp1_up"
},
{
"name": "storage_type",
"value": "file_up"
}
]
}

A sample of the response received is shown below.

Status 200 OK
{
"message": " Service template with id "1" updated successfully."
}

A GET operation is issued to view details of a specific Service Template.

A sample of the response received is shown below.

{
"id": "63",
"guid": "0780653DF4C94F83E053CE74B10ABD91",
"name": "SampleXaas Template",
"displayName": "SampleXaas Template",
"description": "Xaas template",
"serviceType": "CFW_SAMPLEXAAS_SERVICE",
"serviceTemplateTypeId": "82",
"createdOn": "2014-11-10T16:52:18Z",
"createdBy": "SYSMAN",
"modifiedOn": "2014-11-10T16:52:18Z",
"owner": "SYSMAN",
"lastModified": "2014-11-10T16:52:18Z",
"characteristics": [
{
"name": "EXAMPLE.SYSMAN.CFW.ORCL_GTP_CONTACT",
"displayName": "Contact",
"values": [],
"required": false,
"visible": false,
"editable": true
},
{
"name": "EXAMPLE.SYSMAN.CFW.ORCL_GTP_COST_CENTER",
"displayName": "Cost Center",
"values": [],
"required": false,
"visible": false,
"editable": true
},
{
"name": "EXAMPLE.SYSMAN.CFW.ORCL_GTP_DEPARTMENT",
"displayName": "Department",
"values": [],
"required": false,
"visible": false,
"editable": true
},
{
"name": "EXAMPLE.SYSMAN.SAMPLEXAAS.SAMPLEINSTANCETYPE",
"displayName": "Instance Type",
"values": [
"Cfw_Xaas_DB_Service"
],
"required": true,
"visible": true,
"editable": false
},
{
"name": "EXAMPLE.SYSMAN.CFW.ORCL_GTP_LIFECYCLE_STATUS",
"displayName": "Lifecycle Status",
"values": [
"Development",
"MissionCritical",
"Production",
"Stage",
"Test"
],
"required": false,
"visible": false,
"editable": true
},
{
"name": "EXAMPLE.SYSMAN.CFW.ORCL_GTP_LINE_OF_BUS",
"displayName": "Line of Business",
"values": [],
"required": false,
"visible": false,
"editable": true
},
{
"name": "EXAMPLE.SYSMAN.CFW.ORCL_GTP_LOCATION",
"displayName": "Location",
"values": [],
"required": false,
"visible": false,
"editable": true
},
{
"name": "EXAMPLE.SYSMAN.SAMPLEXAAS.STORAGE_OP_BW",
"displayName": "Operation Bandwidth",
"values": [
"10"
],
"required": false,
"visible": true,
"editable": true
}
],
"resourceProvider": {
"lookupCharacteristics": [
{
"characteristics": [
{
"name": "EXAMPLE.SYSMAN.SAMPLEXAAS.STORAGETYPE",
"displayName": "storage_type",
"values": [
"db"
]
}
],
"purposeId": 1
}
]
},
"configurations": [
{
"name": "service_instance_name",
"type": "STRING",
"description": "Specify Instance Name",
"value": "xaas_inst_name",
"required": true,
"secret": false
},
{
"name": "service_type",
"type": "STRING",
"description": "Specify Service type",
"value": "CFW_SAMPLEXAAS_SERVICE",
"required": true,
"secret": false
},
{
"name": "service_param2",
"type": "STRING",
"description": "Service param 2",
"value": "p2",
"required": false,
"secret": false
},
{
"name": "service_param1",
"type": "STRING",
"description": "Service param 1",
"value": "p1",
"required": false,
"secret": false
},
{
"name": "storage_type",
"type": "STRING",
"description": "Specify Storage type",
"value": "file",
"required": true,
"secret": false
}
],
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/63"
},
"selfLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/63"
}
}

A GET operation is issued to view the configuration details of a specific Service Template.

A sample of the response received is shown below.

[
{
"name": "service_instance_name",
"type": "STRING",
"description": "Specify Instance Name",
"value": "xaas_inst_name",
"required": true,
"secret": false
},
{
"name": "service_type",
"type": "STRING",
"description": "Specify Service type",
"value": "CFW_SAMPLEXAAS_SERVICE",
"required": true,
"secret": false
},
{
"name": "service_param2",
"type": "STRING",
"description": "Service param 2",
"value": "p2",
"required": false,
"secret": false
},
{
"name": "service_param1",
"type": "STRING",
"description": "Service param 1",
"value": "p1",
"required": false,
"secret": false
},
{
"name": "WorkLoads",
"type": "VECTOR",
"description": "WorkLoad Values",
"required": false,
"secret": false,
"subvalues": [
{
"name": "Small",
"type": "VECTOR",
"description": "Configuration Values for Small WorkLoad",
"required": false,
"secret": false,
"subvalues": [
{
"name": "DEPL_SIZE_IS_DEFAULT_KEY",
"type": "STRING",
"value": "Y",
"required": false,
"secret": false
},
{
"name": "CPU",
"type": "STRING",
"value": "60",
"required": false,
"secret": false
},
{
"name": "MEMORY",
"type": "STRING",
"value": "4048",
"required": false,
"secret": false
},
{
"name": "STORAGE",
"type": "STRING",
"value": "500",
"required": false,
"secret": false
},
{
"name": "XAAS_TEST",
"type": "STRING",
"value": "NONE",
"required": false,
"secret": false
}
]
},
{
"name": "Medium",
"type": "VECTOR",
"description": "Configuration Values for Medium WorkLoad",
"required": false,
"secret": false,
"subvalues": [
{
"name": "DEPL_SIZE_IS_DEFAULT_KEY",
"type": "STRING",
"value": "N",
"required": false,
"secret": false
},
{
"name": "CPU",
"type": "STRING",
"value": "80",
"required": false,
"secret": false
},
{
"name": "MEMORY",
"type": "STRING",
"value": "8088",
"required": false,
"secret": false
},
{
"name": "STORAGE",
"type": "STRING",
"value": "750",
"required": false,
"secret": false
}
]
},
{
"name": "Large",
"type": "VECTOR",
"description": "Configuration Values for Large WorkLoad",
"required": false,
"secret": false,
"subvalues": [
{
"name": "DEPL_SIZE_IS_DEFAULT_KEY",
"type": "STRING",
"value": "Y",
"required": false,
"secret": false
},
{
"name": "CPU",
"type": "STRING",
"value": "60",
"required": false,
"secret": false
},
{
"name": "MEMORY",
"type": "STRING",
"value": "40448",
"required": false,
"secret": false
},
{
"name": "STORAGE",
"type": "STRING",
"value": "500",
"required": false,
"secret": false
}
]
}
]
},
{
"name": "storage_type",
"type": "STRING",
"description": "Specify Storage type",
"value": "file",
"required": true,
"secret": false
}
]

The DELETE request configuration is shown in the table below.

A sample of the response received is shown below.

{
"message": "Service template with id \"62\" deleted successfully."
}

The GET request configuration to view details of the Service Types resource.

A sample of the response received is shown below.

{
"name": "Service Types",
"type": "Service Types Collection",
"totalResults": 3,
"cfwItems": [
{
"name": "CFW_SAMPLEXAAS_REMOTESERVER_SERVICE",
"displayName": "Cfw Sample RemoteServer XaaS",
"serviceFamily": "CFW_SAMPLEXAAS_SERVICEFAMILY",
"targetTypes": [
"Cfw_Xaas_DB_Service"
]
},
{
"name": "CFW_SAMPLEXAAS_SERVICE",
"displayName": "Cfw Sample XaaS",
"serviceFamily": "CFW_SAMPLEXAAS_SERVICEFAMILY",
"targetTypes": [
"Cfw_Xaas_DB_Service",
"cfw_xaas_storage_service"
]
},
{
"name": "CFW_SAMPLEXAAS_SERVICE_FOR_NOMEM",
"displayName": "Cfw Sample XaaS - Other Service",
"serviceFamily": "CFW_SAMPLEXAAS_SERVICEFAMILY",
"targetTypes": [
"Cfw_Xaas_DB_Service_for_nomem"
]
}
],
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetypes"
},
"selfLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetypes"
}
}

A GET operation is issued to view details of all the Service requests.

A sample of the response received is shown below.

Status 200 OK
{
name: "Service Requests"
type: "Service Request"
hasMore: false
count: 1
cfwItems: [
{
name: "Request1_21-Dec-13 17:37:34"
id: 27
startDate: "2013-12-22T01:37:34'Z'PDT"
status: "SCHEDULED"
canonicalLink:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicereques
ts/27"
} ]
totalCount: 1
canonicalLink: {
href:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicereques
ts"
}
selfLink: {
ref:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicereques
ts"
}}

A GET operation is issued to view details of a Service request.

A sample of the response received is shown below.

Status 200 OK
{
id: "27"
name: "Request1_21-Dec-13 17:37:34"
startDate: "2013-12-22T01:37:34'Z'PDT"
status: "SUCCESS"
serviceFamily:"CFW_SAMPLEXAAS_SERVICEFAMILY"
canonicalLink:
{
href:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicereques
ts/27"
}
}

A PUT operation is issued to reschedule a Service request.

{
"startDate":"2014-01-19T08:06:39ZPDT"
}

A sample of the response received is shown below.

Status 200 OK
{
"message": "Request 27 rescheduled successfully"
}

A PUT operation is issued to clear a collection of Service requests.

{
    "action": "cleanup",
    "ids": [
        "22,23"
    ]
}

A DELETE operation is issued to cancel a Service request.

A sample of the response received is shown below.

Status 200 OK
{
"message": "Request 27 cancelled successfully"
}

A DELETE operation is issued to clear a list of Service requests.

{
"ids": [
"2",
"4"
]
}

A sample of the response received is shown below.

{
"message": "[\"Request 32 deleted successfully\",\"Request 31 deleted successfully\",\"Request
30 deleted successfully\"]"
}

A GET operation is issued to view details of all the Service instances.

A sample of the response received is shown below.

{
selfLink:
{
href: "em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances"
}
CfwItems: [1]
0: {
guid: "92EB43C3F773F3DF3973C1005C54DC43"
status: "SUCCESS"
serviceType: "CFW_SAMPLEXAAS_SERVICE"
serviceFamily: "CFW_SAMPLEXAAS_SERVICEFAMILY"
name: "dfgdfddd"
canonicalLink: {
href:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servic
einstances/92EB43C3F773F3DF3973C1005C54DC43"
rel: "Canonical"
templated: false
}
hasMore: false
totalResults: 9
}

A GET operation is issued to view details of a Service instance.

A sample of the response received is shown below.

Status 200 OK
{
guid: "92EB43C3F773F3DF3973C1005C54DC43"
serviceType: "CFW_SAMPLEXAAS_SERVICE"
serviceFamily: "CFW_SAMPLEXAAS_SERVICEFAMILY"
name: "dfgdfddd"
canonicalLink: {
href:
"em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances/92EB43C3F773
F3DF3973C1005C54DC43"
}
}

A PUT operation is issued to start a Service instance.

A sample of the response received is shown below.

[
"Request submitted with Request ID : 43"
]

A PUT operation is issued to stop a Service instance.

A sample of the response received is shown below.

[
"Request submitted with Request ID : 44"
]

A PUT operation is issued to delete a Service instance.

A sample of the response received is shown below.

[
"Request submitted with Request ID : 45"
]

A PUT operation is issued to start a list of Service instances.

{
"ids": [
"20E46B615DC70027F76A86FEDAC06D17",
"8EAF6A882337F154A1B6D890AF00999B",
"637B0CE930E36BE5EFFF306BE3E57EFA"
]
}

A sample of the response received is shown below.

[
"Request submitted with Request ID : 34",
"Request submitted with Request ID : 35",
"Request submitted with Request ID : 36"
]

A PUT operation is issued to stop a list of Service instances.

{
"ids": [
"20E46B615DC70027F76A86FEDAC06D17",
"8EAF6A882337F154A1B6D890AF00999B",
"637B0CE930E36BE5EFFF306BE3E57EFA"
]
}

A sample of the response received is shown below.

[
"Request submitted with Request ID : 37",
"Request submitted with Request ID : 38",
"Request submitted with Request ID : 39"
]

A PUT operation is issued to delete a list of Service instances.

{
"ids": [
"20E46B615DC70027F76A86FEDAC06D17",
"8EAF6A882337F154A1B6D890AF00999B",
"637B0CE930E36BE5EFFF306BE3E57EFA"
]
}

A sample of the response received is shown below.

[
"Request submitted with Request ID : 40",
"Request submitted with Request ID : 41",
"Request submitted with Request ID : 42"
]

A GET operation is issued to view details of the Global request settings resource.

A sample of the response received is shown below.

{
"requestSettings": [
{
"description": "This setting controls how far a user can make a request",
"displayName": "Future Reservation Length",
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "No Restriction"
},
{
"description": "This setting controls the maximum duration for which a user can make a
request",
"displayName": "Request duration Length",
"name": "REQUEST_DURATION_LENGTH",
"restrictionPolicy": "No Restriction"
},
{
"description": "This setting controls the maximum duration after which archived requests
will be automatically deleted by the system",
"displayName": "Request Archive Retention Length",
"name": "REQUEST_ARCHIVE_RETENTION_LENGTH",
"restrictionPolicy": "No Restriction"
},
{
"description": "Sharing enabled/disabled",
"name": "SERVICE_INSTANCE_USER_SHARE_ALLOWED",
"value": "false"
},
{
"description": "Sharing enabled/disabled",
"name": "SERVICE_INSTANCE_ROLE_SHARE_ALLOWED",
"value": "false"
}
]
}

A PUT operation is issued to update the Global request settings resource.

{
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Weeks",
"value": "4"
}

A sample of the response received is shown below.

{
"message": "\"Global\" settings updated successfully."
}

A GET operation is issued to view details of the Global request settings for a collection of roles.

A sample of the response received is shown below.

{
"items": [
{
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/
global/roles/SSA01",
"name": "SSA01"
},
{
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/
global/roles/SSA05",
"name": "SSA05"
}
],
"totalResults": 2
}

A POST operation is issued to create Global request settings for a role.

{
"SERVICE_INSTANCE_USER_SHARE_ALLOWED": {
"value": "true"
},
"requestSettings": [
{
"name": "REQUEST_DURATION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Weeks",
"value": "4"
},
{
"name": "REQUEST_ARCHIVE_RETENTION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Hours",
"value": "23"
},
{
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Days",
"value": "21"
}
],
"role": "TVMCFW_R1"
}

A sample of the response received is shown below.

{
"message": "\"Global role \" settings created successfully."
}

A GET operation is issued to view details of Global request settings for a specific role.

A sample of the response received is shown below.

{
"requestSettings": [
{
"description": "This setting controls how far a user can make a request",
"displayName": "Future Reservation Length",
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R1",
"unitOfMeasurement": "Days",
"value": "21"
},
{
"description": "This setting controls the maximum duration for which a user can make a
request",
"displayName": "Request duration Length",
"name": "REQUEST_DURATION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R1",
"unitOfMeasurement": "Weeks",
"value": "4"
},
{
"description": "This setting controls the maximum duration after which archived requests
will be automatically deleted by the system",
"displayName": "Request Archive Retention Length",
"name": "REQUEST_ARCHIVE_RETENTION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R1",
"unitOfMeasurement": "Hours",
"value": "23"
},
{
"description": "Sharing enabled/disabled",
"name": "SERVICE_INSTANCE_USER_SHARE_ALLOWED",
"value": "true"
},
{
"description": "Sharing enabled/disabled",
"name": "SERVICE_INSTANCE_ROLE_SHARE_ALLOWED",
"value": "true"
}
]
}

A PUT operation is issued to update the Global request settings for a specific role.

{
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Years",
"value": "75"
}

A sample of the response received is shown below.

{
"message": "\"Global role \" settings updated successfully."
}

A DELETE operation is issued to delete Global request settings for a specific role.

A sample of the response received is shown below.

{
"message": "\"Global role \" settings deleted successfully."
}

A GET operation is issued to view details of the Request Settings for a service family.

A sample of the response received is shown below.

{
"requestSettings": [
{
"description": "This setting controls how far a user can make a request",
"displayName": "Future Reservation Length",
"family": "cfw_samplexaas_servicefamily",
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Days",
"value": "25"
},
{
"description": "This setting controls if there is a restriction on the maximum duration
for which requests can be made",
"displayName": "Request Duration Restricted",
"family": "cfw_samplexaas_servicefamily",
"name": "REQUEST_DURATION_LENGTH",
"restrictionPolicy": "No Restriction"
},
{
"description": "This setting controls if there is a restriction on the maximum duration
after which archived requests will be automatically deleted by the system",
"displayName": "Request Archive Retention Restricted",
"family": "cfw_samplexaas_servicefamily",
"name": "REQUEST_ARCHIVE_RETENTION_LENGTH",
"restrictionPolicy": "No Restriction"
},
{
"displayName": "Service Instance Sharing With Users Restricted",
"family": "cfw_samplexaas_servicefamily",
"name": "SERVICE_INSTANCE_USER_SHARE_ALLOWED",
"value": "false"
},
{
"displayName": "Service Instance Sharing With Roles Restricted",
"family": "cfw_samplexaas_servicefamily",
"name": "SERVICE_INSTANCE_ROLE_SHARE_ALLOWED",
"value": "false"
}
]
}

A PUT operation is issued to update the Request Settings for a Service family.

{
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Weeks",
"value": "4"
}

A sample of the response received is shown below.

{
"message": "\"Family \" settings updated successfully."
}

A GET operation is issued to view details of the Service family settings by roles.

A sample of the response received is shown below.

{
"items": [
{
"href":
"https://xx.idc.example.com:34518/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/r
equestsettings/servicefamily/cfw_samplexaas_servicefamily/roles/TVMCFW_R2",
"name": "TVMCFW_R2"
}
],
"totalResults": 1
}

A POST operation is issued to create Service family settings for a role.

{
"SERVICE_INSTANCE_USER_SHARE_ALLOWED": {
"value": "true"
},
"requestSettings": [
{
"name": "REQUEST_DURATION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Weeks",
"value": "14"
},
{
"name": "REQUEST_ARCHIVE_RETENTION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Hours",
"value": "123"
},
{
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Days",
"value": "121"
}
],
"role": "TVMCFW_R2"
}

A sample of the response received is shown below.

{
"message": "\"Family role \" settings created successfully."
}

A GET operation is issued to view details of the Service family request settings for a specific role.

A sample of the response received is shown below.

{
"requestSettings": [
{
"description": "This setting controls how far a user can make a request",
"displayName": "Future Reservation Length",
"family": "cfw_samplexaas_servicefamily",
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R2",
"unitOfMeasurement": "Days",
"value": "121"
},
{
"description": "This setting controls the maximum duration for which a user can make a
request",
"displayName": "Request duration Length",
"family": "cfw_samplexaas_servicefamily",
"name": "REQUEST_DURATION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R2",
"unitOfMeasurement": "Weeks",
"value": "14"
},
{
"description": "This setting controls the maximum duration after which archived requests
will be automatically deleted by the system",
"displayName": "Request Archive Retention Length",
"family": "cfw_samplexaas_servicefamily",
"name": "REQUEST_ARCHIVE_RETENTION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R2",
"unitOfMeasurement": "Hours",
"value": "123"
},
{
"description": "Sharing enabled/disabled",
"name": "SERVICE_INSTANCE_USER_SHARE_ALLOWED",
"value": "false"
},
{
"description": "Sharing enabled/disabled",
"name": "SERVICE_INSTANCE_ROLE_SHARE_ALLOWED",
"value": "false"
}
]
}

A PUT operation is issued to update the Service family request settings for a specific role.

{
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Years",
"value": "75"
}

A sample of the response received is shown below.

{
"message": "\"Family role\" settings updated successfully."
}

A DELETE operation is issued to delete Service family request settings for a specific role.

A sample of the response received is shown below.

{
"message": "\"Family role \" settings deleted successfully."
}

A GET operation is issued to view details of the Request settings for a service type.

A sample of the response received is shown below.

{
"requestSettings": [
{
"description": "This setting controls if there is a restriction on how far a user can
make a request",
"displayName": "Future Reservation Restricted",
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "No Restriction",
"serviceType": "cfw_samplexaas_service"
},
{
"description": "This setting controls if there is a restriction on the maximum duration
for which requests can be made",
"displayName": "Request Duration Restricted",
"name": "REQUEST_DURATION_LENGTH",
"restrictionPolicy": "No Restriction",
"serviceType": "cfw_samplexaas_service"
},
{
"description": "This setting controls if there is a restriction on the maximum duration
after which archived requests will be automatically deleted by the system",
"displayName": "Request Archive Retention Restricted",
"name": "REQUEST_ARCHIVE_RETENTION_LENGTH",
"restrictionPolicy": "No Restriction",
"serviceType": "cfw_samplexaas_service"
},
{
"displayName": "Service Instance Sharing With Users Restricted",
"name": "SERVICE_INSTANCE_USER_SHARE_ALLOWED",
"serviceType": "cfw_samplexaas_service",
"value": "false"
},
{
"displayName": "Service Instance Sharing With Roles Restricted",
"name": "SERVICE_INSTANCE_ROLE_SHARE_ALLOWED",
"serviceType": "cfw_samplexaas_service",
"value": "false"
}
]
}

A PUT operation is issued to update the Request settings for a service type.

{
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Weeks",
"value": "4"
}

A sample of the response received is shown below.

{
"message": "\"Servicetype \" settings updated successfully."
}

A GET operation is issued to view details of the Service type settings by roles.

A sample of the response received is shown below.

{
"items": [
{
"href":
"https://xx.idc.example.com:34518/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/r
equestsettings/servicetype/cfw_samplexaas_service/roles/TVMCFW_R3",
"name": "TVMCFW_R3"
}
],
"totalResults": 1
}

A POST operation is issued to create a Service type settings for roles.

{
"SERVICE_INSTANCE_USER_SHARE_ALLOWED": {
"value": "true"
},
"requestSettings": [
{
"name": "REQUEST_DURATION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Weeks",
"value": "14"
},
{
"name": "REQUEST_ARCHIVE_RETENTION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Hours",
"value": "123"
},
{
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Days",
"value": "121"
}
],
"role": "TVMCFW_R3"
}

A sample of the response received is shown below.

{
"message": "\"Servicetype role \" settings created successfully."
}

A GET operation is issued to view details of the Service type request settings for a specific role.

A sample of the response received is shown below.

{
"requestSettings": [
{
"description": "This setting controls how far a user can make a request",
"displayName": "Future Reservation Length",
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R3",
"serviceType": "cfw_samplexaas_service",
"unitOfMeasurement": "Days",
"value": "121"
},
{
"description": "This setting controls the maximum duration for which a user can make a
request",
"displayName": "Request duration Length",
"name": "REQUEST_DURATION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R3",
"serviceType": "cfw_samplexaas_service",
"unitOfMeasurement": "Weeks",
"value": "14"
},
{
"description": "This setting controls the maximum duration after which archived requests
will be automatically deleted by the system",
"displayName": "Request Archive Retention Length",
"name": "REQUEST_ARCHIVE_RETENTION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R3",
"serviceType": "cfw_samplexaas_service",
"unitOfMeasurement": "Hours",
"value": "123"
},
{
"description": "Sharing enabled/disabled",
"name": "SERVICE_INSTANCE_USER_SHARE_ALLOWED",
"value": "false"
},
{
"description": "Sharing enabled/disabled",
"name": "SERVICE_INSTANCE_ROLE_SHARE_ALLOWED",
"value": "false"
}
]
}

A PUT operation is issued to update the Service type request settings for a specific role.

{
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Years",
"value": "75"
}

A sample of the response received is shown below.

{
"message": "\"Servicetype role \" settings updated successfully."
}

A DELETE operation is issued to delete Service type request settings for a specific role.

A sample of the response received is shown below.

{
"message": "\"Servicetype role \" settings deleted successfully."
}

A GET operation is issued to view details of all the registered VM Adapters.

A sample of the response received is shown below.

{ "name":"VMAdapters",
"type":"VMAdaptersCollection",
"totalResults":1, 
"items":[ { "id":"1",
"name":"SAMPLEADAPTER", 
"displayName":"SampleAdapter", 
"description":"SampleStand alone adapter",
"instances":{ "count":0, "href":"https://cloudcompany.com/em/websvcs/restful//extws/cloudservices/admin/cfw/v2/resourceproviders/?propertyname=adaptertype&propertyvalue=SAMPLEADAPTER" },
 "canonicalLink":{ "href":"https://cloudcompany.com/em/websvcs/restful//extws/cloudservices/admin/cfw/v2/vmadapters/SAMPLEADAPTER" } } ],
"canonicalLink":{ "href":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/vmadapters/" }}

A GET operation is issued to view details of a registered VM Adapter.

A sample of the response received is shown below.

{ "name": "SAMPLEADAPTER", 
"connection": { "endpoints": [ { "purpose": "login_url", "custom": [ { "name": "CloudType", "type": "STRING", "description": "CoudType, e.g. openstack, ec2, etc", "displayName": "CoudType", "required": false, "secret": false }, 
{ "name": "custom_param1", "type": "STRING", "description": "Custom parameter", "displayName": "Custom parameter", "required": false, "secret": false } ] } ], "virtualizationContainers": [ { "name": "Zone" } ] }, "proxies": [ {} ]}

A GET operation is issued to view details of the staging servers.

A sample of the response received is shown below.

{ "name" : "StagingServers", "totalResults" : 1, "items" : [ { "location" : "script/location", "targetName" : "blr2223141.yourcompany.com",
"targetGuid" : "5BC2376B484BC065B6661458DAF1F56D", "credentialGuid" : "25D30ADD427484310DBC8CF6211A383B" } ],
"canonicalLink" : { "href" : "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/vmadapters/stagingservers" }}

A POST operation is issued to create a staging server.

{ "targetName" : "blr2223141.yourcompany.com",
"location" : "script/location", 
"credentialGuid" : "25D30ADD427484310DBC8CF6211A383B"}

A sample of the response received is shown below.

{ "message" : "StagingServer created successfully."}

The table below shows the GET configuration for viewing the metadata.

A sample of the response received is shown below.

Status 200 OK 
Content-Type: application/json
{
  "constraints" : [ {
    "name" : "MAX_CPU_UTILIZATION",
    "description" : "Maximum CPU Utilization (%)",
    "value" : "80"
  }, {
    "name" : "MAX_MEMORY_ALLOCATION",
    "description" : "Maximum Memory Allocation (%)",
    "value" : "80"
  } ],
  "memberTargetTypes" : [ "oracle_vm_zone", "host" ],
  "message" : "When creating Paas Infrastructure zone: (1) member_type should be set to one of the values shown in member target types. All Zone members have to be of the same type. (2) Please change the value of the constraints as required."
}

The table below shows the GET configuration for listing the PaaS zones.

A sample of the response received is shown below.

Status 200 OK 
Content-Type: application/json	
{
  "name" : "Paas Zones",
  "type" : "Paas Infrastructure Zone",
  "hasMore" : false,
  "count" : 4,
  "items" : [ {
    "name" : "pzone1",
    "id" : "A3CF2D49CFF3F3E664D073303EA51F8E",
    "type" : "self_service_zone",
    "canonicalLink" : 
"https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/A3CF2D49CFF3F3E664D073303EA51F8E"
  }, {
    "name" : "Test Zone 2",
    "id" : "EF3830C71CC54B50B963376F9217AB95",
    "type" : "self_service_zone",
    "description" : "with MAX_CPU_UTILIZATION ",
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/EF3830C71CC54B50B963376F9217AB95"
  }, {
    "name" : "test paas zone",
    "id" : "5D7548C1B879A51CFD894CEA8D5FB19B",
    "type" : "self_service_zone",
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/5D7548C1B879A51CFD894CEA8D5FB19B"
  }, {
    "name" : "Test Zone",
    "id" : "CACBB07A674F280DF84FC4CBFA76DFA7",
    "type" : "self_service_zone",
    "description" : "with MAX_CPU_UTILIZATION ",
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/CACBB07A674F280DF84FC4CBFA76DFA7"
  } ],
  "totalCount" : 4,
  "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones",
  "selfLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones"
}

The table below shows the POST configuration for creating a PaaS zone.

{
    "name":"My Test Zone",
    "description":"This is a TestZone",
    "credential":"NCAIME",
    "memberType":"host",
    "members":[
        "slc05gvt.us.example.com"
    ],
    "constraints":[
        {
            "name":"MAX_CPU_UTILIZATION",
            "value":"85"
        },
        {
            "name":"MAX_MEMORY_ALLOCATION",
            "value":"95"
        }
    ],
    "roles":[
        "SSACOREROLE1",
        "SSACOREROLE2"
    ],
    
}

A sample of the response received is shown below.

Status 201 Created 
Content-Type: application/json
{
  "name" : "My Test Zone",
  "description" : "This is a TestZone",
  "type" : "PaaS Infrastructure Zone",
  "id" : "DDBFEFDAD2AE6490E040F00AA37D4C67",
  "credential" : "NCAIME",
  "members" : {
    "canonicalLink" : 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67/members",
    "memberType" : "host",
    "numberOfHostMembers" : "1"
  },
  "constraints" : {
    "canonicalLink" : 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67/constraints",
    "numberOfConstraints" : "2"
  },
  "roles" : {
    "canonicalLink" : 
"https://cloudcompany.com.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67/roles",
    "numberOfUserRoles" : "2"
  },
  "pools" : {
    "canonicalLink" : 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67/pools",
    "numberOfSoftwarePools" : "0"
  },
  "createdOn" : "2013-05-27 20:57:18",
  "createdBy" : null,
  "modifiedOn" : null,
  "modifiedBy" : null,
  "owner" : "SYSMAN",
  "etag" : null,
  "lastModified" : null,
  "canonicalLink" : 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67",
  "selfLink" : 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67"
}

The table below shows the PUT configuration for updating a PaaS zone.

{
    "name":"My Test Zone",
    "credential":"NCAIME2",
    "description":"Description_01",
    "membersToAdd":[
        "somehost.com",
        "someotherhost.com"
    ],
    "membersToRemove":[
        "removehost.com",
        "removeotherhost2.com"
    ]
    ,
    "rolesToAdd":[
        "ROLE_1",
        "ROLE_2"
    ],
    "rolesToRemove":[
        "ROLE_1_1",
        "ROLE_2_1"
    ],
    "constraints":[
        {
            "name":"MAX_MEMORY_ALLOCATION",
            "value":"80"
        },
         {
            "name":"MAX_CPU_UTILIZATION",
            "value":"80"
        }
    ]
}

A sample of the response received is shown below.

Status 200 OK 
Content-Type: application/json
{
  "message" : "PaaS Infrastructure Zone "My Test Zone" updated successfully."
}

The table below shows the DELETE configuration for deleting a PaaS zone.

A sample of the response received is shown below.

Status 200 OK 
Content-Type: application/json
{
  "message" : "PaaS Infrastructure Zone  "DDBFEFDAD2AE6490E040F00AA37D4C67" deleted    successfully."
}

The table below shows the GET configuration for viewing details of a PaaS zone.

A sample of the response received is shown below.

Status 200 OK 
Content-Type: application/json
{
  "name" : "pzone1",
  "description" : "This zone contains Host members",
  "type" : "PaaS Infrastructure Zone",
  "id" : "A3CF2D49CFF3F3E664D073303EA51F8E",
  "credential" : "SXAASJUNITHOSTCRED",
  "members" : {
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/A3CF2D49CFF3F3E664D073303EA51F8E/members",
    "memberType" : "host",
    "numberOfHostMembers" : "2"
  },
  "constraints" : {
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/A3CF2D49CFF3F3E664D073303EA51F8E/constraints",
    "numberOfConstraints" : "2"
  },
  "roles" : {
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/A3CF2D49CFF3F3E664D073303EA51F8E/roles",
    "numberOfUserRoles" : "1"
  },
  "pools" : {
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/A3CF2D49CFF3F3E664D073303EA51F8E/pools",
    "numberOfSoftwarePools" : "0"
  },
  "createdOn" : "2013-05-22 01:50:30",
  "createdBy" : null,
  "modifiedOn" : null,
  "modifiedBy" : null,
  "owner" : "SYSMAN",
  "etag" : null,
  "lastModified" : null,
  "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/A3CF2D49CFF3F3E664D073303EA51F8E",
  "selfLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/A3CF2D49CFF3F3E664D073303EA51F8E"
}

The get request supports expands query parameter. Based on this query parameter the relevant attribute for a PaasZone is expanded.

The following query parameters are supported:

• members

• role

• constraints

• pools

The table below shows the GET configuration for expanded view of a PaaS zone.

A sample of the response received is shown below.

{
  "name" : "My Test Zone",
  "description" : "Description_02",
  "type" : "PaaS Infrastructure Zone",
  "id" : "DDBFEFDAD2AE6490E040F00AA37D4C67",
  "credential" : "C",
  "members" : {
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67/members",
    "memberType" : "host",
    "numberOfHostMembers" : "1"
  },
  "constraints" : {
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67/constraints",
    "items" : [ {
      "name" : "MAX_MEMORY_ALLOCATION",
      "value" : "25"
    }, {
      "name" : "MAX_CPU_UTILIZATION",
      "value" : "25"
    } ]
  },
  "roles" : {
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67/roles",
    "numberOfUserRoles" : "0"
  },
  "pools" : {
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67/pools",
    "numberOfSoftwarePools" : "0"
  },
  "createdOn" : "2013-05-27 20:57:18",
  "createdBy" : null,
  "modifiedOn" : null,
  "modifiedBy" : null,
  "owner" : "SYSMAN",
  "etag" : null,
  "lastModified" : null,
  "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67",
  "selfLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67"
}

The table below shows the GET configuration for viewing details of the Software pools.

A sample of the response received is shown below.

Status 200 OK 
Content-Type: application/json 
{
name: "Software Pools"
type: "Software Pool"
hasMore: false
count: 2
items: [2]
0:  {
name: "IT_MW_Pool_2"
type: "mwaas_zone"
id: "E284FAAA7FBA6A06F7090115A3E07299"
zoneName: "IT_MW_Zone1"
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/E284FAAA7FBA6A06F7090115A3E07299"
description: "Middleware Pool of Oracle Homes of Version 10.3.5.0"
}-
1:  {
name: "IT_MW_Pool1"
type: "mwaas_zone"
id: "DD73A46E9E3C9866E040F00AE5235A7F"
zoneName: "IT_MW_Zone1"
canonicalLink:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/DD73A46E9E3C9866E040F00AE5235A7F"
description: "Middleware Pool of Oracle Homes"
}-
-
totalCount: 2
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/"
selfLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/"
}

Search on the Software Pools is supported on the following by the following query parameters:

• zonename

• pooltype

Single or multiple search parameters may be specified at once. Wildcard search is supported using '%' character.

The table below shows the GET configuration for filtering the Software pools.

A sample of the response received is shown below.

Status 200 OK 
Content-Type: application/json 
{
name: "Software Pools"
type: "Software Pool"
hasMore: false
count: 1
items: [1]
0:   {
name: "IT_MW_Pool1"
type: "mwaas_zone"
id: "DD73A46E9E3C9866E040F00AE5235A7F"
zoneName: "IT_MW_Zone1"
canonicalLink: 
"https://cloudcompany/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/DD73A46E9E3C9866E040F00AE5235A7F"
description: "Middleware Pool of Oracle Homes"
}
 
totalCount:1 
canonicalLink: 
"https:// cloudcompany/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/"
selfLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/"
}

A POST operation is issued on Software Pools Collection resource to create a Software Pool.

The table below shows the POST configuration for creating a Software pool.

{ 
"name": "IT_MW_Pool1", 
"poolTargetType": "mwaas_zone",
"description": "Middleware Pool of Oracle Homes",
"paasZone": "IT_MW_Zone1",
"members": ["WebLogicServer10_3_6_0_slc01afx_6775","WebLogicServer10_3_6_0_adc2201439_4731"],
"constraints": 
            {"items": [{"name": "MAX_INSTANCES", "value": "10"}]},
"filters": 
         {"items": [{"name": "VERSION","value": "10.3.6.0"}]} 
}   

A sample of the response received is shown below.

Status 201 Created 
Content-Type: application/json
{
name: "IT_MW_Pool1"
description: "Middleware Pool of Oracle Homes"
type: "Middleware Pool"
id: "687FE169ED3556CED38D11DC9BDD5CCD"
zoneName: "IT_MW_Zone1"
members: {
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/members"
numberOfPoolMembers: "2"
}-
constraints: {
canonicalLink:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/constraints"
numberOfConstraints: "1"
}-
filters: {
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/filters"
numberOfFilters: "1"
}-
properties: {
canonicalLink:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/properties"
numberOfPropertiess: "0"
}-
createdOn: "2013-05-24 00:26:42"
createdBy: null
modifiedOn: null
modifiedBy: null
owner: "CLOUD_ADMIN1"
etag: null
lastModified: null
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD"
selfLink:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD"
}

The table below shows the PUT configuration for updating a Software pool.

{ 
"name": "IT_MW_Pool1", 
"poolTargetType": "mwaas_zone",
"description": "Middleware Pool of Oracle Homes Updated",
"membersToAdd": ["WebLogicServer10_3_6_0_slc01afx_6776","WebLogicServer10_3_6_0_adc2201439_4732"],
"constraints": 
            {"items": [{"name": "MAX_INSTANCES", "value": "10"}]},
}            

A sample of the response received is shown below.

Status 200 OK 
Content-Type: application/json 
{
message: "Software Pool  " IT_MW_Pool1" updated successfully."
}

The table below shows the DELETE configuration for deleting a Software pool.

A sample of the response received is shown below.

Status 200 OK 
Content-Type: application/json 
{
message: "Software Pool "687FE169ED3556CED38D11DC9BDD5CCD" deleted successfully."
}

The table below shows the GET configuration for viewing details of a Software pool.

A sample of the response received is shown below.

Status 200 OK 
Content-Type: application/json 
{
name: "IT_MW_Pool1"
description: "Middleware Pool of Oracle Homes"
type: "Middleware Pool"
id: "687FE169ED3556CED38D11DC9BDD5CCD"
zoneName: "IT_MW_Zone1"
members: {
canonicalLink:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/members"
numberOfPoolMembers: "2"
}-
constraints: {
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/constraints"
numberOfConstraints: "1"
}-
filters: {
canonicalLink:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/filters"
numberOfFilters: "1"
}-
properties: {
canonicalLink: https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/properties"
numberOfPropertiess: "0"
}-
createdOn: "2013-05-24 00:26:42"
createdBy: null
modifiedOn: null
modifiedBy: null
owner: "CLOUD_ADMIN1"
etag: null
lastModified: null
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD"
selfLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD"
}

GET operation on SoftwarePool resource supports the expands query parameter to expand the following link resource attributes:

• members: Expands the members attribute to show all the members of this Software Pool.

• filters: Expands the filters attribute to show the filter criteria of the members of this Software Pool.

• constraints: Expands the constraints attribute to show the placement constraints associated with this Software Pool.

• all : Expands all the attributes of the Software Pool when returning the Software Pool details.

The URI has the following format:

https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/{poolid}/?expands=<paramname>

Example:

https://hostname/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD?expands=members

If no query parameter is specified then software pool details data is returned to the user without any attributes expanded.

A GET request is issued to obtain the SoftwarePoolMetadata URI, which is then used to retrieve the metadata information of all the software pool types. Note that you can also use EMCLI commands to retrieve Software Pool information and these commands are described in EM CLI Verbs for SSA Operations for V2

The table below shows the GET configuration for viewing metadata of the Software pools.

A sample of the response received is shown below.

Status 200 OK 
Content-Type: application/json 
 
{
softwarePoolsMetadata: 
{
items: [1]
0:  
{
poolType: "mwaas_zone"
poolTypeDisplayName: "Middleware Pool"
poolTypeDescription: "Middleware Pool is a set of homogeneous Middleware Oracle Homes."
serviceFamily: "MWAAS"
serviceType: "PhysicalWLS"
constraints: 
{
items: [1]
0:  
{
name: "MAX_INSTANCES"
description: "Maximum Number of Java Servers (per host)"
defaultValue: "1"
isRequiredValue: true
}
}
filters: 
{
items: [1]
0:  
{
name: "VERSION"
description: "Version"
defaultValue: "10.3.5.0"
isRequiredValue: true
possibleValues: [7]
0:  
{value: "12.1.1.0"
description: "12.1.1.0"}
1:  
{
value: "10.3.6.0"
description: "10.3.6.0"
}
2:  
{
value: "10.3.5.0"
description: "10.3.5.0"
}
3:  
{
value: "10.3.4.0"
description: "10.3.4.0"
}
4:  
{
value: "10.3.3.0"
description: "10.3.3.0"
}
5:  
{
value: "10.3.2.0"
description: "10.3.2.0"
}
6:  
{
value: "10.3.1.0"
description: "10.3.1.0"
}
}
}
}
}
canonicalLink: "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/metadata"
}

A POST operation on SoftwarePoolFilteredTargets resource is issued to fetch the filtered targets based on the paas zone and filters given. Note that you can also use EMCLI commands to retrieve Filtered Targets information and these commands are described in EM CLI Verbs for SSA Operations for V2

The table below shows the POST configuration for viewing the filtered targets of the Software pools.

{
"targetType": "mwaas_zone",
"paasZone": "IT_MW_Zone1",
"filters": {"items": [{"name": "VERSION", "value": "10.3.6.0"}]}
}

A sample of the response received is shown below.

Status 201 Created 
Content-Type: application/json 
 
{
targets: {
oracle_home: [2]
0:  "WebLogicServer10_3_6_0_slc01afx_6775"
1:  "WebLogicServer10_3_6_0_adc2201439_4731"
}
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/filteredtargets"
}

A GET on SoftwarePoolCapacity resource is issued to get the Software Pool capacity details. Note that you can also use EMCLI commands to retrieve Software Pool Capacity information and these commands are described in EM CLI Verbs for SSA Operations for V2

The table below shows the GET configuration for viewing the Software pool capacity.

A sample of the response received is shown below.

Status 200 OK 
Content-Type: application/json
{
name: "mySchemaPool"
type: "schaas_pool"
capacity: {
items: [1]
0:  {
entityName: "Oemrep_Database"
entityType: "oracle_database"
entityCapacity: {
items: [4]
0:  {
resourceType: "Storage Utilization"
resourceUsed: "64.74"
resourceThreshold: "100.0"
resourceUnit: "%"
}-
1:  {
resourceType: "CPU Utilization"
resourceUsed: "0.0"
resourceThreshold: "0.0"
resourceUnit: "%"
}-
2:  {
resourceType: "Memory Utilization"
resourceUsed: "0.0"
resourceThreshold: "0.0"
resourceUnit: "%"
}-
3:  {
resourceType: "Instances"
resourceUsed: "0"
resourceThreshold: "100"
}-
-
}-
}-
-
}-
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/2E7C9C632B18C3FEB4FEA5A614E51BE7/capacity"
}