Jump to

• Request
• Response
• Examples

Get all policies

get

/apiplatform/administration/v1/policies

Returns a collection of all policies.

Users requesting this resource must be assigned the Administrator role.

Request

Supported Media Types

• application/json

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.

  • [0]: string

  {
      "name":"fields",
      "in":"query",
      "description":"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.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• links(optional): array
  Collection Format: csv

  Filter the specified link rel's.

  • [0]: string

  {
      "name":"links",
      "in":"query",
      "description":"Filter the specified link rel's.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

Back to Top

Response

Supported Media Types

• application/json

200 Response

The collection of policies.

Body ()

Root Schema : PolicyCollectionResponse

Match All

Show Source

• object PolicyCollectionResponse-allOf[0]
• object CollectionResponseFeature
• object LinksResponseFeature

{
    "allOf":[
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "description":"A collection of policies.",
                    "items":{
                        "$ref":"#/definitions/Policy"
                    }
                }
            }
        },
        {
            "$ref":"#/definitions/CollectionResponseFeature"
        },
        {
            "$ref":"#/definitions/LinksResponseFeature"
        }
    ]
}

Nested Schema : PolicyCollectionResponse-allOf[0]

Type: object

Show Source

• items(optional): array items
  A collection of policies.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"A collection of policies.",
            "items":{
                "$ref":"#/definitions/Policy"
            }
        }
    }
}

Nested Schema : CollectionResponseFeature

Type: object

Show Source

• count(optional): integer(int32)
  The number of items in this collection.

{
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of items in this collection."
        }
    }
}

Nested Schema : LinksResponseFeature

Type: object

Show Source

• links(optional): array links
  Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : items

Type: array

A collection of policies.

Show Source

• Array of: object Policy

{
    "type":"array",
    "description":"A collection of policies.",
    "items":{
        "$ref":"#/definitions/Policy"
    }
}

Nested Schema : Policy

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The policy's name."
        },
        "type":{
            "type":"string",
            "description":"The policy's type."
        },
        "version":{
            "type":"string",
            "description":"The policy's version."
        },
        "revision":{
            "type":"integer",
            "description":"The policy's revision."
        },
        "description":{
            "type":"string",
            "description":"The policy's description."
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the policy was created."
        },
        "createdBy":{
            "type":"string",
            "description":"The user who created the policy."
        },
        "lastUpdatedAt":{
            "type":"string",
            "description":"The date and time the policy was last updated."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the policy."
        }
    }
}

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

• Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

Nested Schema : HATEOASLink

Type: object

Show Source

• href(optional): string
  Link href.
• method(optional): string
  HTTP Operation GET, POST, PUT
• rel(optional): string
  Link relation.

{
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "description":"HTTP Operation GET, POST, PUT"
        },
        "rel":{
            "type":"string",
            "description":"Link relation."
        },
        "href":{
            "type":"string",
            "description":"Link href."
        }
    }
}

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 details about all policies 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

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:32:20 GMT
Content-type: application/json
X-oracle-dms-ecid: UShgJ1E3000000000
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.2.0
Transfer-encoding: chunked

Example of Response Body

The following example shows the contents of the response body in JSON format, including details about each policy and HATEOAS links to related operations.

{
  "count": 24,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "https://example.com:443/apiplatform/administration/v1/policies"
    },
    {
      "method": "GET",
      "rel": "canonical",
      "href": "https://example.com:443/apiplatform/administration/v1/policies"
    }
  ],
  "items": [
    {
      "createdAt": "2017-01-05T02:46:30+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "Header Validation",
      "description": "Validates the presence and values of http headers. Can be used for security or to reduce the occurrence of failures/errors at the service layer",
      "type": "o:HeaderValidation",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:30+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:30+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "Service Response",
      "description": "Response from the service",
      "type": "o:ServiceResponse",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:30+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:30+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "Redaction",
      "description": "Manages the fields and headers in the request or response payload. You can either explicitly include, or exclude, the headers and fields sent to the backend service (from the request flow) or sent to the client (from the response flow).",
      "type": "o:FieldRedaction",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:30+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:30+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "OAuth 2.0",
      "description": "Enforces using the OAuth 2.0 protocol, that access to this API is only available to request on behalf of one of the listed accounts below.",
      "type": "o:OAuth",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:30+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:31+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "API Request",
      "description": "This is the relative URI at which the gateway will receive requests for the API. The Gateway IP address, and API Endpoint URI will constitute the full URL for the API.",
      "type": "o:ApiRequest",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:31+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:31+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "Application Rate Limiting",
      "description": "Enforces a limit on the total number of requests to this API per application. Rejects any requests above the defined limit. NOTE: this is different than API rate limiting",
      "type": "o:ApplicationRateLimiting",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:31+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:31+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "Service Request",
      "description": "Specify the backend service URL",
      "type": "o:ServiceRequest",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:31+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:31+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "Logging",
      "description": "Writes a message to the log.",
      "type": "o:Logging",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:31+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:31+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "Application Based Routing",
      "description": "The request will be routed based on the application.",
      "type": "o:ApplicationBasedRouting",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:31+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:31+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "Groovy Script",
      "description": "Executes Groovy script",
      "type": "o:GroovyScript",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:31+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:31+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "API Response",
      "description": "Response from the API",
      "type": "o:ApiResponse",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:31+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:32+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "Service Level Auth",
      "description": "Enforces using the Service Level Auth protocol, that access to this API is only available to request on behalf of one of the listed accounts below.",
      "type": "o:ServiceAuth",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:32+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:32+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "Interface Filtering",
      "description": "Evaluates the application generating the API request.",
      "type": "o:InterfaceFiltering",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:32+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:32+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "Resource Based Routing",
      "description": "The request will be routed based on the resource path. Can be used for security or to reduce the occurrence of failures/errors at the service layer",
      "type": "o:ResourceBasedRouting",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:32+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:32+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "IP Filter Validation",
      "description": "Validates the IP address of the requester. Based on the value of IP the  address, determine whether to pass or reject value.",
      "type": "o:IPFilterValidation",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:32+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:33+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "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",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:33+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:33+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "API Rate Limiting",
      "description": "Enforces a limit on the total number of requests to this API. Rejects any requests above the defined limit. NOTE: this is different than the application-based rate limiting.",
      "type": "o:apiRateLimiting",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:33+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:33+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "Service Callout",
      "description": "Invokes the configured external service with or without payload, with the provided headers and process the incoming request on the basis of response HTTP Status Code from the external service.",
      "type": "o:ServiceCallout",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:33+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:33+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "CORS",
      "description": "Controls which domains are allowed to invoke this API.",
      "type": "o:CORS",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:33+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:34+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "Header Based Routing",
      "description": "The request will be routed based on the header. Can be used for security or to reduce the occurrence of failures/errors at the service layer",
      "type": "o:HeaderBasedRouting",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:34+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:34+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "Basic Auth",
      "description": "Enforces using the Basic Auth protocol, that access to this API is only available to request on behalf of one of the listed accounts below.",
      "type": "o:BasicAuth",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:34+0000"
    },
    {
      "createdAt": "2017-01-05T02:46:34+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "Gateway Based Routing",
      "description": "The request will be routed based on the gateway.",
      "type": "o:GatewayBasedRouting",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:34+0000"
    },
    {
      "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"
    },
    {
      "createdAt": "2017-01-05T02:46:34+0000",
      "updatedBy": "anonymous",
      "createdBy": "anonymous",
      "name": "API Throttling - Delay",
      "description": "Enforces a limit on the number of requests to this API before introducing additional latency. NOTE: this policy differs from the Application Rate Limiting or API Rate Limiting policies.",
      "type": "o:ApiThrottlingDelay",
      "version": "1.0",
      "revision": 1,
      "updatedAt": "2017-01-05T02:46:34+0000"
    }
  ]
}

Back to Top