Get policies of a specified type
get
/apiplatform/administration/v1/policies/{type}
Returns policies of the specified {type}
. The response also contains HATEOAS links to related operations.
Users requesting this resource must be assigned the Administrator role.
Request
Supported Media Types
- application/json
Path Parameters
-
type: string
A policy type.
Query Parameters
-
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. - links(optional): array
Response
Supported Media Types
- application/json
200 Response
A collection of policies with the specified type.
Nested Schema : PolicyCollectionResponse-allOf[0]
Type:
Show Source
object
-
items(optional):
array items
A collection of policies.
Nested Schema : CollectionResponseFeature
Type:
Show Source
object
-
count(optional):
integer(int32)
The number of items in this collection.
Nested Schema : LinksResponseFeature
Type:
Show Source
object
-
links(optional):
array links
Includes 'canonical'.
Nested Schema : Policy
Type:
Show Source
object
-
createdAt(optional):
string
The date and time the policy was created.
-
createdBy(optional):
string
The user who created the policy.
-
description(optional):
string
The policy's description.
-
lastUpdatedAt(optional):
string
The date and time the policy was last updated.
-
lastUpdatedBy(optional):
string
The user who last updated the policy.
-
name(optional):
string
The policy's name.
-
revision(optional):
integer
The policy's revision.
-
type(optional):
string
The policy's type.
-
version(optional):
string
The policy's version.
Nested Schema : HATEOASLink
Type:
Show Source
object
-
href(optional):
string
Link href.
-
method(optional):
string
HTTP Operation GET, POST, PUT
-
rel(optional):
string
Link relation.
403 Response
Forbidden.
Root Schema : Error
Type:
Show Source
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
Unexpected error.
Root Schema : Error
Type:
Show Source
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 all policies of a specified type 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/administration/v1/policies/o:MethodMapping
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.2.0 Date: Thu, 05 Jan 2017 18:37:06 GMT Content-length: 578 Content-type: application/json X-oracle-dms-ecid: DNeNo1x2000000000 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.2.0
Example of Response Body
The following example shows the contents of the response body in JSON format, including details about the policies and HATEOAS links to related operations.
{ "count": 1, "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "https://example.com:443/apiplatform/administration/v1/policies/o:MethodMapping" }, { "templated": "true", "method": "GET", "rel": "canonical", "href": "https://example.com:443/apiplatform/administration/v1/policies/o:MethodMapping" } ], "items": [ { "createdAt": "2017-01-05T02:46:34+0000", "updatedBy": "anonymous", "createdBy": "anonymous", "name": "Method Mapping", "description": "Routes to backend service based on method", "type": "o:MethodMapping", "version": "1.0", "revision": 1, "updatedAt": "2017-01-05T02:46:34+0000" } ] }