REST API for the Management Service in Oracle API Platform Cloud Service

Get Services

get

/apiplatform/management/v1/services

Returns a collection of services the requesting user is authorized to view. 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. Services the user is issued the Manage Service or View All Details grants for are returned.

Request

Supported Media Types

application/json

Query Parameters

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.

[0]: string

{
    "name":"fields",
    "in":"query",
    "description":"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.",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "collectionFormat":"csv"
}

limit(optional): integer(int32)

Number of items to retrieve. 1 is the minumum; 128 is the maximum.

Default Value: 128

links(optional): array

Collection Format: csv

Filter the specified link rel's.

[0]: string

{
    "name":"links",
    "in":"query",
    "description":"Filter the specified link rel's.",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "collectionFormat":"csv"
}

offset(optional): integer(int32)

Offset the list returned results by this amount. Default is zero.

Default Value: 0

orderBy(optional): array

Collection Format: csv

Pass sorting criteria, comma separated.

[0]: string

{
    "name":"orderBy",
    "in":"query",
    "description":"Pass sorting criteria, comma separated.",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "collectionFormat":"csv"
}

q(optional): string

Pass filtering criteria, using the SCIM filter expression syntax
totalResults(optional): boolean

Include the total result count in the response.

Default Value: false

Response

Supported Media Types

application/json

200 Response

The collection of services.

Root Schema : GetServicesResponse

Match All

Show Source

object CollectionResponseFeature
object LinksResponseFeature
object CollectionResponsePagingFeature
object GetServicesResponse-allOf[3]

{
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResponseFeature"
        },
        {
            "$ref":"#/definitions/LinksResponseFeature"
        },
        {
            "$ref":"#/definitions/CollectionResponsePagingFeature"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/GetServicesItem"
                    }
                }
            }
        }
    ]
}

Nested Schema : CollectionResponseFeature

Type: object

Show Source

count(optional): integer(int32)

The number of items in this collection.

{
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of items in this collection."
        }
    }
}

Nested Schema : LinksResponseFeature

Type: object

Show Source

links(optional): array links

Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : CollectionResponsePagingFeature

Type: object

Show Source

totalResults(optional): integer(int32)

The total number of results available. Only provided if the showTotalResults query parameter is set to true

{
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of results available. Only provided if the showTotalResults query parameter is set to true"
        }
    }
}

Nested Schema : GetServicesResponse-allOf[3]

Type: object

Show Source

items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GetServicesItem"
            }
        }
    }
}

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

Nested Schema : HATEOASLink

Type: object

Show Source

href(optional): string

Link href.
method(optional): string

HTTP Operation GET, POST, PUT
rel(optional): string

Link relation.

{
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "description":"HTTP Operation GET, POST, PUT"
        },
        "rel":{
            "type":"string",
            "description":"Link relation."
        },
        "href":{
            "type":"string",
            "description":"Link href."
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: GetServicesItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GetServicesItem"
    }
}

Nested Schema : GetServicesItem

Match All

Show Source

Service
object ResourceLinksProperties

{
    "allOf":[
        {
            "$ref":"#/definitions/Service"
        },
        {
            "$ref":"#/definitions/ResourceLinksProperties"
        }
    ]
}

Nested Schema : Service

Match All

Show Source

object ServiceId
object ServiceIdentity
object ServiceDef
object ServiceState
object ServiceMetadata

{
    "allOf":[
        {
            "$ref":"#/definitions/ServiceId"
        },
        {
            "$ref":"#/definitions/ServiceIdentity"
        },
        {
            "$ref":"#/definitions/ServiceDef"
        },
        {
            "$ref":"#/definitions/ServiceState"
        },
        {
            "$ref":"#/definitions/ServiceMetadata"
        }
    ]
}

Nested Schema : ResourceLinksProperties

Type: object

Show Source

links(optional): array links

Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : ServiceId

Type: object

Show Source

id: string

The service's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The service's ID."
        }
    }
}

Nested Schema : ServiceIdentity

Type: object

Show Source

name: string

The service's name.
version(optional): string

The service's version.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The service's name."
        },
        "version":{
            "type":"string",
            "description":"The service's version."
        }
    }
}

Nested Schema : ServiceDef

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The service's description."
        },
        "type":{
            "type":"string",
            "description":"The service's type. One of HTTP, REST or SOAP."
        },
        "implementation":{
            "type":"object",
            "description":"The service's configuration.",
            "properties":{
            }
        },
        "specification":{
            "type":"object",
            "description":"The service's configuration.",
            "properties":{
                "wsdl":{
                    "type":"object",
                    "description":"The WSDL specification configuration",
                    "properties":{
                        "artifact":{
                            "type":"string",
                            "description":"pathname of the artifact."
                        },
                        "root":{
                            "type":"string",
                            "description":"in case the artifact is a ZIP file containing WSDLs and XML Schemas, root points to the root WSDL defining the SOAP service.."
                        },
                        "binding":{
                            "type":"string",
                            "description":"binding defining the SOAP service (as a QName)."
                        }
                    }
                },
                "type":{
                    "type":"string",
                    "description":"The specification type. Currently limited to WSDL."
                }
            }
        }
    }
}

Nested Schema : ServiceState

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "state":{
            "type":"string",
            "description":"The service's state. <code>ACTIVE</code> indicates it can be referenced in policies; <code>INACTIVE</code> indicates it can't be referenced in policies."
        },
        "stateComments":{
            "type":"string",
            "description":"Comments about the service's state."
        },
        "stateUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the service state."
        },
        "stateUpdatedAt":{
            "type":"string",
            "description":"The date and time the service state was last updated."
        }
    }
}

Nested Schema : ServiceMetadata

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "createdBy":{
            "type":"string",
            "description":"The user who created the service."
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the service was created."
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the service."
        },
        "updatedAt":{
            "type":"string",
            "description":"The date and time the service was last updated."
        }
    }
}

Nested Schema : implementation

Type: object

The service's configuration.

Show Source

{
    "type":"object",
    "description":"The service's configuration.",
    "properties":{
    }
}

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

{
    "type":"object",
    "description":"The service's configuration.",
    "properties":{
        "wsdl":{
            "type":"object",
            "description":"The WSDL specification configuration",
            "properties":{
                "artifact":{
                    "type":"string",
                    "description":"pathname of the artifact."
                },
                "root":{
                    "type":"string",
                    "description":"in case the artifact is a ZIP file containing WSDLs and XML Schemas, root points to the root WSDL defining the SOAP service.."
                },
                "binding":{
                    "type":"string",
                    "description":"binding defining the SOAP service (as a QName)."
                }
            }
        },
        "type":{
            "type":"string",
            "description":"The specification type. Currently limited to WSDL."
        }
    }
}

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..

{
    "type":"object",
    "description":"The WSDL specification configuration",
    "properties":{
        "artifact":{
            "type":"string",
            "description":"pathname of the artifact."
        },
        "root":{
            "type":"string",
            "description":"in case the artifact is a ZIP file containing WSDLs and XML Schemas, root points to the root WSDL defining the SOAP service.."
        },
        "binding":{
            "type":"string",
            "description":"binding defining the SOAP service (as a QName)."
        }
    }
}

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

403 Response

Forbidden.

Root Schema : Error

Type: object

Show Source

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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Root Schema : Error

Type: object

Show Source

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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Examples

The following example shows how to retrieve the services the requesting user is authorized to view 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

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:  Tue, 10 Oct 2017 07:24:25 GMT
Content-Length:  838
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 example shows the contents of the response body in JSON format, including details about the service IDs, service type, details of the policies, and other details.

{
    "offset": 0,
    "count": 3,
    "limit": 128,
    "hasMore": false,
    "links": [
        {
            "method": "GET",
            "rel": "self",
            "href": "http://example.com:443/apiplatform/management/v1/services?offset=0&=128"
        },
        {
            "method": "GET",
            "rel": "canonical",
            "href": "http://example.com:443/apiplatform/management/v1/services"
        },
        {
            "method": "POST",
            "rel": "create",
            "href": "http://example.com:443/apiplatform/management/v1/services"
        }
    ],
    "items": [
        {
            "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"
                }
            ]
        },
        {
            "createdAt": "2018-01-23T17:13:00-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": "test2",
            "links": [
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "self",
                    "href": "http://example.com:443/apiplatform/management/v1/services/101"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "canonical",
                    "href": "http://example.com:443/apiplatform/management/v1/services/101"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "preview",
                    "href": "http://example.com:443/apiplatform/management/v1/services/101/preview"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "history",
                    "href": "http://example.com:443/apiplatform/management/v1/services/101/history"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "edit",
                    "href": "http://example.com:443/apiplatform/management/v1/services/101"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "rename",
                    "href": "http://example.com:443/apiplatform/management/v1/services/101/identity"
                },
                {
                    "templated": "true",
                    "method": "DELETE",
                    "rel": "delete",
                    "href": "http://example.com:443/apiplatform/management/v1/services/101"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "activate",
                    "href": "http://example.com:443/apiplatform/management/v1/services/101/state"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "inactivate",
                    "href": "http://example.com:443/apiplatform/management/v1/services/101/state"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "references",
                    "href": "http://example.com:443/apiplatform/management/v1/services/101/references"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "references.serviceaccounts",
                    "href": "http://example.com:443/apiplatform/management/v1/services/101/references/serviceaccounts"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "grants",
                    "href": "http://example.com:443/apiplatform/management/v1/services/101/grants"
                }
            ],
            "state": "ACTIVE",
            "id": "101",
            "type": "REST",
            "updatedAt": "2018-01-26T09:02:55-0800",
            "artifacts": []
        },
        {
            "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": []
        }
    ]
}