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

Get API details

get

/apiplatform/management/v1/apis/{apiId}

Returns the details of the {apiID} API. The response also contains HATEOAS links to related operations.

Users requesting this resource must be assigned the Plan Manager, Gateway Manager or API Manager role and must be issued the Manage API, View All Details or View Public Details grants for the specified API.

Request

Supported Media Types

application/json

Path Parameters

apiId: string

A unique ID referencing a specific API.

Query Parameters

expand(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 expand values.

[0]: string

{
    "name":"expand",
    "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 expand values.",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "collectionFormat":"csv"
}

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"
}

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"
}

Response

Supported Media Types

application/json

200 Response

The API's definition.

Root Schema : GetApiResponse

Match All

Show Source

object ResourceLinksProperties
object Api

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

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 : Api

Type: object

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

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 details about a specific API 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/apis/{apiId}

{apiId} is the unique ID for an API. To retrieve available API Ids, see Get APIs.

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, 02 Jan 2017 18:18:31 GMT
Content-length: 2483
Content-type: application/json
X-oracle-dms-ecid: 4cWFx1SrR00000000
X-oracle-dms-rid: 0:1
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 the API???s details and HATEOAS links to related operations.

{
    "vanityName": "rest",
    "updatedBy": "apcsadmin",
    "implementation": {
        "executions": {
            "request": [
                "1",
                "2"
            ],
            "response": [
                "3",
                "4"
            ]
        },
        "policies": [
            {
                "schemaVersion": "1",
                "draft": false,
                "id": "1",
                "type": "o:ApiRequest",
                "version": "1.0",
                "config": {
                    "protocols": [
                        "HTTP"
                    ],
                    "url": "proc_test"
                }
            },
            {
                "schemaVersion": "3",
                "draft": false,
                "id": "2",
                "type": "o:ServiceRequest",
                "version": "1.0",
                "config": {
                    "serviceAccount": "101",
                    "serviceId": "100"
                }
            },
            {
                "schemaVersion": "1",
                "id": "3",
                "type": "o:ServiceResponse",
                "version": "1.0",
                "config": {}
            },
            {
                "schemaVersion": "1",
                "id": "4",
                "type": "o:ApiResponse",
                "version": "1.0",
                "config": {}
            }
        ],
        "specification": {
            "apiary": {
                "docType": "swagger",
                "apiaryData": {
                    "apiProjectUuid": "GUID",
                    "apiProjectUriTemplate": "https://example.io/api-projects/key",
                    "descriptionDocumentUrlTemplate": "https://example.io/api-projects/key"
                },
                "name": "Energy",
                "accessToken": "token",
                "refreshToken": "token"
            }
        }
    },
    "version": "1",
    "createdAt": "2018-02-13T10:38:13-0800",
    "createdBy": "apcsadmin",
    "publication": {
        "visibility": "PROTECTED",
        "state": "UNPUBLISHED"
    },
    "name": "proc_test",
    "details": {
        "overview": {
            "data": "Developer Portal",
            "docType": "html",
            "dataType": "text"
        },
        "documentation": {
            "docType": "apiary",
            "dataType": "specification"
        }
    },
    "links": [
        {
            "templated": "true",
            "method": "GET",
            "rel": "self",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "canonical",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "iteration",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109/iterations/5"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "history",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109/history"
        },
        {
            "templated": "true",
            "method": "PUT",
            "rel": "edit",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109"
        },
        {
            "templated": "true",
            "method": "PUT",
            "rel": "rename",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109/identity"
        },
        {
            "templated": "true",
            "method": "POST",
            "rel": "validate",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109/validation"
        },
        {
            "templated": "true",
            "method": "PUT",
            "rel": "lifecycle",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109/state"
        },
        {
            "templated": "true",
            "method": "PUT",
            "rel": "publish",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109/publication"
        },
        {
            "templated": "true",
            "method": "PUT",
            "rel": "unpublish",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109/publication"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "references",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109/references"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "references.applications",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109/references/applications"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "references.gateways",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109/references/gateways"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "references.services",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109/references/services"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "references.serviceaccounts",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109/references/serviceaccounts"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "entitlements",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109/entitlements"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "deployments",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109/deployments"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "grants",
            "href": "http://example.com:443/apiplatform/management/v1/apis/109/grants"
        }
    ],
    "state": "ALPHA",
    "id": "109",
    "iterationId": "5",
    "updatedAt": "2018-02-13T22:54:23-0800",
    "artifacts": []
}