Get a Plan resource
/apiplatform/management/v1/plans/{planId}/resources/{pathname}
Returns the resource at {pathname} for the {planId} Plan. Plan resources are files attached to a plan containing image files. The {pathname} is the filename of the resource you want to view. The pathnames of attached resources appear in the artifacts array returned in response from the /plans/{planId}/
resource.
Users requesting this resource must be assigned the Plan Manager, API Manager, or Gateway Manager role and must be issued the Plan Manager, View All Details or View Public Details grant for the specified plan.
Request
- application/json
-
pathname: string
The path to the Plan resource.
-
planId: string
A unique ID referencing a specific plan.
Response
- application/json
200 Response
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 resource for 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}/resources/{pathname}
-
{planid}
is the unique Id for an plan. To retrieve available plan Ids, see Get plans. -
{pathname}
is the path name of the resource. The path names of attached resources appear in the artifacts array returned in response from View plan details. For example,"artifacts": [ { "content-type": "image/png", "pathname": "planIcon" }
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, 06 Feb 2018 09:22:45 GMT Content-Length: 1076 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 response body shows the contents of the file (planIcon
) requested in the cURL example.