Jump to

• Request
• Response
• Examples

View deployed API definition

get

/apiplatform/management/v1/apis/{apiId}/deployments/{depId}/api

Returns the runtime definition of the {depId} deployment of the {apiId} API.

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

Request

Supported Media Types

• application/json

Path Parameters

• apiId: string
  A unique ID referencing a specific API.
• depId: string
  A unique ID referencing a specific deployment.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The deployed API.

Body ()

Root Schema : DeployedApi

Type: object

Show Source

• implementation(optional): object implementation

{
    "type":"object",
    "properties":{
        "implementation":{
            "type":"object",
            "properties":{
            }
        }
    }
}

Nested Schema : implementation

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

403 Response

Forbidden.

Body ()

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.

Body ()

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

Back to Top

Examples

The following example shows how to retrieve the runtime definition of the deployment 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}/deployments/{depId}/api

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

• {depId} is the unique ID for a deployment. To retrieve available deployment IDs, see Get API deployments.

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date:  Fri, 17 Mar 2017 07:31:31 GMT
Server: Oracle-Traffic-Director/12.2.1.0.0
Content-Length:  522
Content-Type:  application/json
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-0002af4a
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 the ID, name, version, and iteration of the deployment.

{
    "implementation": {
        "executions": {
            "request": [
                "1",
                "2"
            ],
            "response": [
                "3",
                "4"
            ]
        },
        "policies": [
            {
                "draft": false,
                "id": "1",
                "type": "o:ApiRequest",
                "version": "1.0",
                "config": {
                    "protocols": [
                        "HTTP"
                    ],
                    "url": "exampleEndpoint"
                }
            },
            {
                "draft": false,
                "id": "2",
                "type": "o:ServiceRequest",
                "version": "1.0",
                "config": {
                    "useProxy": true,
                    "url": "http://www.example.com"
                }
            },
            {
                "id": "3",
                "type": "o:ServiceResponse",
                "version": "1.0",
                "config": {}
            },
            {
                "id": "4",
                "type": "o:ApiResponse",
                "version": "1.0",
                "config": {}
            }
        ]
    },
    "name": "john test",
    "id": "103",
    "iterationId": "3",
    "version": "1"
}

Back to Top