Create a Service
post
/apiplatform/management/v1/services
Creates a Service.
Users requesting this resource must be assigned the Service Manager role.
Request
Supported Media Types
- application/json
Nested Schema : ServiceIdentity
Type:
Show Source
object
-
name:
string
The service's name.
-
version(optional):
string
The service's version.
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 : ServiceState
Type:
Show Source
object
-
state(optional):
string
The service's state.
ACTIVE
indicates it can be referenced in policies;INACTIVE
indicates it can't be referenced in policies. -
stateComments(optional):
string
Comments about the service's state.
-
stateUpdatedAt(optional):
string
The date and time the service state was last updated.
-
stateUpdatedBy(optional):
string
The user who last updated the service state.
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
201 Response
The service was created.
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 create a service by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X POST
-H "Authorization: Bearer access_token"
-H "Content-Type:application/json"
-d @services-post.json
https://example.com/apiplatform/management/v1/services
Example of Request Body
The following shows an example of the request body in JSON format (included with the request above in a file named services-post.json
) including details about the new service.
{
"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 201 Created Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Wed, 26 Jul 2017 17:10:11 GMT Content-Length: 12 Content-type: application/json X-oracle-dms-ecid: kKFfG1P0000000000 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc-config Proxy-agent: Oracle-Traffic-Director/12.2.1.2.0
Example of Response Body
The following example shows the contents of the response body in JSON format, including the ID of the created service.
{ "id": "100" }