Get Service details
/apiplatform/management/v1/services/{serviceId}
Returns the details of the {serviceId}
service. The response also contains HATEOAS links to related operations.
Users requesting this resource must be assigned the API Manager, Gateway Manager, or Service Manager role and must be issued the Manage Service or View All Details grants for the specified service.
Request
- application/json
-
serviceId: string
A unique ID referencing a specific service.
-
fields(optional): array
Collection Format:
csv
Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values. - links(optional): array
Response
- application/json
200 Response
object
-
links(optional):
array links
Includes 'canonical'.
object
-
href(optional):
string
Link href.
-
method(optional):
string
HTTP Operation GET, POST, PUT
-
rel(optional):
string
Link relation.
object
-
name:
string
The service's name.
-
version(optional):
string
The service's version.
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.
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.
object
-
createdAt(optional):
string
The date and time the service was created.
-
createdBy(optional):
string
The user who created the service.
-
updatedAt(optional):
string
The date and time the service was last updated.
-
updatedBy(optional):
string
The user who last updated the service.
object
-
type(optional):
string
The specification type. Currently limited to WSDL.
-
wsdl(optional):
object wsdl
The WSDL specification configuration
object
-
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..
403 Response
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
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 retrieve the details of the service by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X GET
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/services/{serviceId}
where {serviceId}
is the unique Id of the service. To retrieve the available services, see Get Services.
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Mon, 18 Dec 2017 07:24:25 GMT Content-Length: 3530 Content-Type: application/json X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-00018fc1 X-oracle-dms-rid: 0 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0
Example of Response Body
The following shows an example of the response body of the service type HTTP.
{ "createdAt": "2018-01-23T20:01:18-0800", "updatedBy": "apicsadmin", "createdBy": "apicsadmin", "implementation": { "executions": { "request": [ "1" ], "response": [ "2" ] }, "policies": [ { "id": "1", "type": "o:BackendRequest", "version": "1.0", "config": { "endpoints": [ { "useProxy": false, "url": "http://www.google.com" } ] } }, { "id": "2", "type": "o:BackendResponse", "version": "1.0", "config": {} } ] }, "name": "xyx", "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "http://example.com:443/apiplatform/management/v1/services/102" }, { "templated": "true", "method": "GET", "rel": "canonical", "href": "http://example.com:443/apiplatform/management/v1/services/102" }, { "templated": "true", "method": "GET", "rel": "preview", "href": "http://example.com:443/apiplatform/management/v1/services/102/preview" }, { "templated": "true", "method": "GET", "rel": "history", "href": "http://example.com:443/apiplatform/management/v1/services/102/history" }, { "templated": "true", "method": "PUT", "rel": "edit", "href": "http://example.com:443/apiplatform/management/v1/services/102" }, { "templated": "true", "method": "PUT", "rel": "rename", "href": "http://example.com:443/apiplatform/management/v1/services/102/identity" }, { "templated": "true", "method": "DELETE", "rel": "delete", "href": "http://example.com:443/apiplatform/management/v1/services/102" }, { "templated": "true", "method": "PUT", "rel": "activate", "href": "http://example.com:443/apiplatform/management/v1/services/102/state" }, { "templated": "true", "method": "PUT", "rel": "inactivate", "href": "http://example.com:443/apiplatform/management/v1/services/102/state" }, { "templated": "true", "method": "GET", "rel": "references", "href": "http://example.com:443/apiplatform/management/v1/services/102/references" }, { "templated": "true", "method": "GET", "rel": "references.serviceaccounts", "href": "http://example.com:443/apiplatform/management/v1/services/102/references/serviceaccounts" }, { "templated": "true", "method": "GET", "rel": "grants", "href": "http://example.com:443/apiplatform/management/v1/services/102/grants" } ], "state": "ACTIVE", "id": "102", "type": "HTTP", "updatedAt": "2018-01-23T20:01:18-0800", "artifacts": [] }
The following shows an example of the response body of the service type SOAP.
{ "updatedBy": "apicsadmin", "implementation": { "executions": { "request": [ "1" ], "response": [ "2" ] }, "policies": [ { "id": "1", "type": "o:BackendRequest", "version": "1.0", "config": { "endpoints": [ { "name": "RandServicePort", "useProxy": false, "url": "http://example.com:443/jetty/soapServices/Rand" } ] } }, { "id": "2", "type": "o:BackendResponse", "version": "1.0", "config": {} } ] }, "specification": { "wsdl": { "artifact": "mywsdl2.zip", "root": "wsdl0.wsdl", "binding": "{http://soap.services.test.apiplatform.oracle.com/}RandServicePortBinding" }, "type": "WSDL" }, "type": "SOAP", "version": "1", "createdAt": "2018-01-22T18:40:56-0800", "createdBy": "apicsadmin", "name": "test", "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "http://example.com:443/apiplatform/management/v1/services/100" }, { "templated": "true", "method": "GET", "rel": "canonical", "href": "http://example.com:443/apiplatform/management/v1/services/100" }, { "templated": "true", "method": "GET", "rel": "preview", "href": "http://example.com:443/apiplatform/management/v1/services/100/preview" }, { "templated": "true", "method": "GET", "rel": "history", "href": "http://example.com:443/apiplatform/management/v1/services/100/history" }, { "templated": "true", "method": "PUT", "rel": "edit", "href": "http://example.com:443/apiplatform/management/v1/services/100" }, { "templated": "true", "method": "PUT", "rel": "rename", "href": "http://example.com:443/apiplatform/management/v1/services/100/identity" }, { "templated": "true", "method": "PUT", "rel": "activate", "href": "http://example.com:443/apiplatform/management/v1/services/100/state" }, { "templated": "true", "method": "PUT", "rel": "inactivate", "href": "http://example.com:443/apiplatform/management/v1/services/100/state" }, { "templated": "true", "method": "GET", "rel": "references", "href": "http://example.com:443/apiplatform/management/v1/services/100/references" }, { "templated": "true", "method": "GET", "rel": "references.serviceaccounts", "href": "http://example.com:443/apiplatform/management/v1/services/100/references/serviceaccounts" }, { "templated": "true", "method": "GET", "rel": "grants", "href": "http://example.com:443/apiplatform/management/v1/services/100/grants" } ], "state": "ACTIVE", "id": "100", "updatedAt": "2018-01-26T09:02:35-0800", "artifacts": [ { "content-type": "application/octet-stream", "pathname": "mywsdl2.zip" } ] }