Service Management API
{ http://soa.com/uri/products/serviceadmin/wsdl/1.0 } ServiceAdmin
The API used to manage PM services.
POST/servicesCreates a service with an optional reference to a service definition.
Creates a service with given specification and definition document.
Request
POST /rest/services HTTP/1.1
<ServiceImportSpec xmlns="http://soa.com/uri/products/restapi/xsd/1.0">
<ServiceSpec>
<Name>EchoService1</Name>
<Description>This is Echo Service</Description>
<Key>uddi:834fc30e-5ffb-23e4-b3cf-ded8b9chhdgg</Key>
<QName>http://tempuri.org</QName>
<LocalPart>EchoService1</LocalPart>
<Organization>uddi:6c3564d4-fdaf-11e4-82f2-fdaedf0ec346</Organization>
</ServiceSpec>
<DefinitionSpec>
<Location>http://a.b.c.d/EchoSan/Echo.asmx?wsdl</Location>
<UserName>u</UserName>
<Password>p</Password>
<Format>wsdl</Format>
</DefinitionSpec>
</ServiceImportSpec>
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
body
entity
The service spec.
ServiceImportSpec
ServiceImportSpec {
serviceSpec {
endpointSpecs {
EndpointSpecs {}
definitionSpec {
ServiceSpec( serviceSpec, required )
DefinitionSpec( definitionSpec, required )
}
serviceSpec {
Endpoints( endpointSpecs )
Proxy( boolean, required )
Description( string )
Organization( string )
QName( string )
VirtualizedService( string )
Virtual( boolean, required )
Key( string )
Name( string )
}
endpointSpecs {
EndpointSpecs( Collection of EndpointSpecs )
}
EndpointSpecs {}
definitionSpec {
UserName( string )
Format( string )
Location( string )
Password( string )
}
Reponse
Status Code
Reason
Model
201
The service was created successfully. The Location header provides the new service location.
hostedService
hostedService {
atomLink {
nameValuePair {
qname( string )
organization( string )
name( string )
description( string )
Links( Collection of atomLink )
Properties( Collection of nameValuePair )
key( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
nameValuePair {
name( string )
value( string )
}
300
The service could not be imported using the provided spec.
409
The service could not be created becuase it conflicts with an existing service.
500
The service could not be created because of an error.
PUT/services/{key}Update a service definition.
Updates a service name/description with a given key.
Request
PUT /rest/services/{key} HTTP/1.1
Content-Type: application/json
{
"Name":"Changed Name",
"Description":"Changed Description"
}
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
key
path
The service key.
string
body
entity
The service information to update.
serviceSpec
serviceSpec {
endpointSpecs {
EndpointSpecs {}
Endpoints( endpointSpecs )
Proxy( boolean, required )
Description( string )
Organization( string )
QName( string )
VirtualizedService( string )
Virtual( boolean, required )
Key( string )
Name( string )
}
endpointSpecs {
EndpointSpecs( Collection of EndpointSpecs )
}
EndpointSpecs {}
Reponse
Status Code
Reason
Model
201
The service was changed successfully.
404
A service with the given key could not be found.
500
The service could not be changed.
POST/services/importCreates a service with an optional reference to a service definition. Deprecated.
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
body
entity
The service import information.
ServiceImportSpec
ServiceImportSpec {
serviceSpec {
endpointSpecs {
EndpointSpecs {}
definitionSpec {
ServiceSpec( serviceSpec, required )
DefinitionSpec( definitionSpec, required )
}
serviceSpec {
Endpoints( endpointSpecs )
Proxy( boolean, required )
Description( string )
Organization( string )
QName( string )
VirtualizedService( string )
Virtual( boolean, required )
Key( string )
Name( string )
}
endpointSpecs {
EndpointSpecs( Collection of EndpointSpecs )
}
EndpointSpecs {}
definitionSpec {
UserName( string )
Format( string )
Location( string )
Password( string )
}
Reponse
Status Code
Reason
Model
201
The service was created successfully. The location header will hold the URL of the new service.
500
The service could not be created
POST/services/uploadUpload a service definition.
Creates a service with given specification and definition document.
Request
POST /rest/services?name=EchoUploaded&virtual=false&qname=%7Bhttp%3A%2F%2Ftemp.com%7DTempNameSpace&description=Echo+Decsription&key=uddi%3A978841b1-7088-11e4-8574-cb4613969888&org=uddi%3A3ff2aefb-03d3-11e5-9e1a-ed2c43b446f9& HTTP/1.1
Authorization: Basic YTpw
Content-Length: 2938
Content-Type: multipart/form-data; boundary=Jlo6Rm_FfX2_s3WQ5QhfUoY6qqLxTbdyHMSkf0W
Host: localhost:8800
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.0.1 (java 1.5)
--Jlo6Rm_FfX2_s3WQ5QhfUoY6qqLxTbdyHMSkf0W
Content-Disposition: form-data; name="multipart"; filename="Numberbeforeupdate.wsdl"
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary
<?xml version="1.0" encoding="UTF-8"?>
<definitions targetNamespace="http://www.dataaccess.com/webservicesserver/" xmlns:tns="http://www.dataaccess.com/webservicesserver/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns="http://schemas.xmlsoap.org/wsdl/">
<types>
<xs:schema elementFormDefault="qualified" targetNamespace="http://www.dataaccess.com/webservicesserver/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://www.dataaccess.com/webservicesserver/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="NumberToWords">
<xs:complexType>
<xs:sequence>
<xs:element name="ubiNum" type="xs:unsignedLong"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="NumberToWordsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="NumberToWordsResult" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
</types>
<message name="NumberToWordsSoapResponse">
<part name="parameters" element="tns:NumberToWordsResponse">
</part>
</message>
<message name="NumberToWordsSoapRequest">
<part name="parameters" element="tns:NumberToWords">
</part>
</message>
<portType name="NumberConversionSoapType">
<operation name="NumberToWords">
<documentation>Returns the word corresponding to the positive number passed as parameter. Limited to quadrillions.</documentation>
<input message="tns:NumberToWordsSoapRequest">
</input>
<output message="tns:NumberToWordsSoapResponse">
</output>
</operation>
</portType>
<binding name="NumberConversionSoapBinding" type="tns:NumberConversionSoapType">
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
<operation name="NumberToWords">
<soap:operation soapAction="http://number" style="document"/>
<input>
<soap:body use="literal"/>
</input>
<output>
<soap:body use="literal"/>
</output>
</operation>
</binding>
<service name="NumberConversion">
<wsdl:documentation xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">The Number Conversion Web Service, implemented with Visual DataFlex, provides functions that convert numbers into words or dollar amounts.</wsdl:documentation>
<port name="NumberConversionSoap" binding="tns:NumberConversionSoapBinding">
<soap:address location="http://www.dataaccess.com/webservicesserver/numberconversion.wso"/>
</port>
</service>
</definitions>
--Jlo6Rm_FfX2_s3WQ5QhfUoY6qqLxTbdyHMSkf0W--
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
name
query
The service name.
string
key
query
The service key.
string
qname
query
The service qname.
string
description
query
The service description.
string
org
query
The organization key for the target organization.
string
virtual
query
Indicates that the service is virtual. It is not by default.
boolean
virtualized
query
The key of the service to virtualize (if virtual is true).
string
body
entity
The uploaded file.
base64Binary
Reponse
Status Code
Reason
Model
201
The service was created successfully. The location header will hold the URL of the new service.
hostedService
hostedService {
atomLink {
nameValuePair {
qname( string )
organization( string )
name( string )
description( string )
Links( Collection of atomLink )
Properties( Collection of nameValuePair )
key( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
nameValuePair {
name( string )
value( string )
}
500
The service could not be created
GET/services/{key}Get details for a specific hosted service.
Retrieves the service information based on given key.
Request
The following is an example request for a standard service provided with PM called Workflow Service
GET /rest/services/uddi:soa.com:workflow-servicekey HTTP/1.1
Response
{
"name": "Workflow Service",
"description": "Workflow Service",
"key": "uddi:soa.com:workflow-servicekey",
"qname": "{http://www.soa.com/uri/products/Workflow/wsdl/1.0}WorkflowService",
"organization": "uddi:soa.com:managementconfigurationbusinesskey",
"Links":[
{
"rel": "wsdl",
"href": "http://localhost:9900/rest/services/uddi:soa.com:workflow-servicekey/wsdl"
},{
"rel": "self",
"href": "http://localhost:9900/rest/services/uddi:soa.com:workflow-servicekey"
}
]
}
Parameters
Name
Type
Description
Model
key
path
The service key
string
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
hostedService
hostedService {
atomLink {
nameValuePair {
qname( string )
organization( string )
name( string )
description( string )
Links( Collection of atomLink )
Properties( Collection of nameValuePair )
key( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
nameValuePair {
name( string )
value( string )
}
404
A service with the given key was not found.
DELETE/services/{key}Remove a service
Deletes the service associated with given key.
Request
DELETE /rest/services/{key} HTTP/1.1
Parameters
Name
Type
Description
Model
key
path
The service key.
string
Reponse
Status Code
Reason
Model
200
The service was successfully deleted
404
A service with the given key could not be found
GET/services/{key}/processingReturns the debug options of a (virtual) service
Returns the debug options of a service if its virtual.
Parameters
Name
Type
Description
Model
key
path
The service key.
string
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
Success
ProcessingOptions
ProcessingOptions {
LogLevel( int )
}
404
Specified service not found (Invalid key)
GET/services/{key}/metricsGet real-time metrics for a specific hosted service.
Parameters
Name
Type
Description
Model
key
path
The service key
string
operationKey
query
The Operation Key.
string
startDate
query
The Start Date.
string
endDate
query
The End Date.
string
duration
query
The Duration.
string
timeInterval
query
The Time Interval.
string
timeZone
query
The Time Zone.
string
showSummary
query
The Show Summary.
boolean
ReportType
query
Type of Report.
string
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
Graph
Graph {
TestType {
SummaryType {
Metric {
IntervalType {
GeoLocationMetric {
EndTime( dateTime )
Test( Collection of TestType )
StartTime( dateTime )
Summary( SummaryType )
Summaries( Collection of SummaryType )
Interval( Collection of IntervalType )
}
TestType {
Operator( string )
MetricType( string )
Value( integer )
ValueUnit( string )
}
SummaryType {
StartTime( dateTime )
Duration( duration )
Metric( Collection of Metric )
EndTime( dateTime )
}
Metric {
Value( int )
Key( string )
Name( string )
}
IntervalType {
StartTime( dateTime )
GeoLocationMetric( Collection of GeoLocationMetric )
Metric( Collection of Metric )
}
GeoLocationMetric {
Latitude( double )
Count( unsignedInt )
Longitude( double )
Location( string )
}
404
A service with the given key was not found.
GET/services/{key}/definitionGet the available description documents for a specific service.
Retrieves the service information based on given key. The information includes URLs for any available service definitions including, but not limited to, Swagger, WSDL, WADL, RAML.
Request
The following is an example request and response for standard service provided with PM called Workflow Service.
GET /rest/services/uddi:soa.com:workflow-servicekey/definition HTTP/1.1
Response:
[
{
"rel": "wsdl",
"href": "http://localhost:9900/rest/services/uddi:soa.com:workflow-servicekey/definition/wsdl"
},{
"rel": "wadl",
"href": "http://localhost:9900/rest/services/uddi:soa.com:workflow-servicekey/definition/wadl"
},{
"rel": "raml",
"href": "http://localhost:9900/rest/services/uddi:soa.com:workflow-servicekey/definition/raml"
},{
"rel": "swagger",
"href": "http://localhost:9900/rest/services/uddi:soa.com:workflow-servicekey/definition/swagger"
},{
"rel": "swagger2",
"href": "http://localhost:9900/rest/services/uddi:soa.com:workflow-servicekey/definition/swagger2"
},{
"rel": "swagger-yaml",
"href": "http://localhost:9900/rest/services/uddi:soa.com:workflow-servicekey/definition/swagger-yaml"
}
]
Parameters
Name
Type
Description
Model
key
path
The service key
string
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
atomLink
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
404
A service with the given key was not found.
PUT/services/{key}/definitionUpdate a service by importing a new definition
Updates the service definition associated with given key.
Request
PUT /rest/services/{key}/definition HTTP/1.1
Content-Type: application/json
{
"Location":"http://www.holidaywebservice.com/Holidays/US/Dates/USHolidayDates.asmx?WSDL",
"UserName":"u",
"Password": "p"
}
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
key
path
The service key.
string
body
entity
The service import information.
definitionSpec
definitionSpec {
UserName( string )
Format( string )
Location( string )
Password( string )
}
Reponse
Status Code
Reason
Model
201
The service was changed successfully
404
A service with the given key could not be found
500
The service could not be changed
GET/services/{key}/endpointsGet endpoints for a service
Parameters
Name
Type
Description
Model
key
path
string
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
serviceEndpointList
serviceEndpointList {
endpoints {
NameValue {
atomLink {
endpoints( Collection of endpoints )
links( Collection of atomLink )
}
endpoints {
Description( string )
ConnectionProperties( Collection of NameValue )
ServiceKey( string )
useType( string )
ContainerKey( string )
ListenerName( string )
PortName( string )
Url( string )
Weight( nonNegativeInteger )
Name( string )
ContextPath( string )
MessageProperties( Collection of NameValue )
ProtocolVariant( string )
HeaderProperties( Collection of NameValue )
Protocol( string )
BindingQName( string )
}
NameValue {
Value( string )
Name( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
404
A service with the given key could not be found
POST/services/{key}/endpointsAdd an endpoint to a service.
Adds an endpoint to a service. If virtual the endpoint spec must identify a container listener and a path, not a URL. If physical only a URL is needed. Addressing information is specified in the endpoint spec's properties.
Request
POST /rest/services/{key}/endpoints HTTP/1.1
<Endpoint xmlns="http://soa.com/uri/products/restapi/xsd/1.0">
<Description>my port</Description>
<BindingName>{http://tempuri.org/}EchoServiceSoap</BindingName>
<ListenerName>default-http0</ListenerName>
<BindingType>binding.soap11</BindingType>
<ContainerKey>nd3800</ContainerKey>
<Path>/MyPath11/</Path>
<Name>port77</Name>
<ProtocolVariant>weblogic</ProtocolVariant>
<Properties>
<Property>
<name></name>
<value></value>
</Property>
</Properties>
</Endpoint>
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
key
path
The service key.
string
body
entity
The endpoint specification.
Endpoint
Endpoint {
nameValuePair {
Path( string )
Description( string )
BindingName( string )
BindingType( string )
ProtocolVariant( string )
ContainerKey( string )
ListenerName( string )
Properties( Collection of nameValuePair )
Url( string )
Name( string )
}
nameValuePair {
name( string, required )
value( string )
}
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
The endpoint was successfully added
ServiceEndpoint
ServiceEndpoint {
NameValue {
Description( string )
ConnectionProperties( Collection of NameValue )
ServiceKey( string )
useType( string )
ContainerKey( string )
ListenerName( string )
PortName( string )
Url( string )
Weight( nonNegativeInteger )
Name( string )
ContextPath( string )
MessageProperties( Collection of NameValue )
ProtocolVariant( string )
HeaderProperties( Collection of NameValue )
Protocol( string )
BindingQName( string )
}
NameValue {
Value( string )
Name( string )
}
404
A service with the given key could not be found
POST/services/{key}/pkiUploads PKI keys and certificate for a service
Uploads a keystore that holds PKI key/cert data for a service. Form can contain alias parameter, and optionally keystorePass, aliasPass, forceTrust parameters. The parameters can be optional from query if they are not in the submitted form.
Request
POST /rest/services/uddi:978841b1-7088-11e4-8574-cb4613969888/pki HTTP/1.1
Content-Type: multipart/form-data; boundary=Jlo6Rm_FfX2_s3WQ5QhfUoY6qqLxTbdyHMSkf0W
--Jlo6Rm_FfX2_s3WQ5QhfUoY6qqLxTbdyHMSkf0W
Content-Disposition: form-data; name=\"fileUpload\"; filename=\"test.jks\"
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary
<File content omitted>
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
key
path
The service key.
string
keystorePass
query
Keystore password.
string
alias
query
Alias in the keystore to use.
string
aliasPass
query
Alias password. Can be omitted if not needed or the same as the keystore password.
string
forceTrust
query
Add to trust store if not trusted already. If false and not trusted an error will be returned. Can be omitted. Default is false.
boolean
body
entity
The uploaded file.
base64Binary
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
201
The PKI information was successfully created
pkiAndCertificateInfo
pkiAndCertificateInfo {
atomLink {
availablePKIManagementOptions {
certificateInfo {
privateKeyExists( boolean )
Links( Collection of atomLink )
publicKey( string )
managementOptions( availablePKIManagementOptions )
certificateInfo( certificateInfo )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
availablePKIManagementOptions {
import( boolean )
export( boolean )
delete( boolean )
assign( boolean )
}
certificateInfo {
issuerDN( string )
effectiveDate( long )
subjectDN( string )
serialNo( string )
expirationDate( long )
}
404
A service with the given keys could not be found
DELETE/services/{key}/pkiDeletes PKI Keys of a service
Deletes PKI artifacts of a service
Parameters
Name
Type
Description
Model
key
path
The service key.
string
Reponse
Status Code
Reason
Model
200
Success
404
Specified service not found (Invalid key)
GET/services/{key}/pkiReturns Certificate of a service
Get the PKI options for a service.
Parameters
Name
Type
Description
Model
key
path
The service key.
string
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
Success
availablePKIManagementOptions
availablePKIManagementOptions {
import( boolean )
export( boolean )
delete( boolean )
assign( boolean )
}
404
Specified service not found (Invalid key)
PUT/services/{key}/processingChanges the debug options of a (virtual) service
Changes the debug options of a service if its virtual.
Parameters
Name
Type
Description
Model
key
path
The service key.
string
body
entity
Processing options.
ProcessingOptions
ProcessingOptions {
LogLevel( int, required )
}
Reponse
Status Code
Reason
Model
200
Success
404
Specified service not found (Invalid key)
DELETE/services/{key}/definitionRemove all definition documents for a service.
Deletes definition for a service
Request
DELETE /rest/services/uddi:9ba25256-fe81-11e4-9ad6-a3316407e555 HTTP/1.1
Parameters
Name
Type
Description
Model
key
path
The service key.
string
Reponse
Status Code
Reason
Model
200
The service with the given key was successfully deleted.
404
A service with the given key was not found.
PUT/services/{key}/definition/uploadUpdate Service by uploading a new service definition
Updates a given service with given specification and definition document.
Request
PUT /rest/services/uddi:978841b1-7088-11e4-8574-cb4613969888/definition/upload HTTP/1.1
Content-Length: 2940
Content-Type: multipart/form-data; boundary=YlPkO_6HkMh0gXO6-t9U8e7otDRuJJ2WfjxKkMXu
Host: vnukula-e6420:8800
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.0.1 (java 1.5)
Content-Disposition: form-data; name="multipart"; filename="Numberbeforeupdate.wsdl"
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary
<?xml version="1.0" encoding="UTF-8"?>
<definitions targetNamespace="http://www.dataaccess.com/webservicesserver/" xmlns:tns="http://www.dataaccess.com/webservicesserver/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns="http://schemas.xmlsoap.org/wsdl/">
<types>
<xs:schema elementFormDefault="qualified" targetNamespace="http://www.dataaccess.com/webservicesserver/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://www.dataaccess.com/webservicesserver/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="NumberToWords">
<xs:complexType>
<xs:sequence>
<xs:element name="ubiNum" type="xs:unsignedLong"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="NumberToWordsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="NumberToWordsResult" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
</types>
<message name="NumberToWordsSoapResponse">
<part name="parameters" element="tns:NumberToWordsResponse">
</part>
</message>
<message name="NumberToWordsSoapRequest">
<part name="parameters" element="tns:NumberToWords">
</part>
</message>
<portType name="NumberConversionSoapType">
<operation name="NumberToWords">
<documentation>Returns the word corresponding to the positive number passed as parameter. Limited to quadrillions.</documentation>
<input message="tns:NumberToWordsSoapRequest">
</input>
<output message="tns:NumberToWordsSoapResponse">
</output>
</operation>
</portType>
<binding name="NumberConversionSoapBinding" type="tns:NumberConversionSoapType">
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
<operation name="NumberToWords">
<soap:operation soapAction="http://number" style="document"/>
<input>
<soap:body use="literal"/>
</input>
<output>
<soap:body use="literal"/>
</output>
</operation>
</binding>
<service name="NumberConversion">
<wsdl:documentation xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">The Number Conversion Web Service, implemented with Visual DataFlex, provides functions that convert numbers into words or dollar amounts.</wsdl:documentation>
<port name="NumberConversionSoap" binding="tns:NumberConversionSoapBinding">
<soap:address location="http://www.dataaccess.com/webservicesserver/numberconversion.wso"/>
</port>
</service>
</definitions>
--YlPkO_6HkMh0gXO6-t9U8e7otDRuJJ2WfjxKkMXu--
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
key
path
The service key.
string
body
entity
The uploaded file.
base64Binary
Reponse
Status Code
Reason
Model
201
The service was changed successfully
404
A service with the given key could not be found
500
The service could not be changed
GET/services/{key}/endpoints/{name}Get detailed service endpoint information
Parameters
Name
Type
Description
Model
key
path
The service key.
string
name
path
The endpoint name.
string
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
ServiceEndpoint
ServiceEndpoint {
NameValue {
Description( string )
ConnectionProperties( Collection of NameValue )
ServiceKey( string )
useType( string )
ContainerKey( string )
ListenerName( string )
PortName( string )
Url( string )
Weight( nonNegativeInteger )
Name( string )
ContextPath( string )
MessageProperties( Collection of NameValue )
ProtocolVariant( string )
HeaderProperties( Collection of NameValue )
Protocol( string )
BindingQName( string )
}
NameValue {
Value( string )
Name( string )
}
404
A service with the given key, or endpoint with the specified name, could not be found
PUT/services/{key}/endpoints/{name}Changes a given endpoint of a service
Changes an endpoint to a service. If virtual the endpoint spec must identify a container listener. Addressing information is specified in the endpoint spec's properties.
Request
PUT /rest/services/{key}/endpoints/{name} HTTP/1.1" +
{
"Endpoint": {
"-xmlns":"http://soa.com/uri/products/restapi/xsd/1.0",
"Description":"my port9",
"BindingName":"{http://tempuri.org/}EchoServiceSoap",
"ListenerName":"default-http0",
"BindingType":"binding.soap11",
"ContainerKey":"nd3800",
"ContextPath":"/MyPath11/",
"Name":"port99",
"ProtocolVariant":"weblogic",
"Properties": {
"Property": {
}
}
}
}
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
key
path
The service key.
string
name
path
The endpoint name.
string
body
entity
The endpoint specification.
Endpoint
Endpoint {
nameValuePair {
Path( string )
Description( string )
BindingName( string )
BindingType( string )
ProtocolVariant( string )
ContainerKey( string )
ListenerName( string )
Properties( Collection of nameValuePair )
Url( string )
Name( string )
}
nameValuePair {
name( string, required )
value( string )
}
Reponse
Status Code
Reason
Model
200
The endpoint was successfully changed
ServiceEndpoint
ServiceEndpoint {
NameValue {
Description( string )
ConnectionProperties( Collection of NameValue )
ServiceKey( string )
useType( string )
ContainerKey( string )
ListenerName( string )
PortName( string )
Url( string )
Weight( nonNegativeInteger )
Name( string )
ContextPath( string )
MessageProperties( Collection of NameValue )
ProtocolVariant( string )
HeaderProperties( Collection of NameValue )
Protocol( string )
BindingQName( string )
}
NameValue {
Value( string )
Name( string )
}
404
A service with the given key, or endpoint with the specified name, could not be found
DELETE/services/{key}/endpoints/{name}Remove an endpoint
Deletes the given end point associated with the given service.
Request
DELETE /rest/services/{key}/endpoints/{name} HTTP/1.1
Parameters
Name
Type
Description
Model
key
path
The service key.
string
name
path
The endpoint name.
string
Reponse
Status Code
Reason
Model
200
The endpoint was successfully removed
404
A service with the given key, or endpoint with the specified name, could not be found
POST/services/{key}/policies/{type}Attaches policies of the given type to a service
Attaches policies of the given type to the given service.
Request
POST /rest/services/{key}/policies/operational HTTP/1.1
Content-Type: application/xml
<PolicyKey xmlns="http://soa.com/uri/products/restapi/xsd/1.0">myPolicyKey</PolicyKey>
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
key
path
The service key.
string
type
path
The type of policies. Supported values are "operational", "qos", and "compliance". If omitted operational policies are assumed.
string
body
entity
The policies.
policyAttachments
policyAttachments {
Policies( Collection of string )
}
Reponse
Status Code
Reason
Model
200
The policies were successfully attached
404
A service or policy with the given keys could not be found
DELETE/services/{key}/policies/{type}Detaches all policies of the given type from a service
Detaches all the policies of a given type attached to the given service.
Request
DELETE /rest/services/{key}/policies/operational HTTP/1.1
Parameters
Name
Type
Description
Model
key
path
The service key.
string
type
path
The type of policies. Supported values are "operational", "qos", and "compliance". If omitted operational policies are assumed.
string
Reponse
Status Code
Reason
Model
200
The policies were successfully detached
404
A service or policy with the given keys could not be found
POST/services/{key}/pki/assignAssigns PKI Keys to a Service
Add PKI information to a service.
Parameters
Accepts application/xml application/json
Name
Type
Description
Model
key
path
The service key.
string
body
entity
Alias Info.
assignKeyAliasSpec
assignKeyAliasSpec {
password( string )
alias( string, required )
}
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
201
Success
pkiAndCertificateInfo
pkiAndCertificateInfo {
atomLink {
availablePKIManagementOptions {
certificateInfo {
privateKeyExists( boolean )
Links( Collection of atomLink )
publicKey( string )
managementOptions( availablePKIManagementOptions )
certificateInfo( certificateInfo )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
availablePKIManagementOptions {
import( boolean )
export( boolean )
delete( boolean )
assign( boolean )
}
certificateInfo {
issuerDN( string )
effectiveDate( long )
subjectDN( string )
serialNo( string )
expirationDate( long )
}
404
Specified service or pki key not found (Invalid key)
GET/services/{key}/pki/exportReturns Certificate of a service
Returns Certificate of a service
Parameters
Name
Type
Description
Model
key
path
The service key.
string
Reponse
Produces application/octet-stream
Status Code
Reason
Model
200
Success
byte
404
Specified service not found (Invalid key)
GET/services/{key}/pki/infoReturns Certificate of a service
Fetch the PKI information for a service.
Parameters
Name
Type
Description
Model
key
path
The service key.
string
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
Success
pkiAndCertificateInfo
pkiAndCertificateInfo {
atomLink {
availablePKIManagementOptions {
certificateInfo {
privateKeyExists( boolean )
Links( Collection of atomLink )
publicKey( string )
managementOptions( availablePKIManagementOptions )
certificateInfo( certificateInfo )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
availablePKIManagementOptions {
import( boolean )
export( boolean )
delete( boolean )
assign( boolean )
}
certificateInfo {
issuerDN( string )
effectiveDate( long )
subjectDN( string )
serialNo( string )
expirationDate( long )
}
404
Specified service not found (Invalid key)
GET/services/{key}/definition/{format}Get a particular description document for a service.
Retrieves the service definition in given format, e.g. WSDL, WADL and RAML.
Request
GET /rest/services/uddi:9ba25256-fe81-11e4-9ad6-a3316407e555/definition/wsdl HTTP/1.1
Response
The following is an example of a response for a simple Echo service. Parts of the response are omitted for brevity
<wsdl:definitions targetNamespace="http://tempuri.org/" xmlns:s="http://www.w3.org/2001/XMLSchema"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"
xmlns:tns="http://tempuri.org/"
xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/"
xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<wsdl:types>
</wsdl:types>
<wsdl:message name="EchoSoapOut">
<wsdl:part name="parameters" element="tns:EchoResponse"></wsdl:part>
</wsdl:message>
<wsdl:message name="EchoSoapIn">
<wsdl:part name="parameters" element="tns:Echo"></wsdl:part>
</wsdl:message>
<wsdl:portType name="EchoServiceSoap">
<wsdl:operation name="Echo">
<wsdl:input message="tns:EchoSoapIn"></wsdl:input>
<wsdl:output message="tns:EchoSoapOut"></wsdl:output>
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="EchoServiceSoap12" type="tns:EchoServiceSoap">
</wsdl:binding>
<wsdl:binding name="EchoServiceSoap" type="tns:EchoServiceSoap">
</wsdl:binding>
<wsdl:service name="EchoService">
<wsdl:port name="port77" binding="tns:EchoServiceSoap">
<soap:address location="http://VNUKALA-E6420.soa.local:9901/MyPath11/"/>
</wsdl:port>
<wsdl:port name="MyPort4" binding="tns:EchoServiceSoap">
<soap:address location="http://VNUKALA-E6420.soa.local:9901/MyPath11/"/>
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
Parameters
Name
Type
Description
Model
key
path
The service key
string
format
path
The desired document format, e.g. "wsdl", "wadl", "raml","swagger"
string
Reponse
Produces */*
Status Code
Reason
Model
200
any
404
A service with the given key was not found or there was no descriptor available in the specified format.
GET/services/{key}/definition/{format}/{reference:.+}Get a document referenced from a description document.
Retrieves the contents of document referenced from a given wsdl/wadl/raml document
Request
GET /rest/services/uddi:9ba25256-fe81-11e4-9ad6-a3316407e555/definition/wsdl/{reference} HTTP/1.1
Parameters
Name
Type
Description
Model
key
path
The service key.
string
format
path
The desired document format, e.g. "wsdl", "wadl", "raml","swagger"
string
reference
path
The document reference.
string
Reponse
Produces */*
Status Code
Reason
Model
200
any
404
A service with the given key, or the referenced document, was not found.
