Update a Service
put
/apiplatform/management/v1/services/{serviceId}
Updates the {serviceId}
service.
Users requesting this resource must be assigned the Service Manager role and must be issued the Manage Service grant for the specified service.
Request
Supported Media Types
- application/json
Path Parameters
-
serviceId: string
A unique ID referencing a specific service.
Nested Schema : ServiceDef
Type:
Show Source
object
-
description(optional):
string
The service's description.
-
implementation(optional):
object implementation
The service's configuration.
-
specification(optional):
object specification
The service's configuration.
-
type(optional):
string
The service's type. One of HTTP, REST or SOAP.
Nested Schema : specification
Type:
object
The service's configuration.
Show Source
-
type(optional):
string
The specification type. Currently limited to WSDL.
-
wsdl(optional):
object wsdl
The WSDL specification configuration
Nested Schema : wsdl
Type:
object
The WSDL specification configuration
Show Source
-
artifact(optional):
string
pathname of the artifact.
-
binding(optional):
string
binding defining the SOAP service (as a QName).
-
root(optional):
string
in case the artifact is a ZIP file containing WSDLs and XML Schemas, root points to the root WSDL defining the SOAP service..
Response
Supported Media Types
- application/json
200 Response
The service was updated.
400 Response
Bad request, indicates a problem with the input parameters.
Root Schema : Error
Type:
Show Source
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
403 Response
Forbidden.
Root Schema : Error
Type:
Show Source
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
500 Response
Unexpected error.
Root Schema : Error
Type:
Show Source
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
Examples
The following example shows how to update a service by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X PUT
-H "Authorization: Bearer access_token"
-H "Content-Type:application/json"
-d @service-update.json
https://example.com/apiplatform/management/v1/services/{serviceId}
where {serviceId}
is a unique Id of a specific service. See Get Services.
Example of Request Body
The following shows an example of the request body, included with the request above in a file named service-update.json
.
{ "name": "traffic", "description": "canned service", "implementation": { "executions": { "request": [ "1" ], "response": [ "2" ] }, "policies": [ { "id": "1", "type": "o:BackendRequest", "version": "1.0", "config": { "endpoints": [ { "url": "http://host:80/endpoint" } ] } }, { "id": "2", "type": "o:BackendResponse", "version": "1.0", "config": {} } ] } }
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 204 No Content Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Sun, 22 Oct 2017 08:34:10 GMT X-oracle-dms-ecid: 49d14691-2176-4c99-aed3-38438604f528-00001e4e X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0