View policy metadata
/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
- application/json
-
type: string
The policy type.
-
version: string
The policy version.
Response
- application/json
200 Response
object
403 Response
object
-
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
500 Response
object
-
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
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" }