Return the Apiary project
/apiplatform/management/v1/apis/{apiId}/iterations/{iterId}/apiary
Returns the Apiary project for the given iteration.
Users requesting this resource must be assigned the View Public Details grant for the specified API.
Request
- application/json
-
apiId: string
A unique ID referencing a specific API.
-
iterId: string
A unique ID referencing a specific iteration of an API.
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 details of the Apiary API project configured for the {iterId}
iteration of the {apiId}
API 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/management/v1/apis/{apiId}/iterations/{iterId}/apiary
-
{apiid}
is the unique ID for an API. To retrieve available plan IDs, see Get APIs. -
{iterId}
is the unique ID of the iteration. To view the iteration ID of an API, see Get API details.
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, 22 Mar 2017 09:43:13 GMT Content-Length: 785 Content-Type: text/html;charset=utf-8 X-oracle-dms-ecid: 49d14691-2176-4c99-aed3-38438604f528-00001e9d 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 example shows the contents of the response body in JSON format.
{ "visibility": "public", "gitHubConnected": false, "_links": { "add": { "href": "https://example.apiary.io/api-projects/5888e533f82a9c1f00b0b03d/add" }, "owner": { "href": "https://example.apiary.io/users/57599a5f5a4e710b004533e8" }, "mockUrl": { "href": "http://private-energy23.apiary-mock.com/" }, "htmlEdit": { "href": "https://app.apiary.io/energy23/editor" }, "self": { "href": "https://example.apiary.io/api-projects/5888e533f82a9c1f00b0b03d" }, "ap": { "href": "https://energy23.docs.apiary.io/" } }, "_embedded": { "embedCode": { "scriptCode": "var embed = new Apiary.Embed({uuid: '5888e533f82a9c1f00b0b03d', token: '{your token})", "src": "https://api.apiary.io/seeds/embed.js", "token": "{your token} " }, "version": { "lastUpdated": "2017-01-25T17:49:48.274Z", "_links": { "add": { "href": "https://example.apiary.io/api-projects/version/5888e53ca6e17c1f0072d230/add" }, "self": { "href": "https://example.apiary.io/api-projects/version/5888e53ca6e17c1f0072d230" } }, "author": { "name": "API Developer", "source": "apiary" }, "uuid": "5888e53ca6e17c1f0072d230" } }, "name": "Gas and Electricity Usage", "subdomain": "energy23", "type": "swagger", "uuid": "5888e533f82a9c1f00b0b03d" }