1. REST API for the Management Service in Oracle API Platform Cloud Service - Classic
  2. Tasks
  3. APIs
  4. Iterations

Get API iteration details

get

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

Returns the details of the {iterId) iteration of the {apiId} API. The response also contains HATEOAS links to related operations.

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

Request

Supported Media Types
Path Parameters
Query Parameters
  • 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.
Back to Top

Response

Supported Media Types

200 Response

The details of this iteration of the API.
Body ()
Root Schema : GetApiResponse
Match All
Show Source
Nested Schema : ResourceLinksProperties
Type: object
Show Source
Nested Schema : Api
Type: object

403 Response

Forbidden.
Body ()
Root Schema : Error
Type: object
Show Source
Nested Schema : errorDetails
Type: array
additional errors
Show Source

500 Response

Unexpected error.
Body ()
Root Schema : Error
Type: object
Show Source
Nested Schema : errorDetails
Type: array
additional errors
Show Source
Back to Top

Examples

The following example shows how to retrieve the details of a specific iteration of an API by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X GET 
-u apicsadmin:password
https://example.com/apiplatform/management/v1/apis/{apiId}/iterations/{iterId}

  • {apiId} is the unique Id for an API. To view available API Ids, see Get APIs.

  • {iterId} is the unique ID of the iteration. To view the iteration ID of an API, see Get API details.

Example of Response Headers

The following shows an example of the response headers.

200 OK
Server: Oracle-Traffic-Director/12.2.1.0.0
Date:  Fri, 17 Mar 2017 06:07:13 GMT
Content-Length:  1038
Content-Type:  application/json
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-0002ab1c
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 iteration details, also contains HATEOAS links to related operations.

{
    "vanityName": "allied1",
    "implementation": {
        "executions": {
            "request": [
                "1",
                "5",
                "6",
                "2"
            ],
            "response": [
                "3",
                "4"
            ]
        },
        "policies": [
            {
                "draft": false,
                "id": "1",
                "type": "o:ApiRequest",
                "version": "1.0",
                "config": {
                    "protocols": [
                        "HTTP"
                    ],
                    "url": "allied1"
                }
            },
            {
                "draft": false,
                "id": "2",
                "type": "o:ServiceRequest",
                "version": "1.0",
                "config": {
                    "url": "http://example.com:443/apiplatform/developers/v1/public/enabled"
                }
            },
            {
                "id": "3",
                "type": "o:ServiceResponse",
                "version": "1.0",
                "config": {}
            },
            {
                "id": "4",
                "type": "o:ApiResponse",
                "version": "1.0",
                "config": {}
            },
            {
                "comments": "",
                "draft": false,
                "id": "5",
                "type": "o:KeyValidation",
                "version": "1.0",
                "config": {
                    "keysource": "HEADER",
                    "keyheader": "X-APP-KEY"
                }
            },
            {
                "comments": "",
                "draft": false,
                "id": "6",
                "type": "o:apiRateLimiting",
                "version": "1.0",
                "config": {
                    "conjunction": "ALL",
                    "action": "REJECT",
                    "conditions": [
                        {
                            "rateLimit": "8",
                            "interval": "Minute"
                        }
                    ]
                }
            }
        ]
    },
    "description": "Fast and easy real estate mortgage payment calculator",
    "version": "1.0",
    "createdAt": "2018-02-05T10:27:27-0800",
    "createdBy": "apicsadmin",
    "publication": {
        "visibility": "PROTECTED",
        "portalUrl": "http://example.com:443/developers/apis/allied1",
        "state": "PUBLISHED",
        "iterationId": "1"
    },
    "name": "Allied Mortgage Calculator",
    "details": {
        "overview": {
            "data": "http://example.com:443/apidocs/sample.html",
            "docType": "html",
            "dataType": "link"
        },
        "documentation": {
            "data": "http://example.com:443/apidocs/sample.md",
            "docType": "markdown",
            "dataType": "link"
        }
    },
    "links": [
        {
            "templated": "true",
            "method": "GET",
            "rel": "self",
            "href": "http://example.com:443/apiplatform/management/v1/apis/100/iterations/1"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "canonical",
            "href": "http://example.com:443/apiplatform/management/v1/apis/100"
        }
    ],
    "state": "RELEASED",
    "id": "100",
    "iterationId": "1",
    "artifacts": []
}
Back to Top