Get References for Plan
/apiplatform/management/v1/plans/{planId}/references
Returns the gateways that the {planId}
plan references.
Users requesting this resource must be assigned the Plan Manager, API Manager, or Gateway Manager role and must be issued the Manager Plan or View All Details grant for the specified plan.
Request
- application/json
-
planId: string
A unique ID referencing a specific plan.
-
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. -
limit(optional): integer(int32)
Number of items to retrieve.
1
is the minumum;128
is the maximum.Default Value:128
-
offset(optional): integer(int32)
Offset the list returned results by this amount. Default is zero.Default Value:
0
- orderBy(optional): array
-
q(optional): string
Pass filtering criteria, using the SCIM filter expression syntax
-
totalResults(optional): boolean
Include the total result count in the response.Default Value:
false
Response
- application/json
200 Response
object
-
count(optional):
integer(int32)
The number of items in this collection.
object
-
totalResults(optional):
integer(int32)
The total number of results available. Only provided if the showTotalResults query parameter is set to true
object
-
id:
string
The reference's ID.
-
name(optional):
string
The reference's name.
-
type:
string
The reference's type.
-
version(optional):
string
The reference's version.
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 the gateways referenced to a specific plan 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/plans/{planId}/references
-
{planid}
is the unique Id for an plan. To retrieve available plan Ids, see Get plans.
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: Tue, 13 Feb 2018 09:32:37 GMT Content-Length: 333 Content-Type???image/png X-oracle-dms-ecid: 49d14691-2176-4c99-aed3-38438604f528-00001dcd x-oracle-dms-rid: 0 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0
Example of Response Body
The following shows an example of the response body, including the name, ID of the gateway referenced to the plan.
{ "offset": 0, "count": 2, "limit": 128, "hasMore": false, "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "http://example.com:7201/apiplatform/management/v1/plans/119/references?offset=0&=128" } ], "items": [ { "name": "Production Gateway", "id": "100", "type": "Gateway" }, { "name": "GoldGw", "id": "101", "type": "Gateway" } ] }