1. REST API for the Management Service in Oracle API Platform Cloud Service
  2. Tasks
  3. Policies

View policy metadata

get

/apiplatform/management/v1/policies/{type}/{version}/metadata

Returns metadata for the {version} version of the {type} policy.

Users requesting this resource must be assigned the API Manager, or Gateway Manager role and must be issued the Manage API or View All Details grant for an API or the Manage Gateway or View All Details grant for a gateway.

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

The policy's metadata.
Body ()
Root Schema : PolicyMetadata
Type: object
Policy metadata. See the operation's example for details.

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 metadata of a policy 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/policies/{type}/{version}/metadata

  • {type} is the type of the policy. To retrieve available types, see Get policy types.

  • {version} is the version of the policy. To view the version of a policy type, see Get policy types.

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:  Wed, 15 Mar 2017 07:06:09 GMT
Content-Length:  1010
Content-Type:  application/json
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-00021d3f
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.

{
  "ui": {
    "view": {
      "helpInfo": "#helpInfo",
      "js": "keyvalidation-view.js",
      "helpUrl": "http://www.oracle.com",
      "html": "keyvalidation-view.html",
      "helpTopicId": "policies.key-validation"
    },
    "edit": {
      "helpInfo": "#helpInfo",
      "js": "keyvalidation-edit.js",
      "helpUrl": "http://www.oracle.com",
      "html": "keyvalidation-edit.html",
      "helpTopicId": "policies.key-validation"
    },
    "l10nbundle": "L10n/keyvalidation.json"
  },
  "configuration": {
    "services": [
      {
        "service": "oracle.apiplatform.policies.keyvalidation.KeyValidationValidator",
        "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator"
      }
    ]
  },
  "name": "Key Validation",
  "description": "Enforces that a valid key is provided in the request. The key must be valid and the application must be in the \"Registered\" state for this API.",
  "type": "o:KeyValidation",
  "category": "@implementations.policyCategory.security",
  "version": "1.0",
  "constraints": {
    "singleton": true,
    "requestZone": "10",
    "direction": "REQUEST"
  },
  "ocsgActionName": "AppKeyValidation",
  "revision": "1"
}
Back to Top